SQS / Client / list_queues

list_queues#

SQS.Client.list_queues(**kwargs)#

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

The listQueues 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 listQueues to receive the next page of results.

Note

Cross-account permissions don’t apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_queues(
    QueueNamePrefix='string',
    NextToken='string',
    MaxResults=123
)
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.

  • 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 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. 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.RequestThrottled

  • SQS.Client.exceptions.InvalidSecurity

  • SQS.Client.exceptions.InvalidAddress

  • SQS.Client.exceptions.UnsupportedOperation