Amazonka.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 S3 Glacier (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 Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after 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 more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.

Creating a Request

data DescribeJob

Provides options for retrieving a job description.

See: newDescribeJob smart constructor.

Constructors

DescribeJob'

Fields

• 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 ID of the job to describe.

Instances

ToHeaders DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

toHeaders :: DescribeJob -> [Header]

ToPath DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

toPath :: DescribeJob -> ByteString

ToQuery DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

toQuery :: DescribeJob -> QueryString

AWSRequest DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Associated Types

type AWSResponse DescribeJob

Methods

request :: (Service -> Service) -> DescribeJob -> Request DescribeJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeJob)))

Generic DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Associated Types

type Rep DescribeJob :: Type -> Type

Methods

from :: DescribeJob -> Rep DescribeJob x

to :: Rep DescribeJob x -> DescribeJob

Read DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

readsPrec :: Int -> ReadS DescribeJob

readList :: ReadS [DescribeJob]

readPrec :: ReadPrec DescribeJob

readListPrec :: ReadPrec [DescribeJob]

Show DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

showsPrec :: Int -> DescribeJob -> ShowS

show :: DescribeJob -> String

showList :: [DescribeJob] -> ShowS

NFData DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

rnf :: DescribeJob -> ()

Eq DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

(==) :: DescribeJob -> DescribeJob -> Bool

(/=) :: DescribeJob -> DescribeJob -> Bool

Hashable DescribeJob

Defined in Amazonka.Glacier.DescribeJob

Methods

hashWithSalt :: Int -> DescribeJob -> Int

hash :: DescribeJob -> Int

type AWSResponse DescribeJob

Defined in Amazonka.Glacier.DescribeJob

type AWSResponse DescribeJob = GlacierJobDescription

type Rep DescribeJob

Defined in Amazonka.Glacier.DescribeJob

type Rep DescribeJob = D1 ('MetaData "DescribeJob" "Amazonka.Glacier.DescribeJob" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "DescribeJob'" 'PrefixI 'True) (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))))

newDescribeJob

Arguments

:: Text

$sel:accountId:DescribeJob'

-> Text

DescribeJob

-> Text

DescribeJob

-> DescribeJob

Create a value of DescribeJob 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:accountId:DescribeJob', describeJob_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.

DescribeJob, describeJob_vaultName - The name of the vault.

DescribeJob, describeJob_jobId - The ID of the job to describe.

Request Lenses

describeJob_accountId :: 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 '-' (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.

describeJob_vaultName :: Lens' DescribeJob Text

The name of the vault.

describeJob_jobId :: Lens' DescribeJob Text

The ID of the job to describe.

Destructuring the Response

data GlacierJobDescription

Contains the description of an Amazon S3 Glacier job.

See: newGlacierJobDescription smart constructor.

Constructors

GlacierJobDescription'

Fields

• action :: Maybe ActionCode

  The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

• archiveId :: Maybe Text

  The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

• archiveSHA256TreeHash :: Maybe Text

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

• archiveSizeInBytes :: Maybe Integer

  For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

• completed :: Maybe Bool

  The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

• completionDate :: Maybe Text

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

• creationDate :: Maybe Text

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

• inventoryRetrievalParameters :: Maybe InventoryRetrievalJobDescription

  Parameters used for range inventory retrieval.

• inventorySizeInBytes :: Maybe Integer

  For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

• jobDescription :: Maybe Text

  The job description provided when initiating the job.

• jobId :: Maybe Text

  An opaque string that identifies an Amazon S3 Glacier job.

• jobOutputPath :: Maybe Text

  Contains the job output location.

• outputLocation :: Maybe OutputLocation

  Contains the location where the data from the select job is stored.

• retrievalByteRange :: 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. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

• sHA256TreeHash :: Maybe Text

  For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

  The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

  If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

  This field is null for the following:

  • 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, when the job status is InProgress
  • Inventory jobs
  • Select jobs
• sNSTopic :: Maybe Text

  An Amazon SNS topic that receives notification.

• selectParameters :: Maybe SelectParameters

  Contains the parameters used for a select.

• statusCode :: Maybe StatusCode

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

• statusMessage :: Maybe Text

  A friendly message that describes the job status.

• tier :: Maybe Text

  The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

• vaultARN :: Maybe Text

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

Instances

FromJSON GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

parseJSON :: Value -> Parser GlacierJobDescription

parseJSONList :: Value -> Parser [GlacierJobDescription]

Generic GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Associated Types

type Rep GlacierJobDescription :: Type -> Type

Methods

from :: GlacierJobDescription -> Rep GlacierJobDescription x

to :: Rep GlacierJobDescription x -> GlacierJobDescription

Read GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

readsPrec :: Int -> ReadS GlacierJobDescription

readList :: ReadS [GlacierJobDescription]

readPrec :: ReadPrec GlacierJobDescription

readListPrec :: ReadPrec [GlacierJobDescription]

Show GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

showsPrec :: Int -> GlacierJobDescription -> ShowS

show :: GlacierJobDescription -> String

showList :: [GlacierJobDescription] -> ShowS

NFData GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

rnf :: GlacierJobDescription -> ()

Eq GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

(==) :: GlacierJobDescription -> GlacierJobDescription -> Bool

(/=) :: GlacierJobDescription -> GlacierJobDescription -> Bool

Hashable GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

Methods

hashWithSalt :: Int -> GlacierJobDescription -> Int

hash :: GlacierJobDescription -> Int

type Rep GlacierJobDescription

Defined in Amazonka.Glacier.Types.GlacierJobDescription

type Rep GlacierJobDescription = D1 ('MetaData "GlacierJobDescription" "Amazonka.Glacier.Types.GlacierJobDescription" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "GlacierJobDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionCode)) :*: S1 ('MetaSel ('Just "archiveId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "archiveSHA256TreeHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "archiveSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "completed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inventoryRetrievalParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InventoryRetrievalJobDescription)) :*: (S1 ('MetaSel ('Just "inventorySizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "jobDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobOutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :*: (S1 ('MetaSel ('Just "retrievalByteRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sHA256TreeHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "sNSTopic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "selectParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelectParameters)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusCode)))) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vaultARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newGlacierJobDescription :: GlacierJobDescription

Create a value of GlacierJobDescription 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:action:GlacierJobDescription', glacierJobDescription_action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

$sel:archiveId:GlacierJobDescription', glacierJobDescription_archiveId - The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

$sel:archiveSHA256TreeHash:GlacierJobDescription', glacierJobDescription_archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

$sel:archiveSizeInBytes:GlacierJobDescription', glacierJobDescription_archiveSizeInBytes - For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

$sel:completed:GlacierJobDescription', glacierJobDescription_completed - The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

$sel:completionDate:GlacierJobDescription', glacierJobDescription_completionDate - The UTC time that the job request completed. While the job is in progress, the value is null.

$sel:creationDate:GlacierJobDescription', glacierJobDescription_creationDate - The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

$sel:inventoryRetrievalParameters:GlacierJobDescription', glacierJobDescription_inventoryRetrievalParameters - Parameters used for range inventory retrieval.

$sel:inventorySizeInBytes:GlacierJobDescription', glacierJobDescription_inventorySizeInBytes - For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

$sel:jobDescription:GlacierJobDescription', glacierJobDescription_jobDescription - The job description provided when initiating the job.

$sel:jobId:GlacierJobDescription', glacierJobDescription_jobId - An opaque string that identifies an Amazon S3 Glacier job.

$sel:jobOutputPath:GlacierJobDescription', glacierJobDescription_jobOutputPath - Contains the job output location.

$sel:outputLocation:GlacierJobDescription', glacierJobDescription_outputLocation - Contains the location where the data from the select job is stored.

$sel:retrievalByteRange:GlacierJobDescription', glacierJobDescription_retrievalByteRange - 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. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

$sel:sHA256TreeHash:GlacierJobDescription', glacierJobDescription_sHA256TreeHash - For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

• 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, when the job status is InProgress
• Inventory jobs
• Select jobs

$sel:sNSTopic:GlacierJobDescription', glacierJobDescription_sNSTopic - An Amazon SNS topic that receives notification.

$sel:selectParameters:GlacierJobDescription', glacierJobDescription_selectParameters - Contains the parameters used for a select.

$sel:statusCode:GlacierJobDescription', glacierJobDescription_statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

$sel:statusMessage:GlacierJobDescription', glacierJobDescription_statusMessage - A friendly message that describes the job status.

$sel:tier:GlacierJobDescription', glacierJobDescription_tier - The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

$sel:vaultARN:GlacierJobDescription', glacierJobDescription_vaultARN - The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Response Lenses

glacierJobDescription_action :: Lens' GlacierJobDescription (Maybe ActionCode)

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

glacierJobDescription_archiveId :: Lens' GlacierJobDescription (Maybe Text)

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

glacierJobDescription_archiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)

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

glacierJobDescription_archiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

glacierJobDescription_completed :: Lens' GlacierJobDescription (Maybe Bool)

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

glacierJobDescription_completionDate :: Lens' GlacierJobDescription (Maybe Text)

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

glacierJobDescription_creationDate :: Lens' GlacierJobDescription (Maybe Text)

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

glacierJobDescription_inventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription)

Parameters used for range inventory retrieval.

glacierJobDescription_inventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

glacierJobDescription_jobDescription :: Lens' GlacierJobDescription (Maybe Text)

The job description provided when initiating the job.

glacierJobDescription_jobId :: Lens' GlacierJobDescription (Maybe Text)

An opaque string that identifies an Amazon S3 Glacier job.

glacierJobDescription_jobOutputPath :: Lens' GlacierJobDescription (Maybe Text)

Contains the job output location.

glacierJobDescription_outputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation)

Contains the location where the data from the select job is stored.

glacierJobDescription_retrievalByteRange :: 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. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

glacierJobDescription_sHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

• 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, when the job status is InProgress
• Inventory jobs
• Select jobs

glacierJobDescription_sNSTopic :: Lens' GlacierJobDescription (Maybe Text)

An Amazon SNS topic that receives notification.

glacierJobDescription_selectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters)

Contains the parameters used for a select.

glacierJobDescription_statusCode :: Lens' GlacierJobDescription (Maybe StatusCode)

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

glacierJobDescription_statusMessage :: Lens' GlacierJobDescription (Maybe Text)

A friendly message that describes the job status.

glacierJobDescription_tier :: Lens' GlacierJobDescription (Maybe Text)

The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

glacierJobDescription_vaultARN :: Lens' GlacierJobDescription (Maybe Text)

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