Skip to content

Describe Backup Vault

backup_describe_backup_vault R Documentation

Returns metadata about a backup vault specified by its name

Description

Returns metadata about a backup vault specified by its name.

Usage

backup_describe_backup_vault(BackupVaultName, 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.

BackupVaultAccountId

The account ID of the specified backup vault.

Value

A list with the following syntax:

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

Request syntax

svc$describe_backup_vault(
  BackupVaultName = "string",
  BackupVaultAccountId = "string"
)