AWS Simple Queue Service

AWS Simple Queue Service

Scheme: aws-sqs
Syntax: aws-sqs:queueNameOrArn
Description: The aws-sqs component is used for sending and receiving messages to Amazon's SQS service.
Deprecated:false
Async:false
Maven: org.apache.camel/camel-aws/2.18.1.redhat-000025

The aws-sqs component is used for sending and receiving messages to Amazon's SQS service.

Name Kind Group Required Default Type Enum Description
queueNameOrArn path common true java.lang.String Queue name or ARN
accessKey parameter common java.lang.String Amazon AWS Access Key
amazonSQSClient parameter common com.amazonaws.services.sqs.AmazonSQS To use the AmazonSQS as client
amazonSQSEndpoint parameter common java.lang.String The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client, i.e., if you explicitly set amazonSQSClient, then this setting will have no effect. You would have to set it on the client you create directly
headerFilterStrategy parameter common org.apache.camel.spi.HeaderFilterStrategy To use a custom HeaderFilterStrategy to map headers to/from Camel.
queueOwnerAWSAccountId parameter common java.lang.String Specify the queue owner aws account id when you need to connect the queue with different account owner.
region parameter common java.lang.String Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.
secretKey parameter common java.lang.String Amazon AWS Secret Key
attributeNames parameter consumer java.lang.String A list of attribute names to receive when consuming. Multiple names can be separated by comma.
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
concurrentConsumers parameter consumer 1 int Allows you to use multiple threads to poll the sqs queue to increase throughput
defaultVisibilityTimeout parameter consumer java.lang.Integer The default visibility timeout (in seconds)
deleteAfterRead parameter consumer true boolean Delete message from SQS after it has been read
deleteIfFiltered parameter consumer true boolean Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage.
extendMessageVisibility parameter consumer boolean If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs.
maxMessagesPerPoll parameter consumer int Gets the maximum number of messages as a limit to poll at each polling.

Is default unlimited, but use 0 or negative number to disable it as unlimited.

messageAttributeNames parameter consumer java.lang.String A list of message attribute names to receive when consuming. Multiple names can be separated by comma.
sendEmptyMessageWhenIdle parameter consumer boolean If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
visibilityTimeout parameter consumer java.lang.Integer The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently.
waitTimeSeconds parameter consumer java.lang.Integer Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter consumer (advanced) org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the exchange pattern when the consumer creates an exchange.
pollStrategy parameter consumer (advanced) org.apache.camel.spi.PollingConsumerPollStrategy A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
delaySeconds parameter producer java.lang.Integer Delay sending messages for a number of seconds.
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
backoffErrorThreshold parameter scheduler int The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold parameter scheduler int The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier parameter scheduler int To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
delay parameter scheduler 500 long Milliseconds before the next poll. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour).
greedy parameter scheduler boolean If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay parameter scheduler 1000 long Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour).
runLoggingLevel parameter scheduler TRACE org.apache.camel.LoggingLevel TRACE
DEBUG
INFO
WARN
ERROR
OFF
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService parameter scheduler java.util.concurrent.ScheduledExecutorService Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
scheduler parameter scheduler none org.apache.camel.spi.ScheduledPollConsumerScheduler none
spring
quartz2
To use a cron scheduler from either camel-spring or camel-quartz2 component
schedulerProperties parameter scheduler java.util.Map To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
startScheduler parameter scheduler true boolean Whether the scheduler should be auto started.
timeUnit parameter scheduler MILLISECONDS java.util.concurrent.TimeUnit NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for initialDelay and delay options.
useFixedDelay parameter scheduler true boolean Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
proxyHost parameter proxy java.lang.String To define a proxy host when instantiating the SQS client
proxyPort parameter proxy java.lang.Integer To define a proxy port when instantiating the SQS client
maximumMessageSize parameter queue java.lang.Integer The maximumMessageSize (in bytes) an SQS message can contain for this queue.
messageRetentionPeriod parameter queue java.lang.Integer The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
policy parameter queue java.lang.String The policy for this queue
receiveMessageWaitTimeSeconds parameter queue java.lang.Integer If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.
redrivePolicy parameter queue java.lang.String Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

aws-sqs consumer

A Consumer of messages from the Amazon Web Service Simple Queue Service AWS SQS