list_dead_letter_source_queues¶
Operation¶
list_dead_letter_source_queues
¶
list_dead_letter_source_queues(request: ListDeadLetterSourceQueuesInput | ListDeadLetterSourceQueuesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDeadLetterSourceQueuesInputDict]) -> 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 |
|---|---|---|---|
request
|
ListDeadLetterSourceQueuesInput | ListDeadLetterSourceQueuesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListDeadLetterSourceQueuesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListDeadLetterSourceQueuesOutput
|
An instance of |
list_dead_letter_source_queues
async
¶
list_dead_letter_source_queues(request: ListDeadLetterSourceQueuesInput | ListDeadLetterSourceQueuesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDeadLetterSourceQueuesInputDict]) -> 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 |
|---|---|---|---|
request
|
ListDeadLetterSourceQueuesInput | ListDeadLetterSourceQueuesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListDeadLetterSourceQueuesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListDeadLetterSourceQueuesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListDeadLetterSourceQueuesInputDict
¶
Bases: TypedDict
Dictionary form of ListDeadLetterSourceQueuesInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | 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.
ListDeadLetterSourceQueuesInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | 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.
Output¶
ListDeadLetterSourceQueuesOutput
dataclass
¶
Bases: _SerdeShape
A list of your dead letter source queues.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | 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
¶
A list of source queue URLs that have the RedrivePolicy queue
attribute configured with a dead-letter queue.
response_metadata
class-attribute
instance-attribute
¶
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.