Glacier

Client

class Glacier.Client

A low-level client representing Amazon Glacier:

import boto3

client = boto3.client('glacier')

These are the available methods:

abort_multipart_upload(**kwargs)

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload .

This operation is idempotent.

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 Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.abort_multipart_upload(
    vaultName='string',
    uploadId='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 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 to delete.

Returns

None

Examples

The example deletes an in-progress multipart upload to a vault named my-vault:

response = client.abort_multipart_upload(
    accountId='-',
    uploadId='19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
abort_vault_lock(**kwargs)

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

A vault lock is put into the InProgress state by calling InitiateVaultLock . A vault lock is put into the Locked state by calling CompleteVaultLock . You can get the state of a vault lock by calling GetVaultLock . For more information about the vault locking process, see Amazon Glacier Vault Lock . For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies .

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

See also: AWS API Documentation

Request Syntax

response = client.abort_vault_lock(
    vaultName='string'
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your 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.

Returns

None

Examples

The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.

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

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
add_tags_to_vault(**kwargs)

This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources .

See also: AWS API Documentation

Request Syntax

response = client.add_tags_to_vault(
    vaultName='string',
    Tags={
        'string': '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 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.

  • Tags (dict) --

    The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.

    • (string) --
      • (string) --
Returns

None

Examples

The example adds two tags to a my-vault.

response = client.add_tags_to_vault(
    Tags={
        'examplekey1': 'examplevalue1',
        'examplekey2': 'examplevalue2',
    },
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
complete_multipart_upload(**kwargs)

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon 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, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon 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, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon 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 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 Glacier, Amazon 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 Glacier response to your request.

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

    • location (string) --

      The relative URI path of the newly added archive resource.

    • checksum (string) --

      The checksum of the archive computed by Amazon Glacier.

    • archiveId (string) --

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

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': {
        '...': '...',
    },
}
complete_vault_lock(**kwargs)

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock . You can obtain the state of the vault lock by calling GetVaultLock . For more information about the vault locking process, Amazon Glacier Vault Lock .

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

See also: AWS API Documentation

Request Syntax

response = client.complete_vault_lock(
    vaultName='string',
    lockId='string'
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your 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.

  • lockId (string) --

    [REQUIRED]

    The lockId value is the lock ID obtained from a InitiateVaultLock request.

Returns

None

Examples

The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.

response = client.complete_vault_lock(
    accountId='-',
    lockId='AE863rKkWZU53SLW5be4DUcW',
    vaultName='example-vault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
create_vault(**kwargs)

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.
  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_vault(
    vaultName='string'
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your 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.

Return type

dict

Returns

Response Syntax

{
    'location': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • location (string) --

      The URI of the vault that was created.

Examples

The following example creates a new vault named my-vault.

response = client.create_vault(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'location': '/111122223333/vaults/my-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}
delete_archive(**kwargs)

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.
  • If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

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

See also: AWS API Documentation

Request Syntax

response = client.delete_archive(
    vaultName='string',
    archiveId='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 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.

  • archiveId (string) --

    [REQUIRED]

    The ID of the archive to delete.

Returns

None

Examples

The example deletes the archive specified by the archive ID.

response = client.delete_archive(
    accountId='-',
    archiveId='NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
delete_vault(**kwargs)

This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive) .

This operation is idempotent.

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 Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_vault(
    vaultName='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 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.

Returns

None

Examples

The example deletes a vault named my-vault:

response = client.delete_vault(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
delete_vault_access_policy(**kwargs)

This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.

This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies .

See also: AWS API Documentation

Request Syntax

response = client.delete_vault_access_policy(
    vaultName='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 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.

Returns

None

Examples

The example deletes the access policy associated with the vault named examplevault.

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

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
delete_vault_notifications(**kwargs)

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

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 Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_vault_notifications(
    vaultName='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 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.

Returns

None

Examples

The example deletes the notification configuration set for the vault named examplevault.

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

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
describe_job(**kwargs)

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob .

Note

This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.

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 information about the underlying REST API, see Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_job(
    vaultName='string',
    jobId='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 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.

  • jobId (string) --

    [REQUIRED]

    The ID of the job to describe.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string',
    'JobDescription': 'string',
    'Action': 'ArchiveRetrieval'|'InventoryRetrieval',
    'ArchiveId': 'string',
    'VaultARN': 'string',
    'CreationDate': 'string',
    'Completed': True|False,
    'StatusCode': 'InProgress'|'Succeeded'|'Failed',
    'StatusMessage': 'string',
    'ArchiveSizeInBytes': 123,
    'InventorySizeInBytes': 123,
    'SNSTopic': 'string',
    'CompletionDate': 'string',
    'SHA256TreeHash': 'string',
    'ArchiveSHA256TreeHash': 'string',
    'RetrievalByteRange': 'string',
    'Tier': 'string',
    'InventoryRetrievalParameters': {
        'Format': 'string',
        'StartDate': 'string',
        'EndDate': 'string',
        'Limit': 'string',
        'Marker': 'string'
    }
}

Response Structure

  • (dict) --

    Describes an Amazon Glacier job.

    • JobId (string) --

      An opaque string that identifies an Amazon Glacier job.

    • JobDescription (string) --

      The job description you provided when you initiated the job.

    • Action (string) --

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

    • ArchiveId (string) --

      For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

    • VaultARN (string) --

      The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

    • CreationDate (string) --

      The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    • Completed (boolean) --

      The job status. When a job is completed, you get the job's output.

    • StatusCode (string) --

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

    • StatusMessage (string) --

      A friendly message that describes the job status.

    • ArchiveSizeInBytes (integer) --

      For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

    • InventorySizeInBytes (integer) --

      For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

    • SNSTopic (string) --

      An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

    • CompletionDate (string) --

      The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

    • SHA256TreeHash (string) --

      For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

      The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

      For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

      This field is null in the following situations:

      • Archive retrieval jobs that specify a range that is not tree-hash aligned.
      • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
      • Inventory jobs.
    • ArchiveSHA256TreeHash (string) --

      The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

    • RetrievalByteRange (string) --

      The retrieved byte range for archive retrieval jobs in the form "StartByteValue -EndByteValue " If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

    • Tier (string) --

      The retrieval option to use for the archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.

    • InventoryRetrievalParameters (dict) --

      Parameters used for range inventory retrieval.

      • Format (string) --

        The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON .

      • StartDate (string) --

        The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

      • EndDate (string) --

        The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

      • Limit (string) --

        The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

      • Marker (string) --

        An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null . For more information, see Range Inventory Retrieval .

Examples

The example returns information about the previously initiated job specified by the job ID.

response = client.describe_job(
    accountId='-',
    jobId='zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'Action': 'InventoryRetrieval',
    'Completed': False,
    'CreationDate': '2015-07-17T20:23:41.616Z',
    'InventoryRetrievalParameters': {
        'Format': 'JSON',
    },
    'JobId': 'zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW',
    'StatusCode': 'InProgress',
    'VaultARN': 'arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}
describe_vault(**kwargs)

This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob . Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier .

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 Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_vault(
    vaultName='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 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.

Return type

dict

Returns

Response Syntax

{
    'VaultARN': 'string',
    'VaultName': 'string',
    'CreationDate': 'string',
    'LastInventoryDate': 'string',
    'NumberOfArchives': 123,
    'SizeInBytes': 123
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • VaultARN (string) --

      The Amazon Resource Name (ARN) of the vault.

    • VaultName (string) --

      The name of the vault.

    • CreationDate (string) --

      The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

    • LastInventoryDate (string) --

      The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

    • NumberOfArchives (integer) --

      The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

    • SizeInBytes (integer) --

      Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

Examples

The example retrieves data about a vault named my-vault.

response = client.describe_vault(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'CreationDate': '2016-09-23T19:27:18.665Z',
    'NumberOfArchives': 0,
    'SizeInBytes': 0,
    'VaultARN': 'arn:aws:glacier:us-west-2:111122223333:vaults/my-vault',
    'VaultName': 'my-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_data_retrieval_policy(**kwargs)

This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies .

See also: AWS API Documentation

Request Syntax

response = client.get_data_retrieval_policy(

)
Parameters
accountId (string) --

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Note: this parameter is set to "-" bydefault if no value is not specified.
Return type
dict
Returns
Response Syntax
{
    'Policy': {
        'Rules': [
            {
                'Strategy': 'string',
                'BytesPerHour': 123
            },
        ]
    }
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.

    • Policy (dict) --

      Contains the returned data retrieval policy in JSON format.

      • Rules (list) --

        The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

        • (dict) --

          Data retrieval policy rule.

          • Strategy (string) --

            The type of data retrieval policy to set.

            Valid values: BytesPerHour|FreeTier|None

          • BytesPerHour (integer) --

            The maximum number of bytes that can be retrieved in an hour.

            This field is required only if the value of the Strategy field is BytesPerHour . Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

Examples

The example returns the current data retrieval policy for the account.

response = client.get_data_retrieval_policy(
    accountId='-',
)

print(response)

Expected Output:

{
    'Policy': {
        'Rules': [
            {
                'BytesPerHour': 10737418240,
                'Strategy': 'BytesPerHour',
            },
        ],
    },
    'ResponseMetadata': {
        '...': '...',
    },
}
get_job_output(**kwargs)

This operation downloads the output of the job you initiated using InitiateJob . Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575 , you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

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 Downloading a Vault Inventory , Downloading an Archive , and Get Job Output

See also: AWS API Documentation

Request Syntax

response = client.get_job_output(
    vaultName='string',
    jobId='string',
    range='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 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.

  • jobId (string) --

    [REQUIRED]

    The job ID whose data is downloaded.

  • range (string) --

    The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575 . By default, this operation downloads the entire output.

    If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

    • Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
    • Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
    • Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
    • After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
Return type

dict

Returns

Response Syntax

{
    'body': StreamingBody(),
    'checksum': 'string',
    'status': 123,
    'contentRange': 'string',
    'acceptRanges': 'string',
    'contentType': 'string',
    'archiveDescription': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • body (StreamingBody) --

      The job data, either archive data or inventory data.

    • checksum (string) --

      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
    • status (integer) --

      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

    • contentRange (string) --

      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

    • acceptRanges (string) --

      Indicates the range units accepted. For more information, see RFC2616 .

    • contentType (string) --

      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

    • archiveDescription (string) --

      The description of an archive.

Examples

The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.

response = client.get_job_output(
    accountId='-',
    jobId='zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW',
    range='',
    vaultName='my-vaul',
)

print(response)

Expected Output:

{
    'acceptRanges': 'bytes',
    'body': 'inventory-data',
    'contentType': 'application/json',
    'status': 200,
    'ResponseMetadata': {
        '...': '...',
    },
}
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_vault_access_policy(**kwargs)

This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy) . If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies .

See also: AWS API Documentation

Request Syntax

response = client.get_vault_access_policy(
    vaultName='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 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.

Return type

dict

Returns

Response Syntax

{
    'policy': {
        'Policy': 'string'
    }
}

Response Structure

  • (dict) --

    Output for GetVaultAccessPolicy.

    • policy (dict) --

      Contains the returned vault access policy as a JSON string.

      • Policy (string) --

        The vault access policy.

Examples

The example retrieves the access-policy set on the vault named example-vault.

response = client.get_vault_access_policy(
    accountId='-',
    vaultName='example-vault',
)

print(response)

Expected Output:

{
    'policy': {
        'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"Define-owner-access-rights","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault"}]}',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}
get_vault_lock(**kwargs)

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

  • The vault lock policy set on the vault.
  • The state of the vault lock, which is either InProgess or Locked .
  • When the lock ID expires. The lock ID is used to complete the vault locking process.
  • When the vault lock was initiated and put into the InProgress state.

A vault lock is put into the InProgress state by calling InitiateVaultLock . A vault lock is put into the Locked state by calling CompleteVaultLock . You can abort the vault locking process by calling AbortVaultLock . For more information about the vault locking process, Amazon Glacier Vault Lock .

If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies .

See also: AWS API Documentation

Request Syntax

response = client.get_vault_lock(
    vaultName='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 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.

Return type

dict

Returns

Response Syntax

{
    'Policy': 'string',
    'State': 'string',
    'ExpirationDate': 'string',
    'CreationDate': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • Policy (string) --

      The vault lock policy as a JSON string, which uses "" as an escape character.

    • State (string) --

      The state of the vault lock. InProgress or Locked .

    • ExpirationDate (string) --

      The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state.

    • CreationDate (string) --

      The UTC date and time at which the vault lock was put into the InProgress state.

Examples

The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.

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

print(response)

Expected Output:

{
    'CreationDate': 'exampledate',
    'ExpirationDate': 'exampledate',
    'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"Define-vault-lock","Effect":"Deny","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault","Condition":{"NumericLessThanEquals":{"glacier:ArchiveAgeinDays":"365"}}}]}',
    'State': 'InProgress',
    'ResponseMetadata': {
        '...': '...',
    },
}
get_vault_notifications(**kwargs)

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications . If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier .

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 Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_vault_notifications(
    vaultName='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 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.

Return type

dict

Returns

Response Syntax

{
    'vaultNotificationConfig': {
        'SNSTopic': 'string',
        'Events': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • vaultNotificationConfig (dict) --

      Returns the notification configuration set on the vault.

      • SNSTopic (string) --

        The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

      • Events (list) --

        A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

        • (string) --

Examples

The example retrieves the notification-configuration for the vault named my-vault.

response = client.get_vault_notifications(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'vaultNotificationConfig': {
        'Events': [
            'InventoryRetrievalCompleted',
            'ArchiveRetrievalCompleted',
        ],
        'SNSTopic': 'arn:aws:sns:us-west-2:0123456789012:my-vault',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}
get_waiter(waiter_name)
initiate_job(**kwargs)

This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).

Retrieving data from Amazon Glacier is a two-step process:

  • Initiate a retrieval job.

Note

A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies . For more information about the PolicyEnforcedException exception, see Error Responses .

  • After the job completes, download the bytes.

The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.

The job must complete before you can get its output. To determine when a job is complete, you have the following options:

  • Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications .
  • Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.

Note

The information you get via notification is same that you get by calling DescribeJob .

If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications .

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

About the Vault Inventory

Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.

Range Inventory Retrieval

You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.

Filtering by Archive Creation Date

You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate , you will retrieve the inventory for all archives created on or after the StartDate . If you only provide the EndDate without the StartDate , you will get back the inventory for all archives created before the EndDate .

Limiting Inventory Items per Retrieval

You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.

You can use the Limit parameter together with the date range parameters.

About Ranged Archive Retrieval

You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.

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 Initiate a Job and Downloading a Vault Inventory

Expedited and Bulk Archive Retrievals

When retrieving an archive, you can specify one of the following options in the Tier field of the request body:

  • Standard The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.
  • Bulk Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours.
  • Expedited Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes.

For more information about expedited and bulk retrievals, see Retrieving Amazon Glacier Archives .

See also: AWS API Documentation

Request Syntax

response = client.initiate_job(
    vaultName='string',
    jobParameters={
        'Format': 'string',
        'Type': 'string',
        'ArchiveId': 'string',
        'Description': 'string',
        'SNSTopic': 'string',
        'RetrievalByteRange': 'string',
        'Tier': 'string',
        'InventoryRetrievalParameters': {
            'StartDate': 'string',
            'EndDate': 'string',
            'Limit': 'string',
            'Marker': '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 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.

  • jobParameters (dict) --

    Provides options for specifying job information.

    • Format (string) --

      When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

    • Type (string) --

      The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".

    • ArchiveId (string) --

      The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

    • Description (string) --

      The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

    • SNSTopic (string) --

      The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    • RetrievalByteRange (string) --

      The byte range to retrieve for an archive retrieval. in the form "StartByteValue -EndByteValue " If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

      An error occurs if you specify this field for an inventory retrieval job request.

    • Tier (string) --

      The retrieval option to use for the archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.

    • InventoryRetrievalParameters (dict) --

      Input parameters used for range inventory retrieval.

      • StartDate (string) --

        The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

      • EndDate (string) --

        The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

      • Limit (string) --

        Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

      • Marker (string) --

        An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null .

Return type

dict

Returns

Response Syntax

{
    'location': 'string',
    'jobId': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • location (string) --

      The relative URI path of the job.

    • jobId (string) --

      The ID of the job.

Examples

The example initiates an inventory-retrieval job for the vault named examplevault.

response = client.initiate_job(
    accountId='-',
    jobParameters={
        'Description': 'My inventory job',
        'Format': 'CSV',
        'SNSTopic': 'arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example',
        'Type': 'inventory-retrieval',
    },
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'jobId': ' HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID',
    'location': '/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID',
    'ResponseMetadata': {
        '...': '...',
    },
}
initiate_multipart_upload(**kwargs)

This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart ).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart ), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

Note

You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

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

See also: AWS API Documentation

Request Syntax

response = client.initiate_multipart_upload(
    vaultName='string',
    archiveDescription='string',
    partSize='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 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.

  • archiveDescription (string) --

    The archive description that you are uploading in parts.

    The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

  • partSize (string) -- The size of each part except the last, in bytes. The last part can be smaller than this part size.
Return type

dict

Returns

Response Syntax

{
    'location': 'string',
    'uploadId': 'string'
}

Response Structure

  • (dict) --

    The Amazon Glacier response to your request.

    • location (string) --

      The relative URI path of the multipart upload ID Amazon Glacier created.

    • uploadId (string) --

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

Examples

The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.

response = client.initiate_multipart_upload(
    accountId='-',
    partSize='1048576',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'location': '/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'uploadId': '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'ResponseMetadata': {
        '...': '...',
    },
}
initiate_vault_lock(**kwargs)

This operation initiates the vault locking process by doing the following:

  • Installing a vault lock policy on the specified vault.
  • Setting the lock state of vault lock to InProgress .
  • Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies .

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked .

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock . You can get the state of the vault lock by calling GetVaultLock . For more information about the vault locking process, Amazon Glacier Vault Lock .

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

See also: AWS API Documentation

Request Syntax

response = client.initiate_vault_lock(
    vaultName='string',
    policy={
        'Policy': 'string'
    }
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your 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.

  • policy (dict) --

    The vault lock policy as a JSON string, which uses "" as an escape character.

    • Policy (string) --

      The vault lock policy.

Return type

dict

Returns

Response Syntax

{
    'lockId': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • lockId (string) --

      The lock ID, which is used to complete the vault locking process.

Examples

The example initiates the vault locking process for the vault named my-vault.

response = client.initiate_vault_lock(
    accountId='-',
    policy={
        'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"Define-vault-lock","Effect":"Deny","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault","Condition":{"NumericLessThanEquals":{"glacier:ArchiveAgeinDays":"365"}}}]}',
    },
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'lockId': 'AE863rKkWZU53SLW5be4DUcW',
    'ResponseMetadata': {
        '...': '...',
    },
}
list_jobs(**kwargs)

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

Note

Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data. For an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null . If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress , Succeeded , or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true ) or jobs that were not completed (false ).

For the underlying REST API, see List Jobs .

See also: AWS API Documentation

Request Syntax

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

  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • statuscode (string) -- The type of job status to return. You can specify the following values: InProgress , Succeeded , or Failed .
  • completed (string) -- The state of the jobs to return. You can specify true or false .
Return type

dict

Returns

Response Syntax

{
    'JobList': [
        {
            'JobId': 'string',
            'JobDescription': 'string',
            'Action': 'ArchiveRetrieval'|'InventoryRetrieval',
            'ArchiveId': 'string',
            'VaultARN': 'string',
            'CreationDate': 'string',
            'Completed': True|False,
            'StatusCode': 'InProgress'|'Succeeded'|'Failed',
            'StatusMessage': 'string',
            'ArchiveSizeInBytes': 123,
            'InventorySizeInBytes': 123,
            'SNSTopic': 'string',
            'CompletionDate': 'string',
            'SHA256TreeHash': 'string',
            'ArchiveSHA256TreeHash': 'string',
            'RetrievalByteRange': 'string',
            'Tier': 'string',
            'InventoryRetrievalParameters': {
                'Format': 'string',
                'StartDate': 'string',
                'EndDate': 'string',
                'Limit': 'string',
                'Marker': 'string'
            }
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • JobList (list) --

      A list of job objects. Each job object contains metadata describing the job.

      • (dict) --

        Describes an Amazon Glacier job.

        • JobId (string) --

          An opaque string that identifies an Amazon Glacier job.

        • JobDescription (string) --

          The job description you provided when you initiated the job.

        • Action (string) --

          The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        • ArchiveId (string) --

          For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

        • VaultARN (string) --

          The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

        • CreationDate (string) --

          The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

        • Completed (boolean) --

          The job status. When a job is completed, you get the job's output.

        • StatusCode (string) --

          The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

        • StatusMessage (string) --

          A friendly message that describes the job status.

        • ArchiveSizeInBytes (integer) --

          For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

        • InventorySizeInBytes (integer) --

          For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

        • SNSTopic (string) --

          An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

        • CompletionDate (string) --

          The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

        • SHA256TreeHash (string) --

          For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

          The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

          For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

          This field is null in the following situations:

          • Archive retrieval jobs that specify a range that is not tree-hash aligned.
          • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
          • Inventory jobs.
        • ArchiveSHA256TreeHash (string) --

          The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

        • RetrievalByteRange (string) --

          The retrieved byte range for archive retrieval jobs in the form "StartByteValue -EndByteValue " If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

        • Tier (string) --

          The retrieval option to use for the archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.

        • InventoryRetrievalParameters (dict) --

          Parameters used for range inventory retrieval.

          • Format (string) --

            The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON .

          • StartDate (string) --

            The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

          • EndDate (string) --

            The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

          • Limit (string) --

            The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

          • Marker (string) --

            An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null . For more information, see Range Inventory Retrieval .

    • Marker (string) --

      An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.

Examples

The example lists jobs for the vault named my-vault.

response = client.list_jobs(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'JobList': [
        {
            'Action': 'ArchiveRetrieval',
            'ArchiveId': 'kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
            'ArchiveSHA256TreeHash': '9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67',
            'ArchiveSizeInBytes': 3145728,
            'Completed': False,
            'CreationDate': '2015-07-17T21:16:13.840Z',
            'JobDescription': 'Retrieve archive on 2015-07-17',
            'JobId': 'l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav',
            'RetrievalByteRange': '0-3145727',
            'SHA256TreeHash': '9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67',
            'SNSTopic': 'arn:aws:sns:us-west-2:0123456789012:my-vault',
            'StatusCode': 'InProgress',
            'VaultARN': 'arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault',
        },
        {
            'Action': 'InventoryRetrieval',
            'Completed': False,
            'CreationDate': '2015-07-17T20:23:41.616Z',
            'InventoryRetrievalParameters': {
                'Format': 'JSON',
            },
            'JobId': 'zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW',
            'StatusCode': 'InProgress',
            'VaultARN': 'arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}
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 1,000 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 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 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 1,000 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 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 .

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': {
        '...': '...',
    },
}
list_parts(**kwargs)

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload . List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts 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 parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

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 Glacier and List Parts in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

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

  • marker (string) -- An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
  • limit (string) -- The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.
Return type

dict

Returns

Response Syntax

{
    'MultipartUploadId': 'string',
    'VaultARN': 'string',
    'ArchiveDescription': 'string',
    'PartSizeInBytes': 123,
    'CreationDate': 'string',
    'Parts': [
        {
            'RangeInBytes': 'string',
            'SHA256TreeHash': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • MultipartUploadId (string) --

      The ID of the upload to which the parts are associated.

    • VaultARN (string) --

      The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

    • ArchiveDescription (string) --

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

    • PartSizeInBytes (integer) --

      The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

    • CreationDate (string) --

      The UTC time at which the multipart upload was initiated.

    • Parts (list) --

      A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

      • (dict) --

        A list of the part sizes of the multipart upload.

        • RangeInBytes (string) --

          The byte range of a part, inclusive of the upper value of the range.

        • SHA256TreeHash (string) --

          The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null .

    • Marker (string) --

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

Examples

The example lists all the parts of a multipart upload.

response = client.list_parts(
    accountId='-',
    uploadId='OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'ArchiveDescription': 'archive description',
    'CreationDate': '2012-03-20T17:03:43.221Z',
    'Marker': 'null',
    'MultipartUploadId': 'OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE',
    'PartSizeInBytes': 4194304,
    'Parts': [
        {
            'RangeInBytes': '0-4194303',
            'SHA256TreeHash': '01d34dabf7be316472c93b1ef80721f5d4',
        },
        {
            'RangeInBytes': '4194304-8388607',
            'SHA256TreeHash': '0195875365afda349fc21c84c099987164',
        },
    ],
    'VaultARN': 'arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}
list_provisioned_capacity(**kwargs)

This operation lists the provisioned capacity for the specified AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioned_capacity(

)
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 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

Note: this parameter is set to "-" bydefault if no value is not specified.
Return type
dict
Returns
Response Syntax
{
    'ProvisionedCapacityList': [
        {
            'CapacityId': 'string',
            'StartDate': 'string',
            'ExpirationDate': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ProvisionedCapacityList (list) --

      The response body contains the following JSON fields.

      • (dict) --

        The definition for a provisioned capacity unit.

        • CapacityId (string) --

          The ID that identifies the provisioned capacity unit.

        • StartDate (string) --

          The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).

        • ExpirationDate (string) --

          The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

Examples

The example lists the provisioned capacity units for an account.

response = client.list_provisioned_capacity(
    accountId='-',
)

print(response)

Expected Output:

{
    'ProvisionedCapacityList': [
        {
            'CapacityId': 'zSaq7NzHFQDANTfQkDen4V7z',
            'ExpirationDate': '2016-12-12T00:00:00.000Z',
            'StartDate': '2016-11-11T20:11:51.095Z',
        },
        {
            'CapacityId': 'yXaq7NzHFQNADTfQkDen4V7z',
            'ExpirationDate': '2017-01-15T00:00:00.000Z',
            'StartDate': '2016-12-13T20:11:51.095Z',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}
list_tags_for_vault(**kwargs)

This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources .

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_vault(
    vaultName='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 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.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • Tags (dict) --

      The tags attached to the vault. Each tag is composed of a key and a value.

      • (string) --
        • (string) --

Examples

The example lists all the tags attached to the vault examplevault.

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

print(response)

Expected Output:

{
    'Tags': {
        'date': 'july2015',
        'id': '1234',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}
list_vaults(**kwargs)

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null . To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

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 Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_vaults(
    marker='string',
    limit='string'
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

    Note: this parameter is set to "-" bydefault if no value is not specified.
  • marker (string) -- A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
  • limit (string) -- The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.
Return type

dict

Returns

Response Syntax

{
    'VaultList': [
        {
            'VaultARN': 'string',
            'VaultName': 'string',
            'CreationDate': 'string',
            'LastInventoryDate': 'string',
            'NumberOfArchives': 123,
            'SizeInBytes': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • VaultList (list) --

      List of vaults.

      • (dict) --

        Contains the Amazon Glacier response to your request.

        • VaultARN (string) --

          The Amazon Resource Name (ARN) of the vault.

        • VaultName (string) --

          The name of the vault.

        • CreationDate (string) --

          The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

        • LastInventoryDate (string) --

          The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

        • NumberOfArchives (integer) --

          The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

        • SizeInBytes (integer) --

          Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

    • Marker (string) --

      The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

Examples

The example lists all vaults owned by the specified AWS account.

response = client.list_vaults(
    accountId='-',
    limit='',
    marker='',
)

print(response)

Expected Output:

{
    'VaultList': [
        {
            'CreationDate': '2015-04-06T21:23:45.708Z',
            'LastInventoryDate': '2015-04-07T00:26:19.028Z',
            'NumberOfArchives': 1,
            'SizeInBytes': 3178496,
            'VaultARN': 'arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault',
            'VaultName': 'my-vault',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}
purchase_provisioned_capacity(**kwargs)

This operation purchases a provisioned capacity unit for an AWS account.

See also: AWS API Documentation

Request Syntax

response = client.purchase_provisioned_capacity(

)
Parameters
accountId (string) --

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 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

Note: this parameter is set to "-" bydefault if no value is not specified.
Return type
dict
Returns
Response Syntax
{
    'capacityId': 'string'
}

Response Structure

  • (dict) --
    • capacityId (string) --

      The ID that identifies the provisioned capacity unit.

Examples

The example purchases provisioned capacity unit for an AWS account.

response = client.purchase_provisioned_capacity(
    accountId='-',
)

print(response)

Expected Output:

{
    'capacityId': 'zSaq7NzHFQDANTfQkDen4V7z',
    'ResponseMetadata': {
        '...': '...',
    },
}
remove_tags_from_vault(**kwargs)

This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources . This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags_from_vault(
    vaultName='string',
    TagKeys=[
        '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 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.

  • TagKeys (list) --

    A list of tag keys. Each corresponding tag is removed from the vault.

    • (string) --
Returns

None

Examples

The example removes two tags from the vault named examplevault.

response = client.remove_tags_from_vault(
    TagKeys=[
        'examplekey1',
        'examplekey2',
    ],
    accountId='-',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
set_data_retrieval_policy(**kwargs)

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies .

See also: AWS API Documentation

Request Syntax

response = client.set_data_retrieval_policy(
    Policy={
        'Rules': [
            {
                'Strategy': 'string',
                'BytesPerHour': 123
            },
        ]
    }
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

    Note: this parameter is set to "-" bydefault if no value is not specified.
  • Policy (dict) --

    The data retrieval policy in JSON format.

    • Rules (list) --

      The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

      • (dict) --

        Data retrieval policy rule.

        • Strategy (string) --

          The type of data retrieval policy to set.

          Valid values: BytesPerHour|FreeTier|None

        • BytesPerHour (integer) --

          The maximum number of bytes that can be retrieved in an hour.

          This field is required only if the value of the Strategy field is BytesPerHour . Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

Returns

None

Examples

The example sets and then enacts a data retrieval policy.

response = client.set_data_retrieval_policy(
    Policy={
        'Rules': [
            {
                'BytesPerHour': 10737418240,
                'Strategy': 'BytesPerHour',
            },
        ],
    },
    accountId='-',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
set_vault_access_policy(**kwargs)

This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies .

See also: AWS API Documentation

Request Syntax

response = client.set_vault_access_policy(
    vaultName='string',
    policy={
        'Policy': '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 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.

  • policy (dict) --

    The vault access policy as a JSON string.

    • Policy (string) --

      The vault access policy.

Returns

None

Examples

The example configures an access policy for the vault named examplevault.

response = client.set_vault_access_policy(
    accountId='-',
    policy={
        'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"Define-owner-access-rights","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault"}]}',
    },
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
set_vault_notifications(**kwargs)

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed ( InitiateJob ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob .
  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed ( InitiateJob ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob .

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 Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.set_vault_notifications(
    vaultName='string',
    vaultNotificationConfig={
        'SNSTopic': 'string',
        'Events': [
            '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 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.

  • vaultNotificationConfig (dict) --

    Provides options for specifying notification configuration.

    • SNSTopic (string) --

      The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

    • Events (list) --

      A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

      • (string) --
Returns

None

Examples

The example sets the examplevault notification configuration.

response = client.set_vault_notifications(
    accountId='-',
    vaultName='examplevault',
    vaultNotificationConfig={
        'Events': [
            'ArchiveRetrievalCompleted',
            'InventoryRetrievalCompleted',
        ],
        'SNSTopic': 'arn:aws:sns:us-west-2:012345678901:mytopic',
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}
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 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 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 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 Glacier response to your request.

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

    • location (string) --

      The relative URI path of the newly added archive resource.

    • checksum (string) --

      The checksum of the archive computed by Amazon Glacier.

    • archiveId (string) --

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

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': {
        '...': '...',
    },
}
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 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 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 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 Glacier response to your request.

    • checksum (string) --

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

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': {
        '...': '...',
    },
}

Paginators

The available paginators are:

class Glacier.Paginator.ListJobs
paginator = client.get_paginator('list_jobs')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    vaultName='string',
    statuscode='string',
    completed='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 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.

  • statuscode (string) -- The type of job status to return. You can specify the following values: InProgress , Succeeded , or Failed .
  • completed (string) -- The state of the jobs to return. You can specify true or false .
  • 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

{
    'JobList': [
        {
            'JobId': 'string',
            'JobDescription': 'string',
            'Action': 'ArchiveRetrieval'|'InventoryRetrieval',
            'ArchiveId': 'string',
            'VaultARN': 'string',
            'CreationDate': 'string',
            'Completed': True|False,
            'StatusCode': 'InProgress'|'Succeeded'|'Failed',
            'StatusMessage': 'string',
            'ArchiveSizeInBytes': 123,
            'InventorySizeInBytes': 123,
            'SNSTopic': 'string',
            'CompletionDate': 'string',
            'SHA256TreeHash': 'string',
            'ArchiveSHA256TreeHash': 'string',
            'RetrievalByteRange': 'string',
            'Tier': 'string',
            'InventoryRetrievalParameters': {
                'Format': 'string',
                'StartDate': 'string',
                'EndDate': 'string',
                'Limit': 'string',
                'Marker': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • JobList (list) --

      A list of job objects. Each job object contains metadata describing the job.

      • (dict) --

        Describes an Amazon Glacier job.

        • JobId (string) --

          An opaque string that identifies an Amazon Glacier job.

        • JobDescription (string) --

          The job description you provided when you initiated the job.

        • Action (string) --

          The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        • ArchiveId (string) --

          For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

        • VaultARN (string) --

          The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

        • CreationDate (string) --

          The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

        • Completed (boolean) --

          The job status. When a job is completed, you get the job's output.

        • StatusCode (string) --

          The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

        • StatusMessage (string) --

          A friendly message that describes the job status.

        • ArchiveSizeInBytes (integer) --

          For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

        • InventorySizeInBytes (integer) --

          For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

        • SNSTopic (string) --

          An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

        • CompletionDate (string) --

          The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

        • SHA256TreeHash (string) --

          For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

          The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

          For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

          This field is null in the following situations:

          • Archive retrieval jobs that specify a range that is not tree-hash aligned.
          • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
          • Inventory jobs.
        • ArchiveSHA256TreeHash (string) --

          The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

        • RetrievalByteRange (string) --

          The retrieved byte range for archive retrieval jobs in the form "StartByteValue -EndByteValue " If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

        • Tier (string) --

          The retrieval option to use for the archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.

        • InventoryRetrievalParameters (dict) --

          Parameters used for range inventory retrieval.

          • Format (string) --

            The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON .

          • StartDate (string) --

            The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

          • EndDate (string) --

            The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

          • Limit (string) --

            The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

          • Marker (string) --

            An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null . For more information, see Range Inventory Retrieval .

    • NextToken (string) --

      A token to resume pagination.

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

class Glacier.Paginator.ListParts
paginator = client.get_paginator('list_parts')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • 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

{
    'MultipartUploadId': 'string',
    'VaultARN': 'string',
    'ArchiveDescription': 'string',
    'PartSizeInBytes': 123,
    'CreationDate': 'string',
    'Parts': [
        {
            'RangeInBytes': 'string',
            'SHA256TreeHash': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • MultipartUploadId (string) --

      The ID of the upload to which the parts are associated.

    • VaultARN (string) --

      The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

    • ArchiveDescription (string) --

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

    • PartSizeInBytes (integer) --

      The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

    • CreationDate (string) --

      The UTC time at which the multipart upload was initiated.

    • Parts (list) --

      A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

      • (dict) --

        A list of the part sizes of the multipart upload.

        • RangeInBytes (string) --

          The byte range of a part, inclusive of the upper value of the range.

        • SHA256TreeHash (string) --

          The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null .

    • NextToken (string) --

      A token to resume pagination.

class Glacier.Paginator.ListVaults
paginator = client.get_paginator('list_vaults')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • accountId (string) --

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

    Note: this parameter is set to "-" bydefault if no value is not specified.
  • 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

{
    'VaultList': [
        {
            'VaultARN': 'string',
            'VaultName': 'string',
            'CreationDate': 'string',
            'LastInventoryDate': 'string',
            'NumberOfArchives': 123,
            'SizeInBytes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • VaultList (list) --

      List of vaults.

      • (dict) --

        Contains the Amazon Glacier response to your request.

        • VaultARN (string) --

          The Amazon Resource Name (ARN) of the vault.

        • VaultName (string) --

          The name of the vault.

        • CreationDate (string) --

          The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

        • LastInventoryDate (string) --

          The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

        • NumberOfArchives (integer) --

          The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

        • SizeInBytes (integer) --

          Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

    • NextToken (string) --

      A token to resume pagination.

Waiters

The available waiters are:

class Glacier.Waiter.VaultExists
waiter = client.get_waiter('vault_exists')
wait(**kwargs)

Polls Glacier.Client.describe_vault() every 3 seconds until a successful state is reached. An error is returned after 15 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    vaultName='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 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.

Returns

None

class Glacier.Waiter.VaultNotExists
waiter = client.get_waiter('vault_not_exists')
wait(**kwargs)

Polls Glacier.Client.describe_vault() every 3 seconds until a successful state is reached. An error is returned after 15 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    vaultName='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 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.

Returns

None

Service Resource

class Glacier.ServiceResource

A resource representing Amazon Glacier:

import boto3

glacier = boto3.resource('glacier')

These are the resource's available actions:

These are the resource's available sub-resources:

These are the resource's available collections:

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

create_vault(**kwargs)

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.
  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

vault = glacier.create_vault(
    vaultName='string'
)
Parameters
vaultName (string) --

[REQUIRED]

The name of the vault.

Return type
glacier.Vault
Returns
Vault resource
get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Account(id)

Creates a Account resource.:

account = glacier.Account('id')
Parameters
id (string) -- The Account's id identifier. This must be set.
Return type
Glacier.Account
Returns
A Account resource
Archive(account_id, vault_name, id)

Creates a Archive resource.:

archive = glacier.Archive('account_id','vault_name','id')
Parameters
  • account_id (string) -- The Archive's account_id identifier. This must be set.
  • vault_name (string) -- The Archive's vault_name identifier. This must be set.
  • id (string) -- The Archive's id identifier. This must be set.
Return type

Glacier.Archive

Returns

A Archive resource

Job(account_id, vault_name, id)

Creates a Job resource.:

job = glacier.Job('account_id','vault_name','id')
Parameters
  • account_id (string) -- The Job's account_id identifier. This must be set.
  • vault_name (string) -- The Job's vault_name identifier. This must be set.
  • id (string) -- The Job's id identifier. This must be set.
Return type

Glacier.Job

Returns

A Job resource

MultipartUpload(account_id, vault_name, id)

Creates a MultipartUpload resource.:

multipart_upload = glacier.MultipartUpload('account_id','vault_name','id')
Parameters
  • account_id (string) -- The MultipartUpload's account_id identifier. This must be set.
  • vault_name (string) -- The MultipartUpload's vault_name identifier. This must be set.
  • id (string) -- The MultipartUpload's id identifier. This must be set.
Return type

Glacier.MultipartUpload

Returns

A MultipartUpload resource

Notification(account_id, vault_name)

Creates a Notification resource.:

notification = glacier.Notification('account_id','vault_name')
Parameters
  • account_id (string) -- The Notification's account_id identifier. This must be set.
  • vault_name (string) -- The Notification's vault_name identifier. This must be set.
Return type

Glacier.Notification

Returns

A Notification resource

Vault(account_id, name)

Creates a Vault resource.:

vault = glacier.Vault('account_id','name')
Parameters
  • account_id (string) -- The Vault's account_id identifier. This must be set.
  • name (string) -- The Vault's name identifier. This must be set.
Return type

Glacier.Vault

Returns

A Vault resource

Collections

Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.

vaults

A collection of Vault resources

all()

Creates an iterable of all Vault resources in the collection.

See also: AWS API Documentation

Request Syntax

vault_iterator = glacier.vaults.all()
Return type
list(glacier.Vault)
Returns
A list of Vault resources
filter(**kwargs)

Creates an iterable of all Vault resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

vault_iterator = glacier.vaults.filter(
    marker='string',
    limit='string'
)
Parameters
  • marker (string) -- A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
  • limit (string) -- The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.
Return type

list(glacier.Vault)

Returns

A list of Vault resources

limit(**kwargs)

Creates an iterable up to a specified amount of Vault resources in the collection.

See also: AWS API Documentation

Request Syntax

vault_iterator = glacier.vaults.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Vault)
Returns
A list of Vault resources
page_size(**kwargs)

Creates an iterable of all Vault resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

vault_iterator = glacier.vaults.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Vault)
Returns
A list of Vault resources

Account

class Glacier.Account(id)

A resource representing an Amazon Glacier Account:

import boto3

glacier = boto3.resource('glacier')
account = glacier.Account('id')
Parameters
id (string) -- The Account's id identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available actions:

These are the resource's available sub-resources:

These are the resource's available collections:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

id

(string) The Account's id identifier. This must be set.

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

create_vault(**kwargs)

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.
  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

vault = account.create_vault(
    vaultName='string'
)
Parameters
vaultName (string) --

[REQUIRED]

The name of the vault.

Return type
glacier.Vault
Returns
Vault resource
get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Vault(name)

Creates a Vault resource.:

vault = account.Vault('name')
Parameters
name (string) -- The Vault's name identifier. This must be set.
Return type
Glacier.Vault
Returns
A Vault resource

Collections

Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.

vaults

A collection of Vault resources

all()

Creates an iterable of all Vault resources in the collection.

See also: AWS API Documentation

Request Syntax

vault_iterator = account.vaults.all()
Return type
list(glacier.Vault)
Returns
A list of Vault resources
filter(**kwargs)

Creates an iterable of all Vault resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

vault_iterator = account.vaults.filter(
    marker='string',
    limit='string'
)
Parameters
  • marker (string) -- A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
  • limit (string) -- The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.
Return type

list(glacier.Vault)

Returns

A list of Vault resources

limit(**kwargs)

Creates an iterable up to a specified amount of Vault resources in the collection.

See also: AWS API Documentation

Request Syntax

vault_iterator = account.vaults.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Vault)
Returns
A list of Vault resources
page_size(**kwargs)

Creates an iterable of all Vault resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

vault_iterator = account.vaults.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Vault)
Returns
A list of Vault resources

Archive

class Glacier.Archive(account_id, vault_name, id)

A resource representing an Amazon Glacier Archive:

import boto3

glacier = boto3.resource('glacier')
archive = glacier.Archive('account_id','vault_name','id')
Parameters
  • account_id (string) -- The Archive's account_id identifier. This must be set.
  • vault_name (string) -- The Archive's vault_name identifier. This must be set.
  • id (string) -- The Archive's id identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available actions:

These are the resource's available sub-resources:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

account_id

(string) The Archive's account_id identifier. This must be set.

vault_name

(string) The Archive's vault_name identifier. This must be set.

id

(string) The Archive's id identifier. This must be set.

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

delete()

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.
  • If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

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

See also: AWS API Documentation

Request Syntax

response = archive.delete()
Returns
None
get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str
initiate_archive_retrieval()

This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).

Retrieving data from Amazon Glacier is a two-step process:

  • Initiate a retrieval job.

Note

A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies . For more information about the PolicyEnforcedException exception, see Error Responses .

  • After the job completes, download the bytes.

The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.

The job must complete before you can get its output. To determine when a job is complete, you have the following options:

  • Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications .
  • Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.

Note

The information you get via notification is same that you get by calling DescribeJob .

If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications .

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

About the Vault Inventory

Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.

Range Inventory Retrieval

You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.

Filtering by Archive Creation Date

You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate , you will retrieve the inventory for all archives created on or after the StartDate . If you only provide the EndDate without the StartDate , you will get back the inventory for all archives created before the EndDate .

Limiting Inventory Items per Retrieval

You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.

You can use the Limit parameter together with the date range parameters.

About Ranged Archive Retrieval

You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.

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 Initiate a Job and Downloading a Vault Inventory

Expedited and Bulk Archive Retrievals

When retrieving an archive, you can specify one of the following options in the Tier field of the request body:

  • Standard The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.
  • Bulk Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours.
  • Expedited Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes.

For more information about expedited and bulk retrievals, see Retrieving Amazon Glacier Archives .

See also: AWS API Documentation

Request Syntax

job = archive.initiate_archive_retrieval()
Return type
glacier.Job
Returns
Job resource

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Vault()

Creates a Vault resource.:

vault = archive.Vault()
Return type
Glacier.Vault
Returns
A Vault resource

Job

class Glacier.Job(account_id, vault_name, id)

A resource representing an Amazon Glacier Job:

import boto3

glacier = boto3.resource('glacier')
job = glacier.Job('account_id','vault_name','id')
Parameters
  • account_id (string) -- The Job's account_id identifier. This must be set.
  • vault_name (string) -- The Job's vault_name identifier. This must be set.
  • id (string) -- The Job's id identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available attributes:

These are the resource's available actions:

These are the resource's available sub-resources:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

account_id

(string) The Job's account_id identifier. This must be set.

vault_name

(string) The Job's vault_name identifier. This must be set.

id

(string) The Job's id identifier. This must be set.

Attributes

Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.

action
  • (string) --

    The job type. It is either ArchiveRetrieval or InventoryRetrieval.

archive_id
  • (string) --

    For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

archive_sha256_tree_hash
  • (string) --

    The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

archive_size_in_bytes
  • (integer) --

    For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

completed
  • (boolean) --

    The job status. When a job is completed, you get the job's output.

completion_date
  • (string) --

    The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

creation_date
  • (string) --

    The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

inventory_retrieval_parameters
  • (dict) --

    Parameters used for range inventory retrieval.

    • Format (string) --

      The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON .

    • StartDate (string) --

      The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

    • EndDate (string) --

      The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z .

    • Limit (string) --

      The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

    • Marker (string) --

      An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null . For more information, see Range Inventory Retrieval .

inventory_size_in_bytes
  • (integer) --

    For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

job_description
  • (string) --

    The job description you provided when you initiated the job.

job_id
  • (string) --

    An opaque string that identifies an Amazon Glacier job.

retrieval_byte_range
  • (string) --

    The retrieved byte range for archive retrieval jobs in the form "StartByteValue -EndByteValue " If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

sha256_tree_hash
  • (string) --

    For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

    The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

    For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

    This field is null in the following situations:

    • Archive retrieval jobs that specify a range that is not tree-hash aligned.
    • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
    • Inventory jobs.
sns_topic
  • (string) --

    An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

status_code
  • (string) --

    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

status_message
  • (string) --

    A friendly message that describes the job status.

tier
  • (string) --

    The retrieval option to use for the archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.

vault_arn
  • (string) --

    The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str
get_output(**kwargs)

This operation downloads the output of the job you initiated using InitiateJob . Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575 , you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

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 Downloading a Vault Inventory , Downloading an Archive , and Get Job Output

See also: AWS API Documentation

Request Syntax

response = job.get_output(
    range='string'
)
Parameters
range (string) --

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575 . By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  • Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
  • Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
  • Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
  • After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
Return type
dict
Returns
Response Syntax
{
    'body': StreamingBody(),
    'checksum': 'string',
    'status': 123,
    'contentRange': 'string',
    'acceptRanges': 'string',
    'contentType': 'string',
    'archiveDescription': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • body (StreamingBody) --

      The job data, either archive data or inventory data.

    • checksum (string) --

      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
    • status (integer) --

      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

    • contentRange (string) --

      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

    • acceptRanges (string) --

      Indicates the range units accepted. For more information, see RFC2616 .

    • contentType (string) --

      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

    • archiveDescription (string) --

      The description of an archive.

load()

Calls Glacier.Client.describe_job() to update the attributes of the Job resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

job.load()
Returns
None
reload()

Calls Glacier.Client.describe_job() to update the attributes of the Job resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

job.reload()
Returns
None

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Vault()

Creates a Vault resource.:

vault = job.Vault()
Return type
Glacier.Vault
Returns
A Vault resource

MultipartUpload

class Glacier.MultipartUpload(account_id, vault_name, id)

A resource representing an Amazon Glacier MultipartUpload:

import boto3

glacier = boto3.resource('glacier')
multipart_upload = glacier.MultipartUpload('account_id','vault_name','id')
Parameters
  • account_id (string) -- The MultipartUpload's account_id identifier. This must be set.
  • vault_name (string) -- The MultipartUpload's vault_name identifier. This must be set.
  • id (string) -- The MultipartUpload's id identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available attributes:

These are the resource's available actions:

These are the resource's available sub-resources:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

account_id

(string) The MultipartUpload's account_id identifier. This must be set.

vault_name

(string) The MultipartUpload's vault_name identifier. This must be set.

id

(string) The MultipartUpload's id identifier. This must be set.

Attributes

Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.

archive_description
  • (string) --

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

creation_date
  • (string) --

    The UTC time at which the multipart upload was initiated.

multipart_upload_id
  • (string) --

    The ID of a multipart upload.

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

vault_arn
  • (string) --

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

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

abort()

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload .

This operation is idempotent.

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 Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = multipart_upload.abort()
Returns
None
complete(**kwargs)

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon 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, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon 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, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon 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 = multipart_upload.complete(
    archiveSize='string',
    checksum='string'
)
Parameters
  • 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 Glacier, Amazon 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 Glacier response to your request.

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

    • location (string) --

      The relative URI path of the newly added archive resource.

    • checksum (string) --

      The checksum of the archive computed by Amazon Glacier.

    • archiveId (string) --

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

get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str
parts(**kwargs)

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload . List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts 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 parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

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 Glacier and List Parts in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = multipart_upload.parts(
    marker='string',
    limit='string'
)
Parameters
  • marker (string) -- An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
  • limit (string) -- The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.
Return type

dict

Returns

Response Syntax

{
    'MultipartUploadId': 'string',
    'VaultARN': 'string',
    'ArchiveDescription': 'string',
    'PartSizeInBytes': 123,
    'CreationDate': 'string',
    'Parts': [
        {
            'RangeInBytes': 'string',
            'SHA256TreeHash': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • MultipartUploadId (string) --

      The ID of the upload to which the parts are associated.

    • VaultARN (string) --

      The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

    • ArchiveDescription (string) --

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

    • PartSizeInBytes (integer) --

      The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

    • CreationDate (string) --

      The UTC time at which the multipart upload was initiated.

    • Parts (list) --

      A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

      • (dict) --

        A list of the part sizes of the multipart upload.

        • RangeInBytes (string) --

          The byte range of a part, inclusive of the upper value of the range.

        • SHA256TreeHash (string) --

          The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null .

    • Marker (string) --

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

upload_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 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 = multipart_upload.upload_part(
    range='string',
    body=b'bytes'|file
)
Parameters
  • 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 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 Glacier response to your request.

    • checksum (string) --

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

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Vault()

Creates a Vault resource.:

vault = multipart_upload.Vault()
Return type
Glacier.Vault
Returns
A Vault resource

Notification

class Glacier.Notification(account_id, vault_name)

A resource representing an Amazon Glacier Notification:

import boto3

glacier = boto3.resource('glacier')
notification = glacier.Notification('account_id','vault_name')
Parameters
  • account_id (string) -- The Notification's account_id identifier. This must be set.
  • vault_name (string) -- The Notification's vault_name identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available attributes:

These are the resource's available actions:

These are the resource's available sub-resources:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

account_id

(string) The Notification's account_id identifier. This must be set.

vault_name

(string) The Notification's vault_name identifier. This must be set.

Attributes

Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.

events
  • (list) --

    A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

    • (string) --
sns_topic
  • (string) --

    The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

delete()

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

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 Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.

See also: AWS API Documentation

Request Syntax

response = notification.delete()
Returns
None
get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str
load()

Calls Glacier.Client.get_vault_notifications() to update the attributes of the Notification resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

notification.load()
Returns
None
reload()

Calls Glacier.Client.get_vault_notifications() to update the attributes of the Notification resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

notification.reload()
Returns
None
set(**kwargs)

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed ( InitiateJob ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob .
  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed ( InitiateJob ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob .

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 Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = notification.set(
    vaultNotificationConfig={
        'SNSTopic': 'string',
        'Events': [
            'string',
        ]
    }
)
Parameters
vaultNotificationConfig (dict) --

Provides options for specifying notification configuration.

  • SNSTopic (string) --

    The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

  • Events (list) --

    A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

    • (string) --
Returns
None

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Vault()

Creates a Vault resource.:

vault = notification.Vault()
Return type
Glacier.Vault
Returns
A Vault resource

Vault

class Glacier.Vault(account_id, name)

A resource representing an Amazon Glacier Vault:

import boto3

glacier = boto3.resource('glacier')
vault = glacier.Vault('account_id','name')
Parameters
  • account_id (string) -- The Vault's account_id identifier. This must be set.
  • name (string) -- The Vault's name identifier. This must be set.

These are the resource's available identifiers:

These are the resource's available attributes:

These are the resource's available actions:

These are the resource's available sub-resources:

These are the resource's available collections:

Identifiers

Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

account_id

(string) The Vault's account_id identifier. This must be set.

name

(string) The Vault's name identifier. This must be set.

Attributes

Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.

creation_date
  • (string) --

    The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

last_inventory_date
  • (string) --

    The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

number_of_archives
  • (integer) --

    The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

size_in_bytes
  • (integer) --

    Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

vault_arn
  • (string) --

    The Amazon Resource Name (ARN) of the vault.

vault_name
  • (string) --

    The name of the vault.

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

create()

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.
  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = vault.create()
Return type
dict
Returns
Response Syntax
{
    'location': 'string'
}

Response Structure

  • (dict) --

    Contains the Amazon Glacier response to your request.

    • location (string) --

      The URI of the vault that was created.

delete()

This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive) .

This operation is idempotent.

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 Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide .

See also: AWS API Documentation

Request Syntax

response = vault.delete()
Returns
None
get_available_subresources()

Returns a list of all the available sub-resources for this Resource.

Returns
A list containing the name of each sub-resource for this resource
Return type
list of str
initiate_inventory_retrieval()

This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).

Retrieving data from Amazon Glacier is a two-step process:

  • Initiate a retrieval job.

Note

A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies . For more information about the PolicyEnforcedException exception, see Error Responses .

  • After the job completes, download the bytes.

The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.

The job must complete before you can get its output. To determine when a job is complete, you have the following options:

  • Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications .
  • Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.

Note

The information you get via notification is same that you get by calling DescribeJob .

If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications .

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

About the Vault Inventory

Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.

Range Inventory Retrieval

You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.

Filtering by Archive Creation Date

You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate , you will retrieve the inventory for all archives created on or after the StartDate . If you only provide the EndDate without the StartDate , you will get back the inventory for all archives created before the EndDate .

Limiting Inventory Items per Retrieval

You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.

You can use the Limit parameter together with the date range parameters.

About Ranged Archive Retrieval

You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.

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 Initiate a Job and Downloading a Vault Inventory

Expedited and Bulk Archive Retrievals

When retrieving an archive, you can specify one of the following options in the Tier field of the request body:

  • Standard The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.
  • Bulk Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours.
  • Expedited Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes.

For more information about expedited and bulk retrievals, see Retrieving Amazon Glacier Archives .

See also: AWS API Documentation

Request Syntax

job = vault.initiate_inventory_retrieval()
Return type
glacier.Job
Returns
Job resource
initiate_multipart_upload(**kwargs)

This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart ).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart ), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

Note

You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

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

See also: AWS API Documentation

Request Syntax

multipart_upload = vault.initiate_multipart_upload(
    archiveDescription='string',
    partSize='string'
)
Parameters
  • archiveDescription (string) --

    The archive description that you are uploading in parts.

    The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

  • partSize (string) -- The size of each part except the last, in bytes. The last part can be smaller than this part size.
Return type

glacier.MultipartUpload

Returns

MultipartUpload resource

load()

Calls Glacier.Client.describe_vault() to update the attributes of the Vault resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

vault.load()
Returns
None
reload()

Calls Glacier.Client.describe_vault() to update the attributes of the Vault resource. Note that the load and reload methods are the same method and can be used interchangeably.

See also: AWS API Documentation

Request Syntax

vault.reload()
Returns
None
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 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 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

archive = vault.upload_archive(
    archiveDescription='string',
    body=b'bytes'|file
)
Parameters
  • 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

glacier.Archive

Returns

Archive resource

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

Account()

Creates a Account resource.:

account = vault.Account()
Return type
Glacier.Account
Returns
A Account resource
Archive(id)

Creates a Archive resource.:

archive = vault.Archive('id')
Parameters
id (string) -- The Archive's id identifier. This must be set.
Return type
Glacier.Archive
Returns
A Archive resource
Job(id)

Creates a Job resource.:

job = vault.Job('id')
Parameters
id (string) -- The Job's id identifier. This must be set.
Return type
Glacier.Job
Returns
A Job resource
MultipartUpload(id)

Creates a MultipartUpload resource.:

multipart_upload = vault.MultipartUpload('id')
Parameters
id (string) -- The MultipartUpload's id identifier. This must be set.
Return type
Glacier.MultipartUpload
Returns
A MultipartUpload resource
Notification()

Creates a Notification resource.:

notification = vault.Notification()
Return type
Glacier.Notification
Returns
A Notification resource

Collections

Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.

completed_jobs

A collection of Job resources

all()

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.completed_jobs.all()
Return type
list(glacier.Job)
Returns
A list of Job resources
filter(**kwargs)

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.completed_jobs.filter(
    limit='string',
    marker='string',
    statuscode='string',

)
Parameters
  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • statuscode (string) -- The type of job status to return. You can specify the following values: InProgress , Succeeded , or Failed .
Return type

list(glacier.Job)

Returns

A list of Job resources

limit(**kwargs)

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.completed_jobs.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Job)
Returns
A list of Job resources
page_size(**kwargs)

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.completed_jobs.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Job)
Returns
A list of Job resources
failed_jobs

A collection of Job resources

all()

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.failed_jobs.all()
Return type
list(glacier.Job)
Returns
A list of Job resources
filter(**kwargs)

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.failed_jobs.filter(
    limit='string',
    marker='string',
    completed='string'
)
Parameters
  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • completed (string) -- The state of the jobs to return. You can specify true or false .
Return type

list(glacier.Job)

Returns

A list of Job resources

limit(**kwargs)

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.failed_jobs.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Job)
Returns
A list of Job resources
page_size(**kwargs)

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.failed_jobs.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Job)
Returns
A list of Job resources
jobs

A collection of Job resources

all()

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs.all()
Return type
list(glacier.Job)
Returns
A list of Job resources
filter(**kwargs)

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs.filter(
    limit='string',
    marker='string',
    statuscode='string',
    completed='string'
)
Parameters
  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • statuscode (string) -- The type of job status to return. You can specify the following values: InProgress , Succeeded , or Failed .
  • completed (string) -- The state of the jobs to return. You can specify true or false .
Return type

list(glacier.Job)

Returns

A list of Job resources

limit(**kwargs)

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Job)
Returns
A list of Job resources
page_size(**kwargs)

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Job)
Returns
A list of Job resources
jobs_in_progress

A collection of Job resources

all()

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs_in_progress.all()
Return type
list(glacier.Job)
Returns
A list of Job resources
filter(**kwargs)

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs_in_progress.filter(
    limit='string',
    marker='string',
    completed='string'
)
Parameters
  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • completed (string) -- The state of the jobs to return. You can specify true or false .
Return type

list(glacier.Job)

Returns

A list of Job resources

limit(**kwargs)

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs_in_progress.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Job)
Returns
A list of Job resources
page_size(**kwargs)

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.jobs_in_progress.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Job)
Returns
A list of Job resources
multipart_uplaods

A collection of MultipartUpload resources

all()

Creates an iterable of all MultipartUpload resources in the collection.

See also: AWS API Documentation

Request Syntax

multipart_upload_iterator = vault.multipart_uplaods.all()
Return type
list(glacier.MultipartUpload)
Returns
A list of MultipartUpload resources
filter(**kwargs)

Creates an iterable of all MultipartUpload resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

multipart_upload_iterator = vault.multipart_uplaods.filter(
    marker='string',
    limit='string'
)
Parameters
  • 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 1,000 uploads.
Return type

list(glacier.MultipartUpload)

Returns

A list of MultipartUpload resources

limit(**kwargs)

Creates an iterable up to a specified amount of MultipartUpload resources in the collection.

See also: AWS API Documentation

Request Syntax

multipart_upload_iterator = vault.multipart_uplaods.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.MultipartUpload)
Returns
A list of MultipartUpload resources
page_size(**kwargs)

Creates an iterable of all MultipartUpload resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

multipart_upload_iterator = vault.multipart_uplaods.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.MultipartUpload)
Returns
A list of MultipartUpload resources
succeeded_jobs

A collection of Job resources

all()

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.all()
Return type
list(glacier.Job)
Returns
A list of Job resources
filter(**kwargs)

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.filter(
    limit='string',
    marker='string',
    completed='string'
)
Parameters
  • limit (string) -- The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
  • marker (string) -- An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
  • completed (string) -- The state of the jobs to return. You can specify true or false .
Return type

list(glacier.Job)

Returns

A list of Job resources

limit(**kwargs)

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.limit(
    count=123
)
Parameters
count (integer) -- The limit to the number of resources in the iterable.
Return type
list(glacier.Job)
Returns
A list of Job resources
page_size(**kwargs)

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.page_size(
    count=123
)
Parameters
count (integer) -- The number of items returned by each service call
Return type
list(glacier.Job)
Returns
A list of Job resources