Action

Required

Monitor Messages

Choice

The action performed upon the task execution.

Region

Optional since version 1.1.0

Optional

-

Text

Region for the Amazon Web Service.

Find more information about the AWS Service endpoints and quotas here.

When AWS Region is not populated as part of the task definition, during task execution the integration will look for AWS Region on the task execution environment. Refer to configuration options for more information.

AWS Credentials

Optional since version 1.1.0

Optional

-

Credentials

The

Credentials definition should be as follows.

• AWS Access Key ID as "Runtime User".
• AWS Secret Access Key as "Runtime Password".

When AWS Credentials are not populated as part of the task definition, during task execution the integration will look for AWS Credentials on the task execution environment. Refer to configuration options for more information.

Queue Name

Required

-

Dynamic Choice

Dynamic fetched list of queue names.

The user can select the required queue name from a drop-down list.

Queue Name Prefix

Optional

-

Text

A prefix to use for filtering the Queue Names list results.

Only those queues whose name begins with the specified string are returned.

Queue Names are case-sensitive.

Role Based Access

Optional

False

Boolean

Flag to configure whether the type of authorization is based on IAM Role-Based Access Control(RBAC) strategy.

Find more information about the IAM RBAC authorization model here.

Role ARN

Optional

-

Text

The Role Amazon Resource Name (ARN) to have access to the SQS queue.

Role ARN format: arn:aws:iam::<AWS Account ID>:instance-profile/<Role name>

Required when Role Based Access has been clicked.

Use Proxy

Optional

False

Boolean

Flag to configure whether Proxy should be used in communication.

Proxy Type

Optional

HTTP

Choice

Type of proxy connection to be used.

Available options are:

• HTTP

• HTTPS

• HTTPS With Credentials

Required when Use Proxy is enabled.

Proxy

Optional

-

Text

Proxy server and port. Valid format: http://proxyip:port or https://proxyip:port.

Required when Use Proxy is enabled.

Proxy CA Bundle File

Optional

-

Text

The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy.

Used when Proxy Type is configured for "

HTTPS" or "

HTTPS With Credentials".

Proxy Credentials

Optional

-

Credentials

Credentials to be used for the proxy communication

. The credential definition should be as follows.

• Proxy Username as "Runtime User".
• Proxy Password as "Runtime Password".

Required when "Proxy Type" is configured for "HTTPS" or "HTTPS With Credentials".

Attribute Names

Optional

All

Choice

A list of attributes to be returned along with each message.

Available options are:

• All - Returns all values

• Approximate First Receive Timestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).

• Approximate Receive Count – Returns the number of times a message has been received across all queues but not deleted.

• AWS Trace Header – Returns the X-Ray trace header string.

• SenderId:

  • For an IAM user, returns the IAM user ID.

  • For an IAM role, returns the IAM role ID.

• Sent Timestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).

• Message Deduplication Id – Returns the value provided by the producer of the message for FIFO queue.

• Message Group Id – Returns the value provided by the producer of the message for FIFO queue.

• Sequence Number – Returns the value provided by Amazon SQS.

Message Attribute Names

Optional

-

Text

Attribute names of the message to be returned from the request, separated by a comma.

For example: FirstName,LastName,Title.

ALL returns all attributes of the message.

Retrieve all message attributes starting with a prefix, using for example bar.*.

Naming rules and restrictions:

• Name can contain alphanumeric characters and the underscore (_ ), hyphen (- ), and period (. ).

• Name is case-sensitive and must be unique among all attribute names for the message.

• Name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

• Name must not start or end with a period (. ), and it should not have periods in succession (.. ).

• Name can be up to 256 characters long.

Maximum Number of Messages

Required

10

Integer

The maximum number of messages to return within each request.

Valid values from 1 to 10.

Visibility Timeout (seconds)

Required

1

Integer

The duration that the received messages are hidden from subsequent retrieve requests.

Valid values range from 1 to 43200.

Wait Time (seconds)

Required

1

Integer

The duration for which the call waits for Maximum Number of Messages to arrive in the queue before returning.

If the requested number of messages is available, the messages are returned sooner than Wait Time (seconds).

Polling Interval (seconds)

Required

60

Integer

The amount of time the task will wait before pooling for a new message batch when no messages are found during the last cycle.

Valid values from 0.

Delete After Processing

Required

True

Boolean

Flag to delete the received message after processing.

If an error occurs during the launching task process, the received message will not be deleted regardless of the Delete after processing flag.

Launch Task Name

Required

-

Text

The name of the Task to be launched in the Universal Controller.

The task will always be launched with the Task variables:

• messageId - Returns the MessageId.

• messageBody - Returns the Body of message.

• attributes - Returns the list of specified attributes of the message in JSON format.

• messageAttributes - Returns the list of specified message attributes in JSON format.

• receiptHandle - Returns the received ReceiptHandle value of message.

Universal Controller URL

Required

-

Text

The Universal Controller URL to launch the Task

when receiving a message.

Valid URL format is:

http(s)://

controller_ip:controller_port/uc.

Universal Controller Credentials

Required

-

Credentials

The credentials of Universal Controller URL to be used for launching the task

The Credentials must have “Web Service Access” Permissions.

Last Monitor Datetime

Text

False

Timestamp of the last time the messages were pooled from the queue.

Last Monitor Message Count

Integer

False

Number of fetched messages since the start of the monitoring (task instance).

Launched Task IDs

Text

False

sysID (32 char) of the last launched task as returned by UAC REST API.

Read Message Count

Integer

False

Number of fetched messages since the start of the monitoring (task instance).

Launched Task Count

Integer

False

Number of launched tasks instances since the start of the monitoring (task instance).