Packagecom.amazonaws.services.sqs.model
Classpublic class AddPermissionRequest
InheritanceAddPermissionRequest Inheritance AmazonWebServiceRequest Inheritance Object

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

Container for the parameters to the AddPermission operation. 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.

See also

SQSDeveloperGuide


Public Methods
 MethodDefined By
  
AddPermissionRequest(queueUrl:String = null, label:String = null, aWSAccountIds:Array = null, actions:Array = null)
Constructs a new AddPermissionRequest object.
AddPermissionRequest
  
getActions():Array
The action the client wants to allow for the specified principal.
AddPermissionRequest
  
The AWS account number(s) of the principal who will be given permission.
AddPermissionRequest
  
getLabel():String
The unique identification of the permission.
AddPermissionRequest
  
getQueueUrl():String
The queue URL.
AddPermissionRequest
  
setActions(actions:Array):void
The action you want to allow for the specified principal.
AddPermissionRequest
  
setAWSAccountIds(awsAccountIds:Array):void
The AWS account number(s) of the principal who will be given permission.
AddPermissionRequest
  
setLabel(label:String):void
The unique identification of the permission.
AddPermissionRequest
  
setQueueUrl(queueUrl:String):void
Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
AddPermissionRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
AddPermissionRequest
  
The action you want to allow for the specified principal.
AddPermissionRequest
  
The AWS account number(s) of the principal who will be given permission.
AddPermissionRequest
  
The unique identification of the permission.
AddPermissionRequest
  
Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
AddPermissionRequest
Constructor Detail
AddPermissionRequest()Constructor
public function AddPermissionRequest(queueUrl:String = null, label:String = null, aWSAccountIds:Array = null, actions:Array = null)

Constructs a new AddPermissionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters
queueUrl:String (default = null) — queue URL (http|https://endpoint/12digitOwnerAccountId/QueueName)
 
label:String (default = null) — The unique identification of the permission.
 
aWSAccountIds:Array (default = null) — The AWS account number(s) of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification , see 'Your AWS Identifiers' in the Amazon SQS Developer Guide.
 
actions:Array (default = null) — The action you want to allow for the specified principal. For more information about these actions, see 'Understanding Permissions' in the Amazon SQS Developer Guide. Valid values: | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes

See also

Method Detail
getActions()method
public function getActions():Array

The action the client wants to allow for the specified principal.

Returns
Array — The action(s) the client wants to allow for the specified principal.
getAWSAccountIds()method 
public function getAWSAccountIds():Array

The AWS account number(s) of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Returns
Array — The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.
getLabel()method 
public function getLabel():String

The unique identification of the permission.

Returns
String — The unique identification of the permission.
getQueueUrl()method 
public function getQueueUrl():String

The queue URL. (http|https://endpoint/12digitOwnerAccountId/QueueName).

Returns
String — queue URL
setActions()method 
public function setActions(actions:Array):void

The action you want to allow for the specified principal.

Parameters

actions:Array — The action you want to allow for the specified principal.

setAWSAccountIds()method 
public function setAWSAccountIds(awsAccountIds:Array):void

The AWS account number(s) of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Parameters

awsAccountIds:Array — The AWS account number(s) of the principal who will be given permission.

setLabel()method 
public function setLabel(label:String):void

The unique identification of the permission.

Parameters

label:String — The unique identification of the permission.

setQueueUrl()method 
public function setQueueUrl(queueUrl:String):void

Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

toString()method 
public function toString():String

Returns a string representation of this object; useful for testing and debugging.

Returns
String — A string representation of this object.
withActions()method 
public function withActions(actions:Array):AddPermissionRequest

The action you want to allow for the specified principal.

Parameters

actions:Array — The action you want to allow for the specified principal.

Returns
AddPermissionRequest — A reference to this updated object so that method calls can be chained together.
withAWSAccountIds()method 
public function withAWSAccountIds(awsAccountIds:Array):AddPermissionRequest

The AWS account number(s) of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Parameters

awsAccountIds:Array — The AWS account number(s) of the principal who will be given permission.

Returns
AddPermissionRequest — A reference to this updated object so that method calls can be chained together.
withLabel()method 
public function withLabel(label:String):AddPermissionRequest

The unique identification of the permission.

Parameters

label:String — The unique identification of the permission.

Returns
AddPermissionRequest — A reference to this updated object so that method calls can be chained together.
withQueueUrl()method 
public function withQueueUrl(queueUrl:String):AddPermissionRequest

Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

Returns
AddPermissionRequest — A reference to this updated object so that method calls can be chained together.