> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# S3 Overview

> Overview of the S3 connector

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

### Authorization

We support three authorization methods—pick one that fits your environment:

* [AWS Access Keys](./access-keys) - Uses traditional access key credentials
* [IAM Role-Based Authorization](./iam-role) - Uses AWS IAM roles for secure access
* [Assume Role](./assume-role) - Automatically uses the EC2 instance's attached role for S3 access

### Indexing

Once you've set up your authorization method, follow these steps to index your S3 bucket:

<Steps>
  <Step title="Open S3 connector">
    Navigate to the Onyx Admin Panel and select the **S3** Connector.
  </Step>

  <Step title="Configure authorization">
    In **Step 1**, configure your authorization:

    * If you have existing credentials, select them from the list
    * If you don't have existing credentials, click **Create New** to add new authorization:
    * **Access Keys**: Enter your AWS Access Key ID and Secret Access Key
    * **IAM Role**: Click the IAM Role tab and enter your Role ARN
    * **Assume Role**: Click the Assume Role tab (no credentials required)
  </Step>

  <Step title="Save configuration">
    Click **Create** to save your configuration.
  </Step>

  <Step title="Continue with selected credential">
    Ensure your chosen credential is selected, then click **Continue**
  </Step>

  <Step title="Specify bucket details">
    In **Step 2**, specify your S3 bucket details:

    * **Connector Name**: Enter a name for the connector (e.g., "MyS3Connector")
    * **Bucket Name**: Specify the name of the S3 bucket you want to index
    * **Prefix (Optional)**: Provide a prefix to limit indexing to a specific folder or path
    * **Access Type**: Choose whether documents are **Public** or **Private**
  </Step>

  <Step title="Create connector">
    Click **Create Connector** to begin indexing.
  </Step>
</Steps>

The connector will start indexing your S3 bucket and you can add more buckets or modify settings as needed.

<img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/blob/s3/connector.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=9a1472279bf72a0d99a351195a7d9bff" alt="Onyx S3 connector details page" width="3454" height="1944" data-path="assets/admins/connectors/blob/s3/connector.png" />

## 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).