CancelBulkOperation - Amazon DynamoDB
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

CancelBulkOperation

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.

Request Syntax

{ "BulkOperationArn": "string" }

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

BulkOperationArn

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

Type: String

Length Constraints: Minimum length of 37. Maximum length of 1024.

Required: Yes

Response Syntax

{ "BulkOperationArn": "string", "BulkOperationStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BulkOperationArn

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

Type: String

Length Constraints: Minimum length of 37. Maximum length of 1024.

BulkOperationStatus

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

Type: String

Valid Values: IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | CANCELLING | CANCELLED | FAILED

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

message

The resource which is being requested does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: