@aws-sdk/client-ec2

Description

AWS SDK for JavaScript EC2 Client for Node.js, Browser and React Native.

Amazon Elastic Compute Cloud

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

$3

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:

``js
// ES5 example
const { EC2Client, ListImagesInRecycleBinCommand } = require("@aws-sdk/client-ec2");
`

`ts
// ES6+ example
import { EC2Client, ListImagesInRecycleBinCommand } from "@aws-sdk/client-ec2";
`

$3

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.

`js
// 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:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
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.

`js
// 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

`ts
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.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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

Command API Reference / Input / Output

AcceptCapacityReservationBillingOwnership

Command API Reference / Input / Output

AcceptReservedInstancesExchangeQuote

Command API Reference / Input / Output

AcceptTransitGatewayMulticastDomainAssociations

Command API Reference / Input / Output

AcceptTransitGatewayPeeringAttachment

Command API Reference / Input / Output

AcceptTransitGatewayVpcAttachment

Command API Reference / Input / Output

AcceptVpcEndpointConnections

Command API Reference / Input / Output

AcceptVpcPeeringConnection

Command API Reference / Input / Output

AdvertiseByoipCidr

Command API Reference / Input / Output

AllocateAddress

Command API Reference / Input / Output

AllocateHosts

Command API Reference / Input / Output

AllocateIpamPoolCidr

Command API Reference / Input / Output

ApplySecurityGroupsToClientVpnTargetNetwork

Command API Reference / Input / Output

AssignIpv6Addresses

Command API Reference / Input / Output

AssignPrivateIpAddresses

Command API Reference / Input / Output

AssignPrivateNatGatewayAddress

Command API Reference / Input / Output

AssociateAddress

Command API Reference / Input / Output

AssociateCapacityReservationBillingOwner

Command API Reference / Input / Output

AssociateClientVpnTargetNetwork

Command API Reference / Input / Output

AssociateDhcpOptions

Command API Reference / Input / Output

AssociateEnclaveCertificateIamRole

Command API Reference / Input / Output

AssociateIamInstanceProfile

Command API Reference / Input / Output

AssociateInstanceEventWindow

Command API Reference / Input / Output

AssociateIpamByoasn

Command API Reference / Input / Output

AssociateIpamResourceDiscovery

Command API Reference / Input / Output

AssociateNatGatewayAddress

Command API Reference / Input / Output

AssociateRouteServer

Command API Reference / Input / Output

AssociateRouteTable

Command API Reference / Input / Output

AssociateSecurityGroupVpc

Command API Reference / Input / Output

AssociateSubnetCidrBlock

Command API Reference / Input / Output

AssociateTransitGatewayMulticastDomain

Command API Reference / Input / Output

AssociateTransitGatewayPolicyTable

Command API Reference / Input / Output

AssociateTransitGatewayRouteTable

Command API Reference / Input / Output

AssociateTrunkInterface

Command API Reference / Input / Output

AssociateVpcCidrBlock

Command API Reference / Input / Output

AttachClassicLinkVpc

Command API Reference / Input / Output

AttachInternetGateway

Command API Reference / Input / Output

AttachNetworkInterface

Command API Reference / Input / Output

AttachVerifiedAccessTrustProvider

Command API Reference / Input / Output

AttachVolume

Command API Reference / Input / Output

AttachVpnGateway

Command API Reference / Input / Output

AuthorizeClientVpnIngress

Command API Reference / Input / Output

AuthorizeSecurityGroupEgress

Command API Reference / Input / Output

AuthorizeSecurityGroupIngress

Command API Reference / Input / Output

BundleInstance

Command API Reference / Input / Output

CancelBundleTask

Command API Reference / Input / Output

CancelCapacityReservation

Command API Reference / Input / Output

CancelCapacityReservationFleets

Command API Reference / Input / Output

CancelConversionTask

Command API Reference / Input / Output

CancelDeclarativePoliciesReport

Command API Reference / Input / Output

CancelExportTask

Command API Reference / Input / Output

CancelImageLaunchPermission

Command API Reference / Input / Output

CancelImportTask

Command API Reference / Input / Output

CancelReservedInstancesListing

Command API Reference / Input / Output

CancelSpotFleetRequests

Command API Reference / Input / Output

CancelSpotInstanceRequests

Command API Reference / Input / Output

ConfirmProductInstance

Command API Reference / Input / Output

CopyFpgaImage

Command API Reference / Input / Output

CopyImage

Command API Reference / Input / Output

CopySnapshot

Command API Reference / Input / Output

CopyVolumes

Command API Reference / Input / Output

CreateCapacityManagerDataExport

Command API Reference / Input / Output

CreateCapacityReservation

Command API Reference / Input / Output

CreateCapacityReservationBySplitting

Command API Reference / Input / Output

CreateCapacityReservationFleet

Command API Reference / Input / Output

CreateCarrierGateway

Command API Reference / Input / Output

CreateClientVpnEndpoint

Command API Reference / Input / Output

CreateClientVpnRoute

Command API Reference / Input / Output

CreateCoipCidr

Command API Reference / Input / Output

CreateCoipPool

Command API Reference / Input / Output

CreateCustomerGateway

Command API Reference / Input / Output

CreateDefaultSubnet

Command API Reference / Input / Output

CreateDefaultVpc

Command API Reference / Input / Output

CreateDelegateMacVolumeOwnershipTask

Command API Reference / Input / Output

CreateDhcpOptions

Command API Reference / Input / Output

CreateEgressOnlyInternetGateway

Command API Reference / Input / Output

CreateFleet

Command API Reference / Input / Output

CreateFlowLogs

Command API Reference / Input / Output

CreateFpgaImage

Command API Reference / Input / Output

CreateImage

Command API Reference / Input / Output

CreateImageUsageReport

Command API Reference / Input / Output

CreateInstanceConnectEndpoint

Command API Reference / Input / Output

CreateInstanceEventWindow

Command API Reference / Input / Output

CreateInstanceExportTask

Command API Reference / Input / Output

CreateInternetGateway

Command API Reference / Input / Output

CreateInterruptibleCapacityReservationAllocation

Command API Reference / Input / Output

CreateIpam

Command API Reference / Input / Output

CreateIpamExternalResourceVerificationToken

Command API Reference / Input / Output

CreateIpamPolicy

Command API Reference / Input / Output

CreateIpamPool

Command API Reference / Input / Output

CreateIpamPrefixListResolver

Command API Reference / Input / Output

CreateIpamPrefixListResolverTarget

Command API Reference / Input / Output

CreateIpamResourceDiscovery

Command API Reference / Input / Output

CreateIpamScope

Command API Reference / Input / Output

CreateKeyPair

Command API Reference / Input / Output

CreateLaunchTemplate

Command API Reference / Input / Output

CreateLaunchTemplateVersion

Command API Reference / Input / Output

CreateLocalGatewayRoute

Command API Reference / Input / Output

CreateLocalGatewayRouteTable

Command API Reference / Input / Output

CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation

Command API Reference / Input / Output

CreateLocalGatewayRouteTableVpcAssociation

Command API Reference / Input / Output

CreateLocalGatewayVirtualInterface

Command API Reference / Input / Output

CreateLocalGatewayVirtualInterfaceGroup

Command API Reference / Input / Output

CreateMacSystemIntegrityProtectionModificationTask

Command API Reference / Input / Output

CreateManagedPrefixList

Command API Reference / Input / Output

CreateNatGateway

Command API Reference / Input / Output

CreateNetworkAcl

Command API Reference / Input / Output

CreateNetworkAclEntry

Command API Reference / Input / Output

CreateNetworkInsightsAccessScope

Command API Reference / Input / Output

CreateNetworkInsightsPath

Command API Reference / Input / Output

CreateNetworkInterface

Command API Reference / Input / Output

CreateNetworkInterfacePermission

Command API Reference / Input / Output

CreatePlacementGroup

Command API Reference / Input / Output

CreatePublicIpv4Pool

Command API Reference / Input / Output

CreateReplaceRootVolumeTask

Command API Reference / Input / Output

CreateReservedInstancesListing

Command API Reference / Input / Output

CreateRestoreImageTask

Command API Reference / Input / Output

CreateRoute

Command API Reference / Input / Output

CreateRouteServer

Command API Reference / Input / Output

CreateRouteServerEndpoint

Command API Reference / Input / Output

CreateRouteServerPeer

Command API Reference / Input / Output

CreateRouteTable

Command API Reference / Input / Output

CreateSecondaryNetwork

[Command API Reference](https://docs.aws.amazon.com/AWSJa