listDeadLetterSourceQueues method

Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueues({ required String queueUrl, int? maxResults, String? nextToken, })

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

The ListDeadLetterSourceQueues 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 ListDeadLetterSourceQueues to receive the next page of results.

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

May throw QueueDoesNotExist.

Parameter queueUrl : The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

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.

Implementation

Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueues({
  required String queueUrl,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(queueUrl, 'queueUrl');
  final $request = <String, dynamic>{};
  $request['QueueUrl'] = queueUrl;
  maxResults?.also((arg) => $request['MaxResults'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListDeadLetterSourceQueues',
    version: '2012-11-05',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListDeadLetterSourceQueuesRequest'],
    shapes: shapes,
    resultWrapper: 'ListDeadLetterSourceQueuesResult',
  );
  return ListDeadLetterSourceQueuesResult.fromXml($result);
}