Glacier / Client / list_multipart_uploads

list_multipart_uploads

Glacier.Client.list_multipart_uploads(**kwargs)

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts ( ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

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 the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

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

• marker (string) – An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

• limit (string) – Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 50 uploads.

Return type:

dict

Returns:

Response Syntax

{
    'UploadsList': [
        {
            'MultipartUploadId': 'string',
            'VaultARN': 'string',
            'ArchiveDescription': 'string',
            'PartSizeInBytes': 123,
            'CreationDate': 'string'
        },
    ],
    'Marker': '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.

  • Marker (string) –

    An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.

Exceptions

• Glacier.Client.exceptions.ResourceNotFoundException

• Glacier.Client.exceptions.InvalidParameterValueException

• Glacier.Client.exceptions.MissingParameterValueException

• Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example lists all the in-progress multipart uploads for the vault named examplevault.

response = client.list_multipart_uploads(
    accountId='-',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'Marker': 'null',
    'UploadsList': [
        {
            'ArchiveDescription': 'archive 1',
            'CreationDate': '2012-03-19T23:20:59.130Z',
            'MultipartUploadId': 'xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev',
            'PartSizeInBytes': 4194304,
            'VaultARN': 'arn:aws:glacier:us-west-2:012345678901:vaults/examplevault',
        },
        {
            'ArchiveDescription': 'archive 2',
            'CreationDate': '2012-04-01T15:00:00.000Z',
            'MultipartUploadId': 'nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc',
            'PartSizeInBytes': 4194304,
            'VaultARN': 'arn:aws:glacier:us-west-2:012345678901:vaults/examplevault',
        },
        {
            'ArchiveDescription': 'archive 3',
            'CreationDate': '2012-03-20T17:03:43.221Z',
            'MultipartUploadId': 'qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV',
            'PartSizeInBytes': 4194304,
            'VaultARN': 'arn:aws:glacier:us-west-2:012345678901:vaults/examplevault',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}