Skip to content

S3

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Reads files from an Amazon S3 bucket.

Configuration

yaml
source:
  kind: s3
  s3_bucket: my-bucket
  s3_prefix: data/
  transform:
    namespace_fields: event_type
FieldDefaultDescription
s3_bucket(required)S3 bucket name
s3_prefixKey prefix for filtering objects
transform.namespace_fieldsField or fields used to namespace incoming events

CLI

bash
skippr connect source s3 \
  --bucket my-data-bucket \
  --prefix raw/ \
  --namespace-fields event_type
FlagDescription
--bucketS3 bucket name
--prefixKey prefix to scan
--namespace-fieldsField or fields used to namespace incoming events

Config output

Running connect source s3 writes the following to skippr.yaml:

yaml
source:
  kind: s3
  s3_bucket: my-data-bucket
  s3_prefix: raw/
  transform:
    namespace_fields: event_type

Authentication

S3 access uses standard AWS credentials.

VariableDescription
AWS_ACCESS_KEY_IDAWS access key
AWS_SECRET_ACCESS_KEYAWS secret key
AWS_DEFAULT_REGIONAWS region (if not inferred from bucket location)
bash
export AWS_ACCESS_KEY_ID="AKIA..."
export AWS_SECRET_ACCESS_KEY="..."
export AWS_DEFAULT_REGION="us-east-1"

Permissions or Network Requirements

IAM policy

The IAM user or role needs at minimum:

json
{
  "Effect": "Allow",
  "Action": [
    "s3:GetObject",
    "s3:ListBucket"
  ],
  "Resource": [
    "arn:aws:s3:::my-data-bucket",
    "arn:aws:s3:::my-data-bucket/*"
  ]
}

Using an IAM role (EC2 / ECS / SSO)

If running on AWS infrastructure or using SSO, you can omit the access key variables entirely. The SDK will pick up credentials from the instance metadata service or SSO profile automatically.

Supported file formats

Skippr auto-detects the format of files in the bucket:

  • JSON / JSONL
  • CSV / TSV / delimited
  • Parquet
  • Avro

Troubleshooting

SymptomFix
Access DeniedCheck AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are set, and the IAM policy allows s3:GetObject and s3:ListBucket on the bucket
NoSuchBucketVerify the bucket name and region
No files foundCheck the --prefix value matches the actual key prefix in the bucket

Next steps

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy