How to use IBM® App Connect with Amazon SQS

Amazon Simple Queue Service (SQS) is a fully secure message queuing service that temporarily stores messages to be processed by web applications and cloud services.

Availability:

App Connect Enterprise as a Service connector
Local connector in containers (Continuous Delivery release)
Local connector in containers (Long Term Support release)
Local connector in containers (Long Term Support Cycle-2 release)

Connecting to Amazon SQS
General considerations
Events and actions

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Amazon SQS

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Amazon SQS administrator to obtain these values.

Amazon SQS connection fields:

Connection field	Description
Secret access key	The secret access key for your Amazon SQS account, as generated in the Security Credentials page in the AWS Management Console.
Access key ID	The access key ID for your Amazon SQS account, as generated in the Security Credentials page in the AWS Management Console.
Region	The region of your Amazon SQS instance, for example, `us-east-1`. You can find the value for the Region parameter at the end of the URL when you are logged in to the AWS Management Console (for example, https://us-east-2.console.aws.amazon.com/console/home?region=us-east-2#). Tip: For more information, see AWS service endpoints on the AWS documentation page.

To obtain the connection values for Amazon SQS, see Obtaining connection values for Amazon SQS.

To connect to an Amazon SQS endpoint from the App Connect Designer Applications and APIs page for the first time, expand Amazon SQS, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with Amazon SQS, take note of the following considerations:

(General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
(General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Amazon SQS events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Amazon SQS actions

Your flow completes these actions on this application.

Messages

Put message on queue
Change message visibility
Remove message from queue
Get messages

Queues

Create queue
Purge queue
Delete queue
Update queue
Retrieve queues
Get queue URL
Update policy

Tags

Retrieve tags
Add tags
Remove tags