# aws_sqs

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [cloud-data-platform-full.txt](https://docs.redpanda.com/cloud-data-platform-full.txt)

---
title: aws_sqs
latest-operator-version: v26.2.5
latest-console-tag: v3.14.0
latest-connect-version: 4.117.0
latest-redpanda-tag: v26.2.6
docname: connect/components/inputs/aws_sqs
page-component-name: cloud-data-platform
page-version: master
page-component-version: master
page-component-title: Cloud
page-relative-src-path: connect/components/inputs/aws_sqs.adoc
page-edit-url: https://github.com/redpanda-data/cloud-docs/edit/main/modules/develop/pages/connect/components/inputs/aws_sqs.adoc
description: Consume messages from an AWS SQS URL.
page-git-created-date: "2024-09-09"
page-git-modified-date: "2026-10-30"
page-generated-sources:
  - include: connect:components:partial$descriptions/inputs/aws_sqs.adoc
    generator: null
    version: null
    source: the component specs in https://github.com/redpanda-data/connect
page-generated-content: partial
---

<!-- Source: https://docs.redpanda.com/cloud-data-platform/develop/connect/components/inputs/aws_sqs.md -->

Consume messages from an AWS SQS URL.

## [](#credentials-overview)Credentials

By default Redpanda Connect will use a shared credentials file when connecting to AWS services. It’s also possible to set them explicitly at the component level, allowing you to transfer data across accounts. You can find out more in [AWS credentials](https://docs.redpanda.com/cloud-data-platform/develop/connect/guides/cloud/aws/).

## [](#metadata)Metadata

This input adds the following metadata fields to each message:

-   `sqs_message_id`

-   `sqs_receipt_handle`

-   `sqs_approximate_receive_count`

-   All message attributes


You can access these metadata fields using [function interpolation](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/interpolation/#bloblang-queries).

### Common

```yml
input:
  label: ""
  aws_sqs:
    url: "" # No default (required)
    max_outstanding_messages: 1000
```

### Advanced

```yml
input:
  label: ""
  aws_sqs:
    url: "" # No default (required)
    delete_message: true
    reset_visibility: true
    max_number_of_messages: 10
    max_outstanding_messages: 1000
    wait_time_seconds: 0
    message_timeout: 30s
    region: "" # No default (optional)
    endpoint: "" # No default (optional)
    tcp:
      connect_timeout: 0s
      keep_alive:
        idle: 15s
        interval: 15s
        count: 9
      tcp_user_timeout: 0s
    credentials:
      profile: "" # No default (optional)
      id: "" # No default (optional)
      secret: "" # No default (optional)
      token: "" # No default (optional)
      from_ec2_role: false # No default (optional)
      role: "" # No default (optional)
      role_external_id: "" # No default (optional)
```

## [](#fields)Fields

### [](#credentials)`credentials`

Manually configure the AWS credentials to use (optional). For more information, see the [Amazon Web Services guide](https://docs.redpanda.com/cloud-data-platform/develop/connect/guides/cloud/aws/).

**Type**: `object`

### [](#credentials-from_ec2_role)`credentials.from_ec2_role`

Use the credentials of a host EC2 machine configured to assume [an IAM role associated with the instance](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html).

**Type**: `bool`

### [](#credentials-id)`credentials.id`

The ID of the AWS credentials to use.

**Type**: `string`

### [](#credentials-profile)`credentials.profile`

The profile from `~/.aws/credentials` to use.

**Type**: `string`

### [](#credentials-role)`credentials.role`

The ARN of the role to assume.

**Type**: `string`

### [](#credentials-role_external_id)`credentials.role_external_id`

An external ID to use when assuming a role.

**Type**: `string`

### [](#credentials-secret)`credentials.secret`

The secret for the AWS credentials in use.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

### [](#credentials-token)`credentials.token`

The token for the AWS credentials in use. Required only when using short-term credentials.

**Type**: `string`

### [](#delete_message)`delete_message`

Whether to delete the consumed message when it’s acknowledged. Set to `false` to handle the deletion using a different mechanism.

**Type**: `bool`

**Default**: `true`

### [](#endpoint)`endpoint`

A custom endpoint URL for AWS API requests. Use this to connect to AWS-compatible services or local testing environments instead of the standard AWS endpoints.

**Type**: `string`

### [](#max_number_of_messages)`max_number_of_messages`

The maximum number of messages that Redpanda Connect can return each time it polls the SQS queue. Enter a value from `1` to `10`.

**Type**: `int`

**Default**: `10`

### [](#max_outstanding_messages)`max_outstanding_messages`

The maximum number of pending messages that Redpanda Connect can have in flight at the same time.

**Type**: `int`

**Default**: `1000`

### [](#message_timeout)`message_timeout`

The maximum time allowed to process a received message before Redpanda Connect must refresh its [receipt handle](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html). If the handle is not refreshed in time, the message becomes visible in the queue again. Redpanda Connect attempts to refresh the receipt handle after half of the timeout has elapsed. This value sets the visibility timeout for each received message.

**Type**: `string`

**Default**: `30s`

### [](#region)`region`

The AWS region in which your resources are hosted.

**Type**: `string`

### [](#reset_visibility)`reset_visibility`

Whether to set the visibility timeout of the consumed message to zero when Redpanda Connect receives a negative acknowledgement, which releases the message immediately for reprocessing. Set to `false` to honor the [queue’s visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) instead.

**Type**: `bool`

**Default**: `true`

### [](#tcp)`tcp`

Configure TCP socket-level settings to optimize network performance and reliability. These low-level controls are useful for:

-   **Unresponsive hosts**: Set `connect_timeout` to limit how long a connection attempt can take (the default `0s` sets no limit)

-   **Long-lived connections**: Configure `keep_alive` settings to detect and recover from stale connections

-   **Unstable networks**: Tune keep-alive probes to balance between quick failure detection and avoiding false positives

-   **Linux systems with specific requirements**: Use `tcp_user_timeout` (Linux 2.6.37+) to control data acknowledgment timeouts


Most users should keep the default values. Only modify these settings if you’re experiencing connection stability issues or have specific network requirements.

**Type**: `object`

### [](#tcp-connect_timeout)`tcp.connect_timeout`

Maximum amount of time a dial will wait for a connect to complete. Zero disables.

**Type**: `string`

**Default**: `0s`

### [](#tcp-keep_alive)`tcp.keep_alive`

TCP keep-alive probe configuration.

**Type**: `object`

### [](#tcp-keep_alive-count)`tcp.keep_alive.count`

Maximum unanswered keep-alive probes before dropping the connection. Zero defaults to 9.

**Type**: `int`

**Default**: `9`

### [](#tcp-keep_alive-idle)`tcp.keep_alive.idle`

Duration the connection must be idle before sending the first keep-alive probe. Zero defaults to 15s. Negative values disable keep-alive probes.

**Type**: `string`

**Default**: `15s`

### [](#tcp-keep_alive-interval)`tcp.keep_alive.interval`

Duration between keep-alive probes. Zero defaults to 15s.

**Type**: `string`

**Default**: `15s`

### [](#tcp-tcp_user_timeout)`tcp.tcp_user_timeout`

Maximum time to wait for acknowledgment of transmitted data before killing the connection. Linux-only (kernel 2.6.37+), ignored on other platforms. When enabled, keep\_alive.idle must be greater than this value per RFC 5482. Zero disables.

**Type**: `string`

**Default**: `0s`

### [](#url)`url`

The SQS URL to consume from.

**Type**: `string`

### [](#wait_time_seconds)`wait_time_seconds`

The wait time, in seconds, for each receive request. Valid values are `0` to `20`. Set a value from `1` to `20` to enable [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) for queued messages.

**Type**: `int`

**Default**: `0`