Skip to content

/AWS1/CL_FCSDSCEXPLAINABILIT03

DescribeExplainabilityExportResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_explainabilityexportarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the Explainability export.

iv_explainabilityexportname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the Explainability export.

iv_explainabilityarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the Explainability export.

io_destination TYPE REF TO /AWS1/CL_FCSDATADESTINATION /AWS1/CL_FCSDATADESTINATION

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

iv_message TYPE /AWS1/FCSMESSAGE /AWS1/FCSMESSAGE

Information about any errors that occurred during the export.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

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

iv_format TYPE /AWS1/FCSFORMAT /AWS1/FCSFORMAT

The format of the exported data, CSV or PARQUET.


Queryable Attributes

ExplainabilityExportArn

The Amazon Resource Name (ARN) of the Explainability export.

Accessible with the following methods

Method Description
GET_EXPLAINABILITYEXPORTARN() Getter for EXPLAINABILITYEXPORTARN, with configurable defaul
ASK_EXPLAINABILITYEXPORTARN() Getter for EXPLAINABILITYEXPORTARN w/ exceptions if field ha
HAS_EXPLAINABILITYEXPORTARN() Determine if EXPLAINABILITYEXPORTARN has a value

ExplainabilityExportName

The name of the Explainability export.

Accessible with the following methods

Method Description
GET_EXPLAINABILITYEXPORTNAME() Getter for EXPLAINABILITYEXPORTNAME, with configurable defau
ASK_EXPLAINABILITYEXPORTNAME() Getter for EXPLAINABILITYEXPORTNAME w/ exceptions if field h
HAS_EXPLAINABILITYEXPORTNAME() Determine if EXPLAINABILITYEXPORTNAME has a value

ExplainabilityArn

The Amazon Resource Name (ARN) of the Explainability export.

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

Destination

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

Accessible with the following methods

Method Description
GET_DESTINATION() Getter for DESTINATION

Message

Information about any errors that occurred during the export.

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

Format

The format of the exported data, CSV or PARQUET.

Accessible with the following methods

Method Description
GET_FORMAT() Getter for FORMAT, with configurable default
ASK_FORMAT() Getter for FORMAT w/ exceptions if field has no value
HAS_FORMAT() Determine if FORMAT has a value