Network.AWS.Glacier.GetJobOutput

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

See: AWS API Reference for GetJobOutput.

Creating a Request

getJobOutput

Arguments

:: Text

gjoAccountId

-> Text

gjoVaultName

-> Text

gjoJobId

-> GetJobOutput

Creates a value of GetJobOutput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gjoRange
• gjoAccountId
• gjoVaultName
• gjoJobId

data GetJobOutput

Provides options for downloading output of an Amazon Glacier job.

See: getJobOutput smart constructor.

Instances

Eq GetJobOutput

Data GetJobOutput

Read GetJobOutput

Show GetJobOutput

Generic GetJobOutput

AWSRequest GetJobOutput

ToPath GetJobOutput

ToHeaders GetJobOutput

ToQuery GetJobOutput

Typeable * GetJobOutput

type Rep GetJobOutput

type Sv GetJobOutput = Glacier

type Rs GetJobOutput = GetJobOutputResponse

Request Lenses

gjoRange :: Lens' GetJobOutput (Maybe Text)

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.

gjoAccountId :: Lens' GetJobOutput Text

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 apos-apos (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 (apos-apos) in the ID.

gjoVaultName :: Lens' GetJobOutput Text

The name of the vault.

gjoJobId :: Lens' GetJobOutput Text

The job ID whose data is downloaded.

Destructuring the Response

getJobOutputResponse

Arguments

:: Int

gjorsStatus

-> RsBody

gjorsBody

-> GetJobOutputResponse

Creates a value of GetJobOutputResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gjorsChecksum
• gjorsAcceptRanges
• gjorsArchiveDescription
• gjorsContentRange
• gjorsContentType
• gjorsStatus
• gjorsBody

data GetJobOutputResponse

Contains the Amazon Glacier response to your request.

See: getJobOutputResponse smart constructor.

Instances

Show GetJobOutputResponse

Generic GetJobOutputResponse

type Rep GetJobOutputResponse

Response Lenses

gjorsChecksum :: Lens' GetJobOutputResponse (Maybe Text)

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.

gjorsAcceptRanges :: Lens' GetJobOutputResponse (Maybe Text)

Indicates the range units accepted. For more information, go to RFC2616.

gjorsArchiveDescription :: Lens' GetJobOutputResponse (Maybe Text)

The description of an archive.

gjorsContentRange :: Lens' GetJobOutputResponse (Maybe Text)

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.

gjorsContentType :: Lens' GetJobOutputResponse (Maybe Text)

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.

gjorsStatus :: Lens' GetJobOutputResponse Int

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

gjorsBody :: Lens' GetJobOutputResponse RsBody

The job data, either archive data or inventory data.