Packagecom.amazonaws.services.sqs
Interfacepublic interface AmazonSQS extends flash.events.IEventDispatcher
Implementors AmazonSQSClient

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : January 24. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Interface for accessing AmazonSQS. Amazon Simple Queue Service Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable, hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed components of their applications that perform different tasks, without losing messages or requiring each component to be always available. Amazon SQS makes it easy to build an automated workflow, working in close conjunction with the Amazon Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web services. Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.



Public Methods
 MethodDefined By
  
addPermission(addPermissionRequest:AddPermissionRequest):void
The AddPermission action adds a permission to a queue for a specific principal.
AmazonSQS
  
changeMessageVisibility(changeMessageVisibilityRequest:ChangeMessageVisibilityRequest):void
The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value.
AmazonSQS
  
createQueue(createQueueRequest:CreateQueueRequest):void
The CreateQueue action creates a new queue, or returns the URL of an existing one.
AmazonSQS
  
deleteMessage(deleteMessageRequest:DeleteMessageRequest):void
The DeleteMessage action unconditionally removes the specified message from the specified queue.
AmazonSQS
  
deleteQueue(deleteQueueRequest:DeleteQueueRequest):void
This action unconditionally deletes the queue specified by the queue URL.
AmazonSQS
  
getQueueAttributes(getQueueAttributesRequest:GetQueueAttributesRequest):void
Gets one or all attributes of a queue.
AmazonSQS
  
listQueues(listQueuesRequest:ListQueuesRequest = null):void
The ListQueues action returns a list of your queues.
AmazonSQS
  
receiveMessage(receiveMessageRequest:ReceiveMessageRequest):void
Retrieves one or more messages from the specified queue, including the message body and message ID of each message.
AmazonSQS
  
Removing all event listeners and releasing any resources that might be held open.
AmazonSQS
  
removePermission(removePermissionRequest:RemovePermissionRequest):void
The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter.
AmazonSQS
  
sendMessage(sendMessageRequest:SendMessageRequest):void
The SendMessage action delivers a message to the specified queue.
AmazonSQS
  
Sets an attribute of a queue.
AmazonSQS
Method Detail
addPermission()method
public function addPermission(addPermissionRequest:AddPermissionRequest):void

The AddPermission action adds a permission to a queue for a specific principal. This allows for sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see 'Shared Queues' in the Amazon SQS Developer Guide.

Parameters

addPermissionRequest:AddPermissionRequest — Container for the necessary parameters to execute the AddPermission service method on AmazonSQS.

changeMessageVisibility()method 
public function changeMessageVisibility(changeMessageVisibilityRequest:ChangeMessageVisibilityRequest):void

The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.) For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

IMPORTANT: If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

IMPORTANT: Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

Parameters

changeMessageVisibilityRequest:ChangeMessageVisibilityRequest — Container for the necessary parameters to execute the ChangeMessageVisibility service method on AmazonSQS.

createQueue()method 
public function createQueue(createQueueRequest:CreateQueueRequest):void

The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned.

Parameters

createQueueRequest:CreateQueueRequest — Container for the necessary parameters to execute the CreateQueue service method on AmazonSQS.

deleteMessage()method 
public function deleteMessage(deleteMessageRequest:DeleteMessageRequest):void

The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.

Parameters

deleteMessageRequest:DeleteMessageRequest — Container for the necessary parameters to execute the DeleteMessage service method on AmazonSQS.

deleteQueue()method 
public function deleteQueue(deleteQueueRequest:DeleteQueueRequest):void

This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.

Parameters

deleteQueueRequest:DeleteQueueRequest — Container for the necessary parameters to execute the DeleteQueue service method on AmazonSQS.

getQueueAttributes()method 
public function getQueueAttributes(getQueueAttributesRequest:GetQueueAttributesRequest):void

Gets one or all attributes of a queue. Queues currently have nine (9) attributes you can get:

Parameters

getQueueAttributesRequest:GetQueueAttributesRequest — Container for the necessary parameters to execute the GetQueueAttributes service method on AmazonSQS.

listQueues()method 
public function listQueues(listQueuesRequest:ListQueuesRequest = null):void

The ListQueues action returns a list of your queues.

Parameters

listQueuesRequest:ListQueuesRequest (default = null) — Container for the necessary parameters to execute the ListQueues service method on AmazonSQS. If null then all available queue URLs will be returned.

receiveMessage()method 
public function receiveMessage(receiveMessageRequest:ReceiveMessageRequest):void

Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.

Parameters

receiveMessageRequest:ReceiveMessageRequest — Container for the necessary parameters to execute the ReceiveMessage service method on AmazonSQS.

releaseResources()method 
public function releaseResources():void

Removing all event listeners and releasing any resources that might be held open.

removePermission()method 
public function removePermission(removePermissionRequest:RemovePermissionRequest):void

The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Parameters

removePermissionRequest:RemovePermissionRequest — Container for the necessary parameters to execute the RemovePermission service method on AmazonSQS.

sendMessage()method 
public function sendMessage(sendMessageRequest:SendMessageRequest):void

The SendMessage action delivers a message to the specified queue.

Parameters

sendMessageRequest:SendMessageRequest — Container for the necessary parameters to execute the SendMessage service method on AmazonSQS.

setQueueAttributes()method 
public function setQueueAttributes(setQueueAttributes:SetQueueAttributesRequest):void

Sets an attribute of a queue. Currently, queues currently have four (4) attributes you can set:

Parameters

setQueueAttributes:SetQueueAttributesRequest — Container for the necessary parameters to execute the SetQueueAttributes service method on AmazonSQS.