Skip to content

DynamoDB  >  Operations  >  import_table

import_table

Operation

import_table async

import_table(input: ImportTableInput, plugins: list[Plugin] | None = None) -> ImportTableOutput

Imports table data from an S3 bucket.

Parameters:

Name Type Description Default
input ImportTableInput

An instance of ImportTableInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ImportTableOutput

An instance of ImportTableOutput.

Input

ImportTableInput dataclass

Dataclass for ImportTableInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = None

Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

input_compression_type class-attribute instance-attribute
input_compression_type: InputCompressionType | None = None

Type of compression to be used on the input coming from the imported table.

input_format class-attribute instance-attribute
input_format: InputFormat | None = None

The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

input_format_options class-attribute instance-attribute
input_format_options: InputFormatOptions | None = None

Additional properties that specify how the input is formatted,

s3_bucket_source class-attribute instance-attribute
s3_bucket_source: S3BucketSource | None = None

The S3 bucket that provides the source for the import.

table_creation_parameters class-attribute instance-attribute
table_creation_parameters: TableCreationParameters | None = None

Parameters for the table to import the data into.

Output

ImportTableOutput dataclass

Dataclass for ImportTableOutput structure.

Attributes

import_table_description instance-attribute
import_table_description: ImportTableDescription

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.