Glacier / Paginator / ListMultipartUploads

ListMultipartUploads

class Glacier.Paginator.ListMultipartUploads

paginator = client.get_paginator('list_multipart_uploads')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    vaultName='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 S3 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.

• 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

{
    'UploadsList': [
        {
            'MultipartUploadId': 'string',
            'VaultARN': 'string',
            'ArchiveDescription': 'string',
            'PartSizeInBytes': 123,
            'CreationDate': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the Amazon S3 Glacier response to your request.

  • UploadsList (list) –

    A list of in-progress multipart uploads.

    • (dict) –

      A list of in-progress multipart uploads for a vault.

      • MultipartUploadId (string) –

        The ID of a multipart upload.

      • VaultARN (string) –

        The Amazon Resource Name (ARN) of the vault that contains the archive.

      • ArchiveDescription (string) –

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

      • PartSizeInBytes (integer) –

        The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

      • CreationDate (string) –

        The UTC time at which the multipart upload was initiated.

  • NextToken (string) –

    A token to resume pagination.