Backup / Client / list_backup_vaults

list_backup_vaults#

Backup.Client.list_backup_vaults(**kwargs)#

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

Request Syntax

response = client.list_backup_vaults(
    ByVaultType='BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
    ByShared=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters:

ByVaultType (string) – This parameter will sort the list of vaults by vault type.
ByShared (boolean) – This parameter will sort the list of vaults by shared vaults.
NextToken (string) – 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 (integer) – The maximum number of items to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'BackupVaultList': [
        {
            'BackupVaultName': 'string',
            'BackupVaultArn': 'string',
            'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
            'VaultState': 'CREATING'|'AVAILABLE'|'FAILED',
            'CreationDate': datetime(2015, 1, 1),
            'EncryptionKeyArn': 'string',
            'CreatorRequestId': 'string',
            'NumberOfRecoveryPoints': 123,
            'Locked': True|False,
            'MinRetentionDays': 123,
            'MaxRetentionDays': 123,
            'LockDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- BackupVaultList (list) –
  
  An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
  - (dict) –
    
    Contains metadata about a backup vault.
    - BackupVaultName (string) –
      
      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.
    - BackupVaultArn (string) –
      
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
    - VaultType (string) –
      
      The type of vault in which the described recovery point is stored.
    - VaultState (string) –
      
      The current state of the vault.
    - CreationDate (datetime) –
      
      The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - EncryptionKeyArn (string) –
      
      A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.
      
      To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
    - CreatorRequestId (string) –
      
      A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
      
      If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.
    - NumberOfRecoveryPoints (integer) –
      
      The number of recovery points that are stored in a backup vault.
    - Locked (boolean) –
      
      A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.
    - MinRetentionDays (integer) –
      
      The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
      
      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job’s retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
    - MaxRetentionDays (integer) –
      
      The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
      
      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job’s retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
    - LockDate (datetime) –
      
      The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
      
      If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
      
      This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- NextToken (string) –
  
  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.

Exceptions

Backup.Client.exceptions.ResourceNotFoundException
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ServiceUnavailableException