Glacier / Client / list_vaults

list_vaults

Glacier.Client.list_vaults(**kwargs)

This operation lists all vaults owned by the calling user’s account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

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 Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_vaults(
    marker='string',
    limit='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 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.

• marker (string) – A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

• limit (string) – The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Return type:

dict

Returns:

Response Syntax

{
    'VaultList': [
        {
            'VaultARN': 'string',
            'VaultName': 'string',
            'CreationDate': 'string',
            'LastInventoryDate': 'string',
            'NumberOfArchives': 123,
            'SizeInBytes': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  Contains the Amazon S3 Glacier response to your request.

  • VaultList (list) –

    List of vaults.

    • (dict) –

      Contains the Amazon S3 Glacier response to your request.

      • VaultARN (string) –

        The Amazon Resource Name (ARN) of the vault.

      • VaultName (string) –

        The name of the vault.

      • CreationDate (string) –

        The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

      • LastInventoryDate (string) –

        The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

      • NumberOfArchives (integer) –

        The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

      • SizeInBytes (integer) –

        Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

  • Marker (string) –

    The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

Exceptions

• Glacier.Client.exceptions.ResourceNotFoundException

• Glacier.Client.exceptions.InvalidParameterValueException

• Glacier.Client.exceptions.MissingParameterValueException

• Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example lists all vaults owned by the specified AWS account.

response = client.list_vaults(
    accountId='-',
    limit='',
    marker='',
)

print(response)

Expected Output:

{
    'VaultList': [
        {
            'CreationDate': '2015-04-06T21:23:45.708Z',
            'LastInventoryDate': '2015-04-07T00:26:19.028Z',
            'NumberOfArchives': 1,
            'SizeInBytes': 3178496,
            'VaultARN': 'arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault',
            'VaultName': 'my-vault',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}