If you are upgrading from 1.x to 2.0 of the SDK, please see the [upgrading](https://github.com/aws/aws-sdk-js/blob/master/UPGRADING.md) notes for information on how to migrate existing code to work with the new major version.
In the Browser
To use the SDK in the browser, simply add the following script tag to your HTML pages:
You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of services, or use AWS services that don't currently support CORS if you are working in an environment that does not enforce CORS. To get started:
The AWS SDK is also compatible with browserify.
The preferred way to install the AWS SDK for Node.js is to use the npm package manager for Node.js. Simply type the following into a terminal window:
npm install aws-sdk
In React Native
To use the SDK in a react native project, first install the SDK using npm:
npm install aws-sdk
Then within your application, you can reference the react native compatible version of the SDK with the following:
var AWS = require('aws-sdk/dist/aws-sdk-react-native');
You can also use Bower to install the SDK by typing the following into a terminal window:
bower install aws-sdk-js
Usage and Getting Started
You can find a getting started guide at:
Usage with TypeScript
Our goal is to keep these TypeScript definition files updated with each release for any public api.
Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:
- Use TypeScript v2.x
Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:
npm install --save-dev @types/node
compilerOptions.lib. See tsconfig.json for an example.
In the Browser
To use the TypeScript definition files with the global
/// <reference types="aws-sdk" />
This will provide support for the global
To use the TypeScript definition files within a Node.js project, simply import
aws-sdk as you normally would.
In a TypeScript file:
// import entire SDK import AWS = require('aws-sdk'); // import AWS object without services import AWS = require('aws-sdk/global'); // import individual service import S3 = require('aws-sdk/clients/s3');
// import entire SDK var AWS = require('aws-sdk'); // import AWS object without services var AWS = require('aws-sdk/global'); // import individual service var S3 = require('aws-sdk/clients/s3');
Due to the SDK's reliance on node.js typings, you may encounter compilation issues when using the typings provided by the SDK in an Angular project created using the Angular CLI.
To resolve these issues, either add
"types": ["node"] to the project's
file, or remove the
"types" field entirely.
There are a few known limitations with the bundled TypeScript definitions at this time:
- Service client typings reflect the latest
apiVersion, regardless of which
apiVersionis specified when creating a client.
- Service-bound parameters use the
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Ask a question on StackOverflow and tag it with
- Open a support ticket with AWS Support
- If it turns out that you may have found a bug, please open an issue
Please see SERVICES.md for a list of supported services.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.