Backup / Client / list_recovery_points_by_backup_vault
list_recovery_points_by_backup_vault#
- Backup.Client.list_recovery_points_by_backup_vault(**kwargs)#
Returns detailed information about the recovery points stored in a backup vault.
See also: AWS API Documentation
Request Syntax
response = client.list_recovery_points_by_backup_vault( BackupVaultName='string', BackupVaultAccountId='string', NextToken='string', MaxResults=123, ByResourceArn='string', ByResourceType='string', ByBackupPlanId='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByParentRecoveryPointArn='string' )
- Parameters:
BackupVaultName (string) –
[REQUIRED]
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 Web Services Region where they are created.
Note
Backup vault name might not be available when a supported service creates the backup.
BackupVaultAccountId (string) – This parameter will sort the list of recovery points by account ID.
NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return
MaxResults
number of items,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.MaxResults (integer) – The maximum number of items to be returned.
ByResourceArn (string) – Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
ByResourceType (string) –
Returns only recovery points that match the specified resource type(s):
Aurora
for Amazon AuroraCloudFormation
for CloudFormationDocumentDB
for Amazon DocumentDB (with MongoDB compatibility)DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSx
for Amazon FSxNeptune
for Amazon NeptuneRDS
for Amazon Relational Database ServiceRedshift
for Amazon RedshiftS3
for Amazon Simple Storage Service (Amazon S3)SAP HANA on Amazon EC2
for SAP HANA databases on Amazon Elastic Compute Cloud instancesStorage Gateway
for Storage GatewayTimestream
for Amazon TimestreamVirtualMachine
for VMware virtual machines
ByBackupPlanId (string) – Returns only recovery points that match the specified backup plan ID.
ByCreatedBefore (datetime) – Returns only recovery points that were created before the specified timestamp.
ByCreatedAfter (datetime) – Returns only recovery points that were created after the specified timestamp.
ByParentRecoveryPointArn (string) – This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'SourceBackupVaultArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'IamRoleArn': 'string', 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED', 'StatusMessage': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'BackupSizeInBytes': 123, 'CalculatedLifecycle': { 'MoveToColdStorageAt': datetime(2015, 1, 1), 'DeleteAt': datetime(2015, 1, 1) }, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'EncryptionKeyArn': 'string', 'IsEncrypted': True|False, 'LastRestoreTime': datetime(2015, 1, 1), 'ParentRecoveryPointArn': 'string', 'CompositeMemberIdentifier': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT' }, ] }
Response Structure
(dict) –
NextToken (string) –
The next item following a partial list of returned items. For example, if a request is made to return
MaxResults
number of items,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.RecoveryPoints (list) –
An array of objects that contain detailed information about recovery points saved in a backup vault.
(dict) –
Contains detailed information about the recovery points stored in a backup vault.
RecoveryPointArn (string) –
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
.BackupVaultName (string) –
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 Web Services Region where they are created.
BackupVaultArn (string) –
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.SourceBackupVaultArn (string) –
The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be
null
.ResourceArn (string) –
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
ResourceType (string) –
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
CreatedBy (dict) –
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan that is used to create it.BackupPlanId (string) –
Uniquely identifies a backup plan.
BackupPlanArn (string) –
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.BackupPlanVersion (string) –
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) –
Uniquely identifies a rule used to schedule the backup of a selection of resources.
IamRoleArn (string) –
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.Status (string) –
A status code specifying the state of the recovery point.
StatusMessage (string) –
A message explaining the current status of the recovery point.
CreationDate (datetime) –
The date and time 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.CompletionDate (datetime) –
The date and time a job to restore 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.BackupSizeInBytes (integer) –
The size, in bytes, of a backup.
CalculatedLifecycle (dict) –
A
CalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.MoveToColdStorageAt (datetime) –
A timestamp that specifies when to transition a recovery point to cold storage.
DeleteAt (datetime) –
A timestamp that specifies when to delete a recovery point.
Lifecycle (dict) –
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups 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. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) –
The number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) –
The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in
MoveToColdStorageAfterDays
.OptInToArchiveForSupportedResources (boolean) –
If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
EncryptionKeyArn (string) –
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
.IsEncrypted (boolean) –
A Boolean value that is returned as
TRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.LastRestoreTime (datetime) –
The date and time 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.ParentRecoveryPointArn (string) –
The Amazon Resource Name (ARN) of the parent (composite) recovery point.
CompositeMemberIdentifier (string) –
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.
IsParent (boolean) –
This is a boolean value indicating this is a parent (composite) recovery point.
ResourceName (string) –
The non-unique name of the resource that belongs to the specified backup.
VaultType (string) –
The type of vault in which the described recovery point is stored.
Exceptions
Backup.Client.exceptions.ResourceNotFoundException
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ServiceUnavailableException