@aws-sdk/client-ec2-node
Description
Amazon Elastic Compute Cloud
Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.
To learn more, see the following resources:
-
Amazon EC2: Amazon EC2 product page, Amazon EC2 documentation
-
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
-
Amazon VPC: Amazon VPC product page, Amazon VPC documentation
-
AWS VPN: AWS VPN product page, AWS VPN documentation
Installing
To install the this package using NPM, simply type the following into a terminal window:
npm install @aws-sdk/client-ec2-node
Getting Started
Import
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(EC2Client
) and the commands you need, for example AcceptReservedInstancesExchangeQuoteCommand
:
//JavaScript
const { EC2Client } = require("@aws-sdk/client-ec2-node/EC2Client");
const {
AcceptReservedInstancesExchangeQuoteCommand
} = require("@aws-sdk/client-ec2-node/commands/AcceptReservedInstancesExchangeQuoteCommand");
//TypeScript
import { EC2Client } from "@aws-sdk/client-ec2-node/EC2Client";
import { AcceptReservedInstancesExchangeQuoteCommand } from "@aws-sdk/client-ec2-node/commands/AcceptReservedInstancesExchangeQuoteCommand";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const eC2 = new EC2Client({ region: "region" });
//clients can be shared by different commands
const params = {
ReservedInstanceIds: [
/**a list of string*/
]
};
const acceptReservedInstancesExchangeQuoteCommand = new AcceptReservedInstancesExchangeQuoteCommand(
params
);
eC2
.send(acceptReservedInstancesExchangeQuoteCommand)
.then(data => {
// do something
})
.catch(error => {
// error handling
});
In addition to using promises, there are 2 other ways to send a request:
// async/await
try {
const data = await eC2.send(acceptReservedInstancesExchangeQuoteCommand);
// do something
} catch (error) {
// error handling
}
// callback
eC2.send(acceptReservedInstancesExchangeQuoteCommand, (err, data) => {
//do something
});
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
import * as AWS from "@aws-sdk/@aws-sdk/client-ec2-node/EC2";
const eC2 = new AWS.EC2({ region: "region" });
eC2.acceptReservedInstancesExchangeQuote(params, (err, data) => {
//do something
});
Troubleshooting
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await eC2.send(acceptReservedInstancesExchangeQuoteCommand);
// do something
} catch (error) {
const metadata = error.$metadata;
console.log(
`requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
);
/*
The keys within exceptions are also parsed. You can access them by specifying exception names:
if(error.name === 'SomeServiceException') {
const value = error.specialKeyInException;
}
*/
}
Getting Help
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
aws-sdk-js
- Come join the AWS JavaScript community on gitter
- If it turns out that you may have found a bug, please open an issue
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-ec2-node' package is updated. To contribute to SDK you can checkout our code generator package.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.