Amazon AWS SDK User Manual

• AWS.StorageGateway
• AWS.STS
Each service object in the SDK currently provides low-level access to every API call in the respective
AWS service.The full list of methods and their parameters are documented in the complete API reference
(linked from each service name in the above list).
Constructing a Service
Each service can be constructed with runtime configuration data that is specific to that service object.
The service-specific configuration data will be merged on top of global configuration, so there is no need
to re-specify any global settings. For example, an EC2 object can be created for a specific region:
var ec2 = new EC2({region: 'us-west-2'});
This object will continue to use the globally provided credentials.
Passing Arguments to a Service Method
When calling a method to a service, you should pass parameters in as option values, similar to the way
configuration is passed. For example, to read an object for a given bucket and key in S3, you can pass
the following parameters to the getObject method:
s3.getObject({Bucket: 'bucketName', Key: 'keyName'});
Note that the full parameter documentation for each method is found in each service page in the complete
API reference documentation.
Version 0.9.1-pre.2 : Preview
8
AWS SDK for Node.js Getting Started Guide
Constructing a Service

Amazon AWS SDK Specifications

General

Category	Software Development Kit (SDK)
Developer	Amazon Web Services (AWS)
License	Apache License 2.0
Purpose	To enable developers to interact with AWS services from their applications.
Supported Languages	Java, Python, JavaScript, .NET, Ruby, PHP, Go, C++
Supported AWS Services	All AWS services
Operating Systems	Windows, macOS, Linux
Latest Version	Varies by SDK and language. Refer to the official AWS documentation for the specific SDK.
Repository	GitHub (for many SDKs)
Documentation	Available on the AWS website.
SDK Features	API abstraction, request signing, error handling, retry logic, data serialization, and support for various authentication methods.

Summary

AWS SDK Installation and Initial Usage

Installation

Install the AWS SDK for Node.js using the npm package manager.

Usage

Require the AWS SDK package in your Node.js application.

AWS Account and Credentials

Signing Up for an AWS Account

Steps to create an AWS account and obtain credentials.

Viewing Access Credentials

How to find your AWS access key ID and secret access key.

Configuration Guide

The Configuration Object

Explains how to configure the SDK globally or per service.

Setting AWS Credentials

Methods for providing SDK credentials (env variables, disk).

Setting the Region

Configuring the AWS region for SDK requests.

Service-Specific Configuration

Applying configuration settings to individual service objects.

Supported AWS Services

List of Services

Provides a comprehensive list of supported AWS services.

Constructing a Service Object

How to create service-specific objects for API calls.

Making AWS SDK Requests

Asynchronous Callbacks

Handling asynchronous operations using callback functions.

Request and Response Objects

Understanding the structure of request and response data.

Simplified Callback Method

Using a simplified callback signature for operations.

AWS Request Events

Registering callbacks for request lifecycle events (success, error).

Multiple Callbacks and Chaining

Chaining multiple callbacks for comprehensive request handling.

Examples and Use Cases

Amazon S3 Operations

Examples of listing buckets and creating objects in S3.

Amazon DynamoDB Operations

Example for listing tables in Amazon DynamoDB.