exports

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

Overview

Name	exports
Type	Resource
Id	aws.simpledbv2.exports

Fields

The following fields are returned by SELECT queries:

get_export

Name	Datatype	Description
client_token	string	The client token provided for this export.
domain_name	string	The name of the domain that was exported.
export_arn	string	A unique ARN identifier for the export.
export_data_cutoff_time	string (date-time)	The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
export_manifest	string	The name of the manifest summary file for the export.
export_status	string	The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error. (PENDING, IN_PROGRESS, SUCCEEDED, FAILED)
failure_code	string	Failure code for the result of the failed export. (pattern: <code>[a-zA-Z0-9]+</code>)
failure_message	string	Export failure reason description.
items_count	integer (int64)	Total number of exported items.
requested_at	string (date-time)	Timestamp when the export request was received by the service.
s_3_bucket	string	The name of the S3 bucket for this export. (pattern: <code>[a-z0-9A-Z]+[.-\w]*[a-z0-9A-Z]+</code>)
s_3_bucket_owner	string	The S3 bucket owner account ID for this export. (pattern: <code>[0-9]{12}</code>)
s_3_key_prefix	string	The S3 key prefix provided in the corresponding StartDomainExport request.
s_3_sse_algorithm	string	The S3 SSE encryption algorithm for this export. (AES256, KMS)
s_3_sse_kms_key_id	string	The KMS key ID for this export.

list_exports

Name	Datatype	Description
domain_name	string	The domain name that uniquely identifies a SimpleDB domain within your account.
export_arn	string	A unique ARN identifier for the export.
export_status	string	The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error. (PENDING, IN_PROGRESS, SUCCEEDED, FAILED)
requested_at	string (date-time)	Timestamp when the export request was received by the service

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_export	select	region		Returns information for an existing domain export.
list_exports	select	region		Lists all exports that were created. The results are paginated and can be filtered by domain name.

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

get_export

Returns information for an existing domain export.

SELECT
client_token,
domain_name,
export_arn,
export_data_cutoff_time,
export_manifest,
export_status,
failure_code,
failure_message,
items_count,
requested_at,
s_3_bucket,
s_3_bucket_owner,
s_3_key_prefix,
s_3_sse_algorithm,
s_3_sse_kms_key_id
FROM aws.simpledbv2.exports
WHERE region = '{{ region }}' -- required
;

list_exports

Lists all exports that were created. The results are paginated and can be filtered by domain name.

SELECT
domain_name,
export_arn,
export_status,
requested_at
FROM aws.simpledbv2.exports
WHERE region = '{{ region }}' -- required
;