amazonka-batch-1.6.0: Amazon Batch SDK.

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

Network.AWS.Batch.ListJobs

Contents

Description

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

Synopsis

Creating a Request

listJobs :: ListJobs Source #

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:

  • ljNextToken - The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • ljJobStatus - The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.
  • ljArrayJobId - The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
  • ljJobQueue - The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
  • ljMaxResults - The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

data ListJobs Source #

See: listJobs smart constructor.

Instances

Eq ListJobs Source # 
Data ListJobs Source # 

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 Source # 
Show ListJobs Source # 
Generic ListJobs Source # 

Associated Types

type Rep ListJobs :: * -> * #

Methods

from :: ListJobs -> Rep ListJobs x #

to :: Rep ListJobs x -> ListJobs #

Hashable ListJobs Source # 

Methods

hashWithSalt :: Int -> ListJobs -> Int #

hash :: ListJobs -> Int #

ToJSON ListJobs Source # 
NFData ListJobs Source # 

Methods

rnf :: ListJobs -> () #

AWSRequest ListJobs Source # 
ToHeaders ListJobs Source # 

Methods

toHeaders :: ListJobs -> [Header] #

ToPath ListJobs Source # 
ToQuery ListJobs Source # 
type Rep ListJobs Source # 
type Rep ListJobs = D1 * (MetaData "ListJobs" "Network.AWS.Batch.ListJobs" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "ListJobs'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ljNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobStatus)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljArrayJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljJobQueue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))
type Rs ListJobs Source # 

Request Lenses

ljNextToken :: Lens' ListJobs (Maybe Text) Source #

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

ljJobStatus :: Lens' ListJobs (Maybe JobStatus) Source #

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

ljArrayJobId :: Lens' ListJobs (Maybe Text) Source #

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

ljJobQueue :: Lens' ListJobs (Maybe Text) Source #

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

ljMaxResults :: Lens' ListJobs (Maybe Int) Source #

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

listJobsResponse Source #

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:

  • ljrsNextToken - The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
  • ljrsResponseStatus - -- | The response status code.
  • ljrsJobSummaryList - A list of job summaries that match the request.

data ListJobsResponse Source #

See: listJobsResponse smart constructor.

Instances

Eq ListJobsResponse Source # 
Data ListJobsResponse Source # 

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 Source # 
Show ListJobsResponse Source # 
Generic ListJobsResponse Source # 
NFData ListJobsResponse Source # 

Methods

rnf :: ListJobsResponse -> () #

type Rep ListJobsResponse Source # 
type Rep ListJobsResponse = D1 * (MetaData "ListJobsResponse" "Network.AWS.Batch.ListJobs" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "ListJobsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_ljrsJobSummaryList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [JobSummary])))))

Response Lenses

ljrsNextToken :: Lens' ListJobsResponse (Maybe Text) Source #

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

ljrsResponseStatus :: Lens' ListJobsResponse Int Source #

  • - | The response status code.

ljrsJobSummaryList :: Lens' ListJobsResponse [JobSummary] Source #

A list of job summaries that match the request.