Amazon Simple Queue Service

2020/06/22 - Amazon Simple Queue Service - 2 updated api methods

Changes  AWS SQS adds pagination support for ListQueues and ListDeadLetterSourceQueues APIs

ListDeadLetterSourceQueues (updated) Link ¶
Changes (request, response)
Request
{'MaxResults': 'integer', 'NextToken': 'string'}
Response
{'NextToken': 'string'}

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide .

See also: AWS API Documentation

Request Syntax

client.list_dead_letter_source_queues(
    QueueUrl='string',
    NextToken='string',
    MaxResults=123
)
type QueueUrl

string

param QueueUrl

[REQUIRED]

The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

type NextToken

string

param NextToken

Pagination token to request the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to include in the response.

rtype

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.

ListQueues (updated) Link ¶
Changes (request, response)
Request
{'MaxResults': 'integer', 'NextToken': 'string'}
Response
{'NextToken': 'string'}

Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

Note

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide .

See also: AWS API Documentation

Request Syntax

client.list_queues(
    QueueNamePrefix='string',
    NextToken='string',
    MaxResults=123
)
type QueueNamePrefix

string

param QueueNamePrefix

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

type NextToken

string

param NextToken

Pagination token to request the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to include in the response.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    A list of your queues.

    • QueueUrls (list) --

      A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.

      • (string) --

    • NextToken (string) --

      Pagination token to include in the next request.