This Snap sends messages to the Amazon Simple Queue Service (SQS) for consumption. The Snap supports standard queues as well as FIFO queues. Multiple messages can be sent using the Snap by batching as well as by client-side buffering. 

Users of the Snap must have the following accesses to be able to use this Snap:

• Valid AWS account. 
• Access Key and Secret Key.
• IAM Role access

Works in Ultra Task Pipelines.

The Snap conforms to the limits within SQS. As such the following must be kept in mind when configuring the Snap:

• The maximum allowed size for the message, including message attributes, is 256KB. For a workaround to overcome this please refer to Messages larger than 256KB.
• The maximum number of inflight messages per queue are:
  • Standard queue - 120,000 inflight messages per queue. 
  • FIFO queue - 20,000 inflight messages per queue.
• The queue name for a FIFO queue can be a maximum of 80 characters long, including the ".fifo" suffix.
• Queue names are case-sensitive.

For more information on message-related limits refer to Message-limits. For more information on queue-related limitations please refer to Queue-limits.

The AWS extended library uses S3 only if the message size is more than 256 KB. However, you cannot enable the Client-side buffering option in Amazon SQS Snaps if you select the Enable Large Message Support a 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 name of the target queue. This is a suggestible field and suggestions will be populated based on the region selected. Fore information on queue-related limitations please refer to Queue-limits.

Default value: [None]
Example: snapqatest

Conditional. Specify the URL for the Queue, this can be found through the AWS console under the Details section. When this property is configured, the queue specified in Queue name property will be overridden. 

Default value: [None]

Specify a tag that indicates which message group this message belongs to. The field is used and required by FIFO queue. For more information refer to FIFO Queue Recommendations - Message Group Id.

Default value: [None]
Example: 5

The token used for de-duplication of sent messages in FIFO queue. The property is used by FIFO queue only. For more information refer to FIFO Queue Recommendations - Deduplicate Id.

Default value: [None]
Example: 2

Specify the name for the message attribute. By default this field is expression enabled.

Default value: [None]
Example: snap-runtime

Specify the value for the message attribute.  By default this field is expression enabled. 

Default value: [None]
Example: snap.instanceId

Specify the number of Documents the Snap should batch before processing. The maximum number is 10. This is ignored if client-side buffering is enabled

Example: 5

Default value:10

Select this checkbox to enable the Snap to automatically buffer a maximum 10 outbound requests (or less as configured in the Max buffer size property) and send them as a batch and allow message pre-fetching when consuming. The subsequent properties need to be configured if this property is enabled.

Default value: Not selected

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
Example: 4

Specify the maximum time in millisecond the buffer would wait before sending message batches.  

Default value: 200
Example: 200

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

Default value: 5
Example: 3

Select one of the three modes in which the Snap executes. Available options are:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.