NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class GlacierClient

Client to interact with Amazon Glacier

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\Glacier\GlacierClient

Namespace: Aws\Glacier
Link: User guide
Link: API docs
Located at Aws/Glacier/GlacierClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new Amazon Glacier client using an array of configuration options.

- `public` `abortMultipartUpload ( array $args = array() )`

  Executes the AbortMultipartUpload operation.

- `public` `abortVaultLock ( array $args = array() )`

  Executes the AbortVaultLock operation.

- `public` `addTagsToVault ( array $args = array() )`

  Executes the AddTagsToVault operation.

- `public` `completeMultipartUpload ( array $args = array() )`

  Executes the CompleteMultipartUpload operation.

- `public` `completeVaultLock ( array $args = array() )`

  Executes the CompleteVaultLock operation.

- `public` `createVault ( array $args = array() )`

  Executes the CreateVault operation.

- `public` `deleteArchive ( array $args = array() )`

  Executes the DeleteArchive operation.

- `public` `deleteVault ( array $args = array() )`

  Executes the DeleteVault operation.

- `public` `deleteVaultAccessPolicy ( array $args = array() )`

  Executes the DeleteVaultAccessPolicy operation.

- `public` `deleteVaultNotifications ( array $args = array() )`

  Executes the DeleteVaultNotifications operation.

- `public` `describeJob ( array $args = array() )`

  Executes the DescribeJob operation.

- `public` `describeVault ( array $args = array() )`

  Executes the DescribeVault operation.

- `public` `getDataRetrievalPolicy ( array $args = array() )`

  Executes the GetDataRetrievalPolicy operation.

- `public` `getJobOutput ( array $args = array() )`

  Executes the GetJobOutput operation.

- `public` `getVaultAccessPolicy ( array $args = array() )`

  Executes the GetVaultAccessPolicy operation.

- `public` `getVaultLock ( array $args = array() )`

  Executes the GetVaultLock operation.

- `public` `getVaultNotifications ( array $args = array() )`

  Executes the GetVaultNotifications operation.

- `public` `initiateJob ( array $args = array() )`

  Executes the InitiateJob operation.

- `public` `initiateMultipartUpload ( array $args = array() )`

  Executes the InitiateMultipartUpload operation.

- `public` `initiateVaultLock ( array $args = array() )`

  Executes the InitiateVaultLock operation.

- `public` `listJobs ( array $args = array() )`

  Executes the ListJobs operation.

- `public` `listMultipartUploads ( array $args = array() )`

  Executes the ListMultipartUploads operation.

- `public` `listParts ( array $args = array() )`

  Executes the ListParts operation.

- `public` `listTagsForVault ( array $args = array() )`

  Executes the ListTagsForVault operation.

- `public` `listVaults ( array $args = array() )`

  Executes the ListVaults operation.

- `public` `removeTagsFromVault ( array $args = array() )`

  Executes the RemoveTagsFromVault operation.

- `public` `setDataRetrievalPolicy ( array $args = array() )`

  Executes the SetDataRetrievalPolicy operation.

- `public` `setVaultAccessPolicy ( array $args = array() )`

  Executes the SetVaultAccessPolicy operation.

- `public` `setVaultNotifications ( array $args = array() )`

  Executes the SetVaultNotifications operation.

- `public` `uploadArchive ( array $args = array() )`

  Executes the UploadArchive operation.

- `public` `uploadMultipartPart ( array $args = array() )`

  Executes the UploadMultipartPart operation.

- `public` `waitUntilVaultExists ( array $input )`

  Wait until a vault can be accessed. The input array uses the parameters of the DescribeVault operation and waiter specific settings

- `public` `waitUntilVaultNotExists ( array $input )`

  Wait until a vault is deleted. The input array uses the parameters of the DescribeVault operation and waiter specific settings

- `public` `getListJobsIterator ( array $args = array() )`

  The input array uses the parameters of the ListJobs operation

- `public` `getListMultipartUploadsIterator ( array $args = array() )`

  The input array uses the parameters of the ListMultipartUploads operation

- `public` `getListPartsIterator ( array $args = array() )`

  The input array uses the parameters of the ListParts operation

- `public` `getListVaultsIterator ( array $args = array() )`

  The input array uses the parameters of the ListVaults operation

## Methods detail

# `public static `Aws\Glacier\GlacierClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new Amazon Glacier client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\Glacier\GlacierClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`abortMultipartUpload( array $args = array() )`

Executes the AbortMultipartUpload operation.

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

#### Examples

- Basic formatting example

      $result = $client->abortMultipartUpload(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // uploadId is required
          'uploadId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - uploadId => (string)

    The upload ID of the multipart upload to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`abortVaultLock( array $args = array() )`

Executes the AbortVaultLock operation.

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.

#### Examples

- Basic formatting example

      $result = $client->abortVaultLock(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`addTagsToVault( array $args = array() )`

Executes the AddTagsToVault operation.

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.

#### Examples

- Basic formatting example

      $result = $client->addTagsToVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'Tags' => array(
              // Associative array of custom 'TagKey' key names
              'TagKey' => 'string',
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - Tags => (associative-array<string>)

    Associative array of <TagKey> keys mapping to (string) values. Each array key should be changed to an appropriate <TagKey>.

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

    - <TagKey> => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`completeMultipartUpload( array $args = array() )`

Executes the CompleteMultipartUpload operation.

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

#### Examples

- Basic formatting example

      $result = $client->completeMultipartUpload(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // uploadId is required
          'uploadId' => 'string',
          'archiveSize' => 'string',
          'checksum' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - uploadId => (string)

    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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

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

# `public `Guzzle\Service\Resource\Model``
`completeVaultLock( array $args = array() )`

Executes the CompleteVaultLock operation.

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.

#### Examples

- Basic formatting example

      $result = $client->completeVaultLock(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // lockId is required
          'lockId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - lockId => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`createVault( array $args = array() )`

Executes the CreateVault operation.

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

#### Examples

- Basic formatting example

      $result = $client->createVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- location => (string)

  The URI of the vault that was created.

# `public `Guzzle\Service\Resource\Model``
`deleteArchive( array $args = array() )`

Executes the DeleteArchive operation.

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

#### Examples

- Basic formatting example

      $result = $client->deleteArchive(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // archiveId is required
          'archiveId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - archiveId => (string)

    The ID of the archive to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteVault( array $args = array() )`

Executes the DeleteVault operation.

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

#### Examples

- Basic formatting example

      $result = $client->deleteVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteVaultAccessPolicy( array $args = array() )`

Executes the DeleteVaultAccessPolicy operation.

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.

#### Examples

- Basic formatting example

      $result = $client->deleteVaultAccessPolicy(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteVaultNotifications( array $args = array() )`

Executes the DeleteVaultNotifications operation.

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

#### Examples

- Basic formatting example

      $result = $client->deleteVaultNotifications(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`describeJob( array $args = array() )`

Executes the DescribeJob operation.

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.

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, go to Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide.

#### Examples

- Basic formatting example

      $result = $client->describeJob(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // jobId is required
          'jobId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - jobId => (string)

    The ID of the job to describe.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- 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 => (bool)

  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 => (int)

  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 => (int)

  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.

- InventoryRetrievalParameters => (associative-array)

  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 UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of 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. A string representation of 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. 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.

# `public `Guzzle\Service\Resource\Model``
`describeVault( array $args = array() )`

Executes the DescribeVault operation.

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

#### Examples

- Basic formatting example

      $result = $client->describeVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VaultARN => (string)

  The Amazon Resource Name (ARN) of the vault.

- VaultName => (string)

  The name of the vault.

- CreationDate => (string)

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

- LastInventoryDate => (string)

  The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

- NumberOfArchives => (int)

  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 => (int)

  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.

# `public `Guzzle\Service\Resource\Model``
`getDataRetrievalPolicy( array $args = array() )`

Executes the GetDataRetrievalPolicy operation.

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.

#### Examples

- Basic formatting example

      $result = $client->getDataRetrievalPolicy(array(
          // accountId is required
          'accountId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Policy => (associative-array)

  Contains the returned data retrieval policy in JSON format.

  - Rules => (array<associative-array>)

    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.

    - (associative-array)

      Data retrieval policy rule.

      - Strategy => (string)

        The type of data retrieval policy to set.

        Valid values: BytesPerHour|FreeTier|None

      - BytesPerHour => (int)

        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.

# `public `Guzzle\Service\Resource\Model``
`getJobOutput( array $args = array() )`

Executes the GetJobOutput operation.

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.

A job ID will 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.

If the job output is large, then you can use the Range request header 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:

1. Download a 128 MB chunk of output by specifying the appropriate byte range using the Range header.

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

3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

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

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

#### Examples

- Basic formatting example

      $result = $client->getJobOutput(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // jobId is required
          'jobId' => 'string',
          'range' => 'string',
          'saveAs' => '',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - jobId => (string)

    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 "Range: bytes=0-1048575". By default, this operation downloads the entire output.

  - saveAs => ()
    Specify where the contents of the operation should be downloaded. Can be the path to a file, a resource returned by fopen, or a Guzzle\Http\EntityBodyInterface object.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- body => (string | Guzzle\Http\EntityBody)

  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 => (int)

  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, go to 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.

# `public `Guzzle\Service\Resource\Model``
`getVaultAccessPolicy( array $args = array() )`

Executes the GetVaultAccessPolicy operation.

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.

#### Examples

- Basic formatting example

      $result = $client->getVaultAccessPolicy(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Policy => (string)

  The vault access policy.

# `public `Guzzle\Service\Resource\Model``
`getVaultLock( array $args = array() )`

Executes the GetVaultLock operation.

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.

#### Examples

- Basic formatting example

      $result = $client->getVaultLock(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

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

# `public `Guzzle\Service\Resource\Model``
`getVaultNotifications( array $args = array() )`

Executes the GetVaultNotifications operation.

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

#### Examples

- Basic formatting example

      $result = $client->getVaultNotifications(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- SNSTopic => (string)

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

- Events => (array<string>)

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

# `public `Guzzle\Service\Resource\Model``
`initiateJob( array $args = array() )`

Executes the InitiateJob operation.

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:

1. Initiate a retrieval job.

   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.

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

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

#### Examples

- Basic formatting example

      $result = $client->initiateJob(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'Format' => 'string',
          'Type' => 'string',
          'ArchiveId' => 'string',
          'Description' => 'string',
          'SNSTopic' => 'string',
          'RetrievalByteRange' => 'string',
          'InventoryRetrievalParameters' => array(
              'StartDate' => 'string',
              'EndDate' => 'string',
              'Limit' => 'string',
              'Marker' => 'string',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

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

  - InventoryRetrievalParameters => (associative-array)

    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. A string representation of 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. A string representation of 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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- location => (string)

  The relative URI path of the job.

- jobId => (string)

  The ID of the job.

# `public `Guzzle\Service\Resource\Model``
`initiateMultipartUpload( array $args = array() )`

Executes the InitiateMultipartUpload operation.

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.

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

#### Examples

- Basic formatting example

      $result = $client->initiateMultipartUpload(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'archiveDescription' => 'string',
          'partSize' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

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

# `public `Guzzle\Service\Resource\Model``
`initiateVaultLock( array $args = array() )`

Executes the InitiateVaultLock operation.

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.

#### Examples

- Basic formatting example

      $result = $client->initiateVaultLock(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'Policy' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - Policy => (string)

    The vault lock policy.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- lockId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`listJobs( array $args = array() )`

Executes the ListJobs operation.

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

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, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

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

Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.

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 the underlying REST API, go to List Jobs

#### Examples

- Basic formatting example

      $result = $client->listJobs(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'limit' => 'string',
          'marker' => 'string',
          'statuscode' => 'string',
          'completed' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - limit => (string)

    Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

  - 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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

  - statuscode => (string)

    Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

  - completed => (string)

    Specifies the state of the jobs to return. You can specify true or false.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- JobList => (array<associative-array>)

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

  - (associative-array)

    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 => (bool)

      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 => (int)

      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 => (int)

      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.

    - InventoryRetrievalParameters => (associative-array)

      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 UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of 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. A string representation of 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. 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 that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is null.

# `public `Guzzle\Service\Resource\Model``
`listMultipartUploads( array $args = array() )`

Executes the ListMultipartUploads operation.

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, go to Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

#### Examples

- Basic formatting example

      $result = $client->listMultipartUploads(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'limit' => 'string',
          'marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

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

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- UploadsList => (array<associative-array>)

  A list of in-progress multipart uploads.

  - (associative-array)

    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 => (int)

      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.

# `public `Guzzle\Service\Resource\Model``
`listParts( array $args = array() )`

Executes the ListParts operation.

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, go to Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide.

#### Examples

- Basic formatting example

      $result = $client->listParts(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // uploadId is required
          'uploadId' => 'string',
          'marker' => 'string',
          'limit' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - uploadId => (string)

    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)

    Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- 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 => (int)

  The part size in bytes.

- CreationDate => (string)

  The UTC time at which the multipart upload was initiated.

- Parts => (array<associative-array>)

  A list of the part sizes of the multipart upload.

  - (associative-array)

    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.

# `public `Guzzle\Service\Resource\Model``
`listTagsForVault( array $args = array() )`

Executes the ListTagsForVault operation.

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.

#### Examples

- Basic formatting example

      $result = $client->listTagsForVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Tags => (associative-array<string>)

  Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

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

  - <string> => (string)

# `public `Guzzle\Service\Resource\Model``
`listVaults( array $args = array() )`

Executes the ListVaults operation.

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

#### Examples

- Basic formatting example

      $result = $client->listVaults(array(
          // accountId is required
          'accountId' => 'string',
          'marker' => 'string',
          'limit' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - 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 items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VaultList => (array<associative-array>)

  List of vaults.

  - (associative-array)

    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 UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    - LastInventoryDate => (string)

      The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    - NumberOfArchives => (int)

      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 => (int)

      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.

# `public `Guzzle\Service\Resource\Model``
`removeTagsFromVault( array $args = array() )`

Executes the RemoveTagsFromVault operation.

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.

#### Examples

- Basic formatting example

      $result = $client->removeTagsFromVault(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'TagKeys' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - TagKeys => (array<string>)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`setDataRetrievalPolicy( array $args = array() )`

Executes the SetDataRetrievalPolicy operation.

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.

#### Examples

- Basic formatting example

      $result = $client->setDataRetrievalPolicy(array(
          // accountId is required
          'accountId' => 'string',
          'Policy' => array(
              'Rules' => array(
                  array(
                      'Strategy' => 'string',
                      'BytesPerHour' => integer,
                  ),
                  // ... repeated
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - Policy => (associative-array)

    The data retrieval policy in JSON format.

    - Rules => (array<associative-array>)

      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.

      - (associative-array)

        Data retrieval policy rule.

        - Strategy => (string)

          The type of data retrieval policy to set.

          Valid values: BytesPerHour|FreeTier|None

        - BytesPerHour => (int)

          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

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`setVaultAccessPolicy( array $args = array() )`

Executes the SetVaultAccessPolicy operation.

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.

#### Examples

- Basic formatting example

      $result = $client->setVaultAccessPolicy(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'Policy' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - Policy => (string)

    The vault access policy.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`setVaultNotifications( array $args = array() )`

Executes the SetVaultNotifications operation.

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

#### Examples

- Basic formatting example

      $result = $client->setVaultNotifications(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          'SNSTopic' => 'string',
          'Events' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - SNSTopic => (string)

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

  - Events => (array<string>)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`uploadArchive( array $args = array() )`

Executes the UploadArchive operation.

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

#### Examples

- Basic formatting example

      $result = $client->uploadArchive(array(
          // vaultName is required
          'vaultName' => 'string',
          // accountId is required
          'accountId' => 'string',
          'archiveDescription' => 'string',
          'checksum' => 'string',
          'body' => 'mixed type: string|resource|\Guzzle\Http\EntityBodyInterface',
          // ContentSHA256 has a default value of true
          'ContentSHA256' => '',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - vaultName => (string)

    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.

  - archiveDescription => (string)

    The optional description of the archive you are uploading.

  - checksum => (string)

    The SHA256 tree hash of the data being uploaded.

  - body => (string|resource|\Guzzle\Http\EntityBodyInterface)

    The data to upload.

  - ContentSHA256 => (defaults to: 1) ()
    SHA256 checksum of the body.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

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

# `public `Guzzle\Service\Resource\Model``
`uploadMultipartPart( array $args = array() )`

Executes the UploadMultipartPart operation.

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

#### Examples

- Basic formatting example

      $result = $client->uploadMultipartPart(array(
          // accountId is required
          'accountId' => 'string',
          // vaultName is required
          'vaultName' => 'string',
          // uploadId is required
          'uploadId' => 'string',
          'checksum' => 'string',
          'range' => 'string',
          'body' => 'mixed type: string|resource|\Guzzle\Http\EntityBodyInterface',
          // ContentSHA256 has a default value of true
          'ContentSHA256' => '',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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.

  - vaultName => (string)

    The name of the vault.

  - uploadId => (string)

    The upload ID of the multipart upload.

  - checksum => (string)

    The SHA256 tree hash of the data being uploaded.

  - 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 => (string|resource|\Guzzle\Http\EntityBodyInterface)

    The data to upload.

  - ContentSHA256 => (defaults to: 1) ()
    SHA256 checksum of the body.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- checksum => (string)

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

# `public`
`waitUntilVaultExists( array $input )`

Wait until a vault can be accessed. The input array uses the parameters of the DescribeVault operation and waiter specific settings

#### Parameters

$input
  `array`
  $input

# `public`
`waitUntilVaultNotExists( array $input )`

Wait until a vault is deleted. The input array uses the parameters of the DescribeVault operation and waiter specific settings

#### Parameters

$input
  `array`
  $input

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListJobsIterator( array $args = array() )`

The input array uses the parameters of the ListJobs operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListMultipartUploadsIterator( array $args = array() )`

The input array uses the parameters of the ListMultipartUploads operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListPartsIterator( array $args = array() )`

The input array uses the parameters of the ListParts operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListVaultsIterator( array $args = array() )`

The input array uses the parameters of the ListVaults operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2012-06-01'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`