SQS / Paginator / ListQueues

ListQueues

class SQS.Paginator.ListQueues

paginator = client.get_paginator('list_queues')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SQS.Client.list_queues().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    QueueNamePrefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• QueueNamePrefix (string) –

  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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'QueueUrls': [
        '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) –