BulkOperationDescription
Contains detailed information about a bulk operation.
Contents
Note
In the following list, the required parameters are described first.
- BulkOperationArn
-
The Amazon Resource Name (ARN) of the bulk operation.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: No
- BulkOperationStatus
-
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
ERRORoutput, 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.
Type: String
Valid Values:
IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | CANCELLING | CANCELLED | FAILEDRequired: No
-
- BulkOperationUsage
-
Usage information for the table and its indexes.
Type: Array of BulkOperationUsage objects
Required: No
- ClientToken
-
The idempotency token associated with the start request.
Type: String
Pattern:
^[^\$]+$Required: No
- EndTime
-
The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.
Type: Timestamp
Required: No
- FailedItemCount
-
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.Type: Long
Valid Range: Minimum value of 0.
Required: No
- FailureCode
-
A code that identifies why the bulk operation failed or was cancelled. DynamoDB returns this value only when
BulkOperationStatusisFAILEDorCANCELLED.Type: String
Required: No
- FailureMessage
-
A message that describes why the bulk operation failed or was cancelled. DynamoDB returns this value only when
BulkOperationStatusisFAILEDorCANCELLED.Type: String
Required: No
- InputS3Configuration
-
The Amazon S3 input configuration associated with the bulk operation.
Type: InputS3Configuration object
Required: No
- MaxWriteRequestUnits
-
The maximum write request unit rate configured for the bulk operation.
Type: Long
Valid Range: Minimum value of 1024.
Required: No
- OutputS3Configuration
-
The Amazon S3 output configuration associated with the bulk operation.
Type: OutputS3Configuration object
Required: No
- PerformanceTier
-
The performance tier selected for the bulk operation. Valid values are
STANDARDandACCELERATED. If the start request omitted this value, DynamoDB usesSTANDARD.Type: String
Valid Values:
STANDARD | ACCELERATEDRequired: No
- ProcessedInputBytes
-
The number of bytes that DynamoDB has read from the Amazon S3 input objects.
Type: Long
Valid Range: Minimum value of 0.
Required: No
- ProcessedItemCount
-
The number of input items that DynamoDB has processed. This count includes successful writes, parsing or validation failures, and condition-check failures.
Type: Long
Valid Range: Minimum value of 0.
Required: No
- StartTime
-
The time when DynamoDB accepted the start request.
Type: Timestamp
Required: No
- TableDetails
-
A list containing identifying information for the table targeted by the bulk operation.
Type: Array of BulkOperationTableDetail objects
Required: No
- TotalInputBytes
-
The total size, in bytes, of the Amazon S3 input objects. DynamoDB omits this value until the initial input-size calculation completes.
Type: Long
Valid Range: Minimum value of 0.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: