Skip to content

/AWS1/CL_FCSDSCEXPLAINABILIT01

DescribeExplainabilityResponse

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 resource.

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_enablevisualization TYPE /AWS1/FCSBOOLEAN /AWS1/FCSBOOLEAN

Whether the visualization was enabled for the Explainability resource.

io_datasource TYPE REF TO /AWS1/CL_FCSDATASOURCE /AWS1/CL_FCSDATASOURCE

The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

io_schema TYPE REF TO /AWS1/CL_FCSSCHEMA /AWS1/CL_FCSSCHEMA

Defines the fields of a dataset.

iv_startdatetime TYPE /AWS1/FCSLOCALDATETIME /AWS1/FCSLOCALDATETIME

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

iv_enddatetime TYPE /AWS1/FCSLOCALDATETIME /AWS1/FCSLOCALDATETIME

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

iv_estimatedtimeremainingi00 TYPE /AWS1/FCSLONG /AWS1/FCSLONG

The estimated time remaining in minutes for the CreateExplainability job to complete.

iv_message TYPE /AWS1/FCSMESSAGE /AWS1/FCSMESSAGE

If an error occurred, a message about the error.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

The status of the Explainability resource. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the Explainability resource 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 resource.

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

EnableVisualization

Whether the visualization was enabled for the Explainability resource.

Accessible with the following methods

Method Description
GET_ENABLEVISUALIZATION() Getter for ENABLEVISUALIZATION, with configurable default
ASK_ENABLEVISUALIZATION() Getter for ENABLEVISUALIZATION w/ exceptions if field has no
HAS_ENABLEVISUALIZATION() Determine if ENABLEVISUALIZATION has a value

DataSource

The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

Accessible with the following methods

Method Description
GET_DATASOURCE() Getter for DATASOURCE

Schema

Defines the fields of a dataset.

Accessible with the following methods

Method Description
GET_SCHEMA() Getter for SCHEMA

StartDateTime

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

Accessible with the following methods

Method Description
GET_STARTDATETIME() Getter for STARTDATETIME, with configurable default
ASK_STARTDATETIME() Getter for STARTDATETIME w/ exceptions if field has no value
HAS_STARTDATETIME() Determine if STARTDATETIME has a value

EndDateTime

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

Accessible with the following methods

Method Description
GET_ENDDATETIME() Getter for ENDDATETIME, with configurable default
ASK_ENDDATETIME() Getter for ENDDATETIME w/ exceptions if field has no value
HAS_ENDDATETIME() Determine if ENDDATETIME has a value

EstimatedTimeRemainingInMinutes

The estimated time remaining in minutes for the CreateExplainability job to complete.

Accessible with the following methods

Method Description
GET_ESTIMATEDTIMEREMAINING00() Getter for ESTIMATEDTIMEREMAININGINMINS, with configurable d
ASK_ESTIMATEDTIMEREMAINING00() Getter for ESTIMATEDTIMEREMAININGINMINS w/ exceptions if fie
HAS_ESTIMATEDTIMEREMAINING00() Determine if ESTIMATEDTIMEREMAININGINMINS has a value

Message

If an error occurred, a message about the error.

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

Status

The status of the Explainability resource. 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

CreationTime

When the Explainability resource 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