Class: AWS.EC2
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.EC2
- Identifier:
- ec2
- API Version:
- 2016-11-15
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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: AmazonEC2 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
Sending a Request Using EC2
var ec2 = new AWS.EC2();
ec2.applySecurityGroupsToClientVpnTargetNetwork(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the EC2 object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ec2 = new AWS.EC2({apiVersion: '2016-11-15'});
You can also set the API version globally in AWS.config.apiVersions
using
the ec2 service identifier:
AWS.config.apiVersions = {
ec2: '2016-11-15',
// other service API versions
};
var ec2 = new AWS.EC2();
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
instanceExists, bundleTaskComplete, conversionTaskCancelled, conversionTaskCompleted, conversionTaskDeleted, customerGatewayAvailable, exportTaskCancelled, exportTaskCompleted, imageExists, imageAvailable, instanceRunning, instanceStatusOk, instanceStopped, instanceTerminated, keyPairExists, natGatewayAvailable, networkInterfaceAvailable, passwordDataAvailable, snapshotCompleted, securityGroupExists, spotInstanceRequestFulfilled, subnetAvailable, systemStatusOk, volumeAvailable, volumeDeleted, volumeInUse, vpcAvailable, vpcExists, vpnConnectionAvailable, vpnConnectionDeleted, vpcPeeringConnectionExists, vpcPeeringConnectionDeleted
Constructor Summary collapse
-
new AWS.EC2(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
acceptReservedInstancesExchangeQuote(params = {}, callback) ⇒ AWS.Request
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
-
acceptTransitGatewayMulticastDomainAssociations(params = {}, callback) ⇒ AWS.Request
Accepts a request to associate subnets with a transit gateway multicast domain.
-
acceptTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request
Accepts a transit gateway peering attachment request.
-
acceptTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Accepts a request to attach a VPC to a transit gateway.
-
acceptVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
-
acceptVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request
Accept a VPC peering connection request.
-
advertiseByoipCidr(params = {}, callback) ⇒ AWS.Request
Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
-
allocateAddress(params = {}, callback) ⇒ AWS.Request
Allocates an Elastic IP address to your AWS account.
-
allocateHosts(params = {}, callback) ⇒ AWS.Request
Allocates a Dedicated Host to your account.
-
applySecurityGroupsToClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request
Applies a security group to the association between the target network and the Client VPN endpoint.
-
assignIpv6Addresses(params = {}, callback) ⇒ AWS.Request
Assigns one or more IPv6 addresses to the specified network interface.
-
assignPrivateIpAddresses(params = {}, callback) ⇒ AWS.Request
Assigns one or more secondary private IP addresses to the specified network interface.
-
associateAddress(params = {}, callback) ⇒ AWS.Request
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface.
-
associateClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request
Associates a target network with a Client VPN endpoint.
-
associateDhcpOptions(params = {}, callback) ⇒ AWS.Request
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
-
associateEnclaveCertificateIamRole(params = {}, callback) ⇒ AWS.Request
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate.
-
associateIamInstanceProfile(params = {}, callback) ⇒ AWS.Request
Associates an IAM instance profile with a running or stopped instance.
-
associateRouteTable(params = {}, callback) ⇒ AWS.Request
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC.
-
associateSubnetCidrBlock(params = {}, callback) ⇒ AWS.Request
Associates a CIDR block with your subnet.
-
associateTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
-
associateTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request
Associates the specified attachment with the specified transit gateway route table.
-
associateVpcCidrBlock(params = {}, callback) ⇒ AWS.Request
Associates a CIDR block with your VPC.
-
attachClassicLinkVpc(params = {}, callback) ⇒ AWS.Request
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups.
-
attachInternetGateway(params = {}, callback) ⇒ AWS.Request
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
-
attachNetworkInterface(params = {}, callback) ⇒ AWS.Request
Attaches a network interface to an instance.
-
attachVolume(params = {}, callback) ⇒ AWS.Request
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
-
attachVpnGateway(params = {}, callback) ⇒ AWS.Request
Attaches a virtual private gateway to a VPC.
-
authorizeClientVpnIngress(params = {}, callback) ⇒ AWS.Request
Adds an ingress authorization rule to a Client VPN endpoint.
-
authorizeSecurityGroupEgress(params = {}, callback) ⇒ AWS.Request
[VPC only] Adds the specified egress rules to a security group for use with a VPC.
-
authorizeSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Adds the specified ingress rules to a security group.
-
bundleInstance(params = {}, callback) ⇒ AWS.Request
Bundles an Amazon instance store-backed Windows instance.
-
cancelBundleTask(params = {}, callback) ⇒ AWS.Request
Cancels a bundling operation for an instance store-backed Windows instance.
-
cancelCapacityReservation(params = {}, callback) ⇒ AWS.Request
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.
-
cancelConversionTask(params = {}, callback) ⇒ AWS.Request
Cancels an active conversion task.
-
cancelExportTask(params = {}, callback) ⇒ AWS.Request
Cancels an active export task.
-
cancelImportTask(params = {}, callback) ⇒ AWS.Request
Cancels an in-process import virtual machine or import snapshot task.
-
cancelReservedInstancesListing(params = {}, callback) ⇒ AWS.Request
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
-
cancelSpotFleetRequests(params = {}, callback) ⇒ AWS.Request
Cancels the specified Spot Fleet requests.
-
cancelSpotInstanceRequests(params = {}, callback) ⇒ AWS.Request
Cancels one or more Spot Instance requests.
-
confirmProductInstance(params = {}, callback) ⇒ AWS.Request
Determines whether a product code is associated with an instance.
-
copyFpgaImage(params = {}, callback) ⇒ AWS.Request
Copies the specified Amazon FPGA Image (AFI) to the current Region.
-
copyImage(params = {}, callback) ⇒ AWS.Request
Initiates the copy of an AMI from the specified source Region to the current Region.
-
copySnapshot(params = {}, callback) ⇒ AWS.Request
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.
-
createCapacityReservation(params = {}, callback) ⇒ AWS.Request
Creates a new Capacity Reservation with the specified attributes.
-
createCarrierGateway(params = {}, callback) ⇒ AWS.Request
Creates a carrier gateway.
-
createClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a Client VPN endpoint.
-
createClientVpnRoute(params = {}, callback) ⇒ AWS.Request
Adds a route to a network to a Client VPN endpoint.
-
createCustomerGateway(params = {}, callback) ⇒ AWS.Request
Provides information to AWS about your VPN customer gateway device.
-
createDefaultSubnet(params = {}, callback) ⇒ AWS.Request
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC.
-
createDefaultVpc(params = {}, callback) ⇒ AWS.Request
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone.
-
createDhcpOptions(params = {}, callback) ⇒ AWS.Request
Creates a set of DHCP options for your VPC.
-
createEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request
[IPv6 only] Creates an egress-only internet gateway for your VPC.
-
createFleet(params = {}, callback) ⇒ AWS.Request
Launches an EC2 Fleet.
-
createFlowLogs(params = {}, callback) ⇒ AWS.Request
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
-
createFpgaImage(params = {}, callback) ⇒ AWS.Request
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
-
createImage(params = {}, callback) ⇒ AWS.Request
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
-
createInstanceExportTask(params = {}, callback) ⇒ AWS.Request
Exports a running or stopped instance to an Amazon S3 bucket.
-
createInternetGateway(params = {}, callback) ⇒ AWS.Request
Creates an internet gateway for use with a VPC.
-
createKeyPair(params = {}, callback) ⇒ AWS.Request
Creates a 2048-bit RSA key pair with the specified name.
-
createLaunchTemplate(params = {}, callback) ⇒ AWS.Request
Creates a launch template.
-
createLaunchTemplateVersion(params = {}, callback) ⇒ AWS.Request
Creates a new version for a launch template.
-
createLocalGatewayRoute(params = {}, callback) ⇒ AWS.Request
Creates a static route for the specified local gateway route table.
-
createLocalGatewayRouteTableVpcAssociation(params = {}, callback) ⇒ AWS.Request
Associates the specified VPC with the specified local gateway route table.
-
createManagedPrefixList(params = {}, callback) ⇒ AWS.Request
Creates a managed prefix list.
-
createNatGateway(params = {}, callback) ⇒ AWS.Request
Creates a NAT gateway in the specified public subnet.
-
createNetworkAcl(params = {}, callback) ⇒ AWS.Request
Creates a network ACL in a VPC.
-
createNetworkAclEntry(params = {}, callback) ⇒ AWS.Request
Creates an entry (a rule) in a network ACL with the specified rule number.
-
createNetworkInsightsPath(params = {}, callback) ⇒ AWS.Request
Creates a path to analyze for reachability.
-
createNetworkInterface(params = {}, callback) ⇒ AWS.Request
Creates a network interface in the specified subnet.
-
createNetworkInterfacePermission(params = {}, callback) ⇒ AWS.Request
Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.
-
createPlacementGroup(params = {}, callback) ⇒ AWS.Request
Creates a placement group in which to launch instances.
-
createReservedInstancesListing(params = {}, callback) ⇒ AWS.Request
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.
-
createRoute(params = {}, callback) ⇒ AWS.Request
Creates a route in a route table within a VPC.
-
createRouteTable(params = {}, callback) ⇒ AWS.Request
Creates a route table for the specified VPC.
-
createSecurityGroup(params = {}, callback) ⇒ AWS.Request
Creates a security group.
-
createSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of an EBS volume and stores it in Amazon S3.
-
createSnapshots(params = {}, callback) ⇒ AWS.Request
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.
-
createSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.
-
createSubnet(params = {}, callback) ⇒ AWS.Request
Creates a subnet in a specified VPC.
-
createTags(params = {}, callback) ⇒ AWS.Request
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources.
-
createTrafficMirrorFilter(params = {}, callback) ⇒ AWS.Request
Creates a Traffic Mirror filter.
-
createTrafficMirrorFilterRule(params = {}, callback) ⇒ AWS.Request
Creates a Traffic Mirror filter rule.
-
createTrafficMirrorSession(params = {}, callback) ⇒ AWS.Request
Creates a Traffic Mirror session.
-
createTrafficMirrorTarget(params = {}, callback) ⇒ AWS.Request
Creates a target for your Traffic Mirror session.
-
createTransitGateway(params = {}, callback) ⇒ AWS.Request
Creates a transit gateway.
-
createTransitGatewayConnect(params = {}, callback) ⇒ AWS.Request
Creates a Connect attachment from a specified transit gateway attachment.
-
createTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request
Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
-
createTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request
Creates a multicast domain using the specified transit gateway.
-
createTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).
-
createTransitGatewayPrefixListReference(params = {}, callback) ⇒ AWS.Request
Creates a reference (route) to a prefix list in a specified transit gateway route table.
-
createTransitGatewayRoute(params = {}, callback) ⇒ AWS.Request
Creates a static route for the specified transit gateway route table.
-
createTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request
Creates a route table for the specified transit gateway.
-
createTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Attaches the specified VPC to the specified transit gateway.
-
createVolume(params = {}, callback) ⇒ AWS.Request
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
-
createVpc(params = {}, callback) ⇒ AWS.Request
Creates a VPC with the specified IPv4 CIDR block.
-
createVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a VPC endpoint for a specified service.
-
createVpcEndpointConnectionNotification(params = {}, callback) ⇒ AWS.Request
Creates a connection notification for a specified VPC endpoint or VPC endpoint service.
-
createVpcEndpointServiceConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.
-
createVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.
-
createVpnConnection(params = {}, callback) ⇒ AWS.Request
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway.
-
createVpnConnectionRoute(params = {}, callback) ⇒ AWS.Request
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
createVpnGateway(params = {}, callback) ⇒ AWS.Request
Creates a virtual private gateway.
-
deleteCarrierGateway(params = {}, callback) ⇒ AWS.Request
Deletes a carrier gateway.
-
deleteClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes the specified Client VPN endpoint.
-
deleteClientVpnRoute(params = {}, callback) ⇒ AWS.Request
Deletes a route from a Client VPN endpoint.
-
deleteCustomerGateway(params = {}, callback) ⇒ AWS.Request
Deletes the specified customer gateway.
-
deleteDhcpOptions(params = {}, callback) ⇒ AWS.Request
Deletes the specified set of DHCP options.
-
deleteEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request
Deletes an egress-only internet gateway.
-
deleteFleets(params = {}, callback) ⇒ AWS.Request
Deletes the specified EC2 Fleet.
-
deleteFlowLogs(params = {}, callback) ⇒ AWS.Request
Deletes one or more flow logs.
-
deleteFpgaImage(params = {}, callback) ⇒ AWS.Request
Deletes the specified Amazon FPGA Image (AFI).
-
deleteInternetGateway(params = {}, callback) ⇒ AWS.Request
Deletes the specified internet gateway.
-
deleteKeyPair(params = {}, callback) ⇒ AWS.Request
Deletes the specified key pair, by removing the public key from Amazon EC2.
-
deleteLaunchTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a launch template.
-
deleteLaunchTemplateVersions(params = {}, callback) ⇒ AWS.Request
Deletes one or more versions of a launch template.
-
deleteLocalGatewayRoute(params = {}, callback) ⇒ AWS.Request
Deletes the specified route from the specified local gateway route table.
-
deleteLocalGatewayRouteTableVpcAssociation(params = {}, callback) ⇒ AWS.Request
Deletes the specified association between a VPC and local gateway route table.
-
deleteManagedPrefixList(params = {}, callback) ⇒ AWS.Request
Deletes the specified managed prefix list.
-
deleteNatGateway(params = {}, callback) ⇒ AWS.Request
Deletes the specified NAT gateway.
-
deleteNetworkAcl(params = {}, callback) ⇒ AWS.Request
Deletes the specified network ACL.
-
deleteNetworkAclEntry(params = {}, callback) ⇒ AWS.Request
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
-
deleteNetworkInsightsAnalysis(params = {}, callback) ⇒ AWS.Request
Deletes the specified network insights analysis.
-
deleteNetworkInsightsPath(params = {}, callback) ⇒ AWS.Request
Deletes the specified path.
-
deleteNetworkInterface(params = {}, callback) ⇒ AWS.Request
Deletes the specified network interface.
-
deleteNetworkInterfacePermission(params = {}, callback) ⇒ AWS.Request
Deletes a permission for a network interface.
-
deletePlacementGroup(params = {}, callback) ⇒ AWS.Request
Deletes the specified placement group.
-
deleteQueuedReservedInstances(params = {}, callback) ⇒ AWS.Request
Deletes the queued purchases for the specified Reserved Instances.
-
deleteRoute(params = {}, callback) ⇒ AWS.Request
Deletes the specified route from the specified route table.
-
deleteRouteTable(params = {}, callback) ⇒ AWS.Request
Deletes the specified route table.
-
deleteSecurityGroup(params = {}, callback) ⇒ AWS.Request
Deletes a security group.
-
deleteSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes the specified snapshot.
-
deleteSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request
Deletes the data feed for Spot Instances.
-
deleteSubnet(params = {}, callback) ⇒ AWS.Request
Deletes the specified subnet.
-
deleteTags(params = {}, callback) ⇒ AWS.Request
Deletes the specified set of tags from the specified set of resources.
-
deleteTrafficMirrorFilter(params = {}, callback) ⇒ AWS.Request
Deletes the specified Traffic Mirror filter.
-
deleteTrafficMirrorFilterRule(params = {}, callback) ⇒ AWS.Request
Deletes the specified Traffic Mirror rule.
-
deleteTrafficMirrorSession(params = {}, callback) ⇒ AWS.Request
Deletes the specified Traffic Mirror session.
-
deleteTrafficMirrorTarget(params = {}, callback) ⇒ AWS.Request
Deletes the specified Traffic Mirror target.
-
deleteTransitGateway(params = {}, callback) ⇒ AWS.Request
Deletes the specified transit gateway.
-
deleteTransitGatewayConnect(params = {}, callback) ⇒ AWS.Request
Deletes the specified Connect attachment.
-
deleteTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request
Deletes the specified Connect peer.
-
deleteTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request
Deletes the specified transit gateway multicast domain.
-
deleteTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request
Deletes a transit gateway peering attachment.
-
deleteTransitGatewayPrefixListReference(params = {}, callback) ⇒ AWS.Request
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
-
deleteTransitGatewayRoute(params = {}, callback) ⇒ AWS.Request
Deletes the specified route from the specified transit gateway route table.
-
deleteTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request
Deletes the specified transit gateway route table.
-
deleteTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Deletes the specified VPC attachment.
-
deleteVolume(params = {}, callback) ⇒ AWS.Request
Deletes the specified EBS volume.
-
deleteVpc(params = {}, callback) ⇒ AWS.Request
Deletes the specified VPC.
-
deleteVpcEndpointConnectionNotifications(params = {}, callback) ⇒ AWS.Request
Deletes one or more VPC endpoint connection notifications.
-
deleteVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Deletes one or more specified VPC endpoints.
-
deleteVpcEndpointServiceConfigurations(params = {}, callback) ⇒ AWS.Request
Deletes one or more VPC endpoint service configurations in your account.
-
deleteVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request
Deletes a VPC peering connection.
-
deleteVpnConnection(params = {}, callback) ⇒ AWS.Request
Deletes the specified VPN connection.
-
deleteVpnConnectionRoute(params = {}, callback) ⇒ AWS.Request
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
deleteVpnGateway(params = {}, callback) ⇒ AWS.Request
Deletes the specified virtual private gateway.
-
deprovisionByoipCidr(params = {}, callback) ⇒ AWS.Request
Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
-
deregisterImage(params = {}, callback) ⇒ AWS.Request
Deregisters the specified AMI.
-
deregisterInstanceEventNotificationAttributes(params = {}, callback) ⇒ AWS.Request
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
-
deregisterTransitGatewayMulticastGroupMembers(params = {}, callback) ⇒ AWS.Request
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
-
deregisterTransitGatewayMulticastGroupSources(params = {}, callback) ⇒ AWS.Request
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
-
describeAccountAttributes(params = {}, callback) ⇒ AWS.Request
Describes attributes of your AWS account.
-
describeAddresses(params = {}, callback) ⇒ AWS.Request
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
-
describeAggregateIdFormat(params = {}, callback) ⇒ AWS.Request
Describes the longer ID format settings for all resource types in a specific Region.
-
describeAvailabilityZones(params = {}, callback) ⇒ AWS.Request
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you.
-
describeBundleTasks(params = {}, callback) ⇒ AWS.Request
Describes the specified bundle tasks or all of your bundle tasks.
-
describeByoipCidrs(params = {}, callback) ⇒ AWS.Request
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
-
describeCapacityReservations(params = {}, callback) ⇒ AWS.Request
Describes one or more of your Capacity Reservations.
-
describeCarrierGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your carrier gateways.
-
describeClassicLinkInstances(params = {}, callback) ⇒ AWS.Request
Describes one or more of your linked EC2-Classic instances.
-
describeClientVpnAuthorizationRules(params = {}, callback) ⇒ AWS.Request
Describes the authorization rules for a specified Client VPN endpoint.
-
describeClientVpnConnections(params = {}, callback) ⇒ AWS.Request
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
-
describeClientVpnEndpoints(params = {}, callback) ⇒ AWS.Request
Describes one or more Client VPN endpoints in the account.
-
describeClientVpnRoutes(params = {}, callback) ⇒ AWS.Request
Describes the routes for the specified Client VPN endpoint.
-
describeClientVpnTargetNetworks(params = {}, callback) ⇒ AWS.Request
Describes the target networks associated with the specified Client VPN endpoint.
-
describeCoipPools(params = {}, callback) ⇒ AWS.Request
Describes the specified customer-owned address pools or all of your customer-owned address pools.
-
describeConversionTasks(params = {}, callback) ⇒ AWS.Request
Describes the specified conversion tasks or all your conversion tasks.
-
describeCustomerGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your VPN customer gateways.
-
describeDhcpOptions(params = {}, callback) ⇒ AWS.Request
Describes one or more of your DHCP options sets.
-
describeEgressOnlyInternetGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your egress-only internet gateways.
-
describeElasticGpus(params = {}, callback) ⇒ AWS.Request
Describes the Elastic Graphics accelerator associated with your instances.
-
describeExportImageTasks(params = {}, callback) ⇒ AWS.Request
Describes the specified export image tasks or all of your export image tasks.
-
describeExportTasks(params = {}, callback) ⇒ AWS.Request
Describes the specified export instance tasks or all of your export instance tasks.
-
describeFastSnapshotRestores(params = {}, callback) ⇒ AWS.Request
Describes the state of fast snapshot restores for your snapshots.
-
describeFleetHistory(params = {}, callback) ⇒ AWS.Request
Describes the events for the specified EC2 Fleet during the specified time.
-
describeFleetInstances(params = {}, callback) ⇒ AWS.Request
Describes the running instances for the specified EC2 Fleet.
-
describeFleets(params = {}, callback) ⇒ AWS.Request
Describes the specified EC2 Fleets or all of your EC2 Fleets.
-
describeFlowLogs(params = {}, callback) ⇒ AWS.Request
Describes one or more flow logs.
-
describeFpgaImageAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
-
describeFpgaImages(params = {}, callback) ⇒ AWS.Request
Describes the Amazon FPGA Images (AFIs) available to you.
-
describeHostReservationOfferings(params = {}, callback) ⇒ AWS.Request
Describes the Dedicated Host reservations that are available to purchase.
-
describeHostReservations(params = {}, callback) ⇒ AWS.Request
Describes reservations that are associated with Dedicated Hosts in your account.
-
describeHosts(params = {}, callback) ⇒ AWS.Request
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
-
describeIamInstanceProfileAssociations(params = {}, callback) ⇒ AWS.Request
Describes your IAM instance profile associations.
-
describeIdentityIdFormat(params = {}, callback) ⇒ AWS.Request
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user.
-
describeIdFormat(params = {}, callback) ⇒ AWS.Request
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs.
-
describeImageAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified AMI.
-
describeImages(params = {}, callback) ⇒ AWS.Request
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
-
describeImportImageTasks(params = {}, callback) ⇒ AWS.Request
Displays details about an import virtual machine or import snapshot tasks that are already created.
-
describeImportSnapshotTasks(params = {}, callback) ⇒ AWS.Request
Describes your import snapshot tasks.
-
describeInstanceAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified instance.
-
describeInstanceCreditSpecifications(params = {}, callback) ⇒ AWS.Request
Describes the credit option for CPU usage of the specified burstable performance instances.
-
describeInstanceEventNotificationAttributes(params = {}, callback) ⇒ AWS.Request
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
-
describeInstances(params = {}, callback) ⇒ AWS.Request
Describes the specified instances or all instances.
-
describeInstanceStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the specified instances or all of your instances.
-
describeInstanceTypeOfferings(params = {}, callback) ⇒ AWS.Request
Returns a list of all instance types offered.
-
describeInstanceTypes(params = {}, callback) ⇒ AWS.Request
Describes the details of the instance types that are offered in a location.
-
describeInternetGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your internet gateways.
-
describeIpv6Pools(params = {}, callback) ⇒ AWS.Request
Describes your IPv6 address pools.
-
describeKeyPairs(params = {}, callback) ⇒ AWS.Request
Describes the specified key pairs or all of your key pairs.
-
describeLaunchTemplates(params = {}, callback) ⇒ AWS.Request
Describes one or more launch templates.
-
describeLaunchTemplateVersions(params = {}, callback) ⇒ AWS.Request
Describes one or more versions of a specified launch template.
-
describeLocalGatewayRouteTables(params = {}, callback) ⇒ AWS.Request
Describes one or more local gateway route tables.
-
describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(params = {}, callback) ⇒ AWS.Request
Describes the associations between virtual interface groups and local gateway route tables.
-
describeLocalGatewayRouteTableVpcAssociations(params = {}, callback) ⇒ AWS.Request
Describes the specified associations between VPCs and local gateway route tables.
-
describeLocalGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more local gateways.
-
describeLocalGatewayVirtualInterfaceGroups(params = {}, callback) ⇒ AWS.Request
Describes the specified local gateway virtual interface groups.
-
describeLocalGatewayVirtualInterfaces(params = {}, callback) ⇒ AWS.Request
Describes the specified local gateway virtual interfaces.
-
describeManagedPrefixLists(params = {}, callback) ⇒ AWS.Request
Describes your managed prefix lists and any AWS-managed prefix lists.
-
describeMovingAddresses(params = {}, callback) ⇒ AWS.Request
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform.
-
describeNatGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your NAT gateways.
-
describeNetworkAcls(params = {}, callback) ⇒ AWS.Request
Describes one or more of your network ACLs.
-
describeNetworkInsightsAnalyses(params = {}, callback) ⇒ AWS.Request
Describes one or more of your network insights analyses.
-
describeNetworkInsightsPaths(params = {}, callback) ⇒ AWS.Request
Describes one or more of your paths.
-
describeNetworkInterfaceAttribute(params = {}, callback) ⇒ AWS.Request
Describes a network interface attribute.
-
describeNetworkInterfacePermissions(params = {}, callback) ⇒ AWS.Request
Describes the permissions for your network interfaces.
-
describeNetworkInterfaces(params = {}, callback) ⇒ AWS.Request
Describes one or more of your network interfaces.
-
describePlacementGroups(params = {}, callback) ⇒ AWS.Request
Describes the specified placement groups or all of your placement groups.
-
describePrefixLists(params = {}, callback) ⇒ AWS.Request
Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
-
describePrincipalIdFormat(params = {}, callback) ⇒ AWS.Request
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
-
describePublicIpv4Pools(params = {}, callback) ⇒ AWS.Request
Describes the specified IPv4 address pools.
-
describeRegions(params = {}, callback) ⇒ AWS.Request
Describes the Regions that are enabled for your account, or all Regions.
-
describeReservedInstances(params = {}, callback) ⇒ AWS.Request
Describes one or more of the Reserved Instances that you purchased.
-
describeReservedInstancesListings(params = {}, callback) ⇒ AWS.Request
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
-
describeReservedInstancesModifications(params = {}, callback) ⇒ AWS.Request
Describes the modifications made to your Reserved Instances.
-
describeReservedInstancesOfferings(params = {}, callback) ⇒ AWS.Request
Describes Reserved Instance offerings that are available for purchase.
-
describeRouteTables(params = {}, callback) ⇒ AWS.Request
Describes one or more of your route tables.
-
describeScheduledInstanceAvailability(params = {}, callback) ⇒ AWS.Request
Finds available schedules that meet the specified criteria.
-
describeScheduledInstances(params = {}, callback) ⇒ AWS.Request
Describes the specified Scheduled Instances or all your Scheduled Instances.
-
describeSecurityGroupReferences(params = {}, callback) ⇒ AWS.Request
[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
-
describeSecurityGroups(params = {}, callback) ⇒ AWS.Request
Describes the specified security groups or all of your security groups.
-
describeSnapshotAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified snapshot.
-
describeSnapshots(params = {}, callback) ⇒ AWS.Request
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
-
describeSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request
Describes the data feed for Spot Instances.
-
describeSpotFleetInstances(params = {}, callback) ⇒ AWS.Request
Describes the running instances for the specified Spot Fleet.
-
describeSpotFleetRequestHistory(params = {}, callback) ⇒ AWS.Request
Describes the events for the specified Spot Fleet request during the specified time.
-
describeSpotFleetRequests(params = {}, callback) ⇒ AWS.Request
Describes your Spot Fleet requests.
-
describeSpotInstanceRequests(params = {}, callback) ⇒ AWS.Request
Describes the specified Spot Instance requests.
-
describeSpotPriceHistory(params = {}, callback) ⇒ AWS.Request
Describes the Spot price history.
-
describeStaleSecurityGroups(params = {}, callback) ⇒ AWS.Request
[VPC only] Describes the stale security group rules for security groups in a specified VPC.
-
describeSubnets(params = {}, callback) ⇒ AWS.Request
Describes one or more of your subnets.
-
describeTags(params = {}, callback) ⇒ AWS.Request
Describes the specified tags for your EC2 resources.
-
describeTrafficMirrorFilters(params = {}, callback) ⇒ AWS.Request
Describes one or more Traffic Mirror filters.
-
describeTrafficMirrorSessions(params = {}, callback) ⇒ AWS.Request
Describes one or more Traffic Mirror sessions.
-
describeTrafficMirrorTargets(params = {}, callback) ⇒ AWS.Request
Information about one or more Traffic Mirror targets.
-
describeTransitGatewayAttachments(params = {}, callback) ⇒ AWS.Request
Describes one or more attachments between resources and transit gateways.
-
describeTransitGatewayConnectPeers(params = {}, callback) ⇒ AWS.Request
Describes one or more Connect peers.
-
describeTransitGatewayConnects(params = {}, callback) ⇒ AWS.Request
Describes one or more Connect attachments.
-
describeTransitGatewayMulticastDomains(params = {}, callback) ⇒ AWS.Request
Describes one or more transit gateway multicast domains.
-
describeTransitGatewayPeeringAttachments(params = {}, callback) ⇒ AWS.Request
Describes your transit gateway peering attachments.
-
describeTransitGatewayRouteTables(params = {}, callback) ⇒ AWS.Request
Describes one or more transit gateway route tables.
-
describeTransitGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more transit gateways.
-
describeTransitGatewayVpcAttachments(params = {}, callback) ⇒ AWS.Request
Describes one or more VPC attachments.
-
describeVolumeAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified volume.
-
describeVolumes(params = {}, callback) ⇒ AWS.Request
Describes the specified EBS volumes or all of your EBS volumes.
-
describeVolumesModifications(params = {}, callback) ⇒ AWS.Request
Describes the most recent volume modification request for the specified EBS volumes.
-
describeVolumeStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the specified volumes.
-
describeVpcAttribute(params = {}, callback) ⇒ AWS.Request
Describes the specified attribute of the specified VPC.
-
describeVpcClassicLink(params = {}, callback) ⇒ AWS.Request
Describes the ClassicLink status of one or more VPCs.
-
describeVpcClassicLinkDnsSupport(params = {}, callback) ⇒ AWS.Request
Describes the ClassicLink DNS support status of one or more VPCs.
-
describeVpcEndpointConnectionNotifications(params = {}, callback) ⇒ AWS.Request
Describes the connection notifications for VPC endpoints and VPC endpoint services.
-
describeVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
-
describeVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Describes one or more of your VPC endpoints.
-
describeVpcEndpointServiceConfigurations(params = {}, callback) ⇒ AWS.Request
Describes the VPC endpoint service configurations in your account (your services).
-
describeVpcEndpointServicePermissions(params = {}, callback) ⇒ AWS.Request
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
-
describeVpcEndpointServices(params = {}, callback) ⇒ AWS.Request
Describes available services to which you can create a VPC endpoint.
-
describeVpcPeeringConnections(params = {}, callback) ⇒ AWS.Request
Describes one or more of your VPC peering connections.
-
describeVpcs(params = {}, callback) ⇒ AWS.Request
Describes one or more of your VPCs.
-
describeVpnConnections(params = {}, callback) ⇒ AWS.Request
Describes one or more of your VPN connections.
-
describeVpnGateways(params = {}, callback) ⇒ AWS.Request
Describes one or more of your virtual private gateways.
-
detachClassicLinkVpc(params = {}, callback) ⇒ AWS.Request
Unlinks (detaches) a linked EC2-Classic instance from a VPC.
-
detachInternetGateway(params = {}, callback) ⇒ AWS.Request
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC.
-
detachNetworkInterface(params = {}, callback) ⇒ AWS.Request
Detaches a network interface from an instance.
-
detachVolume(params = {}, callback) ⇒ AWS.Request
Detaches an EBS volume from an instance.
-
detachVpnGateway(params = {}, callback) ⇒ AWS.Request
Detaches a virtual private gateway from a VPC.
-
disableEbsEncryptionByDefault(params = {}, callback) ⇒ AWS.Request
Disables EBS encryption by default for your account in the current Region.
-
disableFastSnapshotRestores(params = {}, callback) ⇒ AWS.Request
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
-
disableTransitGatewayRouteTablePropagation(params = {}, callback) ⇒ AWS.Request
Disables the specified resource attachment from propagating routes to the specified propagation route table.
-
disableVgwRoutePropagation(params = {}, callback) ⇒ AWS.Request
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
-
disableVpcClassicLink(params = {}, callback) ⇒ AWS.Request
Disables ClassicLink for a VPC.
-
disableVpcClassicLinkDnsSupport(params = {}, callback) ⇒ AWS.Request
Disables ClassicLink DNS support for a VPC.
-
disassociateAddress(params = {}, callback) ⇒ AWS.Request
Disassociates an Elastic IP address from the instance or network interface it's associated with.
-
disassociateClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request
Disassociates a target network from the specified Client VPN endpoint.
-
disassociateEnclaveCertificateIamRole(params = {}, callback) ⇒ AWS.Request
Disassociates an IAM role from an AWS Certificate Manager (ACM) certificate.
-
disassociateIamInstanceProfile(params = {}, callback) ⇒ AWS.Request
Disassociates an IAM instance profile from a running or stopped instance.
-
disassociateRouteTable(params = {}, callback) ⇒ AWS.Request
Disassociates a subnet or gateway from a route table.
-
disassociateSubnetCidrBlock(params = {}, callback) ⇒ AWS.Request
Disassociates a CIDR block from a subnet.
-
disassociateTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request
Disassociates the specified subnets from the transit gateway multicast domain.
-
disassociateTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request
Disassociates a resource attachment from a transit gateway route table.
-
disassociateVpcCidrBlock(params = {}, callback) ⇒ AWS.Request
Disassociates a CIDR block from a VPC.
-
enableEbsEncryptionByDefault(params = {}, callback) ⇒ AWS.Request
Enables EBS encryption by default for your account in the current Region.
-
enableFastSnapshotRestores(params = {}, callback) ⇒ AWS.Request
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
-
enableTransitGatewayRouteTablePropagation(params = {}, callback) ⇒ AWS.Request
Enables the specified attachment to propagate routes to the specified propagation route table.
-
enableVgwRoutePropagation(params = {}, callback) ⇒ AWS.Request
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
-
enableVolumeIO(params = {}, callback) ⇒ AWS.Request
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
-
enableVpcClassicLink(params = {}, callback) ⇒ AWS.Request
Enables a VPC for ClassicLink.
-
enableVpcClassicLinkDnsSupport(params = {}, callback) ⇒ AWS.Request
Enables a VPC to support DNS hostname resolution for ClassicLink.
-
exportClientVpnClientCertificateRevocationList(params = {}, callback) ⇒ AWS.Request
Downloads the client certificate revocation list for the specified Client VPN endpoint.
-
exportClientVpnClientConfiguration(params = {}, callback) ⇒ AWS.Request
Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint.
-
exportImage(params = {}, callback) ⇒ AWS.Request
Exports an Amazon Machine Image (AMI) to a VM file.
-
exportTransitGatewayRoutes(params = {}, callback) ⇒ AWS.Request
Exports routes from the specified transit gateway route table to the specified S3 bucket.
-
getAssociatedEnclaveCertificateIamRoles(params = {}, callback) ⇒ AWS.Request
Returns the IAM roles that are associated with the specified AWS Certificate Manager (ACM) certificate.
-
getAssociatedIpv6PoolCidrs(params = {}, callback) ⇒ AWS.Request
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
-
getCapacityReservationUsage(params = {}, callback) ⇒ AWS.Request
Gets usage information about a Capacity Reservation.
-
getCoipPoolUsage(params = {}, callback) ⇒ AWS.Request
Describes the allocations from the specified customer-owned address pool.
-
getConsoleOutput(params = {}, callback) ⇒ AWS.Request
Gets the console output for the specified instance.
-
getConsoleScreenshot(params = {}, callback) ⇒ AWS.Request
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
-
getDefaultCreditSpecification(params = {}, callback) ⇒ AWS.Request
Describes the default credit option for CPU usage of a burstable performance instance family.
-
getEbsDefaultKmsKeyId(params = {}, callback) ⇒ AWS.Request
Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
-
getEbsEncryptionByDefault(params = {}, callback) ⇒ AWS.Request
Describes whether EBS encryption by default is enabled for your account in the current Region.
-
getGroupsForCapacityReservation(params = {}, callback) ⇒ AWS.Request
Lists the resource groups to which a Capacity Reservation has been added.
-
getHostReservationPurchasePreview(params = {}, callback) ⇒ AWS.Request
Preview a reservation purchase with configurations that match those of your Dedicated Host.
-
getLaunchTemplateData(params = {}, callback) ⇒ AWS.Request
Retrieves the configuration data of the specified instance.
-
getManagedPrefixListAssociations(params = {}, callback) ⇒ AWS.Request
Gets information about the resources that are associated with the specified managed prefix list.
-
getManagedPrefixListEntries(params = {}, callback) ⇒ AWS.Request
Gets information about the entries for a specified managed prefix list.
-
getPasswordData(params = {}, callback) ⇒ AWS.Request
Retrieves the encrypted administrator password for a running Windows instance.
-
getReservedInstancesExchangeQuote(params = {}, callback) ⇒ AWS.Request
Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance.
-
getTransitGatewayAttachmentPropagations(params = {}, callback) ⇒ AWS.Request
Lists the route tables to which the specified resource attachment propagates routes.
-
getTransitGatewayMulticastDomainAssociations(params = {}, callback) ⇒ AWS.Request
Gets information about the associations for the transit gateway multicast domain.
-
getTransitGatewayPrefixListReferences(params = {}, callback) ⇒ AWS.Request
Gets information about the prefix list references in a specified transit gateway route table.
-
getTransitGatewayRouteTableAssociations(params = {}, callback) ⇒ AWS.Request
Gets information about the associations for the specified transit gateway route table.
-
getTransitGatewayRouteTablePropagations(params = {}, callback) ⇒ AWS.Request
Gets information about the route table propagations for the specified transit gateway route table.
-
importClientVpnClientCertificateRevocationList(params = {}, callback) ⇒ AWS.Request
Uploads a client certificate revocation list to the specified Client VPN endpoint.
-
importImage(params = {}, callback) ⇒ AWS.Request
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
-
importInstance(params = {}, callback) ⇒ AWS.Request
Creates an import instance task using metadata from the specified disk image.
-
importKeyPair(params = {}, callback) ⇒ AWS.Request
Imports the public key from an RSA key pair that you created with a third-party tool.
-
importSnapshot(params = {}, callback) ⇒ AWS.Request
Imports a disk into an EBS snapshot.
-
importVolume(params = {}, callback) ⇒ AWS.Request
Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
-
modifyAvailabilityZoneGroup(params = {}, callback) ⇒ AWS.Request
Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
-
modifyCapacityReservation(params = {}, callback) ⇒ AWS.Request
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released.
-
modifyClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request
Modifies the specified Client VPN endpoint.
-
modifyDefaultCreditSpecification(params = {}, callback) ⇒ AWS.Request
Modifies the default credit option for CPU usage of burstable performance instances.
-
modifyEbsDefaultKmsKeyId(params = {}, callback) ⇒ AWS.Request
Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
-
modifyFleet(params = {}, callback) ⇒ AWS.Request
Modifies the specified EC2 Fleet.
-
modifyFpgaImageAttribute(params = {}, callback) ⇒ AWS.Request
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
-
modifyHosts(params = {}, callback) ⇒ AWS.Request
Modify the auto-placement setting of a Dedicated Host.
-
modifyIdentityIdFormat(params = {}, callback) ⇒ AWS.Request
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account.
-
modifyIdFormat(params = {}, callback) ⇒ AWS.Request
Modifies the ID format for the specified resource on a per-Region basis.
-
modifyImageAttribute(params = {}, callback) ⇒ AWS.Request
Modifies the specified attribute of the specified AMI.
-
modifyInstanceAttribute(params = {}, callback) ⇒ AWS.Request
Modifies the specified attribute of the specified instance.
-
modifyInstanceCapacityReservationAttributes(params = {}, callback) ⇒ AWS.Request
Modifies the Capacity Reservation settings for a stopped instance.
-
modifyInstanceCreditSpecification(params = {}, callback) ⇒ AWS.Request
Modifies the credit option for CPU usage on a running or stopped burstable performance instance.
-
modifyInstanceEventStartTime(params = {}, callback) ⇒ AWS.Request
Modifies the start time for a scheduled Amazon EC2 instance event.
-
modifyInstanceMetadataOptions(params = {}, callback) ⇒ AWS.Request
Modify the instance metadata parameters on a running or stopped instance.
-
modifyInstancePlacement(params = {}, callback) ⇒ AWS.Request
Modifies the placement attributes for a specified instance.
-
modifyLaunchTemplate(params = {}, callback) ⇒ AWS.Request
Modifies a launch template.
-
modifyManagedPrefixList(params = {}, callback) ⇒ AWS.Request
Modifies the specified managed prefix list.
-
modifyNetworkInterfaceAttribute(params = {}, callback) ⇒ AWS.Request
Modifies the specified network interface attribute.
-
modifyReservedInstances(params = {}, callback) ⇒ AWS.Request
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.
-
modifySnapshotAttribute(params = {}, callback) ⇒ AWS.Request
Adds or removes permission settings for the specified snapshot.
-
modifySpotFleetRequest(params = {}, callback) ⇒ AWS.Request
Modifies the specified Spot Fleet request.
-
modifySubnetAttribute(params = {}, callback) ⇒ AWS.Request
Modifies a subnet attribute.
-
modifyTrafficMirrorFilterNetworkServices(params = {}, callback) ⇒ AWS.Request
Allows or restricts mirroring network services.
-
modifyTrafficMirrorFilterRule(params = {}, callback) ⇒ AWS.Request
Modifies the specified Traffic Mirror rule.
-
modifyTrafficMirrorSession(params = {}, callback) ⇒ AWS.Request
Modifies a Traffic Mirror session.
-
modifyTransitGateway(params = {}, callback) ⇒ AWS.Request
Modifies the specified transit gateway.
-
modifyTransitGatewayPrefixListReference(params = {}, callback) ⇒ AWS.Request
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
-
modifyTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Modifies the specified VPC attachment.
-
modifyVolume(params = {}, callback) ⇒ AWS.Request
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity.
-
modifyVolumeAttribute(params = {}, callback) ⇒ AWS.Request
Modifies a volume attribute.
-
modifyVpcAttribute(params = {}, callback) ⇒ AWS.Request
Modifies the specified attribute of the specified VPC.
-
modifyVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Modifies attributes of a specified VPC endpoint.
-
modifyVpcEndpointConnectionNotification(params = {}, callback) ⇒ AWS.Request
Modifies a connection notification for VPC endpoint or VPC endpoint service.
-
modifyVpcEndpointServiceConfiguration(params = {}, callback) ⇒ AWS.Request
Modifies the attributes of your VPC endpoint service configuration.
-
modifyVpcEndpointServicePermissions(params = {}, callback) ⇒ AWS.Request
Modifies the permissions for your VPC endpoint service.
-
modifyVpcPeeringConnectionOptions(params = {}, callback) ⇒ AWS.Request
Modifies the VPC peering connection options on one side of a VPC peering connection.
-
modifyVpcTenancy(params = {}, callback) ⇒ AWS.Request
Modifies the instance tenancy attribute of the specified VPC.
-
modifyVpnConnection(params = {}, callback) ⇒ AWS.Request
Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection.
-
modifyVpnConnectionOptions(params = {}, callback) ⇒ AWS.Request
Modifies the connection options for your Site-to-Site VPN connection.
-
modifyVpnTunnelCertificate(params = {}, callback) ⇒ AWS.Request
Modifies the VPN tunnel endpoint certificate.
-
modifyVpnTunnelOptions(params = {}, callback) ⇒ AWS.Request
Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection.
-
monitorInstances(params = {}, callback) ⇒ AWS.Request
Enables detailed monitoring for a running instance.
-
moveAddressToVpc(params = {}, callback) ⇒ AWS.Request
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.
-
provisionByoipCidr(params = {}, callback) ⇒ AWS.Request
Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.
-
purchaseHostReservation(params = {}, callback) ⇒ AWS.Request
Purchase a reservation with configurations that match those of your Dedicated Host.
-
purchaseReservedInstancesOffering(params = {}, callback) ⇒ AWS.Request
Purchases a Reserved Instance for use with your account.
-
purchaseScheduledInstances(params = {}, callback) ⇒ AWS.Request
Purchases the Scheduled Instances with the specified schedule.
-
rebootInstances(params = {}, callback) ⇒ AWS.Request
Requests a reboot of the specified instances.
-
registerImage(params = {}, callback) ⇒ AWS.Request
Registers an AMI.
-
registerInstanceEventNotificationAttributes(params = {}, callback) ⇒ AWS.Request
Registers a set of tag keys to include in scheduled event notifications for your resources.
-
registerTransitGatewayMulticastGroupMembers(params = {}, callback) ⇒ AWS.Request
Registers members (network interfaces) with the transit gateway multicast group.
-
registerTransitGatewayMulticastGroupSources(params = {}, callback) ⇒ AWS.Request
Registers sources (network interfaces) with the specified transit gateway multicast group.
-
rejectTransitGatewayMulticastDomainAssociations(params = {}, callback) ⇒ AWS.Request
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
-
rejectTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request
Rejects a transit gateway peering attachment request.
-
rejectTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Rejects a request to attach a VPC to a transit gateway.
-
rejectVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request
Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
-
rejectVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request
Rejects a VPC peering connection request.
-
releaseAddress(params = {}, callback) ⇒ AWS.Request
Releases the specified Elastic IP address.
-
releaseHosts(params = {}, callback) ⇒ AWS.Request
When you no longer want to use an On-Demand Dedicated Host it can be released.
-
replaceIamInstanceProfileAssociation(params = {}, callback) ⇒ AWS.Request
Replaces an IAM instance profile for the specified running instance.
-
replaceNetworkAclAssociation(params = {}, callback) ⇒ AWS.Request
Changes which network ACL a subnet is associated with.
-
replaceNetworkAclEntry(params = {}, callback) ⇒ AWS.Request
Replaces an entry (rule) in a network ACL.
-
replaceRoute(params = {}, callback) ⇒ AWS.Request
Replaces an existing route within a route table in a VPC.
-
replaceRouteTableAssociation(params = {}, callback) ⇒ AWS.Request
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC.
-
replaceTransitGatewayRoute(params = {}, callback) ⇒ AWS.Request
Replaces the specified route in the specified transit gateway route table.
-
reportInstanceStatus(params = {}, callback) ⇒ AWS.Request
Submits feedback about the status of an instance.
-
requestSpotFleet(params = {}, callback) ⇒ AWS.Request
Creates a Spot Fleet request.
-
requestSpotInstances(params = {}, callback) ⇒ AWS.Request
Creates a Spot Instance request.
-
resetEbsDefaultKmsKeyId(params = {}, callback) ⇒ AWS.Request
Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.
-
resetFpgaImageAttribute(params = {}, callback) ⇒ AWS.Request
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.
-
resetImageAttribute(params = {}, callback) ⇒ AWS.Request
Resets an attribute of an AMI to its default value.
-
resetInstanceAttribute(params = {}, callback) ⇒ AWS.Request
Resets an attribute of an instance to its default value.
-
resetNetworkInterfaceAttribute(params = {}, callback) ⇒ AWS.Request
Resets a network interface attribute.
-
resetSnapshotAttribute(params = {}, callback) ⇒ AWS.Request
Resets permission settings for the specified snapshot.
-
restoreAddressToClassic(params = {}, callback) ⇒ AWS.Request
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.
-
restoreManagedPrefixListVersion(params = {}, callback) ⇒ AWS.Request
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
-
revokeClientVpnIngress(params = {}, callback) ⇒ AWS.Request
Removes an ingress authorization rule from a Client VPN endpoint.
-
revokeSecurityGroupEgress(params = {}, callback) ⇒ AWS.Request
[VPC only] Removes the specified egress rules from a security group for EC2-VPC.
-
revokeSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Removes the specified ingress rules from a security group.
-
runInstances(params = {}, callback) ⇒ AWS.Request
Launches the specified number of instances using an AMI for which you have permissions.
-
runScheduledInstances(params = {}, callback) ⇒ AWS.Request
Launches the specified Scheduled Instances.
-
searchLocalGatewayRoutes(params = {}, callback) ⇒ AWS.Request
Searches for routes in the specified local gateway route table.
-
searchTransitGatewayMulticastGroups(params = {}, callback) ⇒ AWS.Request
Searches one or more transit gateway multicast groups and returns the group membership information.
-
searchTransitGatewayRoutes(params = {}, callback) ⇒ AWS.Request
Searches for routes in the specified transit gateway route table.
-
sendDiagnosticInterrupt(params = {}, callback) ⇒ AWS.Request
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances).
-
startInstances(params = {}, callback) ⇒ AWS.Request
Starts an Amazon EBS-backed instance that you've previously stopped.
-
startNetworkInsightsAnalysis(params = {}, callback) ⇒ AWS.Request
Starts analyzing the specified path.
-
startVpcEndpointServicePrivateDnsVerification(params = {}, callback) ⇒ AWS.Request
Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
-
stopInstances(params = {}, callback) ⇒ AWS.Request
Stops an Amazon EBS-backed instance.
-
terminateClientVpnConnections(params = {}, callback) ⇒ AWS.Request
Terminates active Client VPN endpoint connections.
-
terminateInstances(params = {}, callback) ⇒ AWS.Request
Shuts down the specified instances.
-
unassignIpv6Addresses(params = {}, callback) ⇒ AWS.Request
Unassigns one or more IPv6 addresses from a network interface.
-
unassignPrivateIpAddresses(params = {}, callback) ⇒ AWS.Request
Unassigns one or more secondary private IP addresses from a network interface.
-
unmonitorInstances(params = {}, callback) ⇒ AWS.Request
Disables detailed monitoring for a running instance.
-
updateSecurityGroupRuleDescriptionsEgress(params = {}, callback) ⇒ AWS.Request
[VPC only] Updates the description of an egress (outbound) security group rule.
-
updateSecurityGroupRuleDescriptionsIngress(params = {}, callback) ⇒ AWS.Request
Updates the description of an ingress (inbound) security group rule.
-
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given EC2 resource.
-
withdrawByoipCidr(params = {}, callback) ⇒ AWS.Request
Stops advertising an address range that is provisioned as an address pool.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, defineService
Constructor Details
new AWS.EC2(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
acceptReservedInstancesExchangeQuote(params = {}, callback) ⇒ AWS.Request
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
acceptTransitGatewayMulticastDomainAssociations(params = {}, callback) ⇒ AWS.Request
Accepts a request to associate subnets with a transit gateway multicast domain.
acceptTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance
state.
acceptTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance
state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
acceptVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
acceptVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance
state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
advertiseByoipCidr(params = {}, callback) ⇒ AWS.Request
Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.
It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
allocateAddress(params = {}, callback) ⇒ AWS.Request
Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
allocateHosts(params = {}, callback) ⇒ AWS.Request
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
applySecurityGroupsToClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
assignIpv6Addresses(params = {}, callback) ⇒ AWS.Request
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
assignPrivateIpAddresses(params = {}, callback) ⇒ AWS.Request
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s
in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
associateAddress(params = {}, callback) ⇒ AWS.Request
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
associateClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
associateDhcpOptions(params = {}, callback) ⇒ AWS.Request
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
associateEnclaveCertificateIamRole(params = {}, callback) ⇒ AWS.Request
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see AWS Certificate Manager for Nitro Enclaves in the AWS Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, places the certificate, certificate chain, and encrypted private key in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS-managed KMS customer master (CMK) that has an attached attestation-based CMK policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject
on the Amazon S3 bucket returned by the command. To enable the IAM role to access the AWS KMS CMK, you must grant it permission to call kms:Decrypt
on AWS KMS CMK returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the AWS Nitro Enclaves User Guide.
associateIamInstanceProfile(params = {}, callback) ⇒ AWS.Request
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
associateRouteTable(params = {}, callback) ⇒ AWS.Request
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
associateSubnetCidrBlock(params = {}, callback) ⇒ AWS.Request
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
associateTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
associateTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
associateVpcCidrBlock(params = {}, callback) ⇒ AWS.Request
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
attachClassicLinkVpc(params = {}, callback) ⇒ AWS.Request
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running
state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
attachInternetGateway(params = {}, callback) ⇒ AWS.Request
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
attachNetworkInterface(params = {}, callback) ⇒ AWS.Request
Attaches a network interface to an instance.
attachVolume(params = {}, callback) ⇒ AWS.Request
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use.
If a volume has an AWS Marketplace product code:
-
The volume can be attached only to a stopped instance.
-
AWS Marketplace product codes are copied from the volume to the instance.
-
You must be subscribed to the product.
-
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
attachVpnGateway(params = {}, callback) ⇒ AWS.Request
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
authorizeClientVpnIngress(params = {}, callback) ⇒ AWS.Request
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
authorizeSecurityGroupEgress(params = {}, callback) ⇒ AWS.Request
[VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
authorizeSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
bundleInstance(params = {}, callback) ⇒ AWS.Request
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.
cancelBundleTask(params = {}, callback) ⇒ AWS.Request
Cancels a bundling operation for an instance store-backed Windows instance.
cancelCapacityReservation(params = {}, callback) ⇒ AWS.Request
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled
.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
cancelConversionTask(params = {}, callback) ⇒ AWS.Request
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
cancelExportTask(params = {}, callback) ⇒ AWS.Request
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
cancelImportTask(params = {}, callback) ⇒ AWS.Request
Cancels an in-process import virtual machine or import snapshot task.
cancelReservedInstancesListing(params = {}, callback) ⇒ AWS.Request
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
cancelSpotFleetRequests(params = {}, callback) ⇒ AWS.Request
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating
state. Otherwise, the Spot Fleet request enters the cancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.
cancelSpotInstanceRequests(params = {}, callback) ⇒ AWS.Request
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
confirmProductInstance(params = {}, callback) ⇒ AWS.Request
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
copyFpgaImage(params = {}, callback) ⇒ AWS.Request
Copies the specified Amazon FPGA Image (AFI) to the current Region.
copyImage(params = {}, callback) ⇒ AWS.Request
Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted
during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
copySnapshot(params = {}, callback) ⇒ AWS.Request
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
createCapacityReservation(params = {}, callback) ⇒ AWS.Request
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
createCarrierGateway(params = {}, callback) ⇒ AWS.Request
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.
createClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
createClientVpnRoute(params = {}, callback) ⇒ AWS.Request
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
createCustomerGateway(params = {}, callback) ⇒ AWS.Request
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
- 7224 - reserved in the
us-east-1
Region - 9059 - reserved in the
eu-west-1
Region - 17943 - reserved in the
ap-southeast-1
Region - 10124 - reserved in the
ap-northeast-1
Region
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.
createDefaultSubnet(params = {}, callback) ⇒ AWS.Request
Creates a default subnet with a size /20
IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.
createDefaultVpc(params = {}, callback) ⇒ AWS.Request
Creates a default VPC with a size /16
IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
createDhcpOptions(params = {}, callback) ⇒ AWS.Request
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
-
domain-name-servers
- The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified indomain-name
, you must setdomain-name-servers
to a custom DNS server. -
domain-name
- If you're using AmazonProvidedDNS inus-east-1
, specifyec2.internal
. If you're using AmazonProvidedDNS in another Region, specifyregion.compute.internal
(for example,ap-northeast-1.compute.internal
). Otherwise, specify a domain name (for example,ExampleCompany.com
). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. -
ntp-servers
- The IP addresses of up to four Network Time Protocol (NTP) servers. -
netbios-name-servers
- The IP addresses of up to four NetBIOS name servers. -
netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers
option either to AmazonProvidedDNS
or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
createEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
createFleet(params = {}, callback) ⇒ AWS.Request
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.
createFlowLogs(params = {}, callback) ⇒ AWS.Request
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
createFpgaImage(params = {}, callback) ⇒ AWS.Request
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
createImage(params = {}, callback) ⇒ AWS.Request
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
createInstanceExportTask(params = {}, callback) ⇒ AWS.Request
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
createInternetGateway(params = {}, callback) ⇒ AWS.Request
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
createKeyPair(params = {}, callback) ⇒ AWS.Request
Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
createLaunchTemplate(params = {}, callback) ⇒ AWS.Request
Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.
createLaunchTemplateVersion(params = {}, callback) ⇒ AWS.Request
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.