list_queues ( $opt )

Returns a list of your queues.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • QueueNamePrefix - string - Optional - A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

List all of your SQS queues.

// List queues
$sqs = new AmazonSQS();
$response = $sqs->list_queues();

// Success?
var_dump($response->isOK());
Result:
bool(true)

List all of your SQS queues that begin with a given prefix.

// List queues with prefix 'a'
$sqs = new AmazonSQS();
$response = $sqs->list_queues(array(
	'QueueNamePrefix' => 'a'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/sqs.class.php | Toggle source view (6 lines) | View on GitHub

public function list_queues($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('ListQueues', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback