Glacier / Paginator / ListParts

ListParts

class Glacier.Paginator.ListParts

paginator = client.get_paginator('list_parts')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    vaultName='string',
    uploadId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• accountId (string) –

  The AccountId value is the AWS account ID of the account that owns the vault. 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 use an 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.

• uploadId (string) –

  [REQUIRED]

  The upload ID of the multipart upload.

• 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

{
    'MultipartUploadId': 'string',
    'VaultARN': 'string',
    'ArchiveDescription': 'string',
    'PartSizeInBytes': 123,
    'CreationDate': 'string',
    'Parts': [
        {
            'RangeInBytes': 'string',
            'SHA256TreeHash': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the Amazon Glacier response to your request.

  • MultipartUploadId (string) –

    The ID of the upload to which the parts are associated.

  • VaultARN (string) –

    The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

  • ArchiveDescription (string) –

    The description of the archive that was specified in the Initiate Multipart Upload request.

  • PartSizeInBytes (integer) –

    The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

  • CreationDate (string) –

    The UTC time at which the multipart upload was initiated.

  • Parts (list) –

    A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

    • (dict) –

      A list of the part sizes of the multipart upload.

      • RangeInBytes (string) –

        The byte range of a part, inclusive of the upper value of the range.

      • SHA256TreeHash (string) –

        The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.

  • NextToken (string) –

    A token to resume pagination.