SQS - Add Permission

 

Declaration

<AMAWSSQS ACTIVITY="add_permission" QUEUEURL="text" LABEL="text" ACTION="text[options]" AWSACCOUNT="number" />

See Also

SQS - Add Permission | SQS - Change Message Visibility | SQS - Create Queue | SQS - Create Session | SQS - Delete Message | SQS - Delete Queue | SQS - End Session | SQS - Get Queue Attributes | SQS - List Queues | SQS - Receive Message | SQS - Remove Permission | SQS - Send Message | SQS - Set Queue Attributes

Description

Adds a permission to a queue for a specific principal. This allows for sharing access to the queue. This activity writes an SQS-generated policy. If you want to write your own policy, use the Set Queue Attributes activity to upload your policy.

IMPORTANT: The SQS activities in AutoMate use the Amazon's SQS engine to perform their work. Because of this, you must have a valid Amazon SQS service account to use these activities.

Practical Usage

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.

Parameters

Queue Properties

Property

Type

Req'd

Default

Markup

Description

Queue URL

Text

Yes

(Empty)

QUEUEURL=

"https://queue.amazonaws.com/

963068290131/Notification"

The URL uniquely identifying the queue used for this action.

Label

Text

No

(Empty)

LABEL="message"

The unique identification of the permission you're setting.

Action Name

Text

Yes

(Empty)

ACTION="SendMessage"

The action to allow for the specified principal. The available options are:

  • *

  • SendMessage

  • ReceiveMessage

  • DeleteMessage

  • ChangeMessageVisibility

  • GetQueueAttributes

AWS Account ID

Number

Yes

(Empty)

AWSACCOUNT="125074342641"

The 12-digit Amazon Web Service account number of the principal who will be given permission.

NOTE: The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Credentials Properties

These properties allow you to enter a custom set of credentials specific to this activity or link this activity to an existing session created in a previous step.

Property

Type

Req'd

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. The available options are:

  • Custom (Default) - Specifies that a custom set of credentials will be entered for this SQS activity. Select this option if performing a single SQS activity.

  • Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the Create Session activity. This allows several SQS activities to be linked to a specific session, eliminating redundancy.

NOTE: This is a design-time parameter used interactively during  construction mode, thus, contains no markups.

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

A 20-character, alphanumeric string that uniquely identifies a user who owns a SQS account. This along with a Secret Access Key forms a secure information set that SQS uses to confirm a valid user's identity. This property is active only if Custom is selected under the Provide Credentials property.

Secret Access Key

Text

Yes

(Empty)

SECRETKEY="SecretKey"

A 40-character string that serves the role as Password to access SQS. This along with an associated Access Key forms a secure information set that SQS uses to confirm a valid user's identity. This property is active only if Custom is selected under the Provide Credentials property.

User Agent

Text

No

AutoMate

USERAGENT="AutoMate"

The User-Agent header name. The User-Agent request-header field contains information about the user agent originating the request such as time outs, proxies, name, etc. The default User Agent name is AutoMate. This property is active only if Custom is selected under the Provide Credentials property.

Service URL

Text

No

(Empty)

SERVICEURL=

"https://eu-west-1.ec2.amazonaws.com"

The Service URL used to make requests to the SQS service. The Service URL provides the service endpoint. For example, To make the service call to a different region, you can pass the region-specific endpoint, such as 'https://sdb.eu-west-1.amazonaws.com'. This property is active only if Custom is selected under the Provide Credentials property.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Signifies how many times the Amazon SQS engine should retry the request before returning an error. This property is active only if Custom is selected under the Provide Credentials property.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This property is active only if Custom is selected under the Provide Credentials property.

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

The port that should be used to connect to the proxy server. This property is active only if Custom is selected under the Provide Credentials property.

Signature Method

Text

No

(Empty)

 

SIGNMETHOD="HmacSHA256"

The Signature Method for signing the request. This property is active only if Custom is selected under the Provide Credentials property.

Signature Version

Number

No

(Empty)

SIGNVERSION="2"

The Signature Version for signing the request. The version refers to the particular algorithm for signing the request. This property is active only if Custom is selected under the Provide Credentials property.

Session Name

Text

Yes

(Empty)

SESSION="SessionName"

The session name that this activity should originate from. This allows several SQS activities to be linked to a specific session. Numerous sessions can be used within a single task. This property is active only if Session Based is selected under the Provide Credentials property.

NOTE: Use the Create Session activity to create and name an SQS session.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Add "*" permission  to queue "%test.QueueURL%". Permission label is "SendMessage". Give permission to AWS account id "125074342641". Use default SQS session.

 

<AMAWSSQS ACTIVITY="add_permission" QUEUEURL="%test.QueueURL%" LABEL="SendMessage" ACTION="*" AWSACCOUNT="125074342641" />

 

↑ [Top of Page]