Network.AWS.Glacier.ListJobs

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.

Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.

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 the underlying REST API, go to List Jobs

This operation returns paginated results.

Creating a Request

listJobs

Arguments

:: Text

ljAccountId

-> Text

ljVaultName

-> ListJobs

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

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

• ljMarker
• ljCompleted
• ljLimit
• ljStatuscode
• ljAccountId
• ljVaultName

data ListJobs

Provides options for retrieving a job list for an Amazon Glacier vault.

See: listJobs smart constructor.

Instances

Eq ListJobs

Methods

(==) :: ListJobs -> ListJobs -> Bool

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

Data ListJobs

Methods

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

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

toConstr :: ListJobs -> Constr

dataTypeOf :: ListJobs -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListJobs

Methods

readsPrec :: Int -> ReadS ListJobs

readList :: ReadS [ListJobs]

readPrec :: ReadPrec ListJobs

readListPrec :: ReadPrec [ListJobs]

Show ListJobs

Methods

showsPrec :: Int -> ListJobs -> ShowS

show :: ListJobs -> String

showList :: [ListJobs] -> ShowS

Generic ListJobs

Associated Types

type Rep ListJobs :: * -> *

Methods

from :: ListJobs -> Rep ListJobs x

to :: Rep ListJobs x -> ListJobs

Hashable ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int

hash :: ListJobs -> Int

NFData ListJobs

Methods

rnf :: ListJobs -> ()

AWSPager ListJobs

Methods

page :: ListJobs -> Rs ListJobs -> Maybe ListJobs

AWSRequest ListJobs

Associated Types

type Rs ListJobs :: *

Methods

request :: ListJobs -> Request ListJobs

response :: MonadResource m => Logger -> Service -> Proxy * ListJobs -> ClientResponse -> m (Response ListJobs)

ToPath ListJobs

Methods

toPath :: ListJobs -> ByteString

ToHeaders ListJobs

Methods

toHeaders :: ListJobs -> [Header]

ToQuery ListJobs

Methods

toQuery :: ListJobs -> QueryString

type Rep ListJobs

type Rep ListJobs = D1 (MetaData "ListJobs" "Network.AWS.Glacier.ListJobs" "amazonka-glacier-1.4.2-7zfGXRdnBgyLD0x24wdsS" False) (C1 (MetaCons "ListJobs'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ljMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljCompleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ljLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ljStatuscode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ljVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs ListJobs

type Rs ListJobs = ListJobsResponse

Request Lenses

ljMarker :: Lens' ListJobs (Maybe Text)

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

ljCompleted :: Lens' ListJobs (Maybe Text)

Specifies the state of the jobs to return. You can specify true or false.

ljLimit :: Lens' ListJobs (Maybe Text)

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

ljStatuscode :: Lens' ListJobs (Maybe Text)

Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

ljAccountId :: Lens' ListJobs 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.

ljVaultName :: Lens' ListJobs Text

The name of the vault.

Destructuring the Response

listJobsResponse

Arguments

:: Int

ljrsResponseStatus

-> ListJobsResponse

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

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

• ljrsMarker
• ljrsJobList
• ljrsResponseStatus

data ListJobsResponse

Contains the Amazon Glacier response to your request.

See: listJobsResponse smart constructor.

Instances

Eq ListJobsResponse

Methods

(==) :: ListJobsResponse -> ListJobsResponse -> Bool

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

Data ListJobsResponse

Methods

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

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

toConstr :: ListJobsResponse -> Constr

dataTypeOf :: ListJobsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListJobsResponse

Methods

readsPrec :: Int -> ReadS ListJobsResponse

readList :: ReadS [ListJobsResponse]

readPrec :: ReadPrec ListJobsResponse

readListPrec :: ReadPrec [ListJobsResponse]

Show ListJobsResponse

Methods

showsPrec :: Int -> ListJobsResponse -> ShowS

show :: ListJobsResponse -> String

showList :: [ListJobsResponse] -> ShowS

Generic ListJobsResponse

Associated Types

type Rep ListJobsResponse :: * -> *

Methods

from :: ListJobsResponse -> Rep ListJobsResponse x

to :: Rep ListJobsResponse x -> ListJobsResponse

NFData ListJobsResponse

Methods

rnf :: ListJobsResponse -> ()

type Rep ListJobsResponse

type Rep ListJobsResponse = D1 (MetaData "ListJobsResponse" "Network.AWS.Glacier.ListJobs" "amazonka-glacier-1.4.2-7zfGXRdnBgyLD0x24wdsS" False) (C1 (MetaCons "ListJobsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ljrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljrsJobList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GlacierJobDescription]))) (S1 (MetaSel (Just Symbol "_ljrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

ljrsMarker :: Lens' ListJobsResponse (Maybe Text)

An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is null.

ljrsJobList :: Lens' ListJobsResponse [GlacierJobDescription]

A list of job objects. Each job object contains metadata describing the job.

ljrsResponseStatus :: Lens' ListJobsResponse Int

The response status code.