Know the component and how to use it.

Micaella Mazoni avatar
Written by Micaella Mazoni
Updated over a week ago

IMPORTANT: This documentation has been discontinued. Read the updated SQS documentation on our new documentation portal.

To make a dispatch to a queue, you can invoke a JSON Generator that indicates the messages. That way, you can send one message at a time.

IMPORTANT: besides the permissions to publish a message in the SQS queue, you also must have a sqs:GetQueueUrl permission.


The meaning of SQS

Simple Queue Service is a distribution service from Amazon that queues messages. With it, you can program the dispatch to communicate through the Internet.


How to use the component

Let's say you want to use a component to make the subscription in a SQS message queue. That way, you can trigger a pipeline that enables the consumption of a message at a time. 

Example 1 (with JMS Trigger):

1. Select the JMS trigger to create your pipeline.

2. Open the trigger settings and specify the fields values:

- Destination: select queue 

- JMS provider: choose SQS

- Connection string: Amazon connection URL

- REGION: region where the SQS Broker is installed

3. Click on "Confirm".

4. Move on with the pipeline building.

5. Connect its components.

6. Deploy the pipeline:

- Click on "Runtime", located in the upper part of the screen.
- Select the environment, which can be test or prod.
- Click on "Create a new deploy".
- Select the pipeline with its version and capacity.
- Click on "Confirm".

7. When triggered, the pipeline will receive a payload similar to the one below:



  • data: content of the received message.


Example 2 (with JSON Generator):

1.  Create a pipeline and add a JSON Generator.

2.  Open the component settings and send the JSONs you want.

3.  Click on “Confirm”.

4.  Add SQS.

5.  Open the settings and choose an ACCOUNT.

6.  Set the other component fields:

- Name of the QUEUE: name of the SQS queue

- Connection string: Amazon connection URL 

- REGION: region where the Broker SQS is installed

7.  Click on “Confirm”.

8.  Connect all the pipeline components.

9.  Open the Test-Mode and execute a pipeline test. You can use the CTRL + ENTER command for that.

10.  You'll see the result of the executed test, as shown below:


"messageId": "6d95f5c5-08c4-4327-a2d6-950b54d44601",

"messageBodyMD5": "65319b689ece655dd519e5cb0082291b",

"sequenceNumber": null,

"success": true,

"requestId": "4eed2d9e-63cd-5a8e-8d31-7b4c48182c94"


  • messageId: ID of the sent message.

  • messageBodyMD5: MD5 of the sent message.

  • sequenceNumber: sequential number of the message (if it exists).

  • requestId: request ID of the sent message.

  • success: “true” if the message is successfully sent; “false” if it's not successfully sent.

Did this answer your question?