The AWS SQS Listener polls the defined SQS (Amazon Simple Queue Service) queue and retrieves messages.
Listener (Adapter) Configuration Drop-Down List
Basic AWS SQS Listener Configuration Options
On the Basic tab, you can specify:
- Listener Version – select which version of the SQS listener to use
Version 1: SQS SDK Polling Implementation
Version 2: JIvIS 1.1 Implementation
- Queue Configuration Type – Specify Queue String type Queue
Queue Name: SQS Queue Name
Queue URL: SQS Queue URL (V1.0 Only)
- Polling interval – Version 1: Polling time between messages
Version 2: Reconnection intervalIf the value is set with enhanced properties, the units are seconds.
- V1.0 Only: Number of messages per cycle – the number of messages to pull on a single polling cycle. Between 1 and 10.
- V1.0 Only: Dequeue messages after processing – if checked, the message will be removed from the queue after the transaction is started
- Text Message Encoding – the character encoding of received text messages
AWS SQS Listener Basic Configuration Options
Advanced AWS SQS Listener Configuration Options
On the Advanced tab, you can specify:
- Initialize on Trigger Only – if enabled, the Listener doesn’t start up until a trigger initializes it
- Allow Command-line Invocation – if enabled, the listener can be invoked using the CLI client application
- Restart on Listening Error – if enabled, the listener will be restarted after an error occurs
- FIFO Queue Name – The FIFO stuff enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.
- FIFO Queue Delay – It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in.
- Synchronous Acknowledge – If enabled, message acknowledgement will not be sent until a Synchronous Response confirms message has been processed
- Synchronous Ack Timeout – maximum time in seconds before timing out
AWS SQS Listener Advanced Configuration Options
Transaction Logging AWS SQS Listener Configuration Options
On the Transaction Logging tab, you can specify:
- Transaction Logging Enable – this checkbox allows transaction events originating from this listener to be logged by a TransactionEventListener
- Log Transaction Data – if enabled, logs transaction data body
- Log Transaction Data Base64 – if enabled, logs transaction data body as Base64
- Log Transaction Attribute – if enabled, logs transaction attributes
- Log All Attributes – if enabled, no attributes will be filtered
- Allowed Attributes – attributes that are allowed to be logged
AWS SQS Listener Transaction Logging Configuration Options
Inactivity AWS SQS Listener Configuration Options
On the Inactivity tab, you can specify:
- Enable Inactivity Monitor – Check this box to enable inactivity monitoring. This will throw a non-transaction exception if the specified number of transactions haven’t been processed in the specified time interval.
- Min. Transactions to Expect – the number of transactions to expect to be completed per monitoring interval
- Monitoring Interval – how often to check the specified number of transactions have been processed
- Times to Monitor – If set, monitoring will be done during the defined times of day. To ignore, set start and end time equally.
- Days to Exclude from Monitoring – inactivity monitoring will not occur on the days specified
- Include Errors in Transaction Count – if checked, transactions that attempted to start but failed at the Listener stage will also be counted
AWS SQS Listener Inactivity Configuration Options
Throttling AWS SQS Listener Configuration Options
On the Throttling tab, you can specify:
- Throttling Mode – The throttling mode to use for limiting the number of transactions or messages emitted by this Listener. “Timed” will limit transactions based on time intervals, while “Concurrent” will limit based on a concurrent number of transactions. “Concurrent” mode requires a Throttling Response Processor step later in your Interface workflow to acknowledge completion.
- Throttling Mechanism – The mechanism to use for throttling message. “Blocking” prevents the Listener from continuing to process and emit messages altogether, while “Queued” pushes received messages into the Interface queue (or a default, in-memory queue).
- Max Concurrent Messages – how many messages can be concurrently processed, either by time-based limits (“Allow X per Second”) or synchronous (“Allow X at any Time”)
- Timed Emission Interval – the interval for time-based limits (“Allow X per X Timed Emission Interval”)
- Synchronous Timeout Interval – the interval to wait for a synchronous response before failing
AWS SQS Listener Throttling Configuration Options
Scheduling AWS SQS Listener Configuration Options
The Scheduling tab allows you to specify the start times and end times for scheduled execution (choose the three dots to the right of the line in order to see this window). Also, you can specify days of the week or particular dates to exclude from scheduling. The Time Zone drop-down menu allows you to specify the Time Zone that should be used for scheduling; by default, it is set to the Time Zone of the console during initial configuration.
AWS SQS Listener Scheduling Configuration Options
Credentials AWS SQS Listener Configuration Options
On the Credentials tab, you can set the necessary credentials for the connection.
- Region – specify the AWS Region to connect to
- Use Credentials from – Specifies method of getting the credentials. Note: choosing the ‘No Credentials’ option will only allow access to public buckets.
- Access Key Id – access Key Id for making calls to Amazon services
- Secret Key – secret access key for making calls to Amazon services
- Session Token – If using AWS STS, this is for the limited-use session token. If not using STS, leave blank.
- AWS File Path – specifies the file path where the AWS profile configuration file is located
- Profile Name – specifies the name of a local configuration profile
AWS SQS Listener Credentials Configuration Options