Skip to content

SQS  >  Operations  >  list_dead_letter_source_queues

list_dead_letter_source_queues

Operation

list_dead_letter_source_queues async 

list_dead_letter_source_queues(input: ListDeadLetterSourceQueuesInput, plugins: list[Plugin] | None = None) -> ListDeadLetterSourceQueuesOutput

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.

Parameters:

Name Type Description Default
input ListDeadLetterSourceQueuesInput

An instance of ListDeadLetterSourceQueuesInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListDeadLetterSourceQueuesOutput

An instance of ListDeadLetterSourceQueuesOutput.

Input

ListDeadLetterSourceQueuesInput dataclass

Attributes

max_results class-attribute instance-attribute 
max_results: int | None = None

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.

next_token class-attribute instance-attribute 
next_token: str | None = None

Pagination token to request the next set of results.

queue_url class-attribute instance-attribute 
queue_url: str | None = None

The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

Output

ListDeadLetterSourceQueuesOutput dataclass

A list of your dead letter source queues.

Attributes

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

queue_urls instance-attribute 
queue_urls: list[str]

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.