SQS - Create Session

 

Declaration

<AMAWSSQS ACTIVITY="create_session" ACCESSKEY="text" SECRETKEY="text[encrypted]" />

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

Creates a unique session which can be used to associate subsequent SQS steps. This allows a single task the ability to execute numerous SQS operations simultaneously.

NOTE: To end a session, use the End Session activity.  

 

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

Ideally used to create a session to correlate subsequent SQS activities to. Numerous sessions can be created for a single task.   

Parameters

Credentials Properties

Property

Type

Req'd

Default

Markup

Description

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

A 20-character, alphanumeric string that uniquely identifies a user who owns an SQS account (i.e. 022QF06E7MXBSH9DHM02). 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 (i.e. kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct). 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 timeouts, 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

Text

Yes

(Empty)

SESSION="SessionName"

Specifies the session name to create for this activity. Subsequent SQS activities can be linked to this session allowing several SQS operations (that may contain multiple activities) to be performed within a single task. The default session name is SQSSession.

NOTE: Make sure to use an End Session activity to end a particular 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

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: Create SQS session. AWS access key is "AKIAJU2LHLMG6BAACZTA".

 

<AMAWSSQS ACTIVITY="create_session" ACCESSKEY="AKIAJU2LHLMG6BAACZTA" SECRETKEY="AM16I/ZtyZm558AL2TgY91IsZnSDzz65wmtOwlMZLej+8pN1hV0oiGZSEt+I7tngk5orkPqaJSDcLwvSPKP/3oLxyMBvuAhu25tgGI/cJAyVBWXvqzpvsHQxQ==aME" />

 

↑ [Top of Page]