Glacier / Client / complete_multipart_upload

complete_multipart_upload#

Glacier.Client.complete_multipart_upload(**kwargs)#

You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

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 Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.complete_multipart_upload(
    vaultName='string',
    uploadId='string',
    archiveSize='string',
    checksum='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.

  • uploadId (string) –

    [REQUIRED]

    The upload ID of the multipart upload.

  • archiveSize (string) – The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

  • checksum (string) –

    The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.

    This is a required field.

    Ideally you will want to compute this value with checksums from previous uploaded parts, using the algorithm described in Glacier documentation.

    But if you prefer, you can also use botocore.utils.calculate_tree_hash() to compute it from raw file by:

    checksum = calculate_tree_hash(open('your_file.txt', 'rb'))

Return type:

dict

Returns:

Response Syntax

{
    'location': 'string',
    'checksum': 'string',
    'archiveId': 'string'
}

Response Structure

  • (dict) –

    Contains the Amazon S3 Glacier response to your request.

    For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon S3 Glacier.

    • location (string) –

      The relative URI path of the newly added archive resource.

    • checksum (string) –

      The checksum of the archive computed by Amazon S3 Glacier.

    • archiveId (string) –

      The ID of the archive. This value is also included as part of the location.

Exceptions

Examples

The example completes a multipart upload for a 3 MiB archive.

response = client.complete_multipart_upload(
    accountId='-',
    archiveSize='3145728',
    checksum='9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67',
    uploadId='19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'archiveId': 'NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
    'checksum': '9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67',
    'location': '/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
    'ResponseMetadata': {
        '...': '...',
    },
}