Skip to content

start_bulk_put_items

Operation

start_bulk_put_items

start_bulk_put_items(request: StartBulkPutItemsInput | StartBulkPutItemsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartBulkPutItemsInputDict]) -> StartBulkPutItemsOutput

Starts an asynchronous bulk operation that reads items from Amazon S3 and writes them to an existing DynamoDB table, so you can efficiently load or migrate large datasets.

Parameters:

Name Type Description Default
request StartBulkPutItemsInput | StartBulkPutItemsInputDict | 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[StartBulkPutItemsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartBulkPutItemsOutput

An instance of StartBulkPutItemsOutput.

start_bulk_put_items async

start_bulk_put_items(request: StartBulkPutItemsInput | StartBulkPutItemsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartBulkPutItemsInputDict]) -> StartBulkPutItemsOutput

Starts an asynchronous bulk operation that reads items from Amazon S3 and writes them to an existing DynamoDB table, so you can efficiently load or migrate large datasets.

Parameters:

Name Type Description Default
request StartBulkPutItemsInput | StartBulkPutItemsInputDict | 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[StartBulkPutItemsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartBulkPutItemsOutput

An instance of StartBulkPutItemsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StartBulkPutItemsInputDict

Bases: TypedDict

Dictionary form of StartBulkPutItemsInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier that ensures the bulk operation starts no more than one time. During the 8 hours after the initial request, repeated requests that use the same token and parameters return the same bulk operation. If a request reuses the token with different parameters, DynamoDB returns an IdempotentParameterMismatchException. If you omit the token, an Amazon Web Services SDK automatically generates one.

This field is autopopulated if not provided.

input_s3_configuration instance-attribute

The Amazon S3 location, data format, and compression settings for the input objects.

max_write_request_units instance-attribute
max_write_request_units: int | None

The maximum rate, in write request units per second, at which the bulk operation attempts to write. The value must be at least 1,024. With this setting, you limit only the bulk operation; the table's provisioned or on-demand capacity settings don't change. The actual write rate can be lower.

output_s3_configuration instance-attribute

The Amazon S3 location, encryption settings, and output types for the bulk operation.

performance_tier instance-attribute
performance_tier: str | None

The performance tier for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation uses STANDARD.

table_name instance-attribute
table_name: Required[str]

The name or ARN of the existing DynamoDB table that receives the items.

StartBulkPutItemsInput dataclass

Bases: _SerdeShape

Dataclass for StartBulkPutItemsInput structure.

Attributes

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

A unique, case-sensitive identifier that ensures the bulk operation starts no more than one time. During the 8 hours after the initial request, repeated requests that use the same token and parameters return the same bulk operation. If a request reuses the token with different parameters, DynamoDB returns an IdempotentParameterMismatchException. If you omit the token, an Amazon Web Services SDK automatically generates one.

This field is autopopulated if not provided.

input_s3_configuration class-attribute instance-attribute
input_s3_configuration: InputS3Configuration | None = ...

The Amazon S3 location, data format, and compression settings for the input objects.

max_write_request_units class-attribute instance-attribute
max_write_request_units: int | None = ...

The maximum rate, in write request units per second, at which the bulk operation attempts to write. The value must be at least 1,024. With this setting, you limit only the bulk operation; the table's provisioned or on-demand capacity settings don't change. The actual write rate can be lower.

output_s3_configuration class-attribute instance-attribute
output_s3_configuration: OutputS3Configuration | None = ...

The Amazon S3 location, encryption settings, and output types for the bulk operation.

performance_tier class-attribute instance-attribute
performance_tier: str | None = ...

The performance tier for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation uses STANDARD.

table_name class-attribute instance-attribute
table_name: str | None = ...

The name or ARN of the existing DynamoDB table that receives the items.

Output

StartBulkPutItemsOutput dataclass

Bases: _SerdeShape

Dataclass for StartBulkPutItemsOutput structure.

Attributes

bulk_operation_description instance-attribute
bulk_operation_description: BulkOperationDescription

Contains detailed information about a bulk operation.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.