Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).
Retrieving data from Amazon Glacier is a two-step process:
- Initiate a retrieval job.
- 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.
If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications
.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
About the Vault Inventory
Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.
Range Inventory Retrieval
You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.
Filtering by Archive Creation Date
You can retrieve inventory items for archives created between StartDate
and EndDate
by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate
and before the EndDate
will be returned. If you only provide the StartDate
without the EndDate
, you will retrieve the inventory for all archives created on or after the StartDate
. If you only provide the EndDate
without the StartDate
, you will get back the inventory for all archives created before the EndDate
.
Limiting Inventory Items per Retrieval
You can limit the number of inventory items returned by setting the Limit
parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit
. If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob
operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.
You can use the Limit
parameter together with the date range parameters.
About Ranged Archive Retrieval
You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and the underlying REST API, see Initiate a Job and Downloading a Vault Inventory
Expedited and Bulk Archive Retrievals
When retrieving an archive, you can specify one of the following options in the Tier
field of the request body:
- Standard The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.
- Bulk Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours.
- Expedited Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes.
For more information about expedited and bulk retrievals, see Retrieving Amazon Glacier Archives .
- initiateJob :: Text -> Text -> InitiateJob
- data InitiateJob
- ijJobParameters :: Lens' InitiateJob (Maybe JobParameters)
- ijAccountId :: Lens' InitiateJob Text
- ijVaultName :: Lens' InitiateJob Text
- initiateJobResponse :: Int -> InitiateJobResponse
- data InitiateJobResponse
- ijrsJobId :: Lens' InitiateJobResponse (Maybe Text)
- ijrsLocation :: Lens' InitiateJobResponse (Maybe Text)
- ijrsResponseStatus :: Lens' InitiateJobResponse Int
Creating a Request
Creates a value of InitiateJob
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ijJobParameters
- Provides options for specifying job information.ijAccountId
- TheAccountId
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.ijVaultName
- The name of the vault.
data InitiateJob Source #
Provides options for initiating an Amazon Glacier job.
See: initiateJob
smart constructor.
Request Lenses
ijJobParameters :: Lens' InitiateJob (Maybe JobParameters) Source #
Provides options for specifying job information.
ijAccountId :: Lens' InitiateJob Text Source #
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.
ijVaultName :: Lens' InitiateJob Text Source #
The name of the vault.
Destructuring the Response
Creates a value of InitiateJobResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ijrsJobId
- The ID of the job.ijrsLocation
- The relative URI path of the job.ijrsResponseStatus
- -- | The response status code.
data InitiateJobResponse Source #
Contains the Amazon Glacier response to your request.
See: initiateJobResponse
smart constructor.
Response Lenses
ijrsLocation :: Lens' InitiateJobResponse (Maybe Text) Source #
The relative URI path of the job.
ijrsResponseStatus :: Lens' InitiateJobResponse Int Source #
- - | The response status code.