Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeBulkOperation

Describes the specified bulk operation.

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 describe.

Type: String

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

Required: Yes

Response Syntax


{
   "BulkOperationDescription": { 
      "BulkOperationArn": "string",
      "BulkOperationStatus": "string",
      "BulkOperationUsage": [ 
         { 
            "BulkPutBytes": number,
            "GlobalSecondaryIndexes": { 
               "string" : { 
                  "BulkPutBytes": number
               }
            },
            "LocalSecondaryIndexes": { 
               "string" : { 
                  "BulkPutBytes": number
               }
            },
            "Table": { 
               "BulkPutBytes": number
            },
            "TableName": "string",
            "VectorIndexes": { 
               "string" : { 
                  "BulkPutVectorBytes": number
               }
            }
         }
      ],
      "ClientToken": "string",
      "EndTime": number,
      "FailedItemCount": number,
      "FailureCode": "string",
      "FailureMessage": "string",
      "InputS3Configuration": { 
         "InputCompressionType": "string",
         "InputFormat": "string",
         "S3Bucket": "string",
         "S3BucketOwner": "string",
         "S3KeyPrefix": "string"
      },
      "MaxWriteRequestUnits": number,
      "OutputS3Configuration": { 
         "OutputType": [ "string" ],
         "S3Bucket": "string",
         "S3BucketOwner": "string",
         "S3KeyPrefix": "string",
         "S3SseAlgorithm": "string",
         "S3SseKmsKeyId": "string"
      },
      "PerformanceTier": "string",
      "ProcessedInputBytes": number,
      "ProcessedItemCount": number,
      "StartTime": number,
      "TableDetails": [ 
         { 
            "TableId": "string",
            "TableName": "string"
         }
      ],
      "TotalInputBytes": number
   }
}

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.

BulkOperationDescription

Contains detailed information about the bulk operation.

Type: BulkOperationDescription object

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