List Queues

sqs_list_queues

R Documentation

Returns a list of your queues in the current region¶

Description¶

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.

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.

Usage¶

sqs_list_queues(QueueNamePrefix, NextToken, MaxResults)

Arguments¶

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.

NextToken

Pagination token to request the next set of results.

MaxResults

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.

Value¶

A list with the following syntax:

list(
  QueueUrls = list(
    "string"
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_queues(
  QueueNamePrefix = "string",
  NextToken = "string",
  MaxResults = 123
)