Skip to content

List Recovery Points by Backup Vault

backup_list_recovery_points_by_backup_vault R Documentation

Returns detailed information about the recovery points stored in a backup vault

Description

Returns detailed information about the recovery points stored in a backup vault.

Usage

backup_list_recovery_points_by_backup_vault(BackupVaultName,
  BackupVaultAccountId, NextToken, MaxResults, ByResourceArn,
  ByResourceType, ByBackupPlanId, ByCreatedBefore, ByCreatedAfter,
  ByParentRecoveryPointArn)

Arguments

BackupVaultName

[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.

Backup vault name might not be available when a supported service creates the backup.

BackupVaultAccountId

This parameter will sort the list of recovery points by account ID.

NextToken

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

The maximum number of items to be returned.

ByResourceArn

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Returns only recovery points that match the specified resource type(s):

  • Aurora for Amazon Aurora

  • CloudFormation for CloudFormation

  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • FSx for Amazon FSx

  • Neptune for Amazon Neptune

  • RDS for Amazon Relational Database Service

  • Redshift for Amazon Redshift

  • S3 for Amazon Simple Storage Service (Amazon S3)

  • ⁠SAP HANA on Amazon EC2⁠ for SAP HANA databases on Amazon Elastic Compute Cloud instances

  • ⁠Storage Gateway⁠ for Storage Gateway

  • Timestream for Amazon Timestream

  • VirtualMachine for VMware virtual machines

ByBackupPlanId

Returns only recovery points that match the specified backup plan ID.

ByCreatedBefore

Returns only recovery points that were created before the specified timestamp.

ByCreatedAfter

Returns only recovery points that were created after the specified timestamp.

ByParentRecoveryPointArn

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

Value

A list with the following syntax: 

list(
  NextToken = "string",
  RecoveryPoints = list(
    list(
      RecoveryPointArn = "string",
      BackupVaultName = "string",
      BackupVaultArn = "string",
      SourceBackupVaultArn = "string",
      ResourceArn = "string",
      ResourceType = "string",
      CreatedBy = list(
        BackupPlanId = "string",
        BackupPlanArn = "string",
        BackupPlanVersion = "string",
        BackupRuleId = "string"
      ),
      IamRoleArn = "string",
      Status = "COMPLETED"|"PARTIAL"|"DELETING"|"EXPIRED",
      StatusMessage = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CompletionDate = as.POSIXct(
        "2015-01-01"
      ),
      BackupSizeInBytes = 123,
      CalculatedLifecycle = list(
        MoveToColdStorageAt = as.POSIXct(
          "2015-01-01"
        ),
        DeleteAt = as.POSIXct(
          "2015-01-01"
        )
      ),
      Lifecycle = list(
        MoveToColdStorageAfterDays = 123,
        DeleteAfterDays = 123,
        OptInToArchiveForSupportedResources = TRUE|FALSE
      ),
      EncryptionKeyArn = "string",
      IsEncrypted = TRUE|FALSE,
      LastRestoreTime = as.POSIXct(
        "2015-01-01"
      ),
      ParentRecoveryPointArn = "string",
      CompositeMemberIdentifier = "string",
      IsParent = TRUE|FALSE,
      ResourceName = "string",
      VaultType = "BACKUP_VAULT"|"LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
    )
  )
)

Request syntax

svc$list_recovery_points_by_backup_vault(
  BackupVaultName = "string",
  BackupVaultAccountId = "string",
  NextToken = "string",
  MaxResults = 123,
  ByResourceArn = "string",
  ByResourceType = "string",
  ByBackupPlanId = "string",
  ByCreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByParentRecoveryPointArn = "string"
)