Skip to content

BulkOperationDescription

Structure Class

BulkOperationDescription dataclass

Bases: _SerdeShape

Contains detailed information about a bulk operation.

Attributes

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

The Amazon Resource Name (ARN) of the bulk operation.

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

The current status of the bulk operation can be one of the following values:

IN_PROGRESS

DynamoDB is processing the input.

COMPLETED

The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.

COMPLETED_WITH_ERRORS

The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.

CANCELLING

DynamoDB accepted a cancellation request and is stopping the operation.

CANCELLED

DynamoDB stopped the operation after a cancellation request.

FAILED

The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

bulk_operation_usage class-attribute instance-attribute
bulk_operation_usage: list[BulkOperationUsage] | None = ...

Usage information for the table and its indexes.

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

The idempotency token associated with the start request.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.

failed_item_count class-attribute instance-attribute
failed_item_count: int = ...

The number of processed input items that failed because of parsing or validation errors. This count is included in ProcessedItemCount. Condition-check failures do not increase this count.

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

A code that identifies why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

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

A message that describes why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

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

The Amazon S3 input configuration associated with the bulk operation.

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

The maximum write request unit rate configured for the bulk operation.

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

The Amazon S3 output configuration associated with the bulk operation.

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

The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD.

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

The number of bytes that DynamoDB has read from the Amazon S3 input objects.

processed_item_count class-attribute instance-attribute
processed_item_count: int = ...

The number of input items that DynamoDB has processed. This count includes successful writes, parsing or validation failures, and condition-check failures.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The time when DynamoDB accepted the start request.

table_details class-attribute instance-attribute
table_details: list[BulkOperationTableDetail] | None = ...

A list containing identifying information for the table targeted by the bulk operation.

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

The total size, in bytes, of the Amazon S3 input objects. DynamoDB omits this value until the initial input-size calculation completes.