@aws-sdk/client-ec2
v3.140.0@aws-sdk/client-ec2
Description
AWS SDK for JavaScript EC2 Client for Node.js, Browser and React Native.
You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.
Installing
To install this package, simply type add or install @aws-sdk/client-ec2 using your favorite package manager:
npm install @aws-sdk/client-ec2
yarn add @aws-sdk/client-ec2
pnpm add @aws-sdk/client-ec2
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the EC2Client
and
the commands you need, for example ListImagesInRecycleBinCommand
:
// ES5 example
const { EC2Client, ListImagesInRecycleBinCommand } = require("@aws-sdk/client-ec2");
// ES6+ example
import { EC2Client, ListImagesInRecycleBinCommand } from "@aws-sdk/client-ec2";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- 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.
// a client can be shared by different commands.
const client = new EC2Client({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListImagesInRecycleBinCommand(params);
Async/await
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
Callbacks
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
v2 compatible style
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-ec2";
const client = new AWS.EC2({ region: "REGION" });
// async/await.
try {
const data = await client.listImagesInRecycleBin(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listImagesInRecycleBin(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listImagesInRecycleBin(params, (err, data) => {
// process err and data.
});
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 client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, 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, but have limited bandwidth to address them.
- Visit Developer Guide or API Reference.
- Check out the blog posts tagged with
aws-sdk-js
on AWS Developer Blog. - Ask a question on StackOverflow and tag it with
aws-sdk-js
. - Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-ec2
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
Client Commands (Operations List)
AcceptAddressTransfer
AcceptCapacityReservationBillingOwnership
AcceptReservedInstancesExchangeQuote
AcceptTransitGatewayMulticastDomainAssociations
AcceptTransitGatewayPeeringAttachment
AcceptTransitGatewayVpcAttachment
AcceptVpcEndpointConnections
AcceptVpcPeeringConnection
AdvertiseByoipCidr
AllocateAddress
AllocateHosts
AllocateIpamPoolCidr
ApplySecurityGroupsToClientVpnTargetNetwork
AssignIpv6Addresses
AssignPrivateIpAddresses
AssignPrivateNatGatewayAddress
AssociateAddress
AssociateCapacityReservationBillingOwner
AssociateClientVpnTargetNetwork
AssociateDhcpOptions
AssociateEnclaveCertificateIamRole
AssociateIamInstanceProfile
AssociateInstanceEventWindow
AssociateIpamByoasn
AssociateIpamResourceDiscovery
AssociateNatGatewayAddress
AssociateRouteTable
AssociateSubnetCidrBlock
AssociateTransitGatewayMulticastDomain
AssociateTransitGatewayPolicyTable
AssociateTransitGatewayRouteTable
AssociateTrunkInterface
AssociateVpcCidrBlock
AttachClassicLinkVpc
AttachInternetGateway
AttachNetworkInterface
AttachVerifiedAccessTrustProvider
AttachVolume
AttachVpnGateway
AuthorizeClientVpnIngress
AuthorizeSecurityGroupEgress
AuthorizeSecurityGroupIngress
BundleInstance
CancelBundleTask
CancelCapacityReservation
CancelCapacityReservationFleets
CancelConversionTask
CancelExportTask
CancelImageLaunchPermission
CancelImportTask
CancelReservedInstancesListing
CancelSpotFleetRequests
CancelSpotInstanceRequests
ConfirmProductInstance
CopyFpgaImage
CopyImage
CopySnapshot
CreateCapacityReservation
CreateCapacityReservationBySplitting
CreateCapacityReservationFleet
CreateCarrierGateway
CreateClientVpnEndpoint
CreateClientVpnRoute
CreateCoipCidr
CreateCoipPool
CreateCustomerGateway
CreateDefaultSubnet
CreateDefaultVpc
CreateDhcpOptions
CreateEgressOnlyInternetGateway
CreateFleet
CreateFlowLogs
CreateFpgaImage
CreateImage
CreateInstanceConnectEndpoint
CreateInstanceEventWindow
CreateInstanceExportTask
CreateInternetGateway
CreateIpam
CreateIpamExternalResourceVerificationToken
CreateIpamPool
CreateIpamResourceDiscovery
CreateIpamScope
CreateKeyPair
CreateLaunchTemplate
CreateLaunchTemplateVersion
CreateLocalGatewayRoute
CreateLocalGatewayRouteTable
CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
CreateLocalGatewayRouteTableVpcAssociation
CreateManagedPrefixList
CreateNatGateway
CreateNetworkAcl
CreateNetworkAclEntry
CreateNetworkInsightsAccessScope
CreateNetworkInsightsPath
CreateNetworkInterface
CreateNetworkInterfacePermission
CreatePlacementGroup
CreatePublicIpv4Pool
CreateReplaceRootVolumeTask
CreateReservedInstancesListing
CreateRestoreImageTask
CreateRoute
CreateRouteTable
CreateSecurityGroup
CreateSnapshot
CreateSnapshots
CreateSpotDatafeedSubscription
CreateStoreImageTask
CreateSubnet
CreateSubnetCidrReservation
CreateTags
CreateTrafficMirrorFilter
CreateTrafficMirrorFilterRule
CreateTrafficMirrorSession
CreateTrafficMirrorTarget
CreateTransitGateway
CreateTransitGatewayConnect
CreateTransitGatewayConnectPeer
CreateTransitGatewayMulticastDomain
CreateTransitGatewayPeeringAttachment
CreateTransitGatewayPolicyTable
Command API Reference / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/CreateTransitGatewayPol
Metadata
- Apache-2.0
- >=12.0.0
- AWS SDK for JavaScript Team
- released 7/29/2022