---
schema_version: "1"
id: 379f78c60c0139ec83761f5bb0a6fd967039bec57a9d86fc90cf9fbf9fc07c8a
title: Amazon SQS Connector 5.12 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/amazon-sqs-connector/latest/amazon-sqs-connector-reference.md
canonical_url: https://docs.mulesoft.com/amazon-sqs-connector/latest/amazon-sqs-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 32f146d985c10bb04eb9083e0dc066a92c96a43b1542eca715f530d3d5ca340a
description: MuleSoft Documentation Site
release: "5.12"
latest: true
---
---
product: Amazon SQS Connector
version: 5.12
is-latest-version: true
---

# Amazon SQS Connector 5.12 Reference

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

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#config_basic">Basic</a></p></li><li><p><a href="#config_role">Role</a></p></li></ul></div></div></td><td><div><div><p>Connection types for this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Default Global Queue URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div><div><p>A queue URL is constructed in the following format:&nbsp;<code>https://sqs.{REGION}.amazonaws.com/{ACCOUNT_NUMBER}/{QUEUE_NAME}</code>, for example: <code>https://sqs.us-east-1.amazonaws.com/123456789101/test-queue</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Default Wait Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Default value for the maximum duration of a single poll, in seconds:</p></div><div><ul><li><p>Set this field to a value between <code>1</code> and <code>20</code> 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.</p></li><li><p>Set this field to <code>0</code> 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.</p></li></ul></div></div></td><td><div><div><p><code>20</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Basic Connection Type

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session token provided by Amazon STS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Test Queue ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.</p></div><div><p>A queue ARN is constructed in the following format: <code>arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}</code>, for example:&nbsp;<code>arn:aws:sqs:us-east-1:123456789101:test-queue</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Large Payload Support</strong></p></td><td><div><div><p><a href="#LargePayloadSupport">Large Payload Support</a></p></div></div></td><td><div><div><p>Support large message payloads on Amazon SQS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service. A value of <code>0</code> means infinity and is not recommended.</p></div></div></td><td><div><div><p><code>50000</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long to wait for data to be transferred over an established, open connection before the connection times out. A value of <code>0</code> means infinity and is not recommended.</p></div></div></td><td><div><div><p><code>50000</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Socket Timeout</strong> field.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to <code>true</code> to obtain credentials from the AWS environment. Refer to <a href="https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html">Using Credentials</a>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets the topic region endpoint.</p></div></div></td><td><div><div><p><code>US_EAST_1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom SQS Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Role Connection Type

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Role ARN that uniquely identifies the role to assume to gain cross-account access.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>External ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provides an external ID, then provide that value in this field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Test Queue ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.</p></div><div><p>A queue ARN is constructed in the following format: <code>arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}</code>, for example:&nbsp;<code>arn:aws:sqs:us-east-1:123456789101:test-queue</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Large Payload Support</strong></p></td><td><div><div><p><a href="#LargePayloadSupport">Large Payload Support</a></p></div></div></td><td><div><div><p>Support large message payloads on Amazon SQS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service. A value of <code>0</code> means infinity and is not recommended.</p></div></div></td><td><div><div><p><code>50000</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long to wait for data to be transferred over an established, open connection before the connection times out. A value of <code>0</code> means infinity and is not recommended.</p></div></div></td><td><div><div><p><code>50000</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Socket Timeout</strong> field.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to <code>true</code> to obtain credentials from the AWS environment. Refer to <a href="https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html">Using Credentials</a>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets the topic region endpoint.</p></div></div></td><td><div><div><p><code>US_EAST_1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom STS Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom STS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint. The custom STS endpoint might not work if <code>DefaultAWSCredentialsProviderChain</code> is used. Instead, use AWS environment variables such as <code>AWS_STS_REGIONAL_ENDPOINTS</code>, <code>AWS_REGION</code>, and <code>AWS_ENDPOINT_URL</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom SQS Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Sources

- [Receive messages](#receivemessages)

### Receive messages

`<sqs:receivemessages>`

Retrieves one or more messages from a server but triggers a flow for each message separately.

> [!NOTE] In Amazon SQS Connector 5.12.5 and later, the **Receive messages** source performs initial
> validation of the queue URL. If the validation fails, the source stops running. To enable queue
> URL validation, ensure that the IAM role includes an additional policy granting the
> `sqs:GetQueueAttributes` permission.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Visibility Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Period of time during which other consumers are prevented from receiving and processing the same message in the queue.</p></div></div></td><td><div><div><p><code>30</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Visibility Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Visibility Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Messages</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Preserve messages after they are read rather than deleting them immediately from the queue after they are read.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Number Of Messages</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of messages to retrieve on each call. The maximum is <code>10</code>.</p></div></div></td><td><div><div><p><code>1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue in which to receive messages.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Wait time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum duration of a single poll, in seconds:</p></div><div><ul><li><p>Set this field to a value between <code>1</code> and <code>20</code> 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.</p></li><li><p>Set this field to <code>0</code> 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.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Number of consuming threads</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of threads used to consume the messages in the inbound flow. This value must be an integer greater than <code>0</code>.</p></div></div></td><td><div><div><p><code>1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>number</p></div></div></td><td><div><div><p>Frequency at which the connector polls for incoming messages, in the time unit specified in the <strong>Time unit</strong> field. If you set this value to <code>0</code>, the connector polls as fast as possible.</p></div></div></td><td><div><div><p><code>1000</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Start delay</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount of time that the connector waits before it starts polling for incoming messages, in the time unit specified in the <strong>Time unit</strong> field. The default value of <code>0</code> means that the connector starts polling immediately.</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Frequency</strong> and <strong>Start delay</strong> fields.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

## Operations

- [Add Permission](#addPermission)

- [Change Message Visibility](#changeMessageVisibility)

- [Change Message Visibility Batch](#changeMessageVisibilityBatch)

- [Create Queue](#createQueue)

- [Delete Message](#deleteMessage)

- [Delete Message Batch](#deleteMessageBatch)

- [Delete Queue](#deleteQueue)

- [Get Approximate Number Of Messages](#getApproximateNumberOfMessages)

- [Get Queue Attributes](#getQueueAttributes)

- [Get Queue Url](#getQueueUrl)

- [List Dead Letter Source Queues](#listDeadLetterSourceQueues)

- [List Queues](#listQueues)

- [Purge Queue](#purgeQueue)

- [Read](#read)

- [Remove Permission](#removePermission)

- [Send Message](#sendMessage)

- [Send Message Batch](#sendMessageBatch)

- [Set Queue Attributes](#setQueueAttributes)

### Add Permission

`<sqs:add-permission>`

Adds a permission to a message queue.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Label</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this permission.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Account Ids</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>IDs of the AWS accounts to share this queue with.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Actions</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List to indicate how much to share (<strong>Send Message</strong>, <strong>Receive Message</strong>, <strong>Change Message Visibility</strong>, <strong>Delete Message</strong>, and <strong>Get Queue Attributes</strong>).</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Receipt Handle</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Receipt handle associated with the message whose visibility timeout must change.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Visibility Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>New value of the message visibility timeout (up to 4300 seconds or 12 hours).</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Visibility Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Visibility Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Receipt Handles</strong></p></td><td><div><div><p>Array of <a href="#ChangeMessageVisibilityBatchRequestEntry">Change Message Visibility Batch Request Entry</a></p></div></div></td><td><div><div><p>List of receipt handles of the messages for which the visibility timeout must be changed.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#BatchResult">Batch Result</a></p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the queue to create.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Attributes</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of attributes with their corresponding values. Refer to the <a href="#queue-attributes">Queue Attributes</a> table below.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Queue Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DelaySeconds</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values are an integer from <code>0</code> to <code>900</code> seconds (15 minutes).</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>MaximumMessageSize</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values are an integer from <code>1024</code> bytes (1 KiB) to <code>262,144</code> bytes (256 KiB).</p></div></div></td><td><div><div><p><code>262,144</code> (256 KiB)</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>MessageRetentionPeriod</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Length of time, in seconds, for which Amazon SQS retains a message. Valid values are an integer from <code>60</code> seconds (1 minute) to <code>1,209,600</code> seconds (14 days).</p></div></div></td><td><div><div><p><code>345,600</code> (4 days)</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Policy</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Queue’s policy. A valid AWS policy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>ReceiveMessageWaitTimeSeconds</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values are an integer from <code>0</code> to <code>20</code> (seconds).</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>RedrivePolicy</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>String that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>VisibilityTimeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Visibility timeout for the queue, in seconds. Valid values are an integer from <code>0</code> to <code>43,200</code> (12 hours).</p></div></div></td><td><div><div><p><code>30</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>KmsDataKeyReusePeriodSeconds</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 <code>60</code> seconds (1 minute) and <code>86,400</code> seconds (24 hours).</p></div></div></td><td><div><div><p><code>300</code> (5 minutes)</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>FifoQueue</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Designates a queue as FIFO. Valid values are <code>true</code> or <code>false</code>. 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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>ContentBasedDeduplication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables content-based deduplication. Valid values are <code>true</code> or <code>false</code>. Every message must have a unique MessageDeduplicationId.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>ApproximateNumberOfMessages</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Approximate number of messages available for retrieval from the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>ApproximateNumberOfMessagesDelayed</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>ApproximateNumberOfMessagesNotVisible</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>CreatedTimestamp</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Time when the queue was created, in seconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>LastModifiedTimestamp</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Time when the queue was last changed, in seconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>QueueArn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Amazon resource name (ARN) of the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Redrive Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>deadLetterTargetArn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>maxReceiveCount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Receipt Handle</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Receipt handle of the message to delete.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Entries</strong></p></td><td><div><div><p>Array of <a href="#DeleteMessageBatchRequestEntry">Delete Message Batch Request Entry</a></p></div></div></td><td><div><div><p>List of receipt handles for the messages to delete.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#BatchResult">Batch Result</a></p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Number</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Attribute Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of attributes to retrieve information for.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the queue whose URL must be fetched.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Owner AWS Account Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS account ID of the owner that created the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Name Prefix</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>String to use for filtering the list results. Queues only with names beginning with the specified string are returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Number Of Messages</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of messages to read.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Wait time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum duration of a single poll, in seconds:</p></div><div><ul><li><p>Set this field to a value between <code>1</code> and <code>20</code> to use long polling.</p><div><p>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.</p></div></li><li><p>Set this field to <code>0</code> 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.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of <a href="#Message">Message</a></p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Label</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for the permission to remove.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue in which permissions are deleted from.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p><a href="#Message">Message</a></p></div></div></td><td><div><div><p>Message to send.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue in which to send the message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#SendMessageResult">Send Message Result</a></p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Messages</strong></p></td><td><div><div><p>Array of <a href="#Message">Message</a></p></div></div></td><td><div><div><p>List of Message items.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue in which to send the message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#BatchResult">Batch Result</a></p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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).

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Attributes</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of attributes to set.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the queue.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#RequestIDAttribute">Request ID Attribute</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#config)

#### 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](#BatchResult)

- [Batch Result Error Entry](#BatchResultErrorEntry)

- [Change Message Visibility Batch Request Entry](#ChangeMessageVisibilityBatchRequestEntry)

- [CRL File](#CrlFile)

- [Custom OCSP Responder](#CustomOcspResponder)

- [Delete Message Batch Request Entry](#DeleteMessageBatchRequestEntry)

- [Expiration Policy](#ExpirationPolicy)

- [Keystore](#KeyStore)

- [Large Payload Support](#LargePayloadSupport)

- [Message](#Message)

- [Reconnect](#Reconnect)

- [Reconnect Forever](#ReconnectForever)

- [Reconnection](#Reconnection)

- [Redelivery Policy](#RedeliveryPolicy)

- [Request ID Attribute](#RequestIDAttribute)

- [Send Message Result](#SendMessageResult)

- [Standard Revocation Check](#StandardRevocationCheck)

- [TLS](#Tls)

- [Truststore](#TrustStore)

### Batch Result

For each message in the batch, the response contains a String representing the entry ID if the
message succeeds or a BatchResultErrorEntry tag if the message fails.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Failed</strong></p></td><td><div><div><p>Array of <a href="#BatchResultErrorEntry">BatchResultErrorEntry</a></p></div></div></td><td><div><div><p>List of <a href="#BatchResultErrorEntry">Batch Result Error Entry</a> items.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Successful</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of String items representing the entry ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Code</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Error code that represents why the action failed on this entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID of an entry in a batch request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Message that explains why the action failed on this entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Sender Fault</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether the error happened due to the sender’s fault.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Change Message Visibility Batch Request Entry

Used to change the visibility timeout of messages.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receipt Handle</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Receipt handle for this entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Visibility Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>New value (in seconds) for the message’s visibility timeout.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Delete Message Batch Request Entry

Used to delete messages in batch.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receipt Handle</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Receipt handle for this entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Large Payload Support

Supports large message payloads on Amazon SQS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Bucket</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Size Threshold</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p><code>256</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Size Threshold Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li></ul></div></div></td><td><div><div><p>Data unit for the <strong>Message Size Threshold</strong> field.</p></div></div></td><td><div><div><p>KB</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom S3 Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom S3 endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>S3 Key Prefix</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Prefix to prepend to Amazon S3 object keys when storing large message payloads in the S3 bucket.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message

Output attributes for a sent message.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>body</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Message body to send.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>deduplicationId</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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 deduplication interval (5 minutes by default).</p></div><div><p>For FIFO queues, set <strong>ContentBasedDeduplication</strong> to <code>true</code> at a queue level to automatically generate the value for the <strong>deduplicationId</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>delaySeconds</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of seconds that a specific message is delayed. Valid values are <code>0</code> through <code>900</code>. If no value is specified, the default value for the queue is used.</p></div><div><p>The <strong>delaySeconds</strong> field cannot be set per message when <strong>FifoQueue</strong> is set; <strong>delaySeconds</strong> can only be set at a queue level.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>groupId</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Unique identifier for the message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>message Attributes</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of typed key-value pairs to send as message attributes. You must specify a value, key, and data type for each entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>receipt Handle</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Receipt handle for this entry.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. This property can be set only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>Object Store</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Request ID Attribute

Used for a request ID.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Request Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Send Message Result

Sends the result of the message.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>MD5 Of Message Attributes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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 <a href="http://www.faqs.org/rfcs/rfc1321.html">RFC 1321 - The MD5 Message-Digest Algorithm</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>MD5 Of Message Body</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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 <a href="http://www.faqs.org/rfcs/rfc1321.html">RFC 1321 - The MD5 Message-Digest Algorithm</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Element containing the message ID of the message sent to the queue. For more information, refer to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Amazon SQS Queue and Message Identifiers</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

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

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