kapilkoundinya / aws-sdk-js

AWS SDK for JavaScript in the browser and Node.js

AWS SDK for JavaScript

The official AWS SDK for JavaScript, available for browsers and mobile devices, or Node.js backends

For release notes, see the CHANGELOG. Prior to v2.4.8, release notes can be found at http://aws.amazon.com/releasenotes/SDK/JavaScript

If you are upgrading from 1.x to 2.0 of the SDK, please see the {file:UPGRADING.md} notes for information on how to migrate existing code to work with the new major version.

Installing

In the Browser

To use the SDK in the browser, simply add the following script tag to your HTML pages:

<script src="https://sdk.amazonaws.com/js/aws-sdk-2.7.1.min.js"></script>

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:

http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html

The AWS SDK is also compatible with browserify.

In Node.js

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

Using Bower

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:

http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide

Usage with TypeScript

The AWS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files. Our goal is to keep these TypeScript definition files updated with each release for any public api.

Pre-requisites

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

• Your tsconfig.json or jsconfig.json includes 'dom' and 'es2015.promise' under compilerOptions.lib. See tsconfig.json for an example.

In the Browser

To use the TypeScript definition files with the global AWS object in a front-end project, add the following line to the top of your JavaScript file:

/// <reference types="aws-sdk" />

This will provide support for the global AWS object.

In Node.js

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');

In a JavaScript file:

// 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');

Known Limitations

There are a few known limitations with the bundled TypeScript definitions at this time:

• Service client typings reflect the latest apiVersion, regardless of which apiVersion is specified when creating a client.
• Service-bound parameters use the any type.

Supported Services

Note: Although all services are supported in the browser version of the SDK, not all of the services are available in the default hosted build (using the script tag provided above). Instructions on how to build a custom version of the SDK with individual services are provided in the "Building the SDK for Browsers" section of the SDK Developer Guide.

The SDK currently supports the following services:

Service Name	Class Name	API Version
Amazon API Gateway	AWS.APIGateway	2015-07-09
Amazon CloudFront	AWS.CloudFront	2014-10-21
Amazon CloudHSM	AWS.CloudHSM	2014-05-30
Amazon CloudSearch	AWS.CloudSearch	2013-01-01
Amazon CloudSearch Domain	AWS.CloudSearchDomain	2013-01-01
Amazon CloudWatch	AWS.CloudWatch	2010-08-01
Amazon CloudWatch Events	AWS.CloudWatchLogs	2015-10-07
Amazon CloudWatch Logs	AWS.CloudWatchLogs	2014-03-28
Amazon Cognito Identity	AWS.CognitoIdentity	2014-06-30
Amazon Cognito Sync	AWS.CognitoSync	2014-06-30
Amazon DynamoDB	AWS.DynamoDB	2012-08-10
Amazon DynamoDB Streams	AWS.DynamoDBStreams	2012-08-10
Amazon EC2 Container Registry	AWS.ECR	2015-09-21
Amazon EC2 Container Service	AWS.ECS	2014-11-13
Amazon Elastic Compute Cloud	AWS.EC2	2014-10-01
Amazon Elastic File System	AWS.EFS	2015-02-01
Amazon Elastic MapReduce	AWS.EMR	2009-03-31
Amazon Elastic Transcoder	AWS.ElasticTranscoder	2012-09-25
Amazon ElastiCache	AWS.ElastiCache	2014-09-30
Amazon Elasticsearch Service	AWS.ES	2015-01-01
Amazon GameLift	AWS.GameLift	2015-10-01
Amazon Glacier	AWS.Glacier	2012-06-01
Amazon Inspector	AWS.Inspector	2016-02-16
Amazon Kinesis	AWS.Kinesis	2013-12-02
Amazon Kinesis Analytics	AWS.KinesisAnalytics	2015-08-14
Amazon Kinesis Firehose	AWS.Firehose	2015-08-04
Amazon Machine Learning	AWS.MachineLearning	2014-12-12
Amazon Mobile Analytics	AWS.MobileAnalytics	2014-06-05
Amazon Redshift	AWS.Redshift	2012-12-01
Amazon Relational Database Service	AWS.RDS	2014-09-01
Amazon Route 53	AWS.Route53	2013-04-01
Amazon Route 53 Domains	AWS.Route53Domains	2014-05-15
Amazon Simple Email Service	AWS.SES	2010-12-01
Amazon Simple Notification Service	AWS.SNS	2010-03-31
Amazon Simple Queue Service	AWS.SQS	2012-11-05
Amazon Simple Storage Service	AWS.S3	2006-03-01
Amazon Simple Systems Management Service	AWS.SSM	2014-11-06
Amazon Simple Workflow Service	AWS.SWF	2012-01-25
Amazon SimpleDB	AWS.SimpleDB	2009-04-15
Amazon Snowball	AWS.Snowball	2016-06-30
Amazon WorkSpaces	AWS.WorkSpaces	2015-04-08
Auto Scaling	AWS.AutoScaling	2011-01-01
AWS Certificate Manager	AWS.ACM	2015-12-08
AWS CloudFormation	AWS.CloudFormation	2010-05-15
AWS CloudTrail	AWS.CloudTrail	2013-11-01
AWS CodeCommit	AWS.CodeCommit	2015-04-13
AWS CodeDeploy	AWS.CodeDeploy	2014-10-06
AWS CodePipeline	AWS.CodePipeline	2015-07-09
AWS Config	AWS.ConfigService	2014-11-12
AWS Data Pipeline	AWS.DataPipeline	2012-10-29
AWS Database Migration Service	AWS.DMS	2016-01-01
AWS Device Farm	AWS.DeviceFarm	2015-06-23
AWS Direct Connect	AWS.DirectConnect	2012-10-25
AWS Directory Service	AWS.DirectoryService	2015-04-16
AWS Elastic Beanstalk	AWS.ElasticBeanstalk	2010-12-01
AWS Identity and Access Management	AWS.IAM	2010-05-08
AWS Import/Export	AWS.ImportExport	2010-06-01
AWS IoT	AWS.Iot	2015-05-28
AWS IoT Data Plane	AWS.IotData	2015-05-28
AWS Key Management Service	AWS.KMS	2014-11-01
AWS Lambda	AWS.Lambda	2015-03-31
AWS Marketplace Commerce Analytics	AWS.MarketplaceCommerceAnalytics	2015-07-01
AWS Marketplace Metering	AWS.MarketplaceMetering	2016-01-14
AWS OpsWorks	AWS.OpsWorks	2013-02-18
AWS Security Token Service	AWS.STS	2011-06-15
AWS Storage Gateway	AWS.StorageGateway	2013-06-30
AWS Support	AWS.Support	2013-04-15
AWS WAF	AWS.WAF	2015-08-24
Elastic Load Balancing	AWS.ELB	2012-06-01
Elastic Load Balancing v2	AWS.ELBv2	2015-12-01

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.