ListDeadLetterSourceQueues - Amazon Simple Queue Service
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

ListDeadLetterSourceQueues

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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.

Type: Integer

Required: No

NextToken

Pagination token to request the next set of results.

Type: String

Required: No

QueueUrl

The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

NextToken

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

Type: String

QueueUrl.N

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

AWS.SimpleQueueService.NonExistentQueue

The specified queue doesn't exist.

HTTP Status Code: 400

Example

The following example query request returns a list of dead letter source queues. In this example, only one source queue, MySourceQueue, is configured with a dead-letter queue. The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.

Sample Request

?Action=ListDeadLetterSourceQueues &Expires=2020-12-12T22%3A52%3A43PST &Version=2012-11-05 &AUTHPARAMS

Sample Response

<ListDeadLetterSourceQueuesResponse xmlns="https://queue.amazonaws.com/doc/2012-11-05/"> <ListDeadLetterSourceQueuesResult> <QueueUrl>https://sqs.us-east-2.amazonaws.com/123456789012/MySourceQueue</QueueUrl> </ListDeadLetterSourceQueuesResult> <ResponseMetadata> <RequestId>8ffb921f-b85e-53d9-abcf-d8d0057f38fc</RequestId> </ResponseMetadata> </ListDeadLetterSourceQueuesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: