AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListQueues operation. 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 User Name in the Amazon Simple Queue Service Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SQS.AmazonSQSRequest
      Amazon.SQS.Model.ListQueuesRequest

Namespace: Amazon.SQS.Model
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

C#
public class ListQueuesRequest : AmazonSQSRequest
         IAmazonWebServiceRequest

The ListQueuesRequest type exposes the following members

Constructors

NameDescription
Public Method ListQueuesRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method ListQueuesRequest(string)

Instantiates ListQueuesRequest with the parameterized properties

Properties

NameTypeDescription
Public Property MaxResults System.Int32

Gets and sets the property 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.

Public Property NextToken System.String

Gets and sets the property NextToken.

Pagination token to request the next set of results.

Public Property QueueNamePrefix System.String

Gets and sets the property 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.

Examples

This example shows how to list queues.

List queues example

var client = new AmazonSQSClient();

// List all queues that start with "My".
var request = new ListQueuesRequest
{
  QueueNamePrefix = "My"
};

var response = client.ListQueues(request);

if (response.QueueUrls.Count > 0)
{
  Console.WriteLine("Queue URLs:");

  foreach (var url in response.QueueUrls)
  {
    Console.WriteLine("  " + url);
  }
}
else
{
  Console.WriteLine("No matching queues.");
}
      

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5