backup_describe_recovery_point: Returns metadata associated with a recovery point, including...

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

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

Usage

1
backup_describe_recovery_point(BackupVaultName, RecoveryPointArn)

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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",
  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
  ),
  EncryptionKeyArn = "string",
  IsEncrypted = TRUE|FALSE,
  StorageClass = "WARM"|"COLD"|"DELETED",
  LastRestoreTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

1
2
3
4
svc$describe_recovery_point(
  BackupVaultName = "string",
  RecoveryPointArn = "string"
)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.