---
updatedAt: 2026-09-28T14:46:12.000Z
agentTools:
  projectIndex: https://developer.searchblox.com/llms.txt
---

# Amazon S3 Data Source

The Amazon S3 Data Source indexes documents and objects from an Amazon S3 bucket into a SearchBlox collection, making the S3 content searchable using SearchBlox.

## Configuring SearchBlox

Before using the Amazon S3 Data Source, make sure SearchBlox is installed properly and create a Custom Collection.

![](https://files.readme.io/a4ad1e703f06211335c0a662d071abd3449262dd6e52a55601d06c1ed74ec110-image.png)

## Configuration details of Amazon S3 Data Source\*\*

[Accessing Connector UI](https://developer.searchblox.com/docs/connectors-ui)

|                               |                                                                                              |
| :---------------------------- | :------------------------------------------------------------------------------------------- |
| encrypted-ak                  | Encrypted Amazon S3 access key (encrypter available in the downloaded archive).              |
| encrypted-sk                  | Encrypted Amazon S3 secret key (encrypter available in the downloaded archive).              |
| region                        | Region of your Amazon S3 instance.                                                           |
| data-directory                | Folder where data will be stored. Make sure it has write permission.                         |
| api-key                       | SearchBlox API Key                                                                           |
| colname                       | Name of the custom collection in SearchBlox.                                                 |
| queuename                     | Amazon S3 SQS parameter, required for updating documents after indexing.                     |
| private-buckets               | Set to true to index content from private buckets.                                           |
| public-buckets                | Set to true to index content from public buckets.                                            |
| url                           | SearchBlox URL                                                                               |
| includebucket                 | List of S3 buckets to include.                                                               |
| include-formats               | File formats to include.                                                                     |
| expiring-url                  | Expiring URLs in search results (default is expiring URL).                                   |
| expire-time                   | Expire time for URLs (default is 300 minutes).                                               |
| permanent-url:                | Permanent URLs in search results (expiring URLs are preferred if both exist).                |
| max-folder-size               | Maximum size of a folder (in MB) before it is swept..                                        |
| servlet url & delete-api-url: | Make sure the port number is correct; for example, use 8443 if SearchBlox runs on port 8443. |

## Steps to trigger notification when a document is updated in S3

1. In Amazon S3 console, go to Services → Simple Queue Service (SQS) under Application Integration.
2. Click Create New Queue, give a name, and configure the queue.

![](https://files.readme.io/73f49cb-1.png "1.png")

3. Set Message Visibility Timeout, Retention Days, and Receive Message Wait Time.

![](https://files.readme.io/3deb077-2.png "2.png")

4. Set Receive Message Wait Time between 1–20 seconds to enable long polling.
5. In the S3 console, select the bucket for which you want SQS, go to Properties → Advanced Settings → Events.

![](https://files.readme.io/e00dec7-4.png "4.png")

![](https://files.readme.io/7d783da-3.png "3.png")

6. Click Add Notification, give a name, and select the events you want notifications <https://files.readme.io/e00dec7-4.png>

![](https://files.readme.io/64ae6c3-5.png "5.png")

7. Under Send To, select SQS Queue, enter the name of the queue created earlier, and click Save.

![](https://files.readme.io/d281a36-6.png "6.png")

8. Now, whenever a document in the bucket changes, a notification will be sent to SQS.

9. Provide the queue names in the S3 connector YAML file to trigger indexing whenever a document is updated.