Skip to main content

How it works

The S3 connector pulls in all documents from the specified Amazon S3 bucket. It supports various file formats including PDF, DOC, DOCX, TXT, and more. Documents are updated every 1 day.

Setting up

Setup runs through four steps, shown in the left rail of the connector page: Credential, Connector, Space, and Advanced. Before you connect in the Admin panel, create an AWS IAM user with read access to your bucket (see Authorization below).

Authorization

Create a dedicated IAM user with S3 read access and generate an access key pair. UtopikAI uses the AWS Access Key ID and AWS Secret Access Key when you create an S3 credential.
  1. Log into your AWS Management Console.
  2. Navigate to the IAM (Identity and Access Management) dashboard.
  3. In the left sidebar, click Users, then Create user.
  4. Set a name for the new user (for example UtopikAIS3Connector) and click Next.
  5. Click Attach policies directly and search for AmazonS3ReadOnlyAccess or a similarly permissive policy.
  6. Select the policy and click Next.
  7. Add any tags if needed, then click Create user.
  8. On the Users page, open the user you just created.
  9. Click Create access key and select Third-party service.
  10. Select I understand the above recommendation and want to proceed to create an access key, then click Next.
  11. Optionally set a description tag, then click Create access key.
  12. Copy the Access Key ID and Secret Access Key immediately. You cannot retrieve the secret key again after you leave this page.
Store the access key pair securely. You will need both values when creating an S3 credential in the Admin panel.

Step 1: Select Credential

  1. Open Admin from the profile menu, then go to ConnectorsAdd Connector.
  2. Under Storage, select S3.
  3. In Step 1, select an existing credential from the list, or click Create New to add one.
Step 1: Select Credential Existing credentials are listed with their ID, Name, Created date, and Last Updated date. If no credential has been set up yet, the list shows No credentials found.
Ensure the credential you select has read access to the S3 bucket you plan to index. A credential without the required bucket permissions cannot index its contents.

Create a credential

Clicking Create New opens the Create S3 Credential modal: Create S3 Credential
  1. Enter an optional Name to label the credential (for example Production S3).
  2. Enter the AWS Access Key ID and AWS Secret Access Key from the IAM user you created above.
  3. Click + Create to save the credential.
Select the credential you created, then click Continue.

Step 2: Configure the connector

  1. Enter the S3 Bucket Name you want to make searchable.
  2. Set Is Bucket Public? to match your bucket’s access configuration.
  3. Click Continue.
You can add more buckets later using the same credential.

Step 3: Select a space

Choose the space to index the documents from. This controls which space the connector’s indexed content belongs to. Use the search field to filter the list if you have many spaces, then click Continue.

Step 4: Advanced Configuration

The final step controls how often UtopikAI syncs with S3 and how far back it indexes. The defaults work for most setups. Entering 0 or leaving Refresh Frequency blank means UtopikAI will never pull new documents for this connector. Entering 0 or leaving Prune Frequency blank disables pruning for this connector. Pruning checks every document against the source, so lower values (more frequent pruning) increase load — raise the frequency with care on large buckets. Use Reset to restore the default values. When you are done, click Create Connector to save the connector and begin indexing your S3 files. You can return to any earlier step using the Previous button or the step list in the left rail.

Understanding S3 Structure

Amazon S3 organizes data into buckets. Each bucket can contain an unlimited number of objects (files). You can think of a bucket as a root directory, and the objects as files within that directory. For more information on S3 structure, visit the Amazon S3 documentation.