SQS / Client / list_dead_letter_source_queues

list_dead_letter_source_queues#

SQS.Client.list_dead_letter_source_queues(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_dead_letter_source_queues(
    QueueUrl='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • QueueUrl (string) –

    [REQUIRED]

    The URL of a dead-letter queue.

    Queue URLs and names are case-sensitive.

  • NextToken (string) – Pagination token to request the next set of results.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'queueUrls': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A list of your dead letter source queues.

    • queueUrls (list) –

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

      • (string) –

    • NextToken (string) –

      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.

Exceptions

  • SQS.Client.exceptions.QueueDoesNotExist

  • SQS.Client.exceptions.RequestThrottled

  • SQS.Client.exceptions.InvalidSecurity

  • SQS.Client.exceptions.InvalidAddress

  • SQS.Client.exceptions.UnsupportedOperation