Network.AWS.Glacier.ListJobs

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

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. For an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null . If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress , Succeeded , or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true ) or jobs that were not completed (false ).

For the underlying REST API, see 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 - 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 only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
• ljCompleted - The state of the jobs to return. You can specify true or false .
• ljLimit - The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
• ljStatuscode - The type of job status to return. You can specify the following values: InProgress , Succeeded , or Failed .
• ljAccountId - 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.
• ljVaultName - The name of the vault.

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)

ToQuery ListJobs

Methods

toQuery :: ListJobs -> QueryString

ToPath ListJobs

Methods

toPath :: ListJobs -> ByteString

ToHeaders ListJobs

Methods

toHeaders :: ListJobs -> [Header]

type Rep ListJobs

type Rep ListJobs = D1 (MetaData "ListJobs" "Network.AWS.Glacier.ListJobs" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" 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 only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

ljCompleted :: Lens' ListJobs (Maybe Text)

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

ljLimit :: Lens' ListJobs (Maybe Text)

The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

ljStatuscode :: Lens' ListJobs (Maybe Text)

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

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 - An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.
• ljrsJobList - A list of job objects. Each job object contains metadata describing the job.
• ljrsResponseStatus - -- | The response status code.

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.5.0-AWAt53IVogG613fTETHcMP" 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 used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.

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.