## S3 Inventory Report Structure

URL: https://docs.atlan.com/apps/connectors/storage/amazon-s3/references/inventory-report-structure

> Expected folder structure and format for S3 inventory reports used by Atlan's S3 crawler for inventory-based ingestion.

This reference outlines the expected folder layout and file format for [Amazon S3 inventory reports](https://docs.atlan.com/llms/connectors/amazon-s3/set-up-inventory-reports-for-s3/llms.txt) used by Atlan’s S3 crawler when running [inventory-based ingestion](https://docs.atlan.com/llms/connectors/amazon-s3/crawl-s3/llms.txt).

:::warning important
 The crawler supports a single destination bucket, with an optional prefix, to store all inventory reports from multiple source buckets.
:::

## Folder structure

To enable successful [inventory-based crawling](https://docs.atlan.com/llms/connectors/amazon-s3/crawl-s3/llms.txt), your destination bucket must follow this structure once inventory reports are generated: 

```
📦 <destination-bucket>/
├── [📁 <optional-prefix>/] (applies to all buckets)
│ ├── 📁 <source-bucket-1>/
│ │ ├── 📁 <inventory-config-1>/
│ │ │ ├── 📁 / (timestamp folders)
│ │ │ │ └── 📄 manifest.json
│ │ │ └── 📁 data/ (CSV or gzipped files)
│ │ │ └── 📄 <inventory-file>.csv.gz
│ │ └── 📁 <inventory-config-2>/
│ └── 📁 <source-bucket-2>/
└── ...
```

| Required | Component | Description | Example |
|----------|-----------|-------------|---------|
| ✅ | **Destination bucket** | Single S3 bucket to store all inventory reports | `atlan-inventory-reports` |
| ❌ | **Prefix** | Folder prefix to organize reports (same for all source buckets) | `inventory-reports` |
| ✅ | **Source bucket folder** | Folder named after each source bucket | `source-bucket-1` |
| ✅ | **Inventory config folder** | Folder named after the inventory configuration | `daily-inventory` |
| ✅ | **Timestamp folder** | Folder with report generation timestamp | `2024-01-16T00-00Z` |
| ✅ | **Manifest file** | `manifest.json` containing report metadata | `manifest.json` |
| ✅ | **Data folder** | Folder containing compressed inventory files | `data` |
| ✅ | **Inventory files** | `.csv.gz` or `.parquet` files with actual data | `inventory-2024-01-16-00-00Z.csv.gz` |

### Examples

> *📁 Basic structure (single source bucket) — see full content on the documentation site.*

> *📁 Multiple source buckets — see full content on the documentation site.*

> *📁 With optional prefix — see full content on the documentation site.*

## See also

* [Set up inventory reports for S3](https://docs.atlan.com/llms/connectors/amazon-s3/set-up-inventory-reports-for-s3/llms.txt): Set up inventory reports for S3

---