explainability_exports

Creates, updates, deletes, gets or lists an explainability_exports resource.

Overview

Name	explainability_exports
Type	Resource
Id	aws.forecast.explainability_exports

Fields

The following fields are returned by SELECT queries:

describe_explainability_export

Name	Datatype	Description
creation_time	string (date-time)	When the Explainability export was created.
destination	object	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).
explainability_arn	string	The Amazon Resource Name (ARN) of the Explainability export. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
explainability_export_arn	string	The Amazon Resource Name (ARN) of the Explainability export. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
explainability_export_name	string	The name of the Explainability export. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
format	string	The format of the exported data, CSV or PARQUET. (pattern: <code>^CSV|PARQUET$</code>)
last_modification_time	string (date-time)	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.
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

list_explainability_exports

Name	Datatype	Description
creation_time	string (date-time)	When the Explainability was created.
destination	object	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).
explainability_export_arn	string	The Amazon Resource Name (ARN) of the Explainability export. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
explainability_export_name	string	The name of the Explainability export (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
last_modification_time	string (date-time)	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.
message	string	Information about any errors that may have occurred during the Explainability 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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_explainability_export	select	region		Describes an Explainability export created using the CreateExplainabilityExport operation.
list_explainability_exports	select	region		Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
create_explainability_export	insert	region, ExplainabilityExportName, ExplainabilityArn		Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
delete_explainability_export	delete	region		Deletes an Explainability export.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_explainability_export

Describes an Explainability export created using the CreateExplainabilityExport operation.

SELECT
creation_time,
destination,
explainability_arn,
explainability_export_arn,
explainability_export_name,
format,
last_modification_time,
message,
status
FROM aws.forecast.explainability_exports
WHERE region = '{{ region }}' -- required
;

list_explainability_exports

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.

SELECT
creation_time,
destination,
explainability_export_arn,
explainability_export_name,
last_modification_time,
message,
status
FROM aws.forecast.explainability_exports
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_explainability_export

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

INSERT INTO aws.forecast.explainability_exports (
ExplainabilityExportName,
ExplainabilityArn,
Destination,
Tags,
Format,
region
)
SELECT 
'{{ ExplainabilityExportName }}' /* required */,
'{{ ExplainabilityArn }}' /* required */,
'{{ Destination }}',
'{{ Tags }}',
'{{ Format }}',
'{{ region }}'
RETURNING
explainability_export_arn
;

Manifest

# Description fields are for documentation purposes
- name: explainability_exports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the explainability_exports resource.
  - name: ExplainabilityExportName
    value: "{{ ExplainabilityExportName }}"
    description: |
      A unique name for the Explainability export.
  - name: ExplainabilityArn
    value: "{{ ExplainabilityArn }}"
    description: |
      The Amazon Resource Name (ARN) of the Explainability to export.
  - name: Destination
    description: |
      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).
    value:
      S3Config:
        Path: "{{ Path }}"
        RoleArn: "{{ RoleArn }}"
        KMSKeyArn: "{{ KMSKeyArn }}"
  - name: Tags
    description: |
      Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive. The following restrictions apply to tags: For each resource, each tag key must be unique and each tag key must have one value. Maximum number of tags per resource: 50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256 Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply. Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Format
    value: "{{ Format }}"
    description: |
      The format of the exported data, CSV or PARQUET.

DELETE examples

delete_explainability_export

Deletes an Explainability export.

DELETE FROM aws.forecast.explainability_exports
WHERE region = '{{ region }}' --required
;