Skip to content

SQS  >  Operations  >  list_queues

list_queues

Operation

list_queues async 

list_queues(input: ListQueuesInput, plugins: list[Plugin] | None = None) -> ListQueuesOutput

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.

Parameters:

Name Type Description Default
input ListQueuesInput

An instance of ListQueuesInput.

 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
ListQueuesOutput

An instance of ListQueuesOutput.

Input

ListQueuesInput 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_name_prefix class-attribute instance-attribute 
queue_name_prefix: str | None = None

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.

Output

ListQueuesOutput dataclass

A list of your 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 class-attribute instance-attribute 
queue_urls: list[str] | None = None

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

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.