create_backup_vault

Backup.Client.create_backup_vault(**kwargs)

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Note

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

See also: AWS API Documentation

Request Syntax

response = client.create_backup_vault(
    BackupVaultName='string',
    BackupVaultTags={
        'string': 'string'
    },
    EncryptionKeyArn='string',
    CreatorRequestId='string'
)

Parameters

• BackupVaultName (string) --

  [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. They consist of letters, numbers, and hyphens.

• BackupVaultTags (dict) --

  Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

  • (string) --
    • (string) --
• EncryptionKeyArn (string) -- The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
• 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.

Return type

dict

Returns

Response Syntax

{
    'BackupVaultName': 'string',
    'BackupVaultArn': 'string',
    'CreationDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

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

  • BackupVaultArn (string) --

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

  • CreationDate (datetime) --

    The date and time a backup vault 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.

Exceptions

• Backup.Client.exceptions.InvalidParameterValueException
• Backup.Client.exceptions.MissingParameterValueException
• Backup.Client.exceptions.ServiceUnavailableException
• Backup.Client.exceptions.LimitExceededException
• Backup.Client.exceptions.AlreadyExistsException