Skip to content

Latest commit

 

History

History
 
 

README.rst

AWS SDK for JavaScript v3 examples

These are examples for the AWS SDK for JavaScript version 3 (v3) public documentation.

The preview of the AWS SDK for JavaScript v3 is available.

The AWS SDK for JavaScript v3 Developer Guide contains topics for these examples.

NOTE: The AWS SDK for JavaScript v3 is written in TypeScript so, for consistency, these examples are also in TypeScript. TypeScript extends of JavaScript so these examples can also be run as JavaScript. For more information, see the TypeScript homepage .

Note: Examples for AWS SDK for JavaScript version 2 (v2) are available in the javascript/example_code folder in this repo.

Prerequisites

To build and run these examples, you need to:

  • Set up the project environment to run these TypeScript examples with Node.js, and install the required AWS SDK for JavaScript and third-party modules. Follow the instructions in the README.md in the folder with the examples you're running; for example, instructions for Amazon S3 examples.
  • Create a shared configurations file with your user credentials. See the AWS SDK for JavaScript v3 Developer Guide for more information.

Running the examples

Examples are written for either execution in a browser script or in Node.js, usually depending on the use case for each. The two scenarios typically differ in how you supply credentials to the code. For information on the differences, once it's released see the AWS SDK for JavaScript v3 Developer Guide.

To run the examples, you'll need to create a shared credentials file. For more information about how to set up a shared credentials file, once it's released see Loading Credentials in Node.js from the Shared Credentials File in the AWS SDK for JavaScript Developer Guide.

The Node.js examples are all run from the command line.

Documentation

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0