---
schema_version: "1"
id: 1848321fa4600111999fcbe099f480ab04fdabcf714b11c25b6fb8a856692316
title: Upgrading and Migrating Amazon SQS Connector to 5.12
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/amazon-sqs-connector/latest/amazon-sqs-connector-upgrade-migrate.md
canonical_url: https://docs.mulesoft.com/amazon-sqs-connector/latest/amazon-sqs-connector-upgrade-migrate
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 210122f575192912f453e7d38c8f93ad97cc9604649df825c5ab8845e18c6c95
description: MuleSoft Documentation Site
release: "5.12"
latest: true
---
---
product: Amazon SQS Connector
version: 5.12
is-latest-version: true
---

# Upgrading and Migrating Amazon SQS Connector to 5.12

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Anypoint Connector for Amazon SQS to 5.12 to improve and optimize the performance of your
projects using long polling, multithreading, and more control over the polling parameters.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>5.x</p></div></div></td><td><div><div><p>5.12</p></div></div></td></tr></tbody></table>

### 5.12

- Amazon SQS Connector now supports passing an external ID in Role-based authentication.

- In the **Receive messages** source, the **Time unit** field is renamed to **Start delay time
  unit**, and its default value is changed from `MILLISECONDS` to `SECONDS`.

  > [!NOTE] This was changed back in v5.12.2. The field in the **Receive messages** source is now
  > called **Time unit** again, and its default value is set back to `MILLISECONDS`.

### 5.11

All of the Amazon SQS Connector error types are now exported. You can see specific error messages
instead of MULE:UNKNOWN.

### 5.10

Amazon SQS Connector now supports the addition of an SQS endpoint, which you can use with Amazon
Virtual Private Cloud (VPC).

### 5.9

With release 5.9 you now have the ability to enable long polling for the Read Message source and
Read operation and to control the time interval for the polling. Long polling can reduce the number
of network requests without affecting throughput.

Additionally, you can now configure the number of threads for your sources, allowing for a higher
throughput in some situations.

### 5.8

Amazon SQS Connector now supports sending and receiving large messages with payloads of up to 2 GB.
This is beneficial when your application requires large amounts of data to be stored in queues.

> [!NOTE] This feature requires the use of the Amazon S3 service. Large payload transmissions are
> billed as one SQS request and one S3 request. Billing for the payload is based on the amount of
> data stored in Amazon S3.

### 5.7

The Messages object now contains a new `deduplicationId` field. 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.

### 5.6

Cluster node support was added back to the `Receive Messages` input source and works the same as it
did in version 5.4.3. The input source listens for messages on all cluster nodes by default, but you
can change this behavior by using the `Primary node only` field on the `Advanced` sub-tab on the
`Receive Messages` tab. For more information, see
[Receiving Messages in Cluster Mode](https://docs.mulesoft.com/amazon-sqs-connector/latest/amazon-sqs-connector-config-topics#node-behavior).

### 5.5

Version 5.5.0 was deprecated because cluster mode support was removed from that version.

### 5.4.2

The Amazon SDK for Java dependency was upgraded to version 1.11.649.

## Requirements

Ensure your system meets the following requirements before you perform the upgrade:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>Java</p></td><td><p>11</p></td></tr><tr><td><p>Anypoint Studio</p></td><td><p>7.0 and later</p></td></tr></tbody></table>

See the
[Amazon SQS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sqs-connector-release-notes-mule-4)
for updated compatibility information for patch updates.

## Upgrade Prerequisites

Before you upgrade, create a backup of your files, data, and configurations in case you need to
restore them.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, create a Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange**.

3.  Enter `sqs` in the search field.

4.  In the **Available modules** section, select **Amazon SQS Connector** and click **Add**.

5.  Click **Finish**.

6.  Verify that the `mule-amazon-sqs-connector` dependency version is `5.9.x` in the `pom.xml` file
    in the Mule project. Replace `x` with the version that corresponds to the connector you are
    using.

7.  In version 5.5.0, the `Receive Messages` input source received messages on the primary node
    only. To obtain the same behavior in this version, access the **Advanced** tab in the **Receive
    Messages** source operation configuration and select the **Primary node only** field.

    If you’re upgrading from version 5.4.x or earlier to version 5.8 or later, this step is not
    needed.

Studio upgrades the connector automatically.

## Post Upgrade Steps

After you install the latest version of the connector, verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

3.  Test the connection and verify that the operations work.

## Troubleshooting

If there are problems with caching the parameters and metadata, try restarting Studio.

## Revert the Upgrade

If you must revert to your previous version of Amazon SQS Connector, change the
`mule-amazon-sqs-connector` dependency version `5.9.x` in the project’s `pom.xml` to the latest
version which is not deprecated, `5.8`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)
