Skip to main content

aws-s3 Adaptor developer README.md

Source: https://github.com/OpenFn/adaptors/tree/main/packages/aws-s3

language-aws-s3

An OpenFn adaptor for building integration jobs for use with the aws-s3 API.

Documentation​

View the docs site for full technical documentation.

The adaptor uses the AWS SDK @aws-sdk/client-s3.

Operations

  • put(params) — Put an object into a bucket.

    • Params: { bucket, key, body, contentType?, acl?, serverSideEncryption? }

  • get(params) — Retrieve an object from a bucket.

    • Params: { bucket, key }
    • If the object is JSON (Content-Type application/json) the adaptor attempts to parse it and sets state.data to the parsed value.
    • Otherwise the binary body is returned as base64 at state.data.base64, with state.data.contentType and state.data.contentLength set when available.

  • list(params) — List objects in a bucket.

    • Params: { bucket, prefix?, maxKeys?, continuationToken? }

Examples

put({
  bucket: 'openfn-test',
  key: 'patients/1.json',
  body: JSON.stringify({ id: 1, name: 'A' }),
  contentType: 'application/json',
});
get({ bucket: 'openfn-test', key: 'patients/1.json' });
list({ bucket: 'openfn-test', prefix: 'patients/' });

Do not commit real AWS credentials into source control. Use environment variables, CI secrets, or the default provider chain.

Development​

Clone the adaptors monorepo. Follow the "Getting Started" guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To build only the docs run pnpm build docs.