Glacier / Paginator / ListVaults

ListVaults

class Glacier.Paginator.ListVaults

paginator = client.get_paginator('list_vaults')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Glacier.Client.list_vaults().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'VaultList': [
        {
            'VaultARN': 'string',
            'VaultName': 'string',
            'CreationDate': 'string',
            'LastInventoryDate': 'string',
            'NumberOfArchives': 123,
            'SizeInBytes': 123
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    A token to resume pagination.