Skip to content

Describe Recovery Point

backup_describe_recovery_point R Documentation

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle

Description

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Usage

backup_describe_recovery_point(BackupVaultName, RecoveryPointArn,
  BackupVaultAccountId)

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.

RecoveryPointArn

[required] 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⁠.

BackupVaultAccountId

The account ID of the specified backup vault.

Value

A list with the following syntax:

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,
  StorageClass = "WARM"|"COLD"|"DELETED",
  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$describe_recovery_point(
  BackupVaultName = "string",
  RecoveryPointArn = "string",
  BackupVaultAccountId = "string"
)