DescribeBackup
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.
Note
In the following list, the required parameters are described first.
- BackupArn
-
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.
- BackupDescription
-
Contains the description of the backup created for the table.
Type: BackupDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BackupNotFoundException
-
Backup not found for the given BackupARN.
HTTP Status Code: 400
- InternalServerError
-
An error occurred on the server side.
- message
-
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: