listQueues method

Future<ListQueuesResult> listQueues({
  1. int? maxResults,
  2. String? nextToken,
  3. String? queueNamePrefix,
})

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

The listQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to listQueues to receive the next page of results.

Parameter maxResults : Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

Parameter nextToken : Pagination token to request the next set of results.

Parameter queueNamePrefix : A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Implementation

Future<ListQueuesResult> listQueues({
  int? maxResults,
  String? nextToken,
  String? queueNamePrefix,
}) async {
  final $request = <String, dynamic>{};
  maxResults?.also((arg) => $request['MaxResults'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  queueNamePrefix?.also((arg) => $request['QueueNamePrefix'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListQueues',
    version: '2012-11-05',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListQueuesRequest'],
    shapes: shapes,
    resultWrapper: 'ListQueuesResult',
  );
  return ListQueuesResult.fromXml($result);
}