Contact Us 1-800-596-4880
  1. Homepage
  2. Amazon SQS Connector (5.7)

  3. Amazon SQS Connector Reference

All Connectors

Amazon SQS Connector 5.7 Reference - Mule 4

Configurations

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Default Global Queue URL

String

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Session Token

String

The session token provided by AWS Security Token Service (STS).

Test Queue ARN

String

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) 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

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See the Amazon Credentials topic.

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.
Role
Parameters
Name Type Description Default Value Required

Role ARN

String

The Role ARN uniquely identifies role to assume to gain cross account access.

x

Test Queue ARN

String

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) 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

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See the Amazon Credentials topic.

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Operations

Add Permission

<sqs:add-permission>

Adds a permission to this message queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

A name for this permission

x

Account Ids

Array of String

The AWS account ID’s for the account to share this queue with.

x

Actions

Array of String

A list to indicate how much to share (SendMessage, ReceiveMessage, ChangeMessageVisibility, DeleteMessage, GetQueueAttributes)

x

Queue Url

String

Permissions are added to the queue represented by this URL.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Change Message Visibility

<sqs:change-message-visibility>

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. This means that you can’t extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Receipt Handle

String

The receipt handle associated with the message whose visibility timeout should be changed.

#[header:inbound:sqs.message.receipt.handle]

Visibility Timeout

Number

The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message’s visibility timeout.

x

Queue Url

String

The URL of the Amazon SQS queue to take action on.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Change Message Visibility Batch

<sqs:change-message-visibility-batch>

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Receipt Handles

Array of Change Message Visibility Batch Request Entry

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

#[payload]

Queue Url

String

The URL of the Amazon SQS queue to take action on.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Create Queue

<sqs:create-queue>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Name

String

The name for the queue to be created.

x

Attributes

Object

A map of attributes with their corresponding values.

Valid map keys:

  • ApproximateNumberOfMessages

  • ApproximateNumberOfMessagesDelayed

  • ApproximateNumberOfMessagesNotVisible

  • CreatedTimestamp

  • DelaySeconds

  • LastModifiedTimestamp

  • MaximumMessageSize

  • MessageRetentionPeriod

  • Policy

  • QueueArn

  • ReceiveMessageWaitTimeSeconds

  • RedrivePolicy

  • VisibilityTimeout

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Delete Message

<sqs:delete-message>

Deletes the message identified by message object on the queue this object represents.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Receipt Handle

String

Receipt handle of the message to be deleted

x

Queue Url

String

The URL of the queue to delete messages from.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Delete Message Batch

<sqs:delete-message-batch>

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entries

Array of Delete Message Batch Request Entry

A list of receipt handles for the messages to be deleted.

x

Queue Url

String

The URL of the queue from which to delete messages as a batch.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Delete Queue

<sqs:delete-queue>

Deletes the message queue represented by this object. The connector can delete a non-empty queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Url

String

The URL of the queue to delete.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Approximate Number Of Messages

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

Gets an approximate number of visible messages for a queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Url

String

The URL of the queue.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Queue Attributes

<sqs:get-queue-attributes>

Gets queue attributes. This functionality is provided to expose the underlying functionality.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Attribute Names

Array of String

A list of attributes for which to retrieve information.

Queue Url

String

The URL of the Amazon SQS queue to take action on.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Queue URL

<sqs:get-queue-url>

Returns the URL of an existing queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Name

String

The name of the queue associated with the URL to return.

x

Queue Owner AWS Account Id

String

The AWS account ID of the owner that created the queue.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

List Dead Letter Source Queues

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

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Url

String

The queue URL of a dead letter queue.

Target Variable

String

The name of a variable to store the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

List Queues

<sqs:list-queues>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Name Prefix

String

A string or filtering the list results. Only those queues whose name begins with the specified string are returned.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Purge Queue

<sqs:purge-queue>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Url

String

The queue URL from which to retrieve messages

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Read

<sqs:read>

Reads a number of messages from a queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Url

String

The Queue URL.

x

Max Number Of Messages

Number

The maximum number of messages to read. The connector never returns more messages than the number specified, however, fewer messages might be returned. Only values between 1 and 10 are allowed.

1

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Remove Permission

<sqs:remove-permission>

Removes a permission from this message queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

A name for the permission to be removed.

x

Queue Url

String

Permissions will be deleted from the queue represented by this URL.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Send Message

<sqs:send-message>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Message

Message

The message to send.

#[payload]

Queue Url

String

The queue where the message is to be sent.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Send Message Result

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Send Message Batch

<sqs:send-message-batch>

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Messages

Array of Message

A list of SendMessageBatchRequestEntry items.

#[payload]

Queue Url

String

The queue where the message is to be sent.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

Request ID Attribute

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Set Queue Attributes

<sqs:set-queue-attributes>

Sets the value of one or more queue attributes. When you change a queue’s attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Attributes

Object

A map of attributes to set.

#[payload]

Queue Url

String

The URL of the queue.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Sources

  • Receive Messages

Receive messages

<sqs:receivemessages>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Visibility Timeout

Number

30

Preserve Messages

Boolean

false

Number Of Messages

Number

The maximum number of messages to read. The connector never returns more messages than the number specified, however, fewer messages might be returned. Only values between 1-10 are allowed.

1

Queue Url

String

Primary Node Only

Boolean

Whether this source should execute on the primary node only when in a cluster

false

Redelivery Policy

Redelivery Policy

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

String

For Configurations

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

For servers, a truststore contains certificates of the trusted clients. For clients, a truststore contains certificates of the trusted servers.

Key Store

Key Store

For servers, a keystore contains the private and public key of the server. For clients, a keystore contains the private and public key of the client.

Revocation Check

Validates that a certificate was revoked.

Trust Store

Field Type Description Default Value Required

Path

String

The location of the truststore. The path is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the truststore.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, which makes connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location of the keystore. The path is resolved relative to the current classpath and file system, if possible.

Type

String

The type of store used.

Alias

String

The alias of the key to use when the keystore contains multiple private keys. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Verify the last element of the certificate chain only.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method, which is the method not specified in the Prefer Crls field.

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

The alias of the signing certificate for the OCSP response, if present. The alias must be in the truststore.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

How many reconnection attempts to make.

blocking

Boolean

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

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

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

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • DAYS

  • HOURS

  • MICROSECONDS

  • MILLISECONDS

  • MINUTES

  • NANOSECONDS

  • SECONDS

A time unit that qualifies the maxIdleTime attribute

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message.

Use Secure Hash

Boolean

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

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions that determine when a message was redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

Batch Result

Field Type Description Default Value Required

Failed

Array of BatchResultErrorEntry

A list of Batch Result Error Entry items.

Successful

Array of String

A list of Change Message Visibility Batch Request Entry items.

Batch Result Error Entry

Field Type Description Default Value Required

Code

String

An error code that represents why the action failed on this entry.

Id

String

The ID of an entry in a batch request.

Message

String

A message that explains why the action failed on this entry.

Sender Fault

Boolean

Indicates whether the error occurred due to the producer.

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Change Message Visibility Batch Request Entry

Field Type Description Default Value Required

Id

String

An ID for the receipt handle. This ID is used to communicate the result of this request.

Receipt Handle

String

The receipt handle for this entry.

Visibility Timeout

Number

The new value, in seconds, for the message visibility timeout.

Delete Message Batch Request Entry

Field Type Description Default Value Required

Id

String

An ID for the receipt handle. This ID is used to communicate the result of this request.

Receipt Handle

String

The receipt handle for this entry.

Message

The output attributes for a sent message.

Field Type Description Default Value Required

body

String

The message body to send

deduplicationId

String

The 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

The number of seconds for which to delay a specific message. Valid values are 0 through 900.

groupId

String

The group in the FIFO queue to which this message belongs

id

String

A unique identifier for the message

message Attributes

Object

A 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

The receipt handle for this entry.

Send Message Result

Field Type Description Default Value Required

MD5 Of Message Attributes

String

An MD5 digest of the non-URL-encoded message attribute string. You can use this digest to verify that Amazon SQS received the message correctly. Amazon SQS decodes the message URL before it creates the MD5 digest. For information about MD5, see RFC 1321 - The MD5 Message-Digest Algorithm.

MD5 Of Message Body

String

An MD5 digest of the non-URL-encoded message body string. You can use this digest to verify that Amazon SQS received the message correctly. Amazon SQS decodes the message URL before it creates the MD5 digest.

Message Id

String

An element containing the message ID of the message sent to the queue. For more information, see Amazon SQS Queue and Message Identifiers.

See Also

Back to top
View on GitHub