Returns a list of recovery point storage containers along with information about them¶

Description¶

Returns a list of recovery point storage containers along with information about them.

Usage¶

backup_list_backup_vaults(ByVaultType, ByShared, NextToken, MaxResults)

Arguments¶

ByVaultType

This parameter will sort the list of vaults by vault type.
ByShared

This parameter will sort the list of vaults by shared vaults.
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.

Value¶

A list with the following syntax:

list(
  BackupVaultList = list(
    list(
      BackupVaultName = "string",
      BackupVaultArn = "string",
      VaultType = "BACKUP_VAULT"|"LOGICALLY_AIR_GAPPED_BACKUP_VAULT"|"RESTORE_ACCESS_BACKUP_VAULT",
      VaultState = "CREATING"|"AVAILABLE"|"FAILED",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      EncryptionKeyArn = "string",
      CreatorRequestId = "string",
      NumberOfRecoveryPoints = 123,
      Locked = TRUE|FALSE,
      MinRetentionDays = 123,
      MaxRetentionDays = 123,
      LockDate = as.POSIXct(
        "2015-01-01"
      ),
      EncryptionKeyType = "AWS_OWNED_KMS_KEY"|"CUSTOMER_MANAGED_KMS_KEY"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_backup_vaults(
  ByVaultType = "BACKUP_VAULT"|"LOGICALLY_AIR_GAPPED_BACKUP_VAULT"|"RESTORE_ACCESS_BACKUP_VAULT",
  ByShared = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)