| Copyright | (c) 2013-2017 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 |
Network.AWS.Batch.DescribeJobQueues
Description
Describes one or more of your job queues.
- describeJobQueues :: DescribeJobQueues
- data DescribeJobQueues
- djqNextToken :: Lens' DescribeJobQueues (Maybe Text)
- djqJobQueues :: Lens' DescribeJobQueues [Text]
- djqMaxResults :: Lens' DescribeJobQueues (Maybe Int)
- describeJobQueuesResponse :: Int -> DescribeJobQueuesResponse
- data DescribeJobQueuesResponse
- djqsrsNextToken :: Lens' DescribeJobQueuesResponse (Maybe Text)
- djqsrsJobQueues :: Lens' DescribeJobQueuesResponse [JobQueueDetail]
- djqsrsResponseStatus :: Lens' DescribeJobQueuesResponse Int
Creating a Request
describeJobQueues :: DescribeJobQueues Source #
Creates a value of DescribeJobQueues with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
djqNextToken- ThenextTokenvalue returned from a previous paginatedDescribeJobQueuesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.djqJobQueues- A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.djqMaxResults- The maximum number of results returned byDescribeJobQueuesin paginated output. When this parameter is used,DescribeJobQueuesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherDescribeJobQueuesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenDescribeJobQueuesreturns up to 100 results and anextTokenvalue if applicable.
data DescribeJobQueues Source #
See: describeJobQueues smart constructor.
Instances
Request Lenses
djqNextToken :: Lens' DescribeJobQueues (Maybe Text) Source #
The nextToken value returned from a previous paginated DescribeJobQueues 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.
djqJobQueues :: Lens' DescribeJobQueues [Text] Source #
A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
djqMaxResults :: Lens' DescribeJobQueues (Maybe Int) Source #
The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.
Destructuring the Response
describeJobQueuesResponse Source #
Arguments
| :: Int | |
| -> DescribeJobQueuesResponse |
Creates a value of DescribeJobQueuesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
djqsrsNextToken- ThenextTokenvalue to include in a futureDescribeJobQueuesrequest. When the results of aDescribeJobQueuesrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.djqsrsJobQueues- The list of job queues.djqsrsResponseStatus- -- | The response status code.
data DescribeJobQueuesResponse Source #
See: describeJobQueuesResponse smart constructor.
Response Lenses
djqsrsNextToken :: Lens' DescribeJobQueuesResponse (Maybe Text) Source #
The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues 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.
djqsrsJobQueues :: Lens' DescribeJobQueuesResponse [JobQueueDetail] Source #
The list of job queues.
djqsrsResponseStatus :: Lens' DescribeJobQueuesResponse Int Source #
- - | The response status code.