Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glacier.GetJobOutput

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

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

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

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

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

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

For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output

Synopsis

data GetJobOutput = GetJobOutput' {
- range :: Maybe Text
- accountId :: Text
- vaultName :: Text
- jobId :: Text
}
newGetJobOutput :: Text -> Text -> Text -> GetJobOutput
getJobOutput_range :: Lens' GetJobOutput (Maybe Text)
getJobOutput_accountId :: Lens' GetJobOutput Text
getJobOutput_vaultName :: Lens' GetJobOutput Text
getJobOutput_jobId :: Lens' GetJobOutput Text
data GetJobOutputResponse = GetJobOutputResponse' {
- checksum :: Maybe Text
- acceptRanges :: Maybe Text
- archiveDescription :: Maybe Text
- contentRange :: Maybe Text
- contentType :: Maybe Text
- status :: Int
- body :: ResponseBody
}
newGetJobOutputResponse :: Int -> ResponseBody -> GetJobOutputResponse
getJobOutputResponse_checksum :: Lens' GetJobOutputResponse (Maybe Text)
getJobOutputResponse_acceptRanges :: Lens' GetJobOutputResponse (Maybe Text)
getJobOutputResponse_archiveDescription :: Lens' GetJobOutputResponse (Maybe Text)
getJobOutputResponse_contentRange :: Lens' GetJobOutputResponse (Maybe Text)
getJobOutputResponse_contentType :: Lens' GetJobOutputResponse (Maybe Text)
getJobOutputResponse_status :: Lens' GetJobOutputResponse Int
getJobOutputResponse_body :: Lens' GetJobOutputResponse ResponseBody

Creating a Request

data GetJobOutput Source #

Provides options for downloading output of an Amazon S3 Glacier job.

See: newGetJobOutput smart constructor.

Constructors

GetJobOutput'

Fields

range :: 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 the range as bytes=0-1048575. By default, this operation downloads the entire output.
If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
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 S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
accountId :: 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 '-' (hyphen), in which case Amazon S3 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 :: Text
The name of the vault.
jobId :: Text
The job ID whose data is downloaded.

Instances

Instances details

Eq GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods (==) :: GetJobOutput -> GetJobOutput -> Bool # (/=) :: GetJobOutput -> GetJobOutput -> Bool #
Read GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods readsPrec :: Int -> ReadS GetJobOutput # readList :: ReadS [GetJobOutput] # readPrec :: ReadPrec GetJobOutput # readListPrec :: ReadPrec [GetJobOutput] #
Show GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods showsPrec :: Int -> GetJobOutput -> ShowS # show :: GetJobOutput -> String # showList :: [GetJobOutput] -> ShowS #
Generic GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Associated Types type Rep GetJobOutput :: Type -> Type # Methods from :: GetJobOutput -> Rep GetJobOutput x # to :: Rep GetJobOutput x -> GetJobOutput #
NFData GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods rnf :: GetJobOutput -> () #
Hashable GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods hashWithSalt :: Int -> GetJobOutput -> Int # hash :: GetJobOutput -> Int #
AWSRequest GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Associated Types type AWSResponse GetJobOutput # Methods request :: GetJobOutput -> Request GetJobOutput # response :: MonadResource m => Logger -> Service -> Proxy GetJobOutput -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJobOutput))) #
ToHeaders GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods toHeaders :: GetJobOutput -> [Header] #
ToPath GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods toPath :: GetJobOutput -> ByteString #
ToQuery GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods toQuery :: GetJobOutput -> QueryString #
type Rep GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput type Rep GetJobOutput = D1 ('MetaData "GetJobOutput" "Amazonka.Glacier.GetJobOutput" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "GetJobOutput'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetJobOutput Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput type AWSResponse GetJobOutput = GetJobOutputResponse

newGetJobOutput Source #

Arguments

:: Text	`$sel:accountId:GetJobOutput'`
-> Text	`$sel:vaultName:GetJobOutput'`
-> Text	`$sel:jobId:GetJobOutput'`
-> GetJobOutput

Create a value of GetJobOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

$sel:accountId:GetJobOutput', getJobOutput_accountId - 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 S3 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.

$sel:vaultName:GetJobOutput', getJobOutput_vaultName - The name of the vault.

$sel:jobId:GetJobOutput', getJobOutput_jobId - The job ID whose data is downloaded.

Request Lenses

getJobOutput_range :: Lens' GetJobOutput (Maybe Text) Source #

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

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

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

getJobOutput_accountId :: Lens' GetJobOutput 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 S3 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.

getJobOutput_vaultName :: Lens' GetJobOutput Text Source #

The name of the vault.

getJobOutput_jobId :: Lens' GetJobOutput Text Source #

The job ID whose data is downloaded.

Destructuring the Response

data GetJobOutputResponse Source #

Contains the Amazon S3 Glacier response to your request.

See: newGetJobOutputResponse smart constructor.

Constructors

GetJobOutputResponse'

Fields

checksum :: 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.
acceptRanges :: Maybe Text
Indicates the range units accepted. For more information, see RFC2616.
archiveDescription :: Maybe Text
The description of an archive.
contentRange :: Maybe Text
The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
contentType :: 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.
status :: Int
The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
body :: ResponseBody
The job data, either archive data or inventory data.

Instances

Instances details

Show GetJobOutputResponse Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Methods showsPrec :: Int -> GetJobOutputResponse -> ShowS # show :: GetJobOutputResponse -> String # showList :: [GetJobOutputResponse] -> ShowS #
Generic GetJobOutputResponse Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput Associated Types type Rep GetJobOutputResponse :: Type -> Type # Methods from :: GetJobOutputResponse -> Rep GetJobOutputResponse x # to :: Rep GetJobOutputResponse x -> GetJobOutputResponse #
type Rep GetJobOutputResponse Source #
Instance details Defined in Amazonka.Glacier.GetJobOutput type Rep GetJobOutputResponse = D1 ('MetaData "GetJobOutputResponse" "Amazonka.Glacier.GetJobOutput" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "GetJobOutputResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "acceptRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "archiveDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "contentRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody)))))

newGetJobOutputResponse Source #

Arguments

:: Int	`$sel:status:GetJobOutputResponse'`
-> ResponseBody	`$sel:body:GetJobOutputResponse'`
-> GetJobOutputResponse

Create a value of GetJobOutputResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checksum:GetJobOutputResponse', getJobOutputResponse_checksum - 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.

$sel:acceptRanges:GetJobOutputResponse', getJobOutputResponse_acceptRanges - Indicates the range units accepted. For more information, see RFC2616.

$sel:archiveDescription:GetJobOutputResponse', getJobOutputResponse_archiveDescription - The description of an archive.

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

$sel:contentType:GetJobOutputResponse', getJobOutputResponse_contentType - 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.

$sel:status:GetJobOutputResponse', getJobOutputResponse_status - The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

$sel:body:GetJobOutputResponse', getJobOutputResponse_body - The job data, either archive data or inventory data.

Response Lenses

getJobOutputResponse_checksum :: Lens' GetJobOutputResponse (Maybe Text) Source #

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.

getJobOutputResponse_acceptRanges :: Lens' GetJobOutputResponse (Maybe Text) Source #

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

getJobOutputResponse_archiveDescription :: Lens' GetJobOutputResponse (Maybe Text) Source #

The description of an archive.

getJobOutputResponse_contentRange :: Lens' GetJobOutputResponse (Maybe Text) Source #

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

getJobOutputResponse_contentType :: Lens' GetJobOutputResponse (Maybe Text) Source #

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.

getJobOutputResponse_status :: Lens' GetJobOutputResponse Int Source #

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

getJobOutputResponse_body :: Lens' GetJobOutputResponse ResponseBody Source #

The job data, either archive data or inventory data.