DescribeBackup - Amazon DynamoDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Request Syntax

{ "BackupArn": "string" }

Request Parameters

The request accepts the following data in JSON format.


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


The Amazon Resource Name (ARN) associated with the backup.

Type: String

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

Required: Yes

Response Syntax

{ "BackupDescription": { "BackupDetails": { "BackupArn": "string", "BackupCreationDateTime": number, "BackupExpiryDateTime": number, "BackupName": "string", "BackupSizeBytes": number, "BackupStatus": "string", "BackupType": "string" }, "SourceTableDetails": { "BillingMode": "string", "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "OnDemandThroughput": { "MaxReadRequestUnits": number, "MaxWriteRequestUnits": number }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableArn": "string", "TableCreationDateTime": number, "TableId": "string", "TableName": "string", "TableSizeBytes": number }, "SourceTableFeatureDetails": { "GlobalSecondaryIndexes": [ { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "OnDemandThroughput": { "MaxReadRequestUnits": number, "MaxWriteRequestUnits": number }, "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } ], "LocalSecondaryIndexes": [ { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } } ], "SSEDescription": { "InaccessibleEncryptionDateTime": number, "KMSMasterKeyArn": "string", "SSEType": "string", "Status": "string" }, "StreamDescription": { "StreamEnabled": boolean, "StreamViewType": "string" }, "TimeToLiveDescription": { "AttributeName": "string", "TimeToLiveStatus": "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.


Contains the description of the backup created for the table.

Type: BackupDescription object


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


Backup not found for the given BackupARN.

HTTP Status Code: 400


An error occurred on the server side.

HTTP Status Code: 500

See Also

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