This Snap consumes the messages from the Amazon Simple Queue Service (SQS).

ETL Transformations & Data Flow

Consumes the messages from the SQS. The number of messages to be returned is configured in Message count. The maximum number of messages (up to 10) can be configured, however a particular message from the queue cannot be requested.

Input & Output

• Input: This Snap can have one upstream Snap that has one Document output view (for example, the Mapper Snap).
  
  
• Output: This Snap generates a Binary output that contains the Message body and a header. The header contains the queue URL, receipt handle, and message attributes

Modes

• Ultra Pipelines: Works in Ultra Pipelines.

Valid AWS Account and SQS access.

Authentication such as IAM Role access, Access key, and Security Access key.

The AWS extended library uses S3 only when the message size is more than 256 KB. However, you cannot enable the Client-side buffering checkbox when you select the Enable Large Message Support checkbox in your SQS account.

Account & Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See SQS Account for information on setting up this type of account.

Views

Specify the AWS region where the application is implemented.

Default value: None
Example: us-east-1, us-west-1

Specify the name of the target Queue.

Default value: None

Specify the URL for the Queue. This can be found through the AWS console. 

When a new queue is created with a unique name, the Amazon SQS assigns each queue with an identifier called a queue URL that includes the queue name and other SQS components. This URL will override the queue specified in Queue name property.

Default value: None

Specify the maximum number of retry attempts for a failed request.

Default value: 3

Specify the maximum time in seconds the Snap waits for each fetching. A zero wait timeout means that short polling is performed. Otherwise, long polling is performed. If the wait timeout is set to 0, the queue attribute, Receive Message Wait Time, is used.

Default value: 0

Specify the number of messages to read before consuming stops. If this value is set to 0, the Snap reads all available messages and returns. If the count is less than 0, the Snap waits indefinitely.

Default value: -1

The SQS sets a visibility timeout to prevent other consumers from re-processing the same message from a queue. Visibility timeout is a period of time during which Amazon SQS prevents other consumers from receiving and processing the message. Click here for more information.

Default value: 0

Select this checkbox to automatically acknowledge the message after it is received by the Snap.

Default value: Selected

Select this checkbox to enable the Snap buffer up to 10 outbound requests and send them in batch, instead of sending each request separately. It allows pre-fetching of messages when consuming. The Amazon SQS Buffered Asynchronous Client currently does not support the FIFO queues. 

Default value: Not selected

Appears when you select Client-side buffering checkbox.

The configurations for the client-side buffer.

Specify the maximum number of messages that are batched together in a single request. The higher the setting, the fewer batches are required to carry out the same number of requests. The maximum batch size is 10.

Default value: 10

Specify the maximum buffer wait time in milliseconds before sending out the request.

Default value: 200 

Specify the maximum number of concurrent batches for each type of outbound request. The greater the number, greater the throughput that can be achieved (at the expense of consuming more threads).

Default value: 5

Specify the number of receive batches the Snap pre-fetches for client-side buffering.

Default value: 10

Specify the maximum number of inbound batches that are processed in parallel. The higher the setting, the more messages can be received (at the expense of consuming more threads). If the property is set to 0, the pre-fetching is disabled.

Default value: 10