Skip to main content

ISQSListQueuesRequest

Interface in AWS.SQS

Interface for ListQueues requests.

Ancestors

Properties

MaxResults

property MaxResults: TOptional<Integer>

The maximum number of results to return in a single request.

Valid range: 1 to 1000 results per request. If not specified, the response includes a maximum of 1000 results by default. Use this parameter to control the size of each response when dealing with large numbers of queues, helping to manage memory usage and response times in your application.

NextToken

property NextToken: string

The pagination token from a previous ListQueues request.

Use this token to continue listing results from where the previous request left off. This parameter should be empty for the first request in a pagination sequence. The token is returned in the NextToken field of the response when there are additional results available beyond the current page. Pagination tokens are opaque strings and should not be constructed manually. Always use the exact token value returned by the previous response.

QueueNamePrefix

property QueueNamePrefix: string

A prefix to filter queue names in the response.

If specified, only queues with names that begin with the specified value are returned. This parameter is optional; if not specified, all queues in the account are returned. The prefix comparison is case-sensitive and matches from the beginning of the queue name. For example, a prefix of My will match queues named MyQueue, MyTestQueue, but not TestMyQueue. Use this parameter to efficiently filter large numbers of queues when you're looking for queues with a specific naming pattern.