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 .

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 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

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 - 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.
• djVaultName - The name of the vault.
• djJobId - The ID of the job to describe.

data DescribeJob

Provides options for retrieving a job description.

See: describeJob smart constructor.

Instances

Eq DescribeJob

Methods

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

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

Data DescribeJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeJob -> c DescribeJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeJob

toConstr :: DescribeJob -> Constr

dataTypeOf :: DescribeJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeJob)

gmapT :: (forall b. Data b => b -> b) -> DescribeJob -> DescribeJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJob -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeJob -> m DescribeJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJob -> m DescribeJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJob -> m DescribeJob

Read DescribeJob

Methods

readsPrec :: Int -> ReadS DescribeJob

readList :: ReadS [DescribeJob]

readPrec :: ReadPrec DescribeJob

readListPrec :: ReadPrec [DescribeJob]

Show DescribeJob

Methods

showsPrec :: Int -> DescribeJob -> ShowS

show :: DescribeJob -> String

showList :: [DescribeJob] -> ShowS

Generic DescribeJob

Associated Types

type Rep DescribeJob :: * -> *

Methods

from :: DescribeJob -> Rep DescribeJob x

to :: Rep DescribeJob x -> DescribeJob

Hashable DescribeJob

Methods

hashWithSalt :: Int -> DescribeJob -> Int

hash :: DescribeJob -> Int

NFData DescribeJob

Methods

rnf :: DescribeJob -> ()

AWSRequest DescribeJob

Associated Types

type Rs DescribeJob :: *

Methods

request :: DescribeJob -> Request DescribeJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeJob -> ClientResponse -> m (Response DescribeJob)

ToHeaders DescribeJob

Methods

toHeaders :: DescribeJob -> [Header]

ToPath DescribeJob

Methods

toPath :: DescribeJob -> ByteString

ToQuery DescribeJob

Methods

toQuery :: DescribeJob -> QueryString

type Rep DescribeJob

type Rep DescribeJob = D1 * (MetaData "DescribeJob" "Network.AWS.Glacier.DescribeJob" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "DescribeJob'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_djAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_djVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_djJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs 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 '- ' (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.

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 - 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
• gjdArchiveId - The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
• gjdSelectParameters - Contains the parameters used for a select.
• gjdJobId - An opaque string that identifies an Amazon Glacier job.
• gjdJobOutputPath - Contains the job output location.
• gjdRetrievalByteRange - 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.
• gjdInventoryRetrievalParameters - Parameters used for range inventory retrieval.
• gjdAction - The job type. This value is either ArchiveRetrieval , InventoryRetrieval , or Select .
• gjdJobDescription - The job description provided when initiating the job.
• gjdSNSTopic - An Amazon SNS topic that receives notification.
• gjdStatusMessage - A friendly message that describes the job status.
• gjdVaultARN - The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
• gjdOutputLocation - Contains the location where the data from the select job is stored.
• gjdTier - The tier to use for a select or an archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.
• gjdArchiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
• gjdCreationDate - 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" .
• gjdCompleted - The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
• gjdCompletionDate - The UTC time that the job request completed. While the job is in progress, the value is null.
• gjdInventorySizeInBytes - 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.
• gjdArchiveSizeInBytes - 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.
• gjdStatusCode - The status code can be InProgress , Succeeded , or Failed , and indicates the status of the job.

data GlacierJobDescription

Contains the description of an Amazon Glacier job.

See: glacierJobDescription smart constructor.

Instances

Eq GlacierJobDescription

Methods

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

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

Data GlacierJobDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GlacierJobDescription -> c GlacierJobDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GlacierJobDescription

toConstr :: GlacierJobDescription -> Constr

dataTypeOf :: GlacierJobDescription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GlacierJobDescription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GlacierJobDescription)

gmapT :: (forall b. Data b => b -> b) -> GlacierJobDescription -> GlacierJobDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GlacierJobDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GlacierJobDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> GlacierJobDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GlacierJobDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GlacierJobDescription -> m GlacierJobDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GlacierJobDescription -> m GlacierJobDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GlacierJobDescription -> m GlacierJobDescription

Read GlacierJobDescription

Methods

readsPrec :: Int -> ReadS GlacierJobDescription

readList :: ReadS [GlacierJobDescription]

readPrec :: ReadPrec GlacierJobDescription

readListPrec :: ReadPrec [GlacierJobDescription]

Show GlacierJobDescription

Methods

showsPrec :: Int -> GlacierJobDescription -> ShowS

show :: GlacierJobDescription -> String

showList :: [GlacierJobDescription] -> ShowS

Generic GlacierJobDescription

Associated Types

type Rep GlacierJobDescription :: * -> *

Methods

from :: GlacierJobDescription -> Rep GlacierJobDescription x

to :: Rep GlacierJobDescription x -> GlacierJobDescription

Hashable GlacierJobDescription

Methods

hashWithSalt :: Int -> GlacierJobDescription -> Int

hash :: GlacierJobDescription -> Int

FromJSON GlacierJobDescription

Methods

parseJSON :: Value -> Parser GlacierJobDescription

parseJSONList :: Value -> Parser [GlacierJobDescription]

NFData GlacierJobDescription

Methods

rnf :: GlacierJobDescription -> ()

type Rep GlacierJobDescription

type Rep GlacierJobDescription = D1 * (MetaData "GlacierJobDescription" "Network.AWS.Glacier.Types.Product" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "GlacierJobDescription'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdSHA256TreeHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdArchiveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdSelectParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SelectParameters))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdJobOutputPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdRetrievalByteRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdInventoryRetrievalParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe InventoryRetrievalJobDescription)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ActionCode))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdJobDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdSNSTopic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdVaultARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdOutputLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OutputLocation))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gjdArchiveSHA256TreeHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdCompleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_gjdCompletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdInventorySizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gjdArchiveSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_gjdStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StatusCode)))))))))

Response Lenses

gjdSHA256TreeHash :: 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

gjdArchiveId :: Lens' GlacierJobDescription (Maybe Text)

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

gjdSelectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters)

Contains the parameters used for a select.

gjdJobId :: Lens' GlacierJobDescription (Maybe Text)

An opaque string that identifies an Amazon Glacier job.

gjdJobOutputPath :: Lens' GlacierJobDescription (Maybe Text)

Contains the job output location.

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. 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.

gjdInventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription)

Parameters used for range inventory retrieval.

gjdAction :: Lens' GlacierJobDescription (Maybe ActionCode)

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

gjdJobDescription :: Lens' GlacierJobDescription (Maybe Text)

The job description provided when initiating the job.

gjdSNSTopic :: Lens' GlacierJobDescription (Maybe Text)

An 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 an archive retrieval was requested.

gjdOutputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation)

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

gjdTier :: 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.

gjdArchiveSHA256TreeHash :: 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.

gjdCreationDate :: 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" .

gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool)

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

gjdCompletionDate :: Lens' GlacierJobDescription (Maybe Text)

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

gjdInventorySizeInBytes :: 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.

gjdArchiveSizeInBytes :: 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.

gjdStatusCode :: Lens' GlacierJobDescription (Maybe StatusCode)

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