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 SQS Developer Guide.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"QueueUrl": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
Maximum number of results to include in the response. Value range is 1 to 1000. You must set
MaxResults
to receive a value forNextToken
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 Syntax
{
"NextToken": "string",
"queueUrls": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format 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 setMaxResults
in the request.Type: String
- queueUrls
-
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.
- InvalidAddress
-
The
accountId
is invalid.HTTP Status Code: 400
- InvalidSecurity
-
When the request to a queue is not HTTPS and SigV4.
HTTP Status Code: 400
- QueueDoesNotExist
-
The specified queue doesn't exist.
HTTP Status Code: 400
- RequestThrottled
-
The request was denied due to request throttling.
-
The rate of requests per second exceeds the Amazon KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon CloudHSM cluster associated with the Amazon CloudHSM key store is processing numerous commands, including those unrelated to the Amazon CloudHSM key store.
HTTP Status Code: 400
-
- UnsupportedOperation
-
Error code 400. Unsupported operation.
HTTP Status Code: 400
Examples
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 General Reference.
Example
Using Amazon JSON protocol (default)
Sample Request
POST / HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
X-Amz-Target: AmazonSQS.ListDeadLetterSourceQueues
X-Amz-Date: <Date>
Content-Type: application/x-amz-json-1.0
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
"QueueUrl": "https://sqs.us-east-1.amazonaws.com/177715257436/MyQueue"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <requestId>
Content-Length: <PayloadSizeBytes>
Date: <Date>
Content-Type: application/x-amz-json-1.0
{
"queueUrls": [
"https://sqs.us-east-1.amazonaws.com/123456789012/MySourceQueue</QueueUrl>"
]
}
Example
Using Amazon query protocol
Sample Request
POST /177715257436/MyQueue/ HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
Content-Type: application/x-www-form-urlencoded
X-Amz-Date: <Date>
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
Action=ListDeadLetterSourceQueues
Sample Response
HTTP/1.1 200 OK
<?xml version="1.0"?>
<ListDeadLetterSourceQueuesResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
<ListDeadLetterSourceQueuesResult/>
<ResponseMetadata>
<RequestId>8e70ce7e-e3d4-5109-9204-920e21745daf</RequestId>
</ResponseMetadata>
</ListDeadLetterSourceQueuesResponse>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: