import_table¶
Operation¶
import_table
¶
import_table(request: ImportTableInput | ImportTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportTableInputDict]) -> ImportTableOutput
Imports table data from an S3 bucket.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ImportTableInput | ImportTableInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ImportTableInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ImportTableOutput
|
An instance of |
import_table
async
¶
import_table(request: ImportTableInput | ImportTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportTableInputDict]) -> ImportTableOutput
Imports table data from an S3 bucket.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ImportTableInput | ImportTableInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ImportTableInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ImportTableOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ImportTableInputDict
¶
Bases: TypedDict
Dictionary form of ImportTableInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
input_compression_type
instance-attribute
¶
input_compression_type: str | None
Type of compression to be used on the input coming from the imported table.
input_format
instance-attribute
¶
The format of the source data. Valid values for ImportFormat are
CSV, DYNAMODB_JSON or ION.
input_format_options
instance-attribute
¶
input_format_options: InputFormatOptions | InputFormatOptionsDict | None
Additional properties that specify how the input is formatted,
s3_bucket_source
instance-attribute
¶
s3_bucket_source: Required[S3BucketSource | S3BucketSourceDict]
The S3 bucket that provides the source for the import.
table_creation_parameters
instance-attribute
¶
table_creation_parameters: Required[TableCreationParameters | TableCreationParametersDict]
Parameters for the table to import the data into.
ImportTableInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ImportTableInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
input_compression_type
class-attribute
instance-attribute
¶
input_compression_type: str | None = ...
Type of compression to be used on the input coming from the imported table.
input_format
class-attribute
instance-attribute
¶
input_format: str | 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 = ...
Additional properties that specify how the input is formatted,
s3_bucket_source
class-attribute
instance-attribute
¶
s3_bucket_source: S3BucketSource | None = ...
The S3 bucket that provides the source for the import.
table_creation_parameters
class-attribute
instance-attribute
¶
table_creation_parameters: TableCreationParameters | None = ...
Parameters for the table to import the data into.
Output¶
ImportTableOutput
dataclass
¶
Bases: _SerdeShape
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.