Glacier / Client / create_vault

create_vault#

Glacier.Client.create_vault(**kwargs)#

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.

  • Allowed characters are a-z, A-Z, 0-9, ‘_’ (underscore), ‘-’ (hyphen), and ‘.’ (period).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don’t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_vault(
    vaultName='string'
)
Parameters:

  • accountId (string) –

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single ‘ -’ (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (‘-’) in the ID.

    Note: this parameter is set to “-” bydefault if no value is not specified.

  • vaultName (string) –

    [REQUIRED]

    The name of the vault.

Return type:

dict

Returns:

Response Syntax

{
    'location': 'string'
}

Response Structure

  • (dict) –

    Contains the Amazon S3 Glacier response to your request.

    • location (string) –

      The URI of the vault that was created.

Exceptions

Examples

The following example creates a new vault named my-vault.

response = client.create_vault(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'location': '/111122223333/vaults/my-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}