Optional attributeList of queue attributes to retrieve (i.e.
['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']).
@default-value []
Optional authenticationThe duration (in milliseconds) to wait before retrying after an authentication error.
@default-value 10000
Optional batchThe number of messages to request from SQS when polling (default 1).
This cannot be higher than the
AWS limit of 10.
@default-value 1
Optional handleTime in ms to wait for handleMessage to process a message before timing out.
Emits timeout_error on timeout. By default, if handleMessage times out,
the unprocessed message returns to the end of the queue.
Optional heartbeatThe interval (in seconds) between requests to extend the message visibility timeout.
On each heartbeat the visibility is extended by adding visibilityTimeout to
the number of seconds since the start of the handler function.
This value must less than visibilityTimeout.
Optional maxMaximum amount of inflight async messages tasks
@default-value 1
Optional messageList of message attributes to retrieve (i.e. ['name', 'address']).
@default-value []
Optional pollingThe duration (in milliseconds) to wait before repolling the queue.
@default-value 0
Optional regionThe AWS region.
@default-value process.env.AWS_REGION || eu-west-1
Optional shouldDefault to true, if you don't want the package to delete messages from sqs
set this to false.
@default-value true
Optional sqsAn optional SQS Client object to use if you need to configure the client manually.
Optional terminateThe duration (in seconds), sets the message visibility timeout seconds after a processing_error.
Optional terminationDuration to wait for async messages tasks to finish @default-value 0
Optional visibilityThe duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
Optional waitThe duration (in seconds) for which the call will wait for a message to arrive in
the queue before returning.
@default-value 20
Optional handleAn async function (or function that returns a Promise) to be called whenever
a message is received.
In the case that you need to acknowledge the message, return an object containing the MessageId that you'd like to acknowledge.
Optional handleAn async function (or function that returns a Promise) to be called whenever
a batch of messages is received. Similar to handleMessage but will receive the
list of messages, not each message individually.
If both are set, handleMessageBatch overrides handleMessage.
In the case that you need to ack only some of the messages, return an array with the successful messages only.
Optional postOptional pre
The SQS queue URL.