Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
AWS SDK for JavaScript in the browser and Node.js
JavaScript CoffeeScript Cucumber Ruby HTML CSS

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc-src
features
lib
scripts
test
.gitignore
.jshintignore
.jshintrc
.travis.yml
.yardopts
.yardopts_guide
LICENSE.txt
README.md
Rakefile
UPGRADING.md
configuration.sample
package.json

README.md

AWS SDK for Node.js NPM version Build Status

The official JavaScript implementation of the AWS SDK for Node.js.

Release notes can be found at http://aws.amazon.com/releasenotes/SDK/JavaScript

Installing

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

Usage

After you've installed the SDK, you can require the AWS package in your node application using require:

var AWS = require('aws-sdk');

Here is a quick example that makes some requests against Amazon S3 with the SDK:

// Load the AWS SDK for Node.js
var AWS = require('aws-sdk');

/**
 * Don't hard-code your credentials!
 * Load them from disk or your environment instead.
 */
// AWS.config.update({accessKeyId: 'AKID', secretAccessKey: 'SECRET'});

// Instead, do this:
AWS.config.loadFromPath('./path/to/credentials.json');

// Set your region for future requests.
AWS.config.update({region: 'us-east-1'});

// Create a bucket using bound parameters and put something in it.
// Make sure to change the bucket name from "myBucket" to something unique.
var s3bucket = new AWS.S3({params: {Bucket: 'myBucket'}});
s3bucket.createBucket(function() {
  var data = {Key: 'myKey', Body: 'Hello!'};
  s3bucket.putObject(data, function(err, data) {
    if (err) {
      console.log("Error uploading data: ", err);
    } else {
      console.log("Successfully uploaded data to myBucket/myKey");
    }
  });
});

Getting Started Guide

You can find a getting started guide at:

http://docs.amazonwebservices.com/nodejs/latest/dg/

Supported Services

The SDK currently supports the following services:

Service Name Class Name API Version
Amazon CloudFrontAWS.CloudFront2012-05-05
2013-05-12
2013-09-27
Amazon CloudSearchAWS.CloudSearch2011-02-01
Amazon CloudWatchAWS.CloudWatch2010-08-01
Amazon DynamoDBAWS.DynamoDB2011-12-05
2012-08-10
Amazon Elastic Compute CloudAWS.EC22013-10-01
Amazon Elastic MapReduceAWS.EMR2009-03-31
Amazon Elastic TranscoderAWS.ElasticTranscoder2012-09-25
Amazon ElastiCacheAWS.ElastiCache2013-06-15
Amazon GlacierAWS.Glacier2012-06-01
Amazon RedshiftAWS.Redshift2012-12-01
Amazon Relational Database ServiceAWS.RDS2013-01-10
2013-02-12
2013-05-15
Amazon Route 53AWS.Route532012-12-12
Amazon Simple Email ServiceAWS.SES2010-12-01
Amazon Simple Notification ServiceAWS.SNS2010-03-31
Amazon Simple Queue ServiceAWS.SQS2012-11-05
Amazon Simple Storage ServiceAWS.S32006-03-01
Amazon Simple Workflow ServiceAWS.SimpleWorkflow2012-01-25
Amazon SimpleDBAWS.SimpleDB2009-04-15
Auto ScalingAWS.AutoScaling2011-01-01
AWS CloudFormationAWS.CloudFormation2010-05-15
AWS Data PipelineAWS.DataPipeline2012-10-29
AWS Direct ConnectAWS.DirectConnect2012-10-25
AWS Elastic BeanstalkAWS.ElasticBeanstalk2010-12-01
AWS Identity and Access ManagementAWS.IAM2010-05-08
AWS Import/ExportAWS.ImportExport2010-06-01
AWS OpsWorksAWS.OpsWorks2013-02-18
AWS Security Token ServiceAWS.STS2011-06-15
AWS Storage GatewayAWS.StorageGateway2012-06-30
AWS SupportAWS.Support2013-04-15
Elastic Load BalancingAWS.ELB2012-06-01

License

This SDK is distributed under the Apache License, Version 2.0.

Copyright 2012. Amazon Web Services, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Something went wrong with that request. Please try again.