Package | com.amazonaws.services.sqs |
Class | public class AmazonSQSClient |
Inheritance | AmazonSQSClient ![]() ![]() |
Implements | AmazonSQS |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Since : | January 24. 2011 |
Runtime Versions : | Flash Player 10.1, AIR 2.5 |
Method | Defined By | ||
---|---|---|---|
AmazonSQSClient | |||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
| AmazonSQSClient | ||
addPermission(addPermissionRequest:AddPermissionRequest):void
The AddPermission action adds a permission to a queue for a specific principal. | AmazonSQSClient | ||
changeMessageVisibility(changeMessageVisibilityRequest:ChangeMessageVisibilityRequest):void
The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value. | AmazonSQSClient | ||
createQueue(createQueueRequest:CreateQueueRequest):void
The CreateQueue action creates a new queue, or returns the URL of an existing one. | AmazonSQSClient | ||
deleteMessage(deleteMessageRequest:DeleteMessageRequest):void
The DeleteMessage action unconditionally removes the specified message from the specified queue. | AmazonSQSClient | ||
deleteQueue(deleteQueueRequest:DeleteQueueRequest):void
This action unconditionally deletes the queue specified by the queue URL. | AmazonSQSClient | ||
dispatchEvent(event:Event):Boolean [override]
| AmazonSQSClient | ||
getQueueAttributes(getQueueAttributesRequest:GetQueueAttributesRequest):void
Gets one or all attributes of a queue. | AmazonSQSClient | ||
hasEventListener(type:String):Boolean [override]
| AmazonSQSClient | ||
listQueues(listQueuesRequest:ListQueuesRequest = null):void
The ListQueues action returns a list of your queues. | AmazonSQSClient | ||
receiveMessage(receiveMessageRequest:ReceiveMessageRequest):void
Retrieves one or more messages from the specified queue, including the message body and message ID of each message. | AmazonSQSClient | ||
releaseResources():void
Removing all event listeners and releasing any resources that might be held open. | AmazonSQSClient | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
| AmazonSQSClient | ||
removePermission(removePermissionRequest:RemovePermissionRequest):void
The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter. | AmazonSQSClient | ||
sendMessage(sendMessageRequest:SendMessageRequest):void
The SendMessage action delivers a message to the specified queue. | AmazonSQSClient | ||
setQueueAttributes(setQueueAttributes:SetQueueAttributesRequest):void
Sets an attribute of a queue. | AmazonSQSClient | ||
willTrigger(type:String):Boolean [override]
| AmazonSQSClient |
Event | Summary | Defined By | ||
---|---|---|---|---|
AmazonSQSClient | ||||
AmazonSQSClient | ||||
AmazonSQSClient |
AmazonSQSClient | () | Constructor |
public function AmazonSQSClient(awsCredentials:AWSCredentials, clientConfiguration:ClientConfiguration)
Parameters
awsCredentials:AWSCredentials | |
clientConfiguration:ClientConfiguration |
addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
| |
priority:int (default = 0 )
| |
useWeakReference:Boolean (default = false )
|
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when addPermission or one of addPermission parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes add permission. public function addPermission(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:AddPermissionRequest = new AddPermissionRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setLabel("TestLabel"); // mandatory parameter var accountList: Array = new Array(); var actionList: Array = new Array(); accountList.push("0123456789666"); actionList.push(SQSActionsEnum.ALL_SQS_ACTIONS); accountList.push("0123456789777"); actionList.push(SQSActionsEnum.DELETE_MESSAGE); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.addPermission(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: AddPermissionResult = event.result as AddPermissionResult; var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when changeMessageVisibility or one of changeMessageVisibility parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes change message visibility. public function changeMessageVisibility(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:ChangeMessageVisibilityRequest = new ChangeMessageVisibilityRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setReceiptHandle("gH2qdC6bjNsEWHd4XGsHSgXagZjvdrkjJCWbu9iYHo3V3kwWQqEMmf18QzXBk/PqJqy5Zc8kH4KXF7obwb0l34IuPX47P3PK1nFcI0ZVAqDK3FRHPpT0Zub51wUFPeMkHC5G0hfrWahlHph2e8yv/zJOdIdipeoY1apyNuXBwcuiB8oL4y+h2RTs4sqT+5Uv"); request.setVisibilityTimeout(60); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.changeMessageVisibility(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: ChangeMessageVisibilityResult = event.result as ChangeMessageVisibilityResult; var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when createQueueRequest or one of createQueueRequest parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes queue creation. public function createQueue(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:CreateQueueRequest = new CreateQueueRequest(); request.setQueueName("Test"); request.setDefaultVisibilityTimeout(30); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.createQueue(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: CreateQueueResult = event.result as CreateQueueResult; var queueUrl: String = result.getQueueUrl(); var requestId: String = result.getRequestId(); // do something with queueUrl and requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when deleteMessage or one of deleteMessage parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes delete message. public function deleteMessage(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:DeleteMessageRequest = new DeleteMessageRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setReceiptHandle("gH2qdC6bjNsEWHd4XGsHSgXagZjvdrkjJCWbu9iYHo3V3kwWQqEMmf18QzXBk/PqJqy5Zc8kH4KXF7obwb0l34IuPX47P3PK1nFcI0ZVAqDK3FRHPpT0Zub51wUFPeMkHC5G0hfrWahlHph2e8yv/zJOdIdipeoY1apyNuXBwcuiB8oL4y+h2RTs4sqT+5Uv"); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.deleteMessage(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: DeleteMessageResult = event.result as DeleteMessageResult; var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when deleteQueue or one of deleteQueue parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes queue deletion. public function deleteQueue(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:DeleteQueueRequest = new DeleteQueueRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.deleteQueue(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: DeleteMessageResult = event.result as DeleteMessageResult; var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
dispatchEvent | () | method |
override public function dispatchEvent(event:Event):Boolean
Parameters
event:Event |
Boolean |
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when getQueueAttributes or one of getQueueAttributes parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes queue attributes search. public function getQueueAttributes(): void { var awsCredentials: AWSCredentials = new AWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:GetQueueAttributesRequest = new GetQueueAttributesRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); var attributes:Array = new Array(); attributes.push(GetQueueAttributesEnum.ALL); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.getQueueAttributes(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: GetQueueAttributesResult = event.result as GetQueueAttributesResult; var attributes: Array = result.getAttributes(); var requestId: String = result.getRequestId(); if (attributes) { for each(var key:Object in _attributes.keysToArray()) { var value: Object = attributes.itemFor(key); // do something with key and value } // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
hasEventListener | () | method |
override public function hasEventListener(type:String):Boolean
Parameters
type:String |
Boolean |
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes queue list search. public function listQueues(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:ListQueuesRequest = new ListQueuesRequest(); request.setQueueNamePrefix("T"); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); // if 'request' not set then ALL queue names will be searched try { client.listQueues(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: ListQueuesResult = event.result as ListQueuesResult; var queueUrlList: Array = result.getQueueUrls(); var requestId: String = result.getRequestId(); for each(var queueUrl: String in queueUrlList) { // do something with queueUrl } // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when receiveMessage or one of receiveMessage parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes receive message. public function receiveMessage(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:ReceiveMessageRequest = new ReceiveMessageRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setMaxNumberOfMessages(10); request.setVisibilityTimeout(30); var attributes:Array = new Array(); // ALL | APPROXIMATE_FIRST_RECEIVE_TIMESTAMP | APPROXIMATE_RECEIVE_COUNT | SENDER_ID | SENT_TIMESTAMP attributes.push(ReceiveMessageEnum.ALL); request.setAttributeNames(attributes); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.receiveMessage(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: ReceiveMessageResult = event.result as ReceiveMessageResult; var requestId: String = result.getRequestId(); for each (var message:Message in result.getMessages()) { var messageId:String = message.getMessageId(); var receiptHandle:String = message.getReceiptHandle(); var MD5OfBody:String = message.getMD5OfBody(); var body:String = message.getBody(); // do something with messageId, receiptHandle, MD5OfBody and body var attributes: Map = message.getAttributes(); if (attributes) { for each (var key:Object in attributes.keysToArray()) { // do something with 'key' // do something with attributes.itemFor(key) } } // end of "if (!attributes)" block } // end of "for each (var message:Message in _messages)" loop // do something with requestId } // end of function "resultHandler" // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
releaseResources | () | method |
public function releaseResources():void
Removing all event listeners and releasing any resources that might be held open.
removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
|
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when removePermissionRequest or one of removePermissionRequest parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes remove permission. public function removePermission(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:RemovePermissionRequest = new RemovePermissionRequest (); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setLabel("TestLabel"); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.removePermission(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: RemovePermissionResult = event.result as RemovePermissionResult; var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when sendMessage or one of sendMessage parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes send message. public function sendMessage(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:SendMessageRequest = new SendMessageRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); request.setMessageBody("This is a test UTF-8 message: " + new Date().toUTCString()); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.sendMessage(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var result: SendMessageResult = event.result as SendMessageResult; var md5OfBody:String = result.getMD5OfMessageBody(); var messageId:String = result.getMessageId(); var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
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.
|
— This error can occur for the following reasons:
1) Flash Player or AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS.
This error is applicable if the URLRequest object passed to load() is set to perform
a GET operation and if System.useCodePage is set to true.
2) Flash Player or AIR cannot allocate memory for the POST data.
This error is applicable if the URLRequest object passed to load is set to perform a POST operation.
| |
— This error occurs when setQueueAttributes or one of setQueueAttributes parameters in null
| |
— You are trying to connect to a commonly reserved port.
For a complete list of blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
|
See also
// Function executes queue attribute settings. public function setQueueAttributes(): void { var awsCredentials: AWSCredentials = new BasicAWSCredentials("your access key id", "your secret key"); //var awsCredentials: AWSCredentials = new BasicSessionCredentials("your access key id", "your secret key", "your session token"); // Identity Federation support var clientConfig: ClientConfiguration = new ClientConfiguration(); clientConfig.endpoint = "sqs.eu-west-1.amazonaws.com"; clientConfig.protocol = ProtocolEnum.HTTPS; clientConfig.signatureExpires = 60; // signature expires after 60 seconds clientConfig.userAgent = "Funny User Agent"; (optional parameter - only for AIR Runtime) var client: AmazonSQS = new AmazonSQSClient(awsCredentials, clientConfig); var request:SetQueueAttributesRequest = new SetQueueAttributesRequest(); // 123456789012 - your account id. It is optional. // request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/123456789012/Test"); request.setQueueUrl("https://sqs.eu-west-1.amazonaws.com/Test"); var attributes:Map = new Map(); attributes.add(SetQueueAttributesEnum.VISIBILITY_TIMEOUT , 25); request.setAttributes(attributes); client.addEventListener(CompleteActionEvent.COMPLETE, resultHandler, false, 0, true); client.addEventListener(IOErrorActionEvent.IO_ERROR, faultHandler, false, 0, true); try { client.setQueueAttributes(request); } catch (error: Error) { // do something if error thrown } } // Asynchronous positive response. private function resultHandler(event: CompleteActionEvent): void { var request:SetQueueAttributesResult = new SetQueueAttributesResult(); var requestId: String = result.getRequestId(); // do something with requestId } // Asynchronous negative response. private function faultHandler(event: IOErrorActionEvent): void { var result: AmazonWebServiceErrorResult = event.result as AmazonWebServiceErrorResult; var type: String = result.getType(); var code: String = result.getCode(); var message: String = result.getMessage(); var detail: String = result.getDetail(); var requestId: String = result.getRequestId(); // do something with type, code, message, detail and requestId }
willTrigger | () | method |
override public function willTrigger(type:String):Boolean
Parameters
type:String |
Boolean |
complete | Event |
ioError | Event |
securityError | Event |
flash.events.SecurityErrorEvent