|
30 | 30 | * |
31 | 31 | * Visit <a href="http://aws.amazon.com/sqs/">http://aws.amazon.com/sqs/</a> for more information. |
32 | 32 | * |
33 | | - * @version 2012.01.29 |
| 33 | + * @version 2012.10.04 |
34 | 34 | * @license See the included NOTICE.md file for complete information. |
35 | 35 | * @copyright See the included NOTICE.md file for complete information. |
36 | 36 | * @link http://aws.amazon.com/sqs/ Amazon Simple Queue Service |
@@ -134,7 +134,7 @@ class AmazonSQS extends CFRuntime |
134 | 134 | */ |
135 | 135 | public function __construct(array $options = array()) |
136 | 136 | { |
137 | | - $this->api_version = '2011-10-01'; |
| 137 | + $this->api_version = '2012-09-15'; |
138 | 138 | $this->hostname = self::DEFAULT_URL; |
139 | 139 | $this->auth_class = 'AuthV2Query'; |
140 | 140 |
|
@@ -398,7 +398,7 @@ public function change_message_visibility_batch($queue_url, $change_message_visi |
398 | 398 | * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul> |
399 | 399 | * <li><code>Attribute</code> - <code>array</code> - Optional - A map of attributes with their corresponding values. <ul> |
400 | 400 | * <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul> |
401 | | - * <li><code>Name</code> - <code>string</code> - Optional - The name of a queue attribute. [Allowed values: <code>Policy</code>, <code>VisibilityTimeout</code>, <code>MaximumMessageSize</code>, <code>MessageRetentionPeriod</code>, <code>ApproximateNumberOfMessages</code>, <code>ApproximateNumberOfMessagesNotVisible</code>, <code>CreatedTimestamp</code>, <code>LastModifiedTimestamp</code>, <code>QueueArn</code>, <code>ApproximateNumberOfMessagesDelayed</code>, <code>DelaySeconds</code>]</li> |
| 401 | + * <li><code>Name</code> - <code>string</code> - Optional - The name of a queue attribute. [Allowed values: <code>Policy</code>, <code>VisibilityTimeout</code>, <code>MaximumMessageSize</code>, <code>MessageRetentionPeriod</code>, <code>ApproximateNumberOfMessages</code>, <code>ApproximateNumberOfMessagesNotVisible</code>, <code>CreatedTimestamp</code>, <code>LastModifiedTimestamp</code>, <code>QueueArn</code>, <code>ApproximateNumberOfMessagesDelayed</code>, <code>DelaySeconds</code>, <code>ReceiveMessageWaitTimeSeconds</code>]</li> |
402 | 402 | * <li><code>Value</code> - <code>string</code> - Optional - The value of a queue attribute.</li> |
403 | 403 | * </ul></li> |
404 | 404 | * </ul></li> |
@@ -522,6 +522,8 @@ public function delete_queue($queue_url, $opt = null) |
522 | 522 | * <li><code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of |
523 | 523 | * messages that are pending to be added to the queue.</li> |
524 | 524 | * <li><code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li> |
| 525 | + * <li><code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage |
| 526 | + * call will wait for a message to arrive.</li> |
525 | 527 | * </ul> |
526 | 528 | * |
527 | 529 | * @param string $queue_url (Required) The URL of the SQS queue to take action on. |
@@ -589,12 +591,22 @@ public function list_queues($opt = null) |
589 | 591 | * returned on subsequent <code>ReceiveMessage</code> requests for the duration of the |
590 | 592 | * <code>VisibilityTimeout</code>. If you do not specify a <code>VisibilityTimeout</code> in the |
591 | 593 | * request, the overall visibility timeout for the queue is used for the returned messages. |
| 594 | + * |
| 595 | + * If a message is available in the queue, the call will return immediately. Otherwise, it will |
| 596 | + * wait up to <code>WaitTimeSeconds</code> for a message to arrive. If you do not specify |
| 597 | + * <code>WaitTimeSeconds</code> in the request, the queue attribute ReceiveMessageWaitTimeSeconds |
| 598 | + * is used to determine how long to wait. |
| 599 | + * |
| 600 | + * You could ask for additional information about each message through the attributes. Attributes |
| 601 | + * that can be requested are <code>[SenderId, ApproximateFirstReceiveTimestamp, |
| 602 | + * ApproximateReceiveCount, SentTimestamp]</code>. |
592 | 603 | * |
593 | 604 | * @param string $queue_url (Required) The URL of the SQS queue to take action on. |
594 | 605 | * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul> |
595 | | - * <li><code>AttributeName</code> - <code>string|array</code> - Optional - A list of attributes to retrieve information for. Pass a string for a single value, or an indexed array for multiple values.</li> |
| 606 | + * <li><code>AttributeName</code> - <code>string|array</code> - Optional - A list of attributes that need to be returned along with each message. The set of valid attributes are [SenderId, ApproximateFirstReceiveTimestamp, ApproximateReceiveCount, SentTimestamp]. Pass a string for a single value, or an indexed array for multiple values.</li> |
596 | 607 | * <li><code>MaxNumberOfMessages</code> - <code>integer</code> - Optional - The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. All of the messages are not necessarily returned.</li> |
597 | 608 | * <li><code>VisibilityTimeout</code> - <code>integer</code> - Optional - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</li> |
| 609 | + * <li><code>WaitTimeSeconds</code> - <code>integer</code> - Optional - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.</li> |
598 | 610 | * <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li> |
599 | 611 | * <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul> |
600 | 612 | * @return CFResponse A <CFResponse> object containing a parsed HTTP response. |
@@ -689,13 +701,14 @@ public function send_message_batch($queue_url, $send_message_batch_request_entry |
689 | 701 | } |
690 | 702 |
|
691 | 703 | /** |
692 | | - * Sets an attribute of a queue. The set of attributes that can be set are - DelaySeconds, |
693 | | - * MessageRetentionPeriod, MaximumMessageSize, VisibilityTimeout and Policy. |
| 704 | + * Sets the value of one or more queue attributes. Valid attributes that can be set are |
| 705 | + * [VisibilityTimeout, Policy, MaximumMessageSize, MessageRetentionPeriod, |
| 706 | + * ReceiveMessageWaitTimeSeconds]. |
694 | 707 | * |
695 | 708 | * @param string $queue_url (Required) The URL of the SQS queue to take action on. |
696 | 709 | * @param array $attribute (Required) A map of attributes to set. <ul> |
697 | 710 | * <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul> |
698 | | - * <li><code>Name</code> - <code>string</code> - Optional - The name of a queue attribute. [Allowed values: <code>Policy</code>, <code>VisibilityTimeout</code>, <code>MaximumMessageSize</code>, <code>MessageRetentionPeriod</code>, <code>ApproximateNumberOfMessages</code>, <code>ApproximateNumberOfMessagesNotVisible</code>, <code>CreatedTimestamp</code>, <code>LastModifiedTimestamp</code>, <code>QueueArn</code>, <code>ApproximateNumberOfMessagesDelayed</code>, <code>DelaySeconds</code>]</li> |
| 711 | + * <li><code>Name</code> - <code>string</code> - Optional - The name of a queue attribute. [Allowed values: <code>Policy</code>, <code>VisibilityTimeout</code>, <code>MaximumMessageSize</code>, <code>MessageRetentionPeriod</code>, <code>ApproximateNumberOfMessages</code>, <code>ApproximateNumberOfMessagesNotVisible</code>, <code>CreatedTimestamp</code>, <code>LastModifiedTimestamp</code>, <code>QueueArn</code>, <code>ApproximateNumberOfMessagesDelayed</code>, <code>DelaySeconds</code>, <code>ReceiveMessageWaitTimeSeconds</code>]</li> |
699 | 712 | * <li><code>Value</code> - <code>string</code> - Optional - The value of a queue attribute.</li> |
700 | 713 | * </ul></li> |
701 | 714 | * </ul> |
|
0 commit comments