Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Simple Storage Service (Amazon S3).

Amazon S3 is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web.

• Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

For prerequisites, see the README in the javascriptv3 folder.

• Hello Amazon S3 (ListBuckets)

Code examples that show you how to perform the essential operations within a service.

• Learn the basics

Code excerpts that show you how to call individual service functions.

• CopyObject
• CreateBucket
• DeleteBucket
• DeleteBucketPolicy
• DeleteBucketWebsite
• DeleteObject
• DeleteObjects
• GetBucketAcl
• GetBucketCors
• GetBucketPolicy
• GetBucketWebsite
• GetObject
• GetObjectLegalHold
• GetObjectLockConfiguration
• GetObjectRetention
• ListBuckets
• ListObjectsV2
• PutBucketAcl
• PutBucketCors
• PutBucketPolicy
• PutBucketWebsite
• PutObject
• PutObjectLegalHold
• PutObjectLockConfiguration
• PutObjectRetention

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

• Create a presigned URL
• Create a web page that lists Amazon S3 objects
• Delete all objects in a bucket
• Lock Amazon S3 objects
• Make conditional requests
• Upload or download large files

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Some scenarios are web applications that must be bundled. These scenarios are in the scenarios/web folder. Follow these steps to run a web scenario. Some scenarios might require extra steps to get them working.

1. Navigate to the web scenario you want to run.
2. Run npm i.
3. Run npm run dev.

This example shows you how to get started using Amazon S3.

node ./hello.js

This example shows you how to do the following:

• Create a bucket and upload a file to it.
• Download an object from a bucket.
• Copy an object to a subfolder in a bucket.
• List the objects in a bucket.
• Delete the bucket objects and the bucket.

This example shows you how to create a presigned URL for Amazon S3 and upload an object.

This example shows you how to list Amazon S3 objects in a web page.

This example shows you how to delete all of the objects in an Amazon S3 bucket.

This example shows you how to work with S3 object lock features.

This example shows you how to add preconditions to Amazon S3 requests.

This example shows you how to upload or download large files to and from Amazon S3.

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

• Amazon S3 User Guide
• Amazon S3 API Reference
• SDK for JavaScript (v3) Amazon S3 reference

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0