Skip to content

S3 Input

Reads data from an Amazon S3 bucket.

Supported formats

  • JSON (including gzipped)
  • CSV / delimited
  • Parquet

Configuration

yaml
data_sources:
  sample:
    S3:
      s3_bucket: skippr-public-sample-data
      s3_prefix: bike-hire

JSON (including gzipped), CSV, and Parquet are supported.

bash
DATA_SOURCE_PLUGIN_NAME=s3
DATA_SOURCE_S3_BUCKET=my-source-bucket
DATA_SOURCE_S3_PREFIX=events/
AWS_DEFAULT_REGION=us-east-1
VariableDefaultDescription
DATA_SOURCE_S3_BUCKET(required)S3 bucket name
DATA_SOURCE_S3_PREFIXKey prefix to filter objects
DATA_SOURCE_S3_DELIMITER/S3 listing delimiter
DATA_SOURCE_S3_PREFIX_ORDERED_DEPTH0Depth for ordered prefix scanning
DATA_SOURCE_BATCH_SIZE_BYTES1024000Bytes per read batch
DATA_SOURCE_BATCH_SIZE_SECONDS600Max seconds per batch

AWS credentials

Uses the standard AWS credential chain: environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY), instance profile, or IAM role.

Performance tuning

VariableDefaultDescription
S3_DOWNLOAD_CONCURRENCYautoConcurrent S3 download streams
S3_DOWNLOAD_MEMORY_MBautoMemory budget for downloads
S3_INFLATE_RATIO4Expected compression ratio for gzipped data
INGEST_PENDING_MAX_BYTESautoMax bytes in the pending ingest queue

Checkpointing

The S3 input tracks progress by object key and last-modified timestamp. On restart, already-ingested objects are skipped.

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"

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 s3_prefix matches the actual key prefix in the bucket

This site is source-available under PolyForm Shield 1.0.0