> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/aws-s3.md).

# AWS S3

Connect to AWS S3 for cloud storage and file management.

* Knowledge base source

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector           | Authentication  |
| ------------------- | --------------- |
| AWS S3              | Credentials     |
| S3 Events (via SQS) | AWS credentials |

#### AWS S3

Connect to Amazon S3 cloud storage to store and retrieve files and objects. Supports scalable storage for files, backups, and application data.

**Set up in AWS S3**

1. In the AWS IAM console, create (or choose) a user or role with permissions for your bucket (for example s3:GetObject, s3:PutObject, and s3:ListBucket).
2. Create an access key for that identity and copy the Access Key ID and Secret Access Key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **AWS S3**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field                | Required                 | What to enter                                                                                                                                                                                                                                                                                              |
| ---------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AWS Region                   | Yes                      | The AWS region where your S3 bucket is located (e.g., us-east-1, eu-west-1). Find your region in the AWS S3 console or check AWS documentation for available regions. [Provider instructions](https://docs.aws.amazon.com/general/latest/gr/s3.html).                                                      |
| AWS Access Key ID            | Yes                      | Your AWS IAM access key ID for programmatic access. Create this in the AWS IAM console under 'Access keys'. Ensure the IAM user has S3 permissions (s3:GetObject, s3:PutObject, s3:ListBucket). [Provider instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). |
| AWS Secret Access Key        | Yes                      | The secret key that pairs with your Access Key ID. This is only shown once when you create the access key in AWS IAM console. Keep this secure and never share it publicly. [Provider instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).                     |
| S3 Bucket Name               | Yes                      | The name of your S3 bucket (e.g., 'my-company-data'). The bucket must already exist and be accessible with the provided credentials. Bucket names are globally unique across all AWS accounts. [Provider instructions](https://docs.aws.amazon.com/s3/latest/userguide/creating-bucket.html).              |
| AWS Session Token (Optional) | Optional / as applicable | Required only when using temporary credentials from AWS STS (e.g., AssumeRole, SSO, or federated access). Leave empty if using long-lived IAM user access keys. [Provider instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).                          |

**Provider documentation:** [Setup reference](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).

#### S3 Events (via SQS)

Connect to AWS SQS queue for processing S3 event notifications. Automatically triggers workflows when files are uploaded, modified, or deleted in S3.

**Set up in AWS S3**

1. In the AWS console, create an SQS queue that will receive S3 event notifications.
2. On your S3 bucket, add an event notification (for object created/removed events) that targets the SQS queue, and grant the bucket permission to send messages to the queue.
3. Create AWS credentials (Access Key ID and Secret Access Key) with permission to read and delete messages from the queue.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **S3 Events (via SQS)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                     |
| ----------------- | -------- | ----------------------------------------------------------------- |
| SQS Queue URL     | Yes      | The full URL of your SQS queue.                                   |
| AWS Region        | Yes      | The AWS region where your SQS queue is located (e.g., us-east-1). |
| Access Key ID     | Yes      | Your AWS access key ID.                                           |
| Secret Access Key | Yes      | Your AWS secret access key.                                       |

**Provider documentation:** [Setup reference](https://docs.aws.amazon.com/AmazonS3/latest/userguide/NotificationHowTo.html).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **AWS S3** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get File

Get a file from AWS S3 bucket with optional document parsing

**Inputs**

| Field                         | Type   | Required | Description                                                                                                                                                                                                                                                                                                           |
| ----------------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Object Key (S3 Path)          | string | Yes      | The S3 object key (path) of the file to get.                                                                                                                                                                                                                                                                          |
| File Name (extension is kept) | string | No       | Optional: rename the file. Leave empty to keep the name from the object key. The extension is taken from the object key when it has one, otherwise from the file type S3 reports. Include an extension yourself only if neither is available, for example a key with no extension that S3 reports as an unknown type. |

**Outputs**

| Field    | Type   | Description                      |
| -------- | ------ | -------------------------------- |
| File     | object | The S3 file information.         |
| File URL | string | Signed URL to download the file. |

#### Get S3 URL

Get a presigned S3 URL for a file, so recipients download it straight from your bucket instead of through StackAI

**Inputs**

| Field                  | Type    | Required | Description                                                                                                                                                                                                                                                                                                                                                                    |
| ---------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Object Key (S3 Path)   | string  | Yes      | The S3 object key (path) of the file to link to.                                                                                                                                                                                                                                                                                                                               |
| Link lifetime in hours | integer | No       | How long the URL stays valid, from 1 hour up to 168 hours (7 days, the AWS maximum). Anyone holding the URL can download the file until it expires. If your connection uses temporary AWS credentials (STS, SSO or AssumeRole), the link dies when that session token expires, often within 1 to 12 hours, no matter what you set here. Minimum: 1. Maximum: 168. Default: 24. |

**Outputs**

| Field  | Type   | Description                                                                                                                                                                                                                                                       |
| ------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| S3 URL | string | Presigned S3 URL that downloads the file directly from the bucket. Treat it like a password: anyone holding it can download the file until it expires. The file downloads as an attachment named after the object, with spaces and non-ASCII characters replaced. |
| File   | object | Bucket, key, size, type and last-modified time of the linked file.                                                                                                                                                                                                |

#### Create File

Create a file in AWS S3 bucket by downloading from a URL

**Inputs**

| Field                    | Type   | Required | Description                                                                                                                                                                        |
| ------------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| File URL                 | string | Yes      | URL to download the file from and upload to S3.                                                                                                                                    |
| Folder Path              | string | No       | Optional folder path in S3 where the file will be stored. Leave empty to upload to the bucket root. Example: 'reports/2026/' will upload to s3://bucket/reports/2026/filename.pdf. |
| File Name                | string | No       | Optional: Rename the file. If not provided, the original filename from the source URL is preserved automatically.                                                                  |
| Content Type (MIME Type) | string | No       | The MIME type of the file. Auto-detected from the source URL if not provided.                                                                                                      |

**Outputs**

| Field      | Type   | Description                                 |
| ---------- | ------ | ------------------------------------------- |
| File       | object | The created S3 file information.            |
| Version ID | string | Version ID if bucket versioning is enabled. |

#### Update File

Update a file in AWS S3 bucket by overwriting the existing object

**Inputs**

| Field                    | Type   | Required | Description                                                                   |
| ------------------------ | ------ | -------- | ----------------------------------------------------------------------------- |
| Object Key (S3 Path)     | string | Yes      | The S3 object key (path) of the file to update.                               |
| File URL                 | string | Yes      | URL to download the new file content from.                                    |
| Content Type (MIME Type) | string | No       | The MIME type of the file. Auto-detected from the source URL if not provided. |

**Outputs**

| Field      | Type   | Description                                                    |
| ---------- | ------ | -------------------------------------------------------------- |
| File       | object | The updated S3 file information.                               |
| Version ID | string | Version ID of the new version if bucket versioning is enabled. |

#### List Files

List files in AWS S3 bucket

**Inputs**

| Field              | Type    | Required | Description                                                                   |
| ------------------ | ------- | -------- | ----------------------------------------------------------------------------- |
| Prefix             | string  | No       | Filter objects by prefix (folder path).                                       |
| Delimiter          | string  | No       | Character used to group keys (typically '/').                                 |
| Max Keys           | integer | No       | Maximum number of objects (1-1000). Minimum: 1. Maximum: 1000. Default: 1000. |
| Continuation Token | string  | No       | Token for pagination to get next page.                                        |

**Outputs**

| Field                   | Type          | Description                                       |
| ----------------------- | ------------- | ------------------------------------------------- |
| Objects                 | object\_array | List of S3 objects.                               |
| Common Prefixes         | object\_array | Common prefixes (folders) when delimiter is used. |
| Is Truncated            | boolean       | Whether the list was truncated.                   |
| Next Continuation Token | string        | Token for retrieving the next page.               |
| Key Count               | integer       | Number of keys returned.                          |
| Prefix                  | string        | The prefix filter applied.                        |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/aws-s3.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
