DescribeRecoveryPoint
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Request Syntax
GET /backup-vaults/backupVaultName
/recovery-points/recoveryPointArn
?backupVaultAccountId=BackupVaultAccountId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- BackupVaultAccountId
-
The account ID of the specified backup vault.
Pattern:
^[0-9]{12}$
- 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 Amazon Region where they are created.
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
Required: Yes
- recoveryPointArn
-
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CalculatedLifecycle": {
"DeleteAt": number,
"MoveToColdStorageAt": number
},
"CompletionDate": number,
"CompositeMemberIdentifier": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"EncryptionKeyArn": "string",
"IamRoleArn": "string",
"IsEncrypted": boolean,
"IsParent": boolean,
"LastRestoreTime": number,
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"ParentRecoveryPointArn": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"Status": "string",
"StatusMessage": "string",
"StorageClass": "string",
"VaultType": "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.
- BackupSizeInBytes
-
The size, in bytes, of a backup.
Type: Long
- BackupVaultArn
-
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-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.
Type: String
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
- CalculatedLifecycle
-
A
CalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.Type: CalculatedLifecycle object
- CompletionDate
-
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- CompositeMemberIdentifier
-
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
Type: String
- CreatedBy
-
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan used to create it.Type: RecoveryPointCreator object
- CreationDate
-
The date and time that a recovery point 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
- EncryptionKeyArn
-
The server-side encryption key used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.Type: String
- IamRoleArn
-
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.Type: String
- IsEncrypted
-
A Boolean value that is returned as
TRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.Type: Boolean
- IsParent
-
This returns the boolean value that a recovery point is a parent (composite) job.
Type: Boolean
- LastRestoreTime
-
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of
LastRestoreTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- Lifecycle
-
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Amazon Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Amazon Backup ignores this expression for other resource types.
Type: Lifecycle object
- ParentRecoveryPointArn
-
This is an ARN that uniquely identifies a parent (composite) recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Type: String
- RecoveryPointArn
-
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Type: String
- ResourceArn
-
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Type: String
- ResourceName
-
The name of the resource that belongs to the specified backup.
Type: String
- ResourceType
-
The type of Amazon resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$
- SourceBackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
. If the recovery is restored to the same Amazon account or Region, this value will benull
.Type: String
- Status
-
A status code specifying the state of the recovery point.
PARTIAL
status indicates Amazon Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.EXPIRED
status indicates that the recovery point has exceeded its retention period, but Amazon Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.STOPPED
status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Amazon Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.To resolve
STOPPED
status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.For SAP HANA on Amazon EC2
STOPPED
status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.Type: String
Valid Values:
COMPLETED | PARTIAL | DELETING | EXPIRED
- StatusMessage
-
A status message explaining the status of the recovery point.
Type: String
- StorageClass
-
Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
.Type: String
Valid Values:
WARM | COLD | DELETED
- VaultType
-
The type of vault in which the described recovery point is stored.
Type: String
Valid Values:
BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT
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 Amazon SDKs, see the following: