Glacier / Client / upload_archive

upload_archive#

Glacier.Client.upload_archive(**kwargs)#

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

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

See also: AWS API Documentation

Request Syntax

response = client.upload_archive(
    vaultName='string',
    archiveDescription='string',
    body=b'bytes'|file
)
Parameters:

  • vaultName (string) –

    [REQUIRED]

    The name of the vault.

  • 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.

  • archiveDescription (string) – The optional description of the archive you are uploading.

  • 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

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

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 adds an archive to a vault.

response = client.upload_archive(
    accountId='-',
    archiveDescription='',
    body='example-data-to-upload',
    checksum='',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'archiveId': 'kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
    'checksum': '969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67',
    'location': '/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
    'ResponseMetadata': {
        '...': '...',
    },
}