AWS S3 JS

Upload files to an Amazon S3 bucket using JavaScript.

[Special note: aws-s3-js now works straight out of the box with react-scripts 5 and Webpack 5, even if you have not configured your app to polyfill Node Js core modules. aws-s3-js also works with react-scripts 4 straight out of the box.]

Installation

To install the package, in your project run

npm install aws-s3-js

Then use a default import statement:

import awsS3Js from 'aws-s3-js'

aws-s3-js has browser support as well. Read below.

Usage

To get started, call the constructor using the below keys:

1import awsS3Js from 'aws-s3-js'
2
3const config = {
4    bucketName: "<bucket-name>",
5    region: "<bucket-region>",
6    accessKeyId: "<your-accessKey>",
7    secretAccessKey: "<your-secretAccessKey>"
8}
9
10const S3Client = new awsS3Js(config);

Please refer to aws-s3-jsgithub readme for full documentation and example usage.