Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/
Overview
Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications.
This Universal Extension provides the capability to monitor AWS SQS messages from an existing queue and run job(s) and/or workflows accordingly.
Software Requirements
This integration requires a Universal Agent and a Python runtime to execute the Universal Task.
Software Requirements for Universal Template and Universal Task
- Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.
Software Requirements Universal Agent
Both Windows and Linux agents are supported:
Universal Agent for Windows x64 Version 7.1.0.0 and later with python options installed.
Universal Agent for Linux Version 7.1.0.0 and later with python options installed.
Software Requirements Universal Controller
Universal Controller Version 7.0.0.0 and later.
This Universal Task requires that Universal Controller property /wiki/spaces/UC71x/pages/5177877 (uc.web_service.response.content.default) is set to JSON.
Key Features
This Universal Extension provides the following main features:
Support to monitor AWS SQS messages from a standard or a FIFO queue.
Support to launch a task in Universal Controller with variables holding the id, body, attributes, message attributes and receipt handle for each fetched message.
Support for authorization via IAM Role-Based Access Control (RBAC) strategy.
Support for Proxy communication via HTTP/HTTPS protocol.
Import Universal Template
To use the Universal Template, you first must perform the following steps:
This Universal Task requires the /wiki/spaces/UC71x/pages/5178443 feature. Check that the/wiki/spaces/UC71x/pages/5177877 system property has been set to true.
Download the provided ZIP file.
In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.
Click Import Template.
Select the template ZIP file and Import.
When the template has been imported successfully, the Universal Template will appear on the list, Refresh your Navigation Tree to see these tasks in the Automation Center Menu.
Configure Universal Task
For the new Universal Task type, create a new task, and enter the task-specific details that were created in the Universal Template.
Input Fields
The input fields for this Universal Extension are described in the following table.
Field | Input type | Default value | Type | Description |
---|---|---|---|---|
Action | Required | Send Message | Choice | The action performed upon the task execution. |
Region | Required | - | Text | Region for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here. |
Credentials | Required | - | Credentials | The AWS account credentials. They are comprised of:
|
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: Required when Role Based Access has been clicked. |
Use Proxy | Required | 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:
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 password". |
Proxy Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication. They are comprised of:
Required when Proxy Type is configured for "https with password". |
Attribute Names | Optional | All | Choice | A list of attributes to be returned along with each message. Available options are:
|
Message Attribute Names | Optional | - | Text | Attribute names of the message to be returned from the request, separated by a comma. For example:
Retrieve all message attributes starting with a prefix, using for example bar.*. Naming rules and restrictions:
|
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:
|
Universal Controller URL | Required | - | Text | The Universal Controller URL to launch the Task after receiving a message. For example: |
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. |
Task Examples
Monitor Messages from Queue
Example of Universal Task for monitoring messages from an existing queue.
Monitor Messages with Role Based Access Enabled
Example of Universal Task for monitoring messages with Role Based Access Enabled.
HTTP Proxy Type Task Configuration
Example of Universal Task for monitoring messages through HTTP proxy connection.
HTTPS Proxy Type Task Configuration
Example of Universal Task for monitoring messages through HTTPS proxy connection:
HTTPS with password Proxy Type Task Configuration
Example of Universal Task for monitoring messages through HTTPS with password proxy connection.
Task Output
Output Only Fields
The output parameters are set after every message processing. If they are 'preserved on re-run', they prevent a re-run of the task instance from restarting from scratch.
The output fields for this Universal Extension are described in the following table.
Field | Type | Preserved on re-run | Description |
---|---|---|---|
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). |
Exit Codes
The exit codes for this Universal Extension are described in the following table.
Exit Code | Status Classification Code | Status Classification Description | Status Description |
---|---|---|---|
0 | SUCCESS | Successful Execution | SUCCESS: Successful Task execution |
1 | FAIL | Failed Execution | FAIL: < Error Description > |
3 | AUTHORIZATION_ERROR | Insufficient Permissions | AUTHORIZATION_ERROR: The authorization credentials provided for the request are invalid. |
10 | CONNECTION_ERROR | Bad connection data or connection timed out | CONNECTION_ERROR: < Error Description > |
20 | DATA_VALIDATION_ERROR | Bad input fields validation | DATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDERR for more details. |
Document References
This document references the following documents:
Name | Location | Description |
---|---|---|
Universal Templates | https://docs.stonebranch.com/confluence/display/UC71x/Universal+Templates | User documentation for creating Universal Templates in the Universal Controller user interface. |
Universal Tasks | https://docs.stonebranch.com/confluence/display/UC71x/Universal+Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
Amazon SQS quotas | https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html | User documentation for Amazon SQS quotas. |
Amazon Simple Queue Service endpoints and quotas | https://docs.aws.amazon.com/general/latest/gr/sqs-service.html | User Guide for Amazon Simple Queue Service endpoints and quotas. |
IAM RBAC authorization model | User Documentation for Comparing ABAC to the traditional RBAC model. |