DescribeBackupVault
Returns metadata about a backup vault specified by its name.
Request Syntax
GET /backup-vaults/backupVaultName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- backupVaultName
-
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"EncryptionKeyArn": "string",
"NumberOfRecoveryPoints": 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.
- BackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.Type: String
- BackupVaultName
-
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Type: String
- CreationDate
-
The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- CreatorRequestId
-
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Type: String
- EncryptionKeyArn
-
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.Type: String
- NumberOfRecoveryPoints
-
The number of recovery points that are stored in a backup vault.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: