DescribeExplainabilityExport
Describes an Explainability export created using the CreateExplainabilityExport operation.
Request Syntax
{
"ExplainabilityExportArn": "string"
}Request Parameters
The request accepts the following data in JSON format.
- ExplainabilityExportArn
-
The Amazon Resource Name (ARN) of the Explainability export.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+Required: Yes
Response Syntax
{
"CreationTime": number,
"Destination": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"ExplainabilityArn": "string",
"ExplainabilityExportArn": "string",
"ExplainabilityExportName": "string",
"Format": "string",
"LastModificationTime": number,
"Message": "string",
"Status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
When the Explainability export was created.
Type: Timestamp
- Destination
-
The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
Type: DataDestination object
- ExplainabilityArn
-
The Amazon Resource Name (ARN) of the Explainability export.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+ - ExplainabilityExportArn
-
The Amazon Resource Name (ARN) of the Explainability export.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+ - ExplainabilityExportName
-
The name of the Explainability export.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]* - Format
-
The format of the exported data, CSV or PARQUET.
Type: String
Length Constraints: Maximum length of 7.
Pattern:
^CSV|PARQUET$ - LastModificationTime
-
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING- TheCreationTime. -
CREATE_IN_PROGRESS- The current timestamp. -
CREATE_STOPPING- The current timestamp. -
CREATE_STOPPED- When the job stopped. -
ACTIVEorCREATE_FAILED- When the job finished or failed.
Type: Timestamp
-
- Message
-
Information about any errors that occurred during the export.
Type: String
- 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
Type: String
Length Constraints: Maximum length of 256.
-
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
