describeJobQueues method

Future<DescribeJobQueuesResponse> describeJobQueues({ List<String>? jobQueues, int? maxResults, String? nextToken, })

Describes one or more of your job queues.

May throw ClientException. May throw ServerException.

Parameter jobQueues : A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Parameter 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 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 isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

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

Implementation

Future<DescribeJobQueuesResponse> describeJobQueues({
  List<String>? jobQueues,
  int? maxResults,
  String? nextToken,
}) async {
  final $payload = <String, dynamic>{
    if (jobQueues != null) 'jobQueues': jobQueues,
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v1/describejobqueues',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeJobQueuesResponse.fromJson(response);
}