Skip to content

List Recovery Points By Resource

backup_list_recovery_points_by_resource R Documentation

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN)

Description

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Usage

backup_list_recovery_points_by_resource(ResourceArn, NextToken,
  MaxResults, ManagedByAWSBackupOnly)

Arguments

ResourceArn

[required] An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
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.

Amazon RDS requires a value of at least 20.
ManagedByAWSBackupOnly

This attribute filters recovery points based on ownership.

If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup.

If this is set to FALSE, the response will contain all recovery points associated with the selected resource.

Type: Boolean

Value

A list with the following syntax:

list(
  NextToken = "string",
  RecoveryPoints = list(
    list(
      RecoveryPointArn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      Status = "COMPLETED"|"PARTIAL"|"DELETING"|"EXPIRED",
      StatusMessage = "string",
      EncryptionKeyArn = "string",
      BackupSizeBytes = 123,
      BackupVaultName = "string",
      IsParent = TRUE|FALSE,
      ParentRecoveryPointArn = "string",
      ResourceName = "string",
      VaultType = "BACKUP_VAULT"|"LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
      IndexStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING",
      IndexStatusMessage = "string"
    )
  )
)

Request syntax

svc$list_recovery_points_by_resource(
  ResourceArn = "string",
  NextToken = "string",
  MaxResults = 123,
  ManagedByAWSBackupOnly = TRUE|FALSE
)