Glacier / Client / upload_multipart_part

upload_multipart_part#

Glacier.Client.upload_multipart_part(**kwargs)#

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

  • **SHA256 tree hash does not match**To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don’t match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.

  • **Part size does not match**The size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

Note

If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.

  • **Range does not align**The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

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 Upload Part in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.upload_multipart_part(
    vaultName='string',
    uploadId='string',
    range='string',
    body=b'bytes'|file
)
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.

  • checksum (string) –

    The SHA256 tree hash of the data being uploaded.

    Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required

  • range (string) – Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

  • body (bytes or seekable file-like object) – The data to upload.

Return type:

dict

Returns:

Response Syntax

{
    'checksum': 'string'
}

Response Structure

  • (dict) –

    Contains the Amazon S3 Glacier response to your request.

    • checksum (string) –

      The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded part.

Exceptions

  • Glacier.Client.exceptions.ResourceNotFoundException

  • Glacier.Client.exceptions.InvalidParameterValueException

  • Glacier.Client.exceptions.MissingParameterValueException

  • Glacier.Client.exceptions.RequestTimeoutException

  • Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.

response = client.upload_multipart_part(
    accountId='-',
    body='part1',
    checksum='c06f7cd4baacb087002a99a5f48bf953',
    range='bytes 0-1048575/*',
    uploadId='19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'checksum': 'c06f7cd4baacb087002a99a5f48bf953',
    'ResponseMetadata': {
        '...': '...',
    },
}