backup_list_recovery_points_by_backup_vault: Returns detailed information about the recovery points stored...

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

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

Usage

1
2
3
backup_list_recovery_points_by_backup_vault(BackupVaultName, NextToken,
  MaxResults, ByResourceArn, ByResourceType, ByBackupPlanId,
  ByCreatedBefore, ByCreatedAfter)

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.

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.

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.

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
42
43
44
45
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",
      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,
      LastRestoreTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc$list_recovery_points_by_backup_vault(
  BackupVaultName = "string",
  NextToken = "string",
  MaxResults = 123,
  ByResourceArn = "string",
  ByResourceType = "string",
  ByBackupPlanId = "string",
  ByCreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreatedAfter = as.POSIXct(
    "2015-01-01"
  )
)

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