DynamoDB / Client / cancel_bulk_operation

cancel_bulk_operation

DynamoDB.Client.cancel_bulk_operation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_bulk_operation(
    BulkOperationArn='string'
)
Parameters:

BulkOperationArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'BulkOperationArn': 'string',
    'BulkOperationStatus': 'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'CANCELLING'|'CANCELLED'|'FAILED'
}

Response Structure

  • (dict) –

    • BulkOperationArn (string) –

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

    • BulkOperationStatus (string) –

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

Exceptions