describe_explainability_export

ForecastService.Client.describe_explainability_export(**kwargs)

Describes an Explainability export created using the CreateExplainabilityExport operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_explainability_export(
    ExplainabilityExportArn='string'
)

Parameters

ExplainabilityExportArn (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'ExplainabilityExportArn': 'string',
    'ExplainabilityExportName': 'string',
    'ExplainabilityArn': 'string',
    'Destination': {
        'S3Config': {
            'Path': 'string',
            'RoleArn': 'string',
            'KMSKeyArn': 'string'
        }
    },
    'Message': 'string',
    'Status': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'Format': 'string'
}

Response Structure

• (dict) --
  • ExplainabilityExportArn (string) --

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

  • ExplainabilityExportName (string) --

    The name of the Explainability export.

  • ExplainabilityArn (string) --

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

  • Destination (dict) --

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

    • S3Config (dict) --

      The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

      • Path (string) --

        The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

      • RoleArn (string) --

        The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

        Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

      • KMSKeyArn (string) --

        The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.

  • Message (string) --

    Information about any errors that occurred during the export.

  • Status (string) --

    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
  • CreationTime (datetime) --

    When the Explainability export was created.

  • LastModificationTime (datetime) --

    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.
  • Format (string) --

    The format of the exported data, CSV or PARQUET.

Exceptions

• ForecastService.Client.exceptions.InvalidInputException
• ForecastService.Client.exceptions.ResourceNotFoundException