Listener Properties and Commands

This chapter provides a detailed description of the listener commands and properties.

Access Key

Specifies the key of AWS user for the connection. This access key is used to sign programmatic requests to AWS API calls through the adapter. The corresponding adapter command is -AK (or -ACCESSKEY).

Secret Key

Specifies the key of AWS user for the connection. Like the username and password, both the access key ID and secret access key are mandatory to authenticate SQS queue for a Get or Put request. The corresponding adapter command is -SK (or -SECRETKEY).

Region Name

Specifies the name to connect to an AWS region for the IAM user account. The corresponding adapter command is -R (or -REGION).

Queue Name

Specifies the SQS queue name to or from which messages need to be accessed. During action configuration, SQS Adapter provides options to select queue name among available queues in the provided region. The corresponding adapter command is -Q (or -QUEUE).

Create Queue

If specified, this property indicates the SQS adapter to create a queue with the name passed in the ‘queue_name’ property, in case it doesn’t already exist. This property is optional. When the create_queue property is not specified, adapter checks if the queue already exists; if not: it throws an error. The corresponding adapter command is -CQ (or -CREATEQUEUE).

Read Mode

Specifies whether you want to delete or keep a message after reading it. Default is Keep. There are two values:
  • Keep: To keep a message after reading
  • Delete: To delete a message after reading

The corresponding adapter command is -RM (or -READMODE).

Attributes

Specifies if the SQS message should be accessed along with the corresponding message attributes. When the attributes flag is set to true in output card, the passed data should be in predefined JSON format, else data should be in a plain text message. The corresponding adapter command is -A (or -ATTRIBUTES).

Limit

Specifies the total number of messages to consume. The limit property is applicable and utilized only in ITX deployments. Minimum value should be 1. If no limit is specified, adapter fetches only one message at a time from the queue. The corresponding adapter command is -QTY.

Timeout

Specifies the time duration (in seconds) to wait for before retrieving the message from the queue. The timeout property of SQS adapter is applicable and utilized only in ITX deployments. The SQS adapter would listen to the queue for specified seconds. The corresponding adapter command is -LSN.

Logging

Specifies the level of logging to be used for the log (trace) file produced by the adapter. The default is off. The value info means log informational and error messages, the value error means log error messages only, and the value verbose means log debug and trace level messages along with the informational and error messages.

Append Log

Specifies the flag that indicates the action to take when the specified log file already exists. When set to true, the log messages are appended to the file. When set to false: the file is truncated, and the messages are written to the empty file. The default value is true.

Log File Name

Specifies the name of the log file, where the log messages are written. If not specified, the default log file name m4sqs.trc is used, and the file is stored to the directory in which the executed compiled map resides.