AbortMultipartUpload

$result = $client->abortMultipartUpload([/* ... */]);
$promise = $client->abortMultipartUploadAsync([/* ... */]);

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

Parameter Syntax

$result = $client->abortMultipartUpload([
    'accountId' => '<string>',
    'uploadId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To abort a multipart upload identified by the upload ID

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

$result = $client->abortMultipartUpload([
    'accountId' => '-',
    'uploadId' => '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'vaultName' => 'my-vault',
]);

AbortVaultLock

$result = $client->abortVaultLock([/* ... */]);
$promise = $client->abortVaultLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->abortVaultLock([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To abort a vault lock

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

$result = $client->abortVaultLock([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

AddTagsToVault

$result = $client->addTagsToVault([/* ... */]);
$promise = $client->addTagsToVaultAsync([/* ... */]);

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 S3 Glacier Resources.

Parameter Syntax

$result = $client->addTagsToVault([
    'Tags' => ['<string>', ...],
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

LimitExceededException:

Returned if the request results in a vault or account limit being exceeded.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To add tags to a vault

The example adds two tags to a my-vault.

$result = $client->addTagsToVault([
    'Tags' => [
        'examplekey1' => 'examplevalue1',
        'examplekey2' => 'examplevalue2',
    ],
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

CompleteMultipartUpload

$result = $client->completeMultipartUpload([/* ... */]);
$promise = $client->completeMultipartUploadAsync([/* ... */]);

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

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

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

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

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.

Parameter Syntax

$result = $client->completeMultipartUpload([
    'accountId' => '<string>',
    'archiveSize' => '<string>',
    'checksum' => '<string>',
    'uploadId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'archiveId' => '<string>',
    'checksum' => '<string>',
    'location' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To complete a multipart upload

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

$result = $client->completeMultipartUpload([
    'accountId' => '-',
    'archiveSize' => '3145728',
    'checksum' => '9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67',
    'uploadId' => '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'archiveId' => 'NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
    'checksum' => '9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67',
    'location' => '/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
]

CompleteVaultLock

$result = $client->completeVaultLock([/* ... */]);
$promise = $client->completeVaultLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->completeVaultLock([
    'accountId' => '<string>',
    'lockId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To complete a vault lock

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

$result = $client->completeVaultLock([
    'accountId' => '-',
    'lockId' => 'AE863rKkWZU53SLW5be4DUcW',
    'vaultName' => 'example-vault',
]);

CreateVault

$result = $client->createVault([/* ... */]);
$promise = $client->createVaultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createVault([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'location' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

LimitExceededException:

Returned if the request results in a vault or account limit being exceeded.

Examples

Example 1: To create a new vault

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

$result = $client->createVault([
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'location' => '/111122223333/vaults/my-vault',
]

DeleteArchive

$result = $client->deleteArchive([/* ... */]);
$promise = $client->deleteArchiveAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteArchive([
    'accountId' => '<string>',
    'archiveId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To delete an archive

The example deletes the archive specified by the archive ID.

$result = $client->deleteArchive([
    'accountId' => '-',
    'archiveId' => 'NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId',
    'vaultName' => 'examplevault',
]);

DeleteVault

$result = $client->deleteVault([/* ... */]);
$promise = $client->deleteVaultAsync([/* ... */]);

This operation deletes a vault. Amazon S3 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 S3 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 S3 Glacier Developer Guide.

Parameter Syntax

$result = $client->deleteVault([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To delete a vault

The example deletes a vault named my-vault:

$result = $client->deleteVault([
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

DeleteVaultAccessPolicy

$result = $client->deleteVaultAccessPolicy([/* ... */]);
$promise = $client->deleteVaultAccessPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteVaultAccessPolicy([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To delete the vault access policy

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

$result = $client->deleteVaultAccessPolicy([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

DeleteVaultNotifications

$result = $client->deleteVaultNotifications([/* ... */]);
$promise = $client->deleteVaultNotificationsAsync([/* ... */]);

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 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 S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide.

Parameter Syntax

$result = $client->deleteVaultNotifications([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To delete the notification configuration set for a vault

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

$result = $client->deleteVaultNotifications([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

DescribeJob

$result = $client->describeJob([/* ... */]);
$promise = $client->describeJobAsync([/* ... */]);

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 S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.

A job ID will not expire for at least 24 hours after 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 more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.

Parameter Syntax

$result = $client->describeJob([
    'accountId' => '<string>',
    'jobId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Action' => 'ArchiveRetrieval|InventoryRetrieval|Select',
    'ArchiveId' => '<string>',
    'ArchiveSHA256TreeHash' => '<string>',
    'ArchiveSizeInBytes' => <integer>,
    'Completed' => true || false,
    'CompletionDate' => '<string>',
    'CreationDate' => '<string>',
    'InventoryRetrievalParameters' => [
        'EndDate' => '<string>',
        'Format' => '<string>',
        'Limit' => '<string>',
        'Marker' => '<string>',
        'StartDate' => '<string>',
    ],
    'InventorySizeInBytes' => <integer>,
    'JobDescription' => '<string>',
    'JobId' => '<string>',
    'JobOutputPath' => '<string>',
    'OutputLocation' => [
        'S3' => [
            'AccessControlList' => [
                [
                    'Grantee' => [
                        'DisplayName' => '<string>',
                        'EmailAddress' => '<string>',
                        'ID' => '<string>',
                        'Type' => 'AmazonCustomerByEmail|CanonicalUser|Group',
                        'URI' => '<string>',
                    ],
                    'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
                ],
                // ...
            ],
            'BucketName' => '<string>',
            'CannedACL' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
            'Encryption' => [
                'EncryptionType' => 'aws:kms|AES256',
                'KMSContext' => '<string>',
                'KMSKeyId' => '<string>',
            ],
            'Prefix' => '<string>',
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA',
            'Tagging' => ['<string>', ...],
            'UserMetadata' => ['<string>', ...],
        ],
    ],
    'RetrievalByteRange' => '<string>',
    'SHA256TreeHash' => '<string>',
    'SNSTopic' => '<string>',
    'SelectParameters' => [
        'Expression' => '<string>',
        'ExpressionType' => 'SQL',
        'InputSerialization' => [
            'csv' => [
                'Comments' => '<string>',
                'FieldDelimiter' => '<string>',
                'FileHeaderInfo' => 'USE|IGNORE|NONE',
                'QuoteCharacter' => '<string>',
                'QuoteEscapeCharacter' => '<string>',
                'RecordDelimiter' => '<string>',
            ],
        ],
        'OutputSerialization' => [
            'csv' => [
                'FieldDelimiter' => '<string>',
                'QuoteCharacter' => '<string>',
                'QuoteEscapeCharacter' => '<string>',
                'QuoteFields' => 'ALWAYS|ASNEEDED',
                'RecordDelimiter' => '<string>',
            ],
        ],
    ],
    'StatusCode' => 'InProgress|Succeeded|Failed',
    'StatusMessage' => '<string>',
    'Tier' => '<string>',
    'VaultARN' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To get information about a previously initiated job

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

$result = $client->describeJob([
    'accountId' => '-',
    'jobId' => 'zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'Action' => 'InventoryRetrieval',
    'Completed' => ,
    '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',
]

DescribeVault

$result = $client->describeVault([/* ... */]);
$promise = $client->describeVaultAsync([/* ... */]);

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 S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 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 S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide.

Parameter Syntax

$result = $client->describeVault([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationDate' => '<string>',
    'LastInventoryDate' => '<string>',
    'NumberOfArchives' => <integer>,
    'SizeInBytes' => <integer>,
    'VaultARN' => '<string>',
    'VaultName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To retrieve information about a vault

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

$result = $client->describeVault([
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    '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',
]

GetDataRetrievalPolicy

$result = $client->getDataRetrievalPolicy([/* ... */]);
$promise = $client->getDataRetrievalPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDataRetrievalPolicy([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Policy' => [
        'Rules' => [
            [
                'BytesPerHour' => <integer>,
                'Strategy' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To get the current data retrieval policy for an account

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

$result = $client->getDataRetrievalPolicy([
    'accountId' => '-',
]);

Result syntax:

[
    'Policy' => [
        'Rules' => [
            [
                'BytesPerHour' => 10737418240,
                'Strategy' => 'BytesPerHour',
            ],
        ],
    ],
]

GetJobOutput

$result = $client->getJobOutput([/* ... */]);
$promise = $client->getJobOutputAsync([/* ... */]);

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 S3 Glacier (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 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 S3 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, 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 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

Parameter Syntax

$result = $client->getJobOutput([
    'accountId' => '<string>',
    'jobId' => '<string>', // REQUIRED
    'range' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acceptRanges' => '<string>',
    'archiveDescription' => '<string>',
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'checksum' => '<string>',
    'contentRange' => '<string>',
    'contentType' => '<string>',
    'status' => <integer>,
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To get the output of a previously initiated job

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

$result = $client->getJobOutput([
    'accountId' => '-',
    'jobId' => 'zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW',
    'range' => '',
    'vaultName' => 'my-vaul',
]);

Result syntax:

[
    'acceptRanges' => 'bytes',
    'body' => <BLOB>,
    'contentType' => 'application/json',
    'status' => 200,
]

GetVaultAccessPolicy

$result = $client->getVaultAccessPolicy([/* ... */]);
$promise = $client->getVaultAccessPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getVaultAccessPolicy([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'Policy' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To get the access-policy set on the vault

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

$result = $client->getVaultAccessPolicy([
    'accountId' => '-',
    'vaultName' => 'example-vault',
]);

Result syntax:

[
    '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"}]}',
    ],
]

GetVaultLock

$result = $client->getVaultLock([/* ... */]);
$promise = $client->getVaultLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getVaultLock([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationDate' => '<string>',
    'ExpirationDate' => '<string>',
    'Policy' => '<string>',
    'State' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To retrieve vault lock-policy related attributes that are set on a vault

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

$result = $client->getVaultLock([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

Result syntax:

[
    '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',
]

GetVaultNotifications

$result = $client->getVaultNotifications([/* ... */]);
$promise = $client->getVaultNotificationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getVaultNotifications([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'vaultNotificationConfig' => [
        'Events' => ['<string>', ...],
        'SNSTopic' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To get the notification-configuration for the specified vault

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

$result = $client->getVaultNotifications([
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'vaultNotificationConfig' => [
        'Events' => [
            'InventoryRetrievalCompleted',
            'ArchiveRetrievalCompleted',
        ],
        'SNSTopic' => 'arn:aws:sns:us-west-2:0123456789012:my-vault',
    ],
]

InitiateJob

$result = $client->initiateJob([/* ... */]);
$promise = $client->initiateJobAsync([/* ... */]);

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

Parameter Syntax

$result = $client->initiateJob([
    'accountId' => '<string>',
    'jobParameters' => [
        'ArchiveId' => '<string>',
        'Description' => '<string>',
        'Format' => '<string>',
        'InventoryRetrievalParameters' => [
            'EndDate' => '<string>',
            'Limit' => '<string>',
            'Marker' => '<string>',
            'StartDate' => '<string>',
        ],
        'OutputLocation' => [
            'S3' => [
                'AccessControlList' => [
                    [
                        'Grantee' => [
                            'DisplayName' => '<string>',
                            'EmailAddress' => '<string>',
                            'ID' => '<string>',
                            'Type' => 'AmazonCustomerByEmail|CanonicalUser|Group', // REQUIRED
                            'URI' => '<string>',
                        ],
                        'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
                    ],
                    // ...
                ],
                'BucketName' => '<string>',
                'CannedACL' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
                'Encryption' => [
                    'EncryptionType' => 'aws:kms|AES256',
                    'KMSContext' => '<string>',
                    'KMSKeyId' => '<string>',
                ],
                'Prefix' => '<string>',
                'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA',
                'Tagging' => ['<string>', ...],
                'UserMetadata' => ['<string>', ...],
            ],
        ],
        'RetrievalByteRange' => '<string>',
        'SNSTopic' => '<string>',
        'SelectParameters' => [
            'Expression' => '<string>',
            'ExpressionType' => 'SQL',
            'InputSerialization' => [
                'csv' => [
                    'Comments' => '<string>',
                    'FieldDelimiter' => '<string>',
                    'FileHeaderInfo' => 'USE|IGNORE|NONE',
                    'QuoteCharacter' => '<string>',
                    'QuoteEscapeCharacter' => '<string>',
                    'RecordDelimiter' => '<string>',
                ],
            ],
            'OutputSerialization' => [
                'csv' => [
                    'FieldDelimiter' => '<string>',
                    'QuoteCharacter' => '<string>',
                    'QuoteEscapeCharacter' => '<string>',
                    'QuoteFields' => 'ALWAYS|ASNEEDED',
                    'RecordDelimiter' => '<string>',
                ],
            ],
        ],
        'Tier' => '<string>',
        'Type' => '<string>',
    ],
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'jobOutputPath' => '<string>',
    'location' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

PolicyEnforcedException:

Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

InsufficientCapacityException:

Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To initiate an inventory-retrieval job

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

$result = $client->initiateJob([
    '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',
]);

Result syntax:

[
    'jobId' => ' HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID',
    'location' => '/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID',
]

InitiateMultipartUpload

$result = $client->initiateMultipartUpload([/* ... */]);
$promise = $client->initiateMultipartUploadAsync([/* ... */]);

This operation initiates a multipart upload. Amazon S3 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.

After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. 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.

Parameter Syntax

$result = $client->initiateMultipartUpload([
    'accountId' => '<string>',
    'archiveDescription' => '<string>',
    'partSize' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'location' => '<string>',
    'uploadId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To initiate a multipart upload

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.

$result = $client->initiateMultipartUpload([
    'accountId' => '-',
    'partSize' => '1048576',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'location' => '/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'uploadId' => '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
]

InitiateVaultLock

$result = $client->initiateVaultLock([/* ... */]);
$promise = $client->initiateVaultLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->initiateVaultLock([
    'accountId' => '<string>',
    'policy' => [
        'Policy' => '<string>',
    ],
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lockId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To initiate the vault locking process

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

$result = $client->initiateVaultLock([
    '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',
]);

Result syntax:

[
    'lockId' => 'AE863rKkWZU53SLW5be4DUcW',
]

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. 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 50. 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 more information about using this operation, see the documentation for the underlying REST API List Jobs.

Parameter Syntax

$result = $client->listJobs([
    'accountId' => '<string>',
    'completed' => '<string>',
    'limit' => '<string>',
    'marker' => '<string>',
    'statuscode' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'JobList' => [
        [
            'Action' => 'ArchiveRetrieval|InventoryRetrieval|Select',
            'ArchiveId' => '<string>',
            'ArchiveSHA256TreeHash' => '<string>',
            'ArchiveSizeInBytes' => <integer>,
            'Completed' => true || false,
            'CompletionDate' => '<string>',
            'CreationDate' => '<string>',
            'InventoryRetrievalParameters' => [
                'EndDate' => '<string>',
                'Format' => '<string>',
                'Limit' => '<string>',
                'Marker' => '<string>',
                'StartDate' => '<string>',
            ],
            'InventorySizeInBytes' => <integer>,
            'JobDescription' => '<string>',
            'JobId' => '<string>',
            'JobOutputPath' => '<string>',
            'OutputLocation' => [
                'S3' => [
                    'AccessControlList' => [
                        [
                            'Grantee' => [
                                'DisplayName' => '<string>',
                                'EmailAddress' => '<string>',
                                'ID' => '<string>',
                                'Type' => 'AmazonCustomerByEmail|CanonicalUser|Group',
                                'URI' => '<string>',
                            ],
                            'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
                        ],
                        // ...
                    ],
                    'BucketName' => '<string>',
                    'CannedACL' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
                    'Encryption' => [
                        'EncryptionType' => 'aws:kms|AES256',
                        'KMSContext' => '<string>',
                        'KMSKeyId' => '<string>',
                    ],
                    'Prefix' => '<string>',
                    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA',
                    'Tagging' => ['<string>', ...],
                    'UserMetadata' => ['<string>', ...],
                ],
            ],
            'RetrievalByteRange' => '<string>',
            'SHA256TreeHash' => '<string>',
            'SNSTopic' => '<string>',
            'SelectParameters' => [
                'Expression' => '<string>',
                'ExpressionType' => 'SQL',
                'InputSerialization' => [
                    'csv' => [
                        'Comments' => '<string>',
                        'FieldDelimiter' => '<string>',
                        'FileHeaderInfo' => 'USE|IGNORE|NONE',
                        'QuoteCharacter' => '<string>',
                        'QuoteEscapeCharacter' => '<string>',
                        'RecordDelimiter' => '<string>',
                    ],
                ],
                'OutputSerialization' => [
                    'csv' => [
                        'FieldDelimiter' => '<string>',
                        'QuoteCharacter' => '<string>',
                        'QuoteEscapeCharacter' => '<string>',
                        'QuoteFields' => 'ALWAYS|ASNEEDED',
                        'RecordDelimiter' => '<string>',
                    ],
                ],
            ],
            'StatusCode' => 'InProgress|Succeeded|Failed',
            'StatusMessage' => '<string>',
            'Tier' => '<string>',
            'VaultARN' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list jobs for a vault

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

$result = $client->listJobs([
    'accountId' => '-',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'JobList' => [
        [
            'Action' => 'ArchiveRetrieval',
            'ArchiveId' => 'kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
            'ArchiveSHA256TreeHash' => '9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67',
            'ArchiveSizeInBytes' => 3145728,
            'Completed' => ,
            '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' => ,
            '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',
        ],
    ],
]

ListMultipartUploads

$result = $client->listMultipartUploads([/* ... */]);
$promise = $client->listMultipartUploadsAsync([/* ... */]);

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

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

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

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

Parameter Syntax

$result = $client->listMultipartUploads([
    'accountId' => '<string>',
    'limit' => '<string>',
    'marker' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'UploadsList' => [
        [
            'ArchiveDescription' => '<string>',
            'CreationDate' => '<string>',
            'MultipartUploadId' => '<string>',
            'PartSizeInBytes' => <integer>,
            'VaultARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list all the in-progress multipart uploads for a vault

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

$result = $client->listMultipartUploads([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

Result syntax:

[
    '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',
        ],
    ],
]

ListParts

$result = $client->listParts([/* ... */]);
$promise = $client->listPartsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listParts([
    'accountId' => '<string>',
    'limit' => '<string>',
    'marker' => '<string>',
    'uploadId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ArchiveDescription' => '<string>',
    'CreationDate' => '<string>',
    'Marker' => '<string>',
    'MultipartUploadId' => '<string>',
    'PartSizeInBytes' => <integer>,
    'Parts' => [
        [
            'RangeInBytes' => '<string>',
            'SHA256TreeHash' => '<string>',
        ],
        // ...
    ],
    'VaultARN' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list the parts of an archive that have been uploaded in a multipart upload

The example lists all the parts of a multipart upload.

$result = $client->listParts([
    'accountId' => '-',
    'uploadId' => 'OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE',
    'vaultName' => 'examplevault',
]);

Result syntax:

[
    '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',
]

ListProvisionedCapacity

$result = $client->listProvisionedCapacity([/* ... */]);
$promise = $client->listProvisionedCapacityAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProvisionedCapacity([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ProvisionedCapacityList' => [
        [
            'CapacityId' => '<string>',
            'ExpirationDate' => '<string>',
            'StartDate' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list the provisioned capacity units for an account

The example lists the provisioned capacity units for an account.

$result = $client->listProvisionedCapacity([
    'accountId' => '-',
]);

Result syntax:

[
    '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',
        ],
    ],
]

ListTagsForVault

$result = $client->listTagsForVault([/* ... */]);
$promise = $client->listTagsForVaultAsync([/* ... */]);

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 S3 Glacier Resources.

Parameter Syntax

$result = $client->listTagsForVault([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list the tags for a vault

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

$result = $client->listTagsForVault([
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

Result syntax:

[
    'Tags' => [
        'date' => 'july2015',
        'id' => '1234',
    ],
]

ListVaults

$result = $client->listVaults([/* ... */]);
$promise = $client->listVaultsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listVaults([
    'accountId' => '<string>',
    'limit' => '<string>',
    'marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'VaultList' => [
        [
            'CreationDate' => '<string>',
            'LastInventoryDate' => '<string>',
            'NumberOfArchives' => <integer>,
            'SizeInBytes' => <integer>,
            'VaultARN' => '<string>',
            'VaultName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To list all vaults owned by the calling user's account

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

$result = $client->listVaults([
    'accountId' => '-',
    'limit' => '',
    'marker' => '',
]);

Result syntax:

[
    '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',
        ],
    ],
]

PurchaseProvisionedCapacity

$result = $client->purchaseProvisionedCapacity([/* ... */]);
$promise = $client->purchaseProvisionedCapacityAsync([/* ... */]);

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

Parameter Syntax

$result = $client->purchaseProvisionedCapacity([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'capacityId' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

LimitExceededException:

Returned if the request results in a vault or account limit being exceeded.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To purchases a provisioned capacity unit for an AWS account

The example purchases provisioned capacity unit for an AWS account.

$result = $client->purchaseProvisionedCapacity([
    'accountId' => '-',
]);

Result syntax:

[
    'capacityId' => 'zSaq7NzHFQDANTfQkDen4V7z',
]

RemoveTagsFromVault

$result = $client->removeTagsFromVault([/* ... */]);
$promise = $client->removeTagsFromVaultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->removeTagsFromVault([
    'TagKeys' => ['<string>', ...],
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To remove tags from a vault

The example removes two tags from the vault named examplevault.

$result = $client->removeTagsFromVault([
    'TagKeys' => [
        'examplekey1',
        'examplekey2',
    ],
    'accountId' => '-',
    'vaultName' => 'examplevault',
]);

SetDataRetrievalPolicy

$result = $client->setDataRetrievalPolicy([/* ... */]);
$promise = $client->setDataRetrievalPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setDataRetrievalPolicy([
    'Policy' => [
        'Rules' => [
            [
                'BytesPerHour' => <integer>,
                'Strategy' => '<string>',
            ],
            // ...
        ],
    ],
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To set and then enact a data retrieval policy

The example sets and then enacts a data retrieval policy.

$result = $client->setDataRetrievalPolicy([
    'Policy' => [
        'Rules' => [
            [
                'BytesPerHour' => 10737418240,
                'Strategy' => 'BytesPerHour',
            ],
        ],
    ],
    'accountId' => '-',
]);

SetVaultAccessPolicy

$result = $client->setVaultAccessPolicy([/* ... */]);
$promise = $client->setVaultAccessPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setVaultAccessPolicy([
    'accountId' => '<string>',
    'policy' => [
        'Policy' => '<string>',
    ],
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To set the access-policy on a vault

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

$result = $client->setVaultAccessPolicy([
    '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',
]);

SetVaultNotifications

$result = $client->setVaultNotifications([/* ... */]);
$promise = $client->setVaultNotificationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->setVaultNotifications([
    'accountId' => '<string>',
    'vaultName' => '<string>', // REQUIRED
    'vaultNotificationConfig' => [
        'Events' => ['<string>', ...],
        'SNSTopic' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To configure a vault to post a message to an Amazon SNS topic when jobs complete

The example sets the examplevault notification configuration.

$result = $client->setVaultNotifications([
    'accountId' => '-',
    'vaultName' => 'examplevault',
    'vaultNotificationConfig' => [
        'Events' => [
            'ArchiveRetrievalCompleted',
            'InventoryRetrievalCompleted',
        ],
        'SNSTopic' => 'arn:aws:sns:us-west-2:012345678901:mytopic',
    ],
]);

UploadArchive

$result = $client->uploadArchive([/* ... */]);
$promise = $client->uploadArchiveAsync([/* ... */]);

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

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

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

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

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

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.

Parameter Syntax

$result = $client->uploadArchive([
    'accountId' => '<string>',
    'archiveDescription' => '<string>',
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'checksum' => '<string>',
    'contentSHA256' => '<string>',
    'sourceFile' => '<string>',
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'archiveId' => '<string>',
    'checksum' => '<string>',
    'location' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

RequestTimeoutException:

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To upload an archive

The example adds an archive to a vault.

$result = $client->uploadArchive([
    'accountId' => '-',
    'archiveDescription' => '',
    'body' => <BLOB>,
    'checksum' => '',
    'vaultName' => 'my-vault',
]);

Result syntax:

[
    'archiveId' => 'kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
    'checksum' => '969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67',
    'location' => '/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw',
]

UploadMultipartPart

$result = $client->uploadMultipartPart([/* ... */]);
$promise = $client->uploadMultipartPartAsync([/* ... */]);

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 matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.

• Part size does not matchThe 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.

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

Parameter Syntax

$result = $client->uploadMultipartPart([
    'accountId' => '<string>',
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'checksum' => '<string>',
    'contentSHA256' => '<string>',
    'range' => '<string>',
    'sourceFile' => '<string>',
    'uploadId' => '<string>', // REQUIRED
    'vaultName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'checksum' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

InvalidParameterValueException:

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException:

Returned if a required header or parameter is missing from the request.

RequestTimeoutException:

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.

ServiceUnavailableException:

Returned if the service cannot complete the request.

Examples

Example 1: To upload the first part of an archive

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

$result = $client->uploadMultipartPart([
    'accountId' => '-',
    'body' => <BLOB>,
    'checksum' => 'c06f7cd4baacb087002a99a5f48bf953',
    'range' => 'bytes 0-1048575/*',
    'uploadId' => '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
    'vaultName' => 'examplevault',
]);

Result syntax:

[
    'checksum' => 'c06f7cd4baacb087002a99a5f48bf953',
]