Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Credentials

The S3 resource needs an AWS access key pair with read (and optionally write) access to your bucket.

​
1. Create an IAM User

  1. Go to https://console.aws.amazon.com/iam/
  2. Users -> Create user
  3. Attach the AmazonS3ReadOnlyAccess policy (or AmazonS3FullAccess for write)
  4. Security credentials -> Create access key -> Application running outside AWS
  5. Copy the Access key ID and Secret access key

​
2. Set Environment Variables

# .env.development
AWS_S3_BUCKET=my-bucket
AWS_DEFAULT_REGION=us-east-1
AWS_ACCESS_KEY_ID=AKIA...
AWS_SECRET_ACCESS_KEY=wJal...

​
Alternative: AWS Profile

If you have ~/.aws/credentials configured, you can use a profile name instead of explicit access keys. For the Python resource API, see the S3 resource doc.