imports

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

Overview

Name	imports
Type	Resource
Id	aws.dynamodb.imports

Fields

The following fields are returned by SELECT queries:

describe_import

Name	Datatype	Description
client_token	string	The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent. (pattern: <code>^[^$]+$</code>)
cloud_watch_log_group_arn	string	The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.
end_time	string (date-time)	The time at which the creation of the table associated with this import task completed.
error_count	integer (int64)	The number of errors occurred on importing the source file into the target table.
failure_code	string	The error code corresponding to the failure that the import job ran into during execution.
failure_message	string	The error message corresponding to the failure that the import job ran into during execution.
import_arn	string	The Amazon Resource Number (ARN) corresponding to the import request.
import_status	string	The status of the import. (IN_PROGRESS, COMPLETED, CANCELLING, CANCELLED, FAILED)
imported_item_count	integer (int64)	The number of items successfully imported into the new table.
input_compression_type	string	The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD. (GZIP, ZSTD, NONE)
input_format	string	The format of the source data going into the target table. (DYNAMODB_JSON, ION, CSV)
input_format_options	object	The format options for the data that was imported into the target table. There is one value, CsvOption.
processed_item_count	integer (int64)	The total number of items processed from the source file.
processed_size_bytes	integer (int64)	The total size of data processed from the source file, in Bytes.
s3_bucket_source	object	Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).
start_time	string (date-time)	The time when this import task started.
table_arn	string	The Amazon Resource Number (ARN) of the table being imported into.
table_creation_parameters	object	The parameters for the new table that is being imported into.
table_id	string	The table id corresponding to the table created by import table process. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)

list_imports

Name	Datatype	Description
import_summary_list	array	A list of ImportSummary objects.
next_token	string	If this value is returned, there are additional results to be displayed. To retrieve them, call ListImports again, with NextToken set to this value. (pattern: <code>([0-9a-f]{16})+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_import	select	region		Represents the properties of the import.
list_imports	select	region		Lists completed imports within the past 90 days.

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_import

Represents the properties of the import.

SELECT
client_token,
cloud_watch_log_group_arn,
end_time,
error_count,
failure_code,
failure_message,
import_arn,
import_status,
imported_item_count,
input_compression_type,
input_format,
input_format_options,
processed_item_count,
processed_size_bytes,
s3_bucket_source,
start_time,
table_arn,
table_creation_parameters,
table_id
FROM aws.dynamodb.imports
WHERE region = '{{ region }}' -- required
;

list_imports

Lists completed imports within the past 90 days.

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