Network.AWS.Glacier.DescribeJob

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.

See: AWS API Reference for DescribeJob.

Creating a Request

describeJob

Arguments

:: Text

djAccountId

-> Text

djVaultName

-> Text

djJobId

-> DescribeJob

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

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

• djAccountId
• djVaultName
• djJobId

data DescribeJob

Provides options for retrieving a job description.

See: describeJob smart constructor.

Instances

Eq DescribeJob

Data DescribeJob

Read DescribeJob

Show DescribeJob

Generic DescribeJob

AWSRequest DescribeJob

ToPath DescribeJob

ToHeaders DescribeJob

ToQuery DescribeJob

type Rep DescribeJob

type Rs DescribeJob = GlacierJobDescription

Request Lenses

djAccountId :: Lens' DescribeJob 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.

djVaultName :: Lens' DescribeJob Text

The name of the vault.

djJobId :: Lens' DescribeJob Text

The ID of the job to describe.

Destructuring the Response

glacierJobDescription :: GlacierJobDescription

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

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

• gjdSHA256TreeHash
• gjdArchiveId
• gjdJobId
• gjdRetrievalByteRange
• gjdInventoryRetrievalParameters
• gjdAction
• gjdJobDescription
• gjdSNSTopic
• gjdStatusMessage
• gjdVaultARN
• gjdArchiveSHA256TreeHash
• gjdCreationDate
• gjdCompleted
• gjdCompletionDate
• gjdInventorySizeInBytes
• gjdArchiveSizeInBytes
• gjdStatusCode

data GlacierJobDescription

Describes an Amazon Glacier job.

See: glacierJobDescription smart constructor.

Instances

Eq GlacierJobDescription

Data GlacierJobDescription

Read GlacierJobDescription

Show GlacierJobDescription

Generic GlacierJobDescription

FromJSON GlacierJobDescription

type Rep GlacierJobDescription

Response Lenses

gjdSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)

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.

gjdArchiveId :: Lens' GlacierJobDescription (Maybe Text)

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

gjdJobId :: Lens' GlacierJobDescription (Maybe Text)

An opaque string that identifies an Amazon Glacier job.

gjdRetrievalByteRange :: Lens' GlacierJobDescription (Maybe Text)

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.

gjdInventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription)

Parameters used for range inventory retrieval.

gjdAction :: Lens' GlacierJobDescription (Maybe ActionCode)

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

gjdJobDescription :: Lens' GlacierJobDescription (Maybe Text)

The job description you provided when you initiated the job.

gjdSNSTopic :: Lens' GlacierJobDescription (Maybe Text)

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

gjdStatusMessage :: Lens' GlacierJobDescription (Maybe Text)

A friendly message that describes the job status.

gjdVaultARN :: Lens' GlacierJobDescription (Maybe Text)

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

gjdArchiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

gjdCreationDate :: Lens' GlacierJobDescription (Maybe Text)

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

gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool)

The job status. When a job is completed, you get the job's output.

gjdCompletionDate :: Lens' GlacierJobDescription (Maybe Text)

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

gjdInventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

gjdArchiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)

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.

gjdStatusCode :: Lens' GlacierJobDescription (Maybe StatusCode)

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.