| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Batch.DescribeJobQueues
Description
Describes one or more of your job queues.
This operation returns paginated results.
Synopsis
- data DescribeJobQueues = DescribeJobQueues' {}
- newDescribeJobQueues :: DescribeJobQueues
- describeJobQueues_jobQueues :: Lens' DescribeJobQueues (Maybe [Text])
- describeJobQueues_maxResults :: Lens' DescribeJobQueues (Maybe Int)
- describeJobQueues_nextToken :: Lens' DescribeJobQueues (Maybe Text)
- data DescribeJobQueuesResponse = DescribeJobQueuesResponse' {
- jobQueues :: Maybe [JobQueueDetail]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeJobQueuesResponse :: Int -> DescribeJobQueuesResponse
- describeJobQueuesResponse_jobQueues :: Lens' DescribeJobQueuesResponse (Maybe [JobQueueDetail])
- describeJobQueuesResponse_nextToken :: Lens' DescribeJobQueuesResponse (Maybe Text)
- describeJobQueuesResponse_httpStatus :: Lens' DescribeJobQueuesResponse Int
Creating a Request
data DescribeJobQueues Source #
Contains the parameters for DescribeJobQueues.
See: newDescribeJobQueues smart constructor.
Constructors
| DescribeJobQueues' | |
Fields
| |
Instances
newDescribeJobQueues :: DescribeJobQueues Source #
Create a value of DescribeJobQueues with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeJobQueues, describeJobQueues_jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
entries.
$sel:maxResults:DescribeJobQueues', describeJobQueues_maxResults - 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 and 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 isn't used, then DescribeJobQueues returns up to 100
results and a nextToken value if applicable.
DescribeJobQueues, describeJobQueues_nextToken - 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.
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Request Lenses
describeJobQueues_jobQueues :: Lens' DescribeJobQueues (Maybe [Text]) Source #
A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
describeJobQueues_maxResults :: 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 and 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 isn't used, then DescribeJobQueues returns up to 100
results and a nextToken value if applicable.
describeJobQueues_nextToken :: 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.
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Destructuring the Response
data DescribeJobQueuesResponse Source #
See: newDescribeJobQueuesResponse smart constructor.
Constructors
| DescribeJobQueuesResponse' | |
Fields
| |
Instances
newDescribeJobQueuesResponse Source #
Create a value of DescribeJobQueuesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeJobQueues, describeJobQueuesResponse_jobQueues - The list of job queues.
DescribeJobQueues, describeJobQueuesResponse_nextToken - 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.
$sel:httpStatus:DescribeJobQueuesResponse', describeJobQueuesResponse_httpStatus - The response's http status code.
Response Lenses
describeJobQueuesResponse_jobQueues :: Lens' DescribeJobQueuesResponse (Maybe [JobQueueDetail]) Source #
The list of job queues.
describeJobQueuesResponse_nextToken :: 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.
describeJobQueuesResponse_httpStatus :: Lens' DescribeJobQueuesResponse Int Source #
The response's http status code.