Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 113 lines (90 sloc) 5.351 kB
cd607bb @lsegal Remove Node.js specific references from README, title, and remove UPG…
lsegal authored
1 # AWS SDK for JavaScript [![Version](https://badge.fury.io/js/aws-sdk.png)](http://badge.fury.io/js/aws-sdk) [![Build Status](https://travis-ci.org/aws/aws-sdk-js.png?branch=master)](https://travis-ci.org/aws/aws-sdk-js)
d120626 @lsegal Add basic README, update package.json
lsegal authored
2
cd607bb @lsegal Remove Node.js specific references from README, title, and remove UPG…
lsegal authored
3 The official AWS SDK for JavaScript, available for browsers and mobile devices,
4 or Node.js backends
d120626 @lsegal Add basic README, update package.json
lsegal authored
5
e34f36a @lsegal Add link to release notes
lsegal authored
6 Release notes can be found at http://aws.amazon.com/releasenotes/SDK/JavaScript
7
d120626 @lsegal Add basic README, update package.json
lsegal authored
8 ## Installing
9
cd607bb @lsegal Remove Node.js specific references from README, title, and remove UPG…
lsegal authored
10 ### In the Browser
11
12 To use the SDK in the browser, simply add the following script tag to your
13 HTML pages:
14
39d318b @lsegal Bump version to v2.0.0-rc9
lsegal authored
15 <script src="https://sdk.amazonaws.com/js/aws-sdk-2.0.0-rc9.min.js"></script>
cd607bb @lsegal Remove Node.js specific references from README, title, and remove UPG…
lsegal authored
16
17 ### In Node.js
18
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
19 The preferred way to install the AWS SDK for Node.js is to use the
20 [npm](http://npmjs.org) package manager for Node.js. Simply type the following
59d84d9 @lsegal Fix typo in README
lsegal authored
21 into a terminal window:
d120626 @lsegal Add basic README, update package.json
lsegal authored
22
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
23 ```sh
24 npm install aws-sdk
d120626 @lsegal Add basic README, update package.json
lsegal authored
25 ```
26
cd607bb @lsegal Remove Node.js specific references from README, title, and remove UPG…
lsegal authored
27 ## Usage and Getting Started
d120626 @lsegal Add basic README, update package.json
lsegal authored
28
f2d4016 @carljparker editorial review
carljparker authored
29 You can find a getting started guide at:
3194a3f @trevorrowe Updated README (getting started guide).
trevorrowe authored
30
1f1180c @lsegal Update README, gitignore, and yardopts
lsegal authored
31 http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/
3194a3f @trevorrowe Updated README (getting started guide).
trevorrowe authored
32
4f5c0e7 @lsegal Add list of supported services to README
lsegal authored
33 ## Supported Services
34
33e58f3 @lsegal Add note in supported services list about available services in the h…
lsegal authored
35 <p class="note"><strong>Note</strong>:
36 Although all services are supported in the browser version of the SDK,
37 not all of the services are available in the default hosted build (using the
38 script tag provided above). A list of services in the hosted build are provided
39 in the "<a href="http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/browser-services.html">Working With Services</a>"
40 section of the browser SDK guide, including instructions on how to build a
41 custom version of the SDK with extra services.
42 </p>
43
4f5c0e7 @lsegal Add list of supported services to README
lsegal authored
44 The SDK currently supports the following services:
45
4632ed1 @lsegal Resize services table in README.md
lsegal authored
46 <table>
4f5c0e7 @lsegal Add list of supported services to README
lsegal authored
47 <thead>
48 <th>Service Name</th>
49 <th>Class Name</th>
3086a98 @lsegal Update API versions in README
lsegal authored
50 <th>API Version</th>
4f5c0e7 @lsegal Add list of supported services to README
lsegal authored
51 </thead>
52 <tbody>
1d81794 @lsegal Update CloudFront API versions
lsegal authored
53 <tr><td rowspan="2">Amazon CloudFront</td><td rowspan="2">AWS.CloudFront</td><td>2012-05-05</td></tr>
54 <tr><td>2013-11-11</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
55 <tr><td>Amazon CloudSearch</td><td>AWS.CloudSearch</td><td>2011-02-01</td></tr>
56 <tr><td>Amazon CloudWatch</td><td>AWS.CloudWatch</td><td>2010-08-01</td></tr>
57 <tr><td rowspan="2">Amazon DynamoDB</td><td rowspan="2">AWS.DynamoDB</td><td>2011-12-05</td></tr>
58 <tr><td>2012-08-10</td></tr>
3d1298c @lsegal Update supported API versions in README
lsegal authored
59 <tr><td>Amazon Elastic Compute Cloud</td><td>AWS.EC2</td><td>2013-10-15</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
60 <tr><td>Amazon Elastic MapReduce</td><td>AWS.EMR</td><td>2009-03-31</td></tr>
61 <tr><td>Amazon Elastic Transcoder</td><td>AWS.ElasticTranscoder</td><td>2012-09-25</td></tr>
92795c7 @lsegal Updated Amazon ElastiCache API version to 2013-06-15
lsegal authored
62 <tr><td>Amazon ElastiCache</td><td>AWS.ElastiCache</td><td>2013-06-15</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
63 <tr><td>Amazon Glacier</td><td>AWS.Glacier</td><td>2012-06-01</td></tr>
4195c88 @lsegal Add support for Amazon Kinesis (AWS.Kinesis)
lsegal authored
64 <tr><td>Amazon Kinesis</td><td>AWS.Kinesis</td><td>2013-12-02</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
65 <tr><td>Amazon Redshift</td><td>AWS.Redshift</td><td>2012-12-01</td></tr>
66 <tr><td rowspan="3">Amazon Relational Database Service</td><td rowspan="3">AWS.RDS</td><td>2013-01-10</td></tr>
67 <tr><td>2013-02-12</td></tr>
133a013 @lsegal Update README with new API versions
lsegal authored
68 <tr><td>2013-09-09</td></tr>
c1ae541 @lsegal Bump Route53 API version to 2013-04-01
lsegal authored
69 <tr><td>Amazon Route 53</td><td>AWS.Route53</td><td>2013-04-01</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
70 <tr><td>Amazon Simple Email Service</td><td>AWS.SES</td><td>2010-12-01</td></tr>
71 <tr><td>Amazon Simple Notification Service</td><td>AWS.SNS</td><td>2010-03-31</td></tr>
72 <tr><td>Amazon Simple Queue Service</td><td>AWS.SQS</td><td>2012-11-05</td></tr>
73 <tr><td>Amazon Simple Storage Service</td><td>AWS.S3</td><td>2006-03-01</td></tr>
74 <tr><td>Amazon Simple Workflow Service</td><td>AWS.SimpleWorkflow</td><td>2012-01-25</td></tr>
75 <tr><td>Amazon SimpleDB</td><td>AWS.SimpleDB</td><td>2009-04-15</td></tr>
76 <tr><td>Auto Scaling</td><td>AWS.AutoScaling</td><td>2011-01-01</td></tr>
77 <tr><td>AWS CloudFormation</td><td>AWS.CloudFormation</td><td>2010-05-15</td></tr>
3d1298c @lsegal Update supported API versions in README
lsegal authored
78 <tr><td>AWS CloudTrail</td><td>AWS.CloudTrail</td><td>2013-11-01</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
79 <tr><td>AWS Data Pipeline</td><td>AWS.DataPipeline</td><td>2012-10-29</td></tr>
80 <tr><td>AWS Direct Connect</td><td>AWS.DirectConnect</td><td>2012-10-25</td></tr>
81 <tr><td>AWS Elastic Beanstalk</td><td>AWS.ElasticBeanstalk</td><td>2010-12-01</td></tr>
82 <tr><td>AWS Identity and Access Management</td><td>AWS.IAM</td><td>2010-05-08</td></tr>
83 <tr><td>AWS Import/Export</td><td>AWS.ImportExport</td><td>2010-06-01</td></tr>
84 <tr><td>AWS OpsWorks</td><td>AWS.OpsWorks</td><td>2013-02-18</td></tr>
85 <tr><td>AWS Security Token Service</td><td>AWS.STS</td><td>2011-06-15</td></tr>
3d1298c @lsegal Update supported API versions in README
lsegal authored
86 <tr><td rowspan="2">AWS Storage Gateway</td><td rowspan="2">AWS.StorageGateway</td><td>2012-06-30</td></tr>
87 <tr><td>2013-06-30</td></tr>
3086a98 @lsegal Update API versions in README
lsegal authored
88 <tr><td>AWS Support</td><td>AWS.Support</td><td>2013-04-15</td></tr>
89 <tr><td>Elastic Load Balancing</td><td>AWS.ELB</td><td>2012-06-01</td></tr>
4f5c0e7 @lsegal Add list of supported services to README
lsegal authored
90 </tbody>
91 </table>
92
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
93 ## License
d120626 @lsegal Add basic README, update package.json
lsegal authored
94
95 This SDK is distributed under the
96 [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
97
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
98 ```no-highlight
5ae1bd9 @lsegal Consolidate copyright headers into LICENSE.txt and update year
lsegal authored
99 Copyright 2012-2014. Amazon Web Services, Inc. All Rights Reserved.
d120626 @lsegal Add basic README, update package.json
lsegal authored
100
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
101 Licensed under the Apache License, Version 2.0 (the "License");
102 you may not use this file except in compliance with the License.
103 You may obtain a copy of the License at
d120626 @lsegal Add basic README, update package.json
lsegal authored
104
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
105 http://www.apache.org/licenses/LICENSE-2.0
d120626 @lsegal Add basic README, update package.json
lsegal authored
106
5b8905c @lsegal Add initial getting started guide docs
lsegal authored
107 Unless required by applicable law or agreed to in writing, software
108 distributed under the License is distributed on an "AS IS" BASIS,
109 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
110 See the License for the specific language governing permissions and
111 limitations under the License.
112 ```
Something went wrong with that request. Please try again.