Contact Free trial Login

Amazon SQS Connector Reference - Mule 4

Support Category: Select

Amazon SQS Connector v5.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

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

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

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

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

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 unique 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

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

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

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.

Associated Sources

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 will be 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 to evaluate against the operation’s output and store the expression outcome 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 you can set the value to is 12 hours. This means 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 to evaluate against the operation’s output and store the expression outcome 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

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome 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

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

x

Queue Url

String

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

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Delete Queue

<sqs:delete-queue>

Deletes the message queue represented by this object. Will 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 to evaluate against the operation’s output and store the expression outcome 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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

Attributes Type

For Configurations

Throws

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Queue Attributes

<sqs:get-queue-attributes>

Gets queue attributes. This 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 attribute retrieve information for.

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

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 whose URL must be fetched.

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

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 to use for 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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

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 where messages are to be fetched from.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome 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.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome 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

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Send Message Result

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Batch Result

Attributes Type

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 to evaluate against the operation’s output and store the expression outcome 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

<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

1

Queue Url

String

Primary Node Only

Boolean

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

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

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 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 to use to determine when a message has been 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 going to be stored.

Batch Result

Field Type Description Default Value Required

Failed

Successful

Array of String

Batch Result Error Entry

Field Type Description Default Value Required

Code

String

Id

String

Message

String

Sender Fault

Boolean

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

Receipt Handle

String

Visibility Timeout

Number

Delete Message Batch Request Entry

Field Type Description Default Value Required

Id

String

Receipt Handle

String

Message

Field Type Description Default Value Required

Body

String

Delay Seconds

Number

Group Id

String

Id

String

Message Attributes

Object

Receipt Handle

String

Send Message Result

Field Type Description Default Value Required

MD5 Of Message Attributes

String

MD5 Of Message Body

String

MD5 Of Message Attributes

String

MD5 Of Message Body

String

Message Id

String

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.