Network.AWS.Batch.ListJobs

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.

Creating a Request

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

• 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

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

ToJSON ListJobs

Methods

toJSON :: ListJobs -> Value

toEncoding :: ListJobs -> Encoding

toJSONList :: [ListJobs] -> Value

toEncodingList :: [ListJobs] -> Encoding

NFData ListJobs

Methods

rnf :: ListJobs -> ()

AWSRequest ListJobs

Associated Types

type Rs ListJobs :: *

Methods

request :: ListJobs -> Request ListJobs

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

ToHeaders ListJobs

Methods

toHeaders :: ListJobs -> [Header]

ToPath ListJobs

Methods

toPath :: ListJobs -> ByteString

ToQuery ListJobs

Methods

toQuery :: ListJobs -> QueryString

type Rep ListJobs

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

type Rs ListJobs = ListJobsResponse

Request Lenses

ljNextToken :: Lens' ListJobs (Maybe Text)

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)

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)

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)

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

ljMaxResults :: Lens' ListJobs (Maybe Int)

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

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

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

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

• - | The response status code.

ljrsJobSummaryList :: Lens' ListJobsResponse [JobSummary]

A list of job summaries that match the request.