Skip to content

cancel_bulk_operation

Operation

cancel_bulk_operation

cancel_bulk_operation(request: CancelBulkOperationInput | CancelBulkOperationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelBulkOperationInputDict]) -> CancelBulkOperationOutput

Cancels an in-progress bulk operation asynchronously. Cancellation doesn't remove items that the operation has already written. Use DescribeBulkOperation to monitor the operation until it reaches a terminal status.

Parameters:

Name Type Description Default
request CancelBulkOperationInput | CancelBulkOperationInputDict | 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[CancelBulkOperationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelBulkOperationOutput

An instance of CancelBulkOperationOutput.

cancel_bulk_operation async

cancel_bulk_operation(request: CancelBulkOperationInput | CancelBulkOperationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelBulkOperationInputDict]) -> CancelBulkOperationOutput

Cancels an in-progress bulk operation asynchronously. Cancellation doesn't remove items that the operation has already written. Use DescribeBulkOperation to monitor the operation until it reaches a terminal status.

Parameters:

Name Type Description Default
request CancelBulkOperationInput | CancelBulkOperationInputDict | 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[CancelBulkOperationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelBulkOperationOutput

An instance of CancelBulkOperationOutput.

Input

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

CancelBulkOperationInputDict

Bases: TypedDict

Dictionary form of CancelBulkOperationInput.

Attributes

bulk_operation_arn instance-attribute
bulk_operation_arn: Required[str]

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

CancelBulkOperationInput dataclass

Bases: _SerdeShape

Dataclass for CancelBulkOperationInput structure.

Attributes

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

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

Output

CancelBulkOperationOutput dataclass

Bases: _SerdeShape

Dataclass for CancelBulkOperationOutput structure.

Attributes

bulk_operation_arn instance-attribute
bulk_operation_arn: str

The Amazon Resource Name (ARN) of the bulk operation for which DynamoDB accepted the cancellation request.

bulk_operation_status instance-attribute
bulk_operation_status: str

The status returned after DynamoDB accepts the cancellation request. This value is CANCELLING. Use DescribeBulkOperation to determine when the operation reaches CANCELLED.

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.