Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- listJobs :: ListJobs
- data ListJobs
- ljNextToken :: Lens' ListJobs (Maybe Text)
- ljJobStatus :: Lens' ListJobs (Maybe JobStatus)
- ljArrayJobId :: Lens' ListJobs (Maybe Text)
- ljJobQueue :: Lens' ListJobs (Maybe Text)
- ljMaxResults :: Lens' ListJobs (Maybe Int)
- listJobsResponse :: Int -> ListJobsResponse
- data ListJobsResponse
- ljrsNextToken :: Lens' ListJobsResponse (Maybe Text)
- ljrsResponseStatus :: Lens' ListJobsResponse Int
- ljrsJobSummaryList :: Lens' ListJobsResponse [JobSummary]
Creating a Request
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
- ThenextToken
value returned from a previous paginatedListJobs
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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, onlyRUNNING
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 byListJobs
in paginated output. When this parameter is used,ListJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListJobs
returns up to 100 results and anextToken
value if applicable.
See: listJobs
smart constructor.
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
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
- ThenextToken
value to include in a futureListJobs
request. When the results of aListJobs
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
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.
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.