amazonka-glacier-1.4.5: Amazon Glacier SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Glacier.DescribeJob

Contents

Description

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 information about the underlying REST API, see Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide .

Synopsis

Creating a Request

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 # 
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 # 
Show DescribeJob # 
Generic DescribeJob # 

Associated Types

type Rep DescribeJob :: * -> * #

Hashable DescribeJob # 
NFData DescribeJob # 

Methods

rnf :: DescribeJob -> () #

AWSRequest DescribeJob # 
ToQuery DescribeJob # 
ToPath DescribeJob # 
ToHeaders DescribeJob # 

Methods

toHeaders :: DescribeJob -> [Header] #

type Rep DescribeJob # 
type Rep DescribeJob = D1 (MetaData "DescribeJob" "Network.AWS.Glacier.DescribeJob" "amazonka-glacier-1.4.5-1XURZNaWj8uGGcizdrtXIY" 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 # 

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 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 - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
  • gjdJobId - An opaque string that identifies an Amazon Glacier job.
  • 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
  • gjdInventoryRetrievalParameters - Parameters used for range inventory retrieval.
  • gjdAction - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
  • gjdJobDescription - The job description you provided when you initiated the job.
  • gjdSNSTopic - An Amazon Simple Notification Service (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 the archive retrieval was requested.
  • gjdTier - The retrieval option to use for the 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 jobs, this field is null.
  • gjdCreationDate - 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 - The job status. When a job is completed, you get the job's output.
  • gjdCompletionDate - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
  • gjdInventorySizeInBytes - 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 - 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 - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

data GlacierJobDescription #

Describes an Amazon Glacier job.

See: glacierJobDescription smart constructor.

Instances

Eq GlacierJobDescription # 
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 # 
Show GlacierJobDescription # 
Generic GlacierJobDescription # 
Hashable GlacierJobDescription # 
FromJSON GlacierJobDescription # 
NFData GlacierJobDescription # 

Methods

rnf :: GlacierJobDescription -> () #

type Rep GlacierJobDescription # 
type Rep GlacierJobDescription = D1 (MetaData "GlacierJobDescription" "Network.AWS.Glacier.Types.Product" "amazonka-glacier-1.4.5-1XURZNaWj8uGGcizdrtXIY" 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 "_gjdJobId") 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 "_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 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.

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.

gjdTier :: Lens' GlacierJobDescription (Maybe Text) #

The retrieval option to use for the 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 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.