exports

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

Overview

Name	exports
Type	Resource
Id	aws.dynamodb.exports

Fields

The following fields are returned by SELECT queries:

describe_export

Name	Datatype	Description
billed_size_bytes	integer (int64)	The billable size of the table export.
client_token	string	The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call. (pattern: <code>^[^$]+$</code>)
end_time	string (date-time)	The time at which the export task completed.
export_arn	string	The Amazon Resource Name (ARN) of the table export.
export_format	string	The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION. (DYNAMODB_JSON, ION)
export_manifest	string	The name of the manifest file for the export task.
export_status	string	Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED. (IN_PROGRESS, COMPLETED, FAILED)
export_time	string (date-time)	Point in time from which table data was exported.
export_type	string	The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. (FULL_EXPORT, INCREMENTAL_EXPORT)
failure_code	string	Status code for the result of the failed export.
failure_message	string	Export failure reason description.
incremental_export_specification	object	Optional object containing the parameters specific to an incremental export.
item_count	integer (int64)	The number of items exported.
s3_bucket	string	The name of the Amazon S3 bucket containing the export. (pattern: <code>^[a-z0-9A-Z]+[.-\w]*[a-z0-9A-Z]+$</code>)
s3_bucket_owner	string	The ID of the Amazon Web Services account that owns the bucket containing the export. (pattern: <code>[0-9]{12}</code>)
s3_prefix	string	The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
s3_sse_algorithm	string	Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are: AES256 - server-side encryption with Amazon S3 managed keys KMS - server-side encryption with KMS managed keys (AES256, KMS)
s3_sse_kms_key_id	string	The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
start_time	string (date-time)	The time at which the export task began.
table_arn	string	The Amazon Resource Name (ARN) of the table that was exported.
table_id	string	Unique ID of the table that was exported. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)

list_exports

Name	Datatype	Description
export_summaries	array	A list of ExportSummary objects.
next_token	string	If this value is returned, there are additional results to be displayed. To retrieve them, call ListExports again, with NextToken set to this value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_export	select	region		Describes an existing table export.
list_exports	select	region		Lists completed exports within the past 90 days, in reverse alphanumeric order of ExportArn.

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_export

Describes an existing table export.

SELECT
billed_size_bytes,
client_token,
end_time,
export_arn,
export_format,
export_manifest,
export_status,
export_time,
export_type,
failure_code,
failure_message,
incremental_export_specification,
item_count,
s3_bucket,
s3_bucket_owner,
s3_prefix,
s3_sse_algorithm,
s3_sse_kms_key_id,
start_time,
table_arn,
table_id
FROM aws.dynamodb.exports
WHERE region = '{{ region }}' -- required
;

list_exports

Lists completed exports within the past 90 days, in reverse alphanumeric order of ExportArn.

SELECT
export_summaries,
next_token
FROM aws.dynamodb.exports
WHERE region = '{{ region }}' -- required
;