+
+

Amazon SQS Connector 5.11 Reference - Mule 4

Anypoint Connector for Amazon SQS (Amazon SQS Connector) enables you to interface with the Amazon Simple Queue Service (Amazon SQS) API and manage SQS queueing services without having to interact with the Amazon SQS API directly.

Configuration

Default Configuration for Amazon SQS Connector.

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Default Global Queue URL

String

This value is used when you do not set the queue URL at the operation level. If you do not specify the queue URL here or at the operation level, an exception is thrown.

A queue URL is constructed in the following format: https://sqs.{REGION}.amazonaws.com/{ACCOUNT_NUMBER}/{QUEUE_NAME}, for example: https://sqs.us-east-1.amazonaws.com/123456789101/test-queue.

Default Wait Time

Number

Default value for the maximum duration of a single poll, in seconds:

  • Set this field to a value between 1 and 20 to use long polling. With long polling, if there are messages available immediately, the connector returns the query results immediately. If not, the connector waits up to the specified amount of seconds for a message to be added before returning an empty response.

  • Set this field to 0 to use short polling. With short polling, the connector always returns the query results as soon as possible, even if that means returning an empty response.

20

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Basic Connection Type

Uses a session token provided by Amazon STS to connect to Amazon SQS.

Name Type Description Default Value Required

Session Token

String

Session token provided by Amazon STS.

Test Queue ARN

String

Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.

A queue ARN is constructed in the following format: arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}, for example: arn:aws:sqs:us-east-1:123456789101:test-queue.

Large Payload Support

Support large message payloads on Amazon SQS.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. A value of 0 means infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

MILLISECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

How long to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

MILLISECONDS

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. Refer to Using Credentials.

false

Region Endpoint

String

Sets the topic region endpoint.

US_EAST_1

Custom SQS Endpoint

String

Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Host

String

Optional proxy host.

Port

Number

Optional proxy port.

Username

String

Optional proxy username.

Password

String

Optional proxy password.

Domain

String

Optional proxy domain.

Workstation

String

Optional proxy workstation.

Role Connection Type

Configures the Amazon role ARN that uniquely identifies the role to assume to allow cross-account access.

Name Type Description Default Value Required

Role ARN

String

Role ARN that uniquely identifies the role to assume to gain cross-account access.

x

Test Queue ARN

String

Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.

A queue ARN is constructed in the following format: arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}, for example: arn:aws:sqs:us-east-1:123456789101:test-queue.

Large Payload Support

Support large message payloads on Amazon SQS.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. A value of 0 means infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

MILLISECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

How long to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

MILLISECONDS

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. Refer to Using Credentials.

false

Region Endpoint

String

Sets the topic region endpoint.

US_EAST_1

Custom STS Endpoint

String

Sets a custom STS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

Custom SQS Endpoint

String

Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Host

String

Optional proxy host.

Port

Number

Optional proxy port.

Username

String

Optional proxy username.

Password

String

Optional proxy password.

Domain

String

Optional proxy domain.

Workstation

String

Optional proxy workstation.

Sources

Receive messages

<sqs:receivemessages>

Retrieves one or more messages.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Visibility Timeout

Number

Period of time during which other consumers are prevented from receiving and processing the same message in the queue.

30

Visibility Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Visibility Timeout field.

SECONDS

Preserve Messages

Boolean

Preserve messages after they are read rather than deleting them immediately from the queue after they are read.

false

Number Of Messages

Number

Number of messages to retrieve on each call. The maximum is 10.

1

Queue Url

String

URL of the queue in which to receive messages.

Wait time

Number

Maximum duration of a single poll, in seconds:

  • Set this field to a value between 1 and 20 to use long polling. With long polling, if there are messages available immediately, the connector returns the query results immediately. If not, the connector waits up to the specified amount of seconds for a message to be added before returning an empty response.

  • Set this field to 0 to use short polling. With short polling, the connector always returns the query results as soon as possible, even if that means returning an empty response.

Number of consuming threads

Number

Number of threads used to consume the messages in the inbound flow. This value must be an integer greater than 0.

1

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Frequency

number

Frequency at which the connector polls for incoming messages, in the time unit specified in the Time unit field. If you set this value to 0, the connector polls as fast as possible.

1000

Start delay

Number

Amount of time that the connector waits before it starts polling for incoming messages, in the time unit specified in the Time unit field. The default value of 0 means that the connector starts polling immediately.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Object

Associated Configurations

Operations

Add Permission

<sqs:add-permission>

Adds a permission to a message queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

Name for this permission.

x

Account Ids

Array of String

IDs of the AWS accounts to share this queue with.

x

Actions

Array of String

List to indicate how much to share (Send Message, Receive Message, Change Message Visibility, Delete Message, and Get Queue Attributes).

x

Queue Url

String

URL of the queue in which to add permissions to. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:OVER_LIMIT

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Change Message Visibility

<sqs:change-message-visibility>

Changes the visibility timeout of a specified message in a queue to a new value, not to exceed 12 hours.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Receipt Handle

String

Receipt handle associated with the message whose visibility timeout must change.

Visibility Timeout

Number

New value of the message visibility timeout (up to 4300 seconds or 12 hours).

x

Visibility Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Visibility Timeout field.

SECONDS

Queue Url

String

URL of the queue to act on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_NOT_IN_FLIGHT

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Change Message Visibility Batch

<sqs:change-message-visibility-batch>

Changes the visibility timeout of up to 10 ChangeMessageVisibility requests, with each result reported individually in the response.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Receipt Handles

List of receipt handles of the messages for which the visibility timeout must be changed.

#[payload]

Queue Url

String

URL of the queue to act on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Create Queue

<sqs:create-queue>

Creates a new queue or returns the URL of an existing one.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Name

String

Name of the queue to create.

x

Attributes

Object

Map of attributes with their corresponding values. Refer to the Queue Attributes table below.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Queue Attributes

Name Type Description Default Value Required

DelaySeconds

Number

Length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values are an integer from 0 to 900 seconds (15 minutes).

0

MaximumMessageSize

Number

Limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values are an integer from 1024 bytes (1 KiB) to 262,144 bytes (256 KiB).

262,144 (256 KiB)

MessageRetentionPeriod

Number

Length of time, in seconds, for which Amazon SQS retains a message. Valid values are an integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days).

345,600 (4 days)

Policy

String

Queue’s policy. A valid AWS policy.

ReceiveMessageWaitTimeSeconds

Number

Length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values are an integer from 0 to 20 (seconds).

0

RedrivePolicy

String

String that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object.

VisibilityTimeout

Number

Visibility timeout for the queue, in seconds. Valid values are an integer from 0 to 43,200 (12 hours).

30

KmsMasterKeyId

String

ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.

KmsDataKeyReusePeriodSeconds

Number

Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. Valid values are an integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours).

300 (5 minutes)

FifoQueue

Boolean

Designates a queue as FIFO. Valid values are true or false. If you don’t specify this attribute, Amazon SQS creates a standard queue. You must provide this attribute during queue creation, and you can’t change it for an existing queue. When you set this attribute, you must also explicitly provide the MessageGroupId for your messages.

ContentBasedDeduplication

Boolean

Enables content-based deduplication. Valid values are true or false. Every message must have a unique MessageDeduplicationId.

ApproximateNumberOfMessages

Number

Approximate number of messages available for retrieval from the queue.

ApproximateNumberOfMessagesDelayed

Number

Approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.

ApproximateNumberOfMessagesNotVisible

Number

Approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.

CreatedTimestamp

Number

Time when the queue was created, in seconds.

LastModifiedTimestamp

Number

Time when the queue was last changed, in seconds.

QueueArn

String

Amazon resource name (ARN) of the queue.

Redrive Policy

Name Type Description Default Value Required

deadLetterTargetArn

String

Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

maxReceiveCount

Number

Number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter queue.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:QUEUE_ALREADY_EXISTS

  • SQS:QUEUE_DELETED_RECENTLY

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Delete Message

<sqs:delete-message>

Deletes the message identified by the message object in the queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Receipt Handle

String

Receipt handle of the message to delete.

x

Queue Url

String

URL of the queue. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Delete Message Batch

<sqs:delete-message-batch>

Deletes up to 10 messages from the specified queue. This is a batch version of Delete Message.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Entries

List of receipt handles for the messages to delete.

x

Queue Url

String

URL of the queue to delete messages as a batch from. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Delete Queue

<sqs:delete-queue>

Deletes the message queue represented by this object and can even delete a non-empty queue. Because deleting a queue can take up to 60 seconds, wait at least that long before you create a new queue with the same name.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Url

String

URL of the queue to delete. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Get Approximate Number Of Messages

<sqs:get-approximate-number-of-messages>

Retrieves an approximate number of visible messages for a queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Url

String

URL of the queue.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Get Queue Attributes

<sqs:get-queue-attributes>

Shows queue attributes to expose the underlying functionality.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Attribute Names

Array of String

List of attributes to retrieve information for.

Queue Url

String

URL of the queue to take action on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Get Queue Url

<sqs:get-queue-url>

Returns the URL of an existing queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Name

String

Name of the queue whose URL must be fetched.

x

Queue Owner AWS Account Id

String

AWS account ID of the owner that created the queue.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

List Dead Letter Source Queues

<sqs:list-dead-letter-source-queues>

Returns a list of the queues that have the Redrive Policy queue attribute configured with a dead-letter queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Url

String

URL of a dead-letter queue. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

List Queues

<sqs:list-queues>

Returns a list of your queues. The maximum number of queues that can be returned is 1000.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Name Prefix

String

String to use for filtering the list results. Queues only with names beginning with the specified string are returned.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Purge Queue

<sqs:purge-queue>

Deletes the messages in a queue specified by the queue URL.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Url

String

URL of the queue from which messages are fetched. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:PURGE_QUEUE_IN_PROGRESS

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Read

<sqs:read>

Reads a number of messages from a queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Queue Url

String

URL of the queue.

Max Number Of Messages

Number

Maximum number of messages to read.

x

Wait time

Number

Maximum duration of a single poll, in seconds:

  • Set this field to a value between 1 and 20 to use long polling.

    With long polling, if there are messages available immediately, the connector returns the query results immediately. If not, the connector waits up to the specified amount of seconds for a message to be added before returning an empty response.

  • Set this field to 0 to use short polling. With short polling, the connector always returns the query results as soon as possible, even if that means returning an empty response.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:OVER_LIMIT

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Remove Permission

<sqs:remove-permission>

Removes a permission from this message queue.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

Name for the permission to remove.

x

Queue Url

String

URL of the queue in which permissions are deleted from.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Send Message

<sqs:send-message>

Sends a message to a specified queue. The message must be between 1 and 256K bytes long.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Message

Message to send.

#[payload]

Queue Url

String

URL of the queue in which to send the message.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Send Message Result

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Send Message Batch

<sqs:send-message-batch>

Delivers up to 10 messages to the specified queue. This is a batch version of Send Message.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Messages

Array of Message

List of SendMessageBatchRequestEntry items.

#[payload]

Queue Url

String

URL of the queue in which to send the message.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:OPT_IN_REQUIRED

  • SQS:PARAMETER_OUT_OF_RANGE

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Set Queue Attributes

<sqs:set-queue-attributes>

Sets the value of one or more queue attributes, which can take up to 60 seconds to propagate throughout the SQS system (although changes made to the MessageRetentionPeriod attribute can take up to 15 minutes).

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Attributes

Object

Map of attributes to set.

#[payload]

Queue Url

String

URL of the queue.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Associated Configurations

Throws

  • SQS:ACCESS_DENIED

  • SQS:CONNECTIVITY

  • SQS:INTERNAL_FAILURE

  • SQS:INVALID_CREDENTIALS

  • SQS:INVALID_DATA

  • SQS:OPT_IN_REQUIRED

  • SQS:REQUEST_EXPIRED

  • SQS:RETRY_EXHAUSTED

  • SQS:SERVICE_UNAVAILABLE

  • SQS:THROTTLING_EXCEPTION

Object Types

Batch Result

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Field Type Description Default Value Required

Failed

List of Batch Result Error Entry items.

Successful

Array of String

Batch Result Error Entry

Used in the responses of a batch API to give a detailed description of the result of an action on each entry in the request.

Field Type Description Default Value Required

Code

String

Error code that represents why the action failed on this entry.

Id

String

ID of an entry in a batch request.

Message

String

Message that explains why the action failed on this entry.

Sender Fault

Boolean

Whether the error happened due to the sender’s fault.

Change Message Visibility Batch Request Entry

Used to change the visibility timeout of messages.

Field Type Description Default Value Required

Id

String

Identifier for this particular receipt handle. This is used to communicate the result. The IDs of a batch request must be unique within the request.

Receipt Handle

String

Receipt handle for this entry.

Visibility Timeout

Number

New value (in seconds) for the message’s visibility timeout.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Delete Message Batch Request Entry

Used to delete messages in batch.

Field Type Description Default Value Required

Id

String

Identifier for this particular receipt handle. This is used to communicate the result. The IDs of a batch request must be unique within the request.

Receipt Handle

String

Receipt handle for this entry.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Large Payload Support

Supports large message payloads on Amazon SQS.

Field Type Description Default Value Required

Bucket

String

Name of the AWS S3 bucket in which to store large payload messages. The AWS S3 bucket must already be created and configured in AWS S3. Enabling this feature incurs additional charges for using AWS S3.

x

Message Size Threshold

Number

Message size threshold value for storing message payloads in the AWS S3 bucket. The default value for the message size threshold is 256 KB and the maximum threshold size value is 256 KB. The maximum message size is 2 GB.

256

Message Size Threshold Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Data unit for the Message Size Threshold field.

KB

Custom S3 Endpoint

String

Sets a custom S3 endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

Message

Output attributes for a sent message.

Field Type Description Default Value Required

body

String

Message body to send.

deduplicationId

String

Token for deduplicating sent messages. If multiple messages are sent with the same deduplication ID, Amazon SQS accepts the messages successfully, but delivers only the first message during the 5-minute deduplication interval.

delaySeconds

Number

Number of seconds that a specific message is delayed. Valid values are 0 through 900. If no value is specified, the default value for the queue is used.

This parameter can be set only on a queue level-- when FifoQueue is set, DelaySeconds cannot be set per message.

groupId

String

Group this message belongs to in the FIFO queue. This parameter applies only to FIFO queues. When creating a FIFO queue, this parameter is required.

id

String

Unique identifier for the message.

message Attributes

Object

Map of typed key-value pairs to send as message attributes. You must specify a value, key, and data type for each entry.

receipt Handle

String

Receipt handle for this entry.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Id Expression

String

One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

Object Store

Configures the object store that stores the redelivery counter for each message.

Request ID Attribute

Used for a request ID.

Field Type Description Default Value Required

Request Id

String

AWS request ID used when a service call isn’t working as expected and you need to work with AWS support to debug an issue.

Send Message Result

Sends the result of the message.

Field Type Description Default Value Required

MD5 Of Message Attributes

String

MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. The first URL in Amazon SQS decodes the message before creating the MD5 digest. For information about MD5, refer to RFC 1321 - The MD5 Message-Digest Algorithm.

MD5 Of Message Body

String

MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. The first URL in Amazon SQS decodes the message before creating the MD5 digest. For information about MD5, refer to RFC 1321 - The MD5 Message-Digest Algorithm.

Message Id

String

Element containing the message ID of the message sent to the queue. For more information, refer to Amazon SQS Queue and Message Identifiers.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!