Skip to content

/AWS1/CL_FCSEXPLAINABILITYSUMM

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ExplainabilityArn.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_explainabilityarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the Explainability.

iv_explainabilityname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the Explainability.

iv_resourcearn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

io_explainabilityconfig TYPE REF TO /AWS1/CL_FCSEXPLAINABILITYCFG /AWS1/CL_FCSEXPLAINABILITYCFG

The configuration settings that define the granularity of time series and time points for the Explainability.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

The status of the Explainability. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

iv_message TYPE /AWS1/FCSMESSAGE /AWS1/FCSMESSAGE

Information about any errors that may have occurred during the Explainability creation process.

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the Explainability was created.

iv_lastmodificationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Queryable Attributes

ExplainabilityArn

The Amazon Resource Name (ARN) of the Explainability.

Accessible with the following methods

Method Description
GET_EXPLAINABILITYARN() Getter for EXPLAINABILITYARN, with configurable default
ASK_EXPLAINABILITYARN() Getter for EXPLAINABILITYARN w/ exceptions if field has no v
HAS_EXPLAINABILITYARN() Determine if EXPLAINABILITYARN has a value

ExplainabilityName

The name of the Explainability.

Accessible with the following methods

Method Description
GET_EXPLAINABILITYNAME() Getter for EXPLAINABILITYNAME, with configurable default
ASK_EXPLAINABILITYNAME() Getter for EXPLAINABILITYNAME w/ exceptions if field has no
HAS_EXPLAINABILITYNAME() Determine if EXPLAINABILITYNAME has a value

ResourceArn

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

Accessible with the following methods

Method Description
GET_RESOURCEARN() Getter for RESOURCEARN, with configurable default
ASK_RESOURCEARN() Getter for RESOURCEARN w/ exceptions if field has no value
HAS_RESOURCEARN() Determine if RESOURCEARN has a value

ExplainabilityConfig

The configuration settings that define the granularity of time series and time points for the Explainability.

Accessible with the following methods

Method Description
GET_EXPLAINABILITYCONFIG() Getter for EXPLAINABILITYCONFIG

Status

The status of the Explainability. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

Message

Information about any errors that may have occurred during the Explainability creation process.

Accessible with the following methods

Method Description
GET_MESSAGE() Getter for MESSAGE, with configurable default
ASK_MESSAGE() Getter for MESSAGE w/ exceptions if field has no value
HAS_MESSAGE() Determine if MESSAGE has a value

CreationTime

When the Explainability was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

LastModificationTime

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Accessible with the following methods

Method Description
GET_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME, with configurable default
ASK_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME w/ exceptions if field has n
HAS_LASTMODIFICATIONTIME() Determine if LASTMODIFICATIONTIME has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_EXPLAINABILITIES

TYPES TT_EXPLAINABILITIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_FCSEXPLAINABILITYSUMM WITH DEFAULT KEY
.