Amazon Simple Queue Service
API Reference (API Version 2012-11-05)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ListQueues

Description

The ListQueues action returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the specified value are returned.

Request Parameters

The following table lists the special request parameters the ListQueues action uses in addition to the common request parameters all actions use. For more information, see Common Query Parameters.

NameDescriptionRequired

QueueNamePrefix

String to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Type: String

Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

No

Response Elements

The following table lists the response elements the ListQueues action returns in addition to the common response elements all actions return. For more information, see Responses section in the Amazon SQS Developer Guide.

NameDescription

QueueUrl

The queue URL for a queue. The response can contain up to 1000 QueueUrl elements.

Type: String

Ancestor: ListQueuesResult

Special Errors

The ListQueues action returns no special errors besides the common errors all actions return. For more information, see Common Errors.

Examples

The following example Query request returns the queues whose names begin with the letter "T".

Sample Request

http://sqs.us-east-1.amazonaws.com/
?Action=ListQueues
&QueueNamePrefix=t
&Version=2009-02-01
&SignatureMethod=HmacSHA256
&Expires=2009-04-18T22%3A52%3A43PST
&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE
&SignatureVersion=2
&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE

Sample Response

<ListQueuesResponse>
    <ListQueuesResult>
        <QueueUrl>
            http://sqs.us-east-1.amazonaws.com/123456789012/testQueue
        </QueueUrl>
    </ListQueuesResult>
    <ResponseMetadata>
        <RequestId>
            725275ae-0b9b-4762-b238-436d7c65a1ac
        </RequestId>
    </ResponseMetadata>
</ListQueuesResponse>