Class AbstractAmazonEC2
- All Implemented Interfaces:
AmazonEC2
- Direct Known Subclasses:
AbstractAmazonEC2Async
AmazonEC2
. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSimplified method form for invoking the AcceptVpcPeeringConnection operation.Accept a VPC peering connection request.Simplified method form for invoking the AllocateAddress operation.allocateAddress
(AllocateAddressRequest request) Acquires an Elastic IP address.allocateHosts
(AllocateHostsRequest request) Allocates a Dedicated host to your account.Assigns one or more secondary private IP addresses to the specified network interface.associateAddress
(AssociateAddressRequest request) Associates an Elastic IP address with an instance or a network interface.Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.Associates a subnet with a route table.Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups.Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.Attaches a network interface to an instance.attachVolume
(AttachVolumeRequest request) Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.attachVpnGateway
(AttachVpnGatewayRequest request) Attaches a virtual private gateway to a VPC.[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.Adds one or more ingress rules to a security group.bundleInstance
(BundleInstanceRequest request) Bundles an Amazon instance store-backed Windows instance.cancelBundleTask
(CancelBundleTaskRequest request) Cancels a bundling operation for an instance store-backed Windows instance.Cancels an active conversion task.cancelExportTask
(CancelExportTaskRequest request) Cancels an active export task.Simplified method form for invoking the CancelImportTask operation.cancelImportTask
(CancelImportTaskRequest request) Cancels an in-process import virtual machine or import snapshot task.Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.Cancels the specified Spot fleet requests.Cancels one or more Spot instance requests.Determines whether a product code is associated with an instance.copyImage
(CopyImageRequest request) Initiates the copy of an AMI from the specified source region to the current region.copySnapshot
(CopySnapshotRequest request) Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.Provides information to AWS about your VPN customer gateway device.Creates a set of DHCP options for your VPC.createFlowLogs
(CreateFlowLogsRequest request) Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC.createImage
(CreateImageRequest request) Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.Exports a running or stopped instance to an S3 bucket.Simplified method form for invoking the CreateInternetGateway operation.Creates an Internet gateway for use with a VPC.createKeyPair
(CreateKeyPairRequest request) Creates a 2048-bit RSA key pair with the specified name.createNatGateway
(CreateNatGatewayRequest request) Creates a NAT gateway in the specified subnet.createNetworkAcl
(CreateNetworkAclRequest request) Creates a network ACL in a VPC.Creates an entry (a rule) in a network ACL with the specified rule number.Creates a network interface in the specified subnet.Creates a placement group that you launch cluster instances into.Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace.createRoute
(CreateRouteRequest request) Creates a route in a route table within a VPC.createRouteTable
(CreateRouteTableRequest request) Creates a route table for the specified VPC.Creates a security group.createSnapshot
(CreateSnapshotRequest request) Creates a snapshot of an EBS volume and stores it in Amazon S3.Creates a data feed for Spot instances, enabling you to view Spot instance usage logs.createSubnet
(CreateSubnetRequest request) Creates a subnet in an existing VPC.createTags
(CreateTagsRequest request) Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources.createVolume
(CreateVolumeRequest request) Creates an EBS volume that can be attached to an instance in the same Availability Zone.createVpc
(CreateVpcRequest request) Creates a VPC with the specified CIDR block.Creates a VPC endpoint for a specified AWS service.Simplified method form for invoking the CreateVpcPeeringConnection operation.Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection.Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway.Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.createVpnGateway
(CreateVpnGatewayRequest request) Creates a virtual private gateway.Deletes the specified customer gateway.Deletes the specified set of DHCP options.deleteFlowLogs
(DeleteFlowLogsRequest request) Deletes one or more flow logs.Deletes the specified Internet gateway.deleteKeyPair
(DeleteKeyPairRequest request) Deletes the specified key pair, by removing the public key from Amazon EC2.deleteNatGateway
(DeleteNatGatewayRequest request) Deletes the specified NAT gateway.deleteNetworkAcl
(DeleteNetworkAclRequest request) Deletes the specified network ACL.Deletes the specified ingress or egress entry (rule) from the specified network ACL.Deletes the specified network interface.Deletes the specified placement group.deleteRoute
(DeleteRouteRequest request) Deletes the specified route from the specified route table.deleteRouteTable
(DeleteRouteTableRequest request) Deletes the specified route table.Deletes a security group.deleteSnapshot
(DeleteSnapshotRequest request) Deletes the specified snapshot.Simplified method form for invoking the DeleteSpotDatafeedSubscription operation.Deletes the data feed for Spot instances.deleteSubnet
(DeleteSubnetRequest request) Deletes the specified subnet.deleteTags
(DeleteTagsRequest request) Deletes the specified set of tags from the specified set of resources.deleteVolume
(DeleteVolumeRequest request) Deletes the specified EBS volume.deleteVpc
(DeleteVpcRequest request) Deletes the specified VPC.Deletes one or more specified VPC endpoints.Deletes a VPC peering connection.Deletes the specified VPN connection.Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.deleteVpnGateway
(DeleteVpnGatewayRequest request) Deletes the specified virtual private gateway.deregisterImage
(DeregisterImageRequest request) Deregisters the specified AMI.Simplified method form for invoking the DescribeAccountAttributes operation.Describes attributes of your AWS account.Simplified method form for invoking the DescribeAddresses operation.Describes one or more of your Elastic IP addresses.Simplified method form for invoking the DescribeAvailabilityZones operation.Describes one or more of the Availability Zones that are available to you.Simplified method form for invoking the DescribeBundleTasks operation.Describes one or more of your bundling tasks.Simplified method form for invoking the DescribeClassicLinkInstances operation.Describes one or more of your linked EC2-Classic instances.Simplified method form for invoking the DescribeConversionTasks operation.Describes one or more of your conversion tasks.Simplified method form for invoking the DescribeCustomerGateways operation.Describes one or more of your VPN customer gateways.Simplified method form for invoking the DescribeDhcpOptions operation.Describes one or more of your DHCP options sets.Simplified method form for invoking the DescribeExportTasks operation.Describes one or more of your export tasks.Simplified method form for invoking the DescribeFlowLogs operation.describeFlowLogs
(DescribeFlowLogsRequest request) Describes one or more flow logs.Simplified method form for invoking the DescribeHosts operation.describeHosts
(DescribeHostsRequest request) Describes one or more of your Dedicated hosts.Simplified method form for invoking the DescribeIdFormat operation.describeIdFormat
(DescribeIdFormatRequest 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.Describes the specified attribute of the specified AMI.Simplified method form for invoking the DescribeImages operation.describeImages
(DescribeImagesRequest request) Describes one or more of the images (AMIs, AKIs, and ARIs) available to you.Simplified method form for invoking the DescribeImportImageTasks operation.Displays details about an import virtual machine or import snapshot tasks that are already created.Simplified method form for invoking the DescribeImportSnapshotTasks operation.Describes your import snapshot tasks.Describes the specified attribute of the specified instance.Simplified method form for invoking the DescribeInstances operation.Describes one or more of your instances.Simplified method form for invoking the DescribeInstanceStatus operation.Describes the status of one or more instances.Simplified method form for invoking the DescribeInternetGateways operation.Describes one or more of your Internet gateways.Simplified method form for invoking the DescribeKeyPairs operation.describeKeyPairs
(DescribeKeyPairsRequest request) Describes one or more of your key pairs.Simplified method form for invoking the DescribeMovingAddresses operation.Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform.Describes one or more of the your NAT gateways.Simplified method form for invoking the DescribeNetworkAcls operation.Describes one or more of your network ACLs.Describes a network interface attribute.Simplified method form for invoking the DescribeNetworkInterfaces operation.Describes one or more of your network interfaces.Simplified method form for invoking the DescribePlacementGroups operation.Describes one or more of your placement groups.Simplified method form for invoking the DescribePrefixLists operation.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.Simplified method form for invoking the DescribeRegions operation.describeRegions
(DescribeRegionsRequest request) Describes one or more regions that are currently available to you.Simplified method form for invoking the DescribeReservedInstances operation.Describes one or more of the Reserved Instances that you purchased.Simplified method form for invoking the DescribeReservedInstancesListings operation.Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.Simplified method form for invoking the DescribeReservedInstancesModifications operation.Describes the modifications made to your Reserved Instances.Simplified method form for invoking the DescribeReservedInstancesOfferings operation.Describes Reserved Instance offerings that are available for purchase.Simplified method form for invoking the DescribeRouteTables operation.Describes one or more of your route tables.Finds available schedules that meet the specified criteria.Describes one or more of your Scheduled Instances.[EC2-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.Simplified method form for invoking the DescribeSecurityGroups operation.Describes one or more of your security groups.Describes the specified attribute of the specified snapshot.Simplified method form for invoking the DescribeSnapshots operation.Describes one or more of the EBS snapshots available to you.Simplified method form for invoking the DescribeSpotDatafeedSubscription operation.Describes the data feed for Spot instances.Describes the running instances for the specified Spot fleet.Describes the events for the specified Spot fleet request during the specified time.Simplified method form for invoking the DescribeSpotFleetRequests operation.Describes your Spot fleet requests.Simplified method form for invoking the DescribeSpotInstanceRequests operation.Describes the Spot instance requests that belong to your account.Simplified method form for invoking the DescribeSpotPriceHistory operation.Describes the Spot price history.[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.Simplified method form for invoking the DescribeSubnets operation.describeSubnets
(DescribeSubnetsRequest request) Describes one or more of your subnets.Simplified method form for invoking the DescribeTags operation.describeTags
(DescribeTagsRequest request) Describes one or more of the tags for your EC2 resources.Describes the specified attribute of the specified volume.Simplified method form for invoking the DescribeVolumes operation.describeVolumes
(DescribeVolumesRequest request) Describes the specified EBS volumes.Simplified method form for invoking the DescribeVolumeStatus operation.Describes the status of the specified volumes.Describes the specified attribute of the specified VPC.Simplified method form for invoking the DescribeVpcClassicLink operation.Describes the ClassicLink status of one or more VPCs.Describes the ClassicLink DNS support status of one or more VPCs.Simplified method form for invoking the DescribeVpcEndpoints operation.Describes one or more of your VPC endpoints.Simplified method form for invoking the DescribeVpcEndpointServices operation.Describes all supported AWS services that can be specified when creating a VPC endpoint.Simplified method form for invoking the DescribeVpcPeeringConnections operation.Describes one or more of your VPC peering connections.Simplified method form for invoking the DescribeVpcs operation.describeVpcs
(DescribeVpcsRequest request) Describes one or more of your VPCs.Simplified method form for invoking the DescribeVpnConnections operation.Describes one or more of your VPN connections.Simplified method form for invoking the DescribeVpnGateways operation.Describes one or more of your virtual private gateways.Unlinks (detaches) a linked EC2-Classic instance from a VPC.Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.Detaches a network interface from an instance.detachVolume
(DetachVolumeRequest request) Detaches an EBS volume from an instance.detachVpnGateway
(DetachVpnGatewayRequest request) Detaches a virtual private gateway from a VPC.Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.Disables ClassicLink for a VPC.Disables ClassicLink DNS support for a VPC.Disassociates an Elastic IP address from the instance or network interface it's associated with.Disassociates a subnet from a route table.<X extends AmazonWebServiceRequest>
DryRunResult<X>dryRun
(DryRunSupportedRequest<X> request) Checks whether you have the required permissions for the provided Amazon EC2 operation, without actually running it.Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.enableVolumeIO
(EnableVolumeIORequest request) Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.Enables a VPC for ClassicLink.Enables a VPC to support DNS hostname resolution for ClassicLink.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getConsoleOutput
(GetConsoleOutputRequest request) Gets the console output for the specified instance.getPasswordData
(GetPasswordDataRequest request) Retrieves the encrypted administrator password for an instance running Windows.Simplified method form for invoking the ImportImage operation.importImage
(ImportImageRequest request) Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).importInstance
(ImportInstanceRequest request) Creates an import instance task using metadata from the specified disk image.importKeyPair
(ImportKeyPairRequest request) Imports the public key from an RSA key pair that you created with a third-party tool.Simplified method form for invoking the ImportSnapshot operation.importSnapshot
(ImportSnapshotRequest request) Imports a disk into an EBS snapshot.importVolume
(ImportVolumeRequest request) Creates an import volume task using metadata from the specified disk image.modifyHosts
(ModifyHostsRequest request) Modify the auto-placement setting of a Dedicated host.modifyIdFormat
(ModifyIdFormatRequest request) Modifies the ID format for the specified resource on a per-region basis.Modifies the specified attribute of the specified AMI.Modifies the specified attribute of the specified instance.Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.Modifies the specified network interface attribute.Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.Adds or removes permission settings for the specified snapshot.Modifies the specified Spot fleet request.Modifies a subnet attribute.Modifies a volume attribute.Modifies the specified attribute of the specified VPC.Modifies attributes of a specified VPC endpoint.Modifies the VPC peering connection options on one side of a VPC peering connection.monitorInstances
(MonitorInstancesRequest request) Enables monitoring for a running instance.moveAddressToVpc
(MoveAddressToVpcRequest request) Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.Purchases a Reserved Instance for use with your account.Purchases one or more Scheduled Instances with the specified schedule.rebootInstances
(RebootInstancesRequest request) Requests a reboot of one or more instances.registerImage
(RegisterImageRequest request) Registers an AMI.Rejects a VPC peering connection request.releaseAddress
(ReleaseAddressRequest request) Releases the specified Elastic IP address.releaseHosts
(ReleaseHostsRequest request) When you no longer want to use a Dedicated host it can be released.Changes which network ACL a subnet is associated with.Replaces an entry (rule) in a network ACL.replaceRoute
(ReplaceRouteRequest request) Replaces an existing route within a route table in a VPC.Changes the route table associated with a given subnet in a VPC.Submits feedback about the status of an instance.requestSpotFleet
(RequestSpotFleetRequest request) Creates a Spot fleet request.Creates a Spot instance request.Resets an attribute of an AMI to its default value.Resets an attribute of an instance to its default value.Resets a network interface attribute.Resets permission settings for the specified snapshot.Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.Simplified method form for invoking the RevokeSecurityGroupIngress operation.Removes one or more ingress rules from a security group.runInstances
(RunInstancesRequest request) Launches the specified number of instances using an AMI for which you have permissions.Launches the specified Scheduled Instances.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://ec2.us-east-1.amazonaws.com").void
An alternative toAmazonEC2.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.startInstances
(StartInstancesRequest request) Starts an Amazon EBS-backed AMI that you've previously stopped.stopInstances
(StopInstancesRequest request) Stops an Amazon EBS-backed instance.Shuts down one or more instances.Unassigns one or more secondary private IP addresses from a network interface.Disables monitoring for a running instance.
-
Constructor Details
-
AbstractAmazonEC2
protected AbstractAmazonEC2()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonEC2
Overrides the default endpoint for this client ("https://ec2.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "ec2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonEC2
- Parameters:
endpoint
- The endpoint (ex: "ec2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AmazonEC2
An alternative toAmazonEC2.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonEC2
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
Region#getRegion(com.amazonaws.regions.Regions)
Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
Region.isServiceSupported(String)
-
acceptVpcPeeringConnection
public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest request) Description copied from interface:AmazonEC2
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 theDescribeVpcPeeringConnections
request to view your outstanding VPC peering connection requests.- Specified by:
acceptVpcPeeringConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AcceptVpcPeeringConnection.- Returns:
- Result of the AcceptVpcPeeringConnection operation returned by the service.
-
acceptVpcPeeringConnection
Description copied from interface:AmazonEC2
Simplified method form for invoking the AcceptVpcPeeringConnection operation.- Specified by:
acceptVpcPeeringConnection
in interfaceAmazonEC2
- See Also:
-
allocateAddress
Description copied from interface:AmazonEC2
Acquires an Elastic IP address.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
allocateAddress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AllocateAddress.- Returns:
- Result of the AllocateAddress operation returned by the service.
-
allocateAddress
Description copied from interface:AmazonEC2
Simplified method form for invoking the AllocateAddress operation.- Specified by:
allocateAddress
in interfaceAmazonEC2
- See Also:
-
allocateHosts
Description copied from interface:AmazonEC2
Allocates a Dedicated host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.
- Specified by:
allocateHosts
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AllocateHosts.- Returns:
- Result of the AllocateHosts operation returned by the service.
-
assignPrivateIpAddresses
public AssignPrivateIpAddressesResult assignPrivateIpAddresses(AssignPrivateIpAddressesRequest request) Description copied from interface:AmazonEC2
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.
AssignPrivateIpAddresses is available only in EC2-VPC.
- Specified by:
assignPrivateIpAddresses
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AssignPrivateIpAddresses.- Returns:
- Result of the AssignPrivateIpAddresses operation returned by the service.
-
associateAddress
Description copied from interface:AmazonEC2
Associates an Elastic IP address with an instance or a network interface.
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.
[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.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
- Specified by:
associateAddress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AssociateAddress.- Returns:
- Result of the AssociateAddress operation returned by the service.
-
associateDhcpOptions
Description copied from interface:AmazonEC2
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.
- Specified by:
associateDhcpOptions
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AssociateDhcpOptions.- Returns:
- Result of the AssociateDhcpOptions operation returned by the service.
-
associateRouteTable
Description copied from interface:AmazonEC2
Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet 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 from the subnet later. A route table can be associated with multiple subnets.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
associateRouteTable
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AssociateRouteTable.- Returns:
- Result of the AssociateRouteTable operation returned by the service.
-
attachClassicLinkVpc
Description copied from interface:AmazonEC2
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.
- Specified by:
attachClassicLinkVpc
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AttachClassicLinkVpc.- Returns:
- Result of the AttachClassicLinkVpc operation returned by the service.
-
attachInternetGateway
Description copied from interface:AmazonEC2
Attaches an Internet 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.
- Specified by:
attachInternetGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AttachInternetGateway.- Returns:
- Result of the AttachInternetGateway operation returned by the service.
-
attachNetworkInterface
Description copied from interface:AmazonEC2
Attaches a network interface to an instance.
- Specified by:
attachNetworkInterface
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AttachNetworkInterface.- Returns:
- Result of the AttachNetworkInterface operation returned by the service.
-
attachVolume
Description copied from interface:AmazonEC2
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.
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 an overview of the AWS Marketplace, see Introducing AWS Marketplace.
For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
attachVolume
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AttachVolume.- Returns:
- Result of the AttachVolume operation returned by the service.
-
-
attachVpnGateway
Description copied from interface:AmazonEC2
Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
attachVpnGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AttachVpnGateway.- Returns:
- Result of the AttachVpnGateway operation returned by the service.
-
authorizeSecurityGroupEgress
public AuthorizeSecurityGroupEgressResult authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest request) Description copied from interface:AmazonEC2
[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
You can have up to 50 rules per security group (covering both ingress and egress rules).
Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. 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.
- Specified by:
authorizeSecurityGroupEgress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AuthorizeSecurityGroupEgress.- Returns:
- Result of the AuthorizeSecurityGroupEgress operation returned by the service.
-
authorizeSecurityGroupIngress
public AuthorizeSecurityGroupIngressResult authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest request) Description copied from interface:AmazonEC2
Adds one or more ingress rules to a security group.
EC2-Classic: You can have up to 100 rules per group.
EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.
[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.
- Specified by:
authorizeSecurityGroupIngress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for AuthorizeSecurityGroupIngress.- Returns:
- Result of the AuthorizeSecurityGroupIngress operation returned by the service.
-
bundleInstance
Description copied from interface:AmazonEC2
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.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
For more information, see Creating an Instance Store-Backed Windows AMI.
- Specified by:
bundleInstance
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for BundleInstance.- Returns:
- Result of the BundleInstance operation returned by the service.
-
cancelBundleTask
Description copied from interface:AmazonEC2
Cancels a bundling operation for an instance store-backed Windows instance.
- Specified by:
cancelBundleTask
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelBundleTask.- Returns:
- Result of the CancelBundleTask operation returned by the service.
-
cancelConversionTask
Description copied from interface:AmazonEC2
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 Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
cancelConversionTask
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelConversionTask.- Returns:
- Result of the CancelConversionTask operation returned by the service.
-
cancelExportTask
Description copied from interface:AmazonEC2
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.
- Specified by:
cancelExportTask
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelExportTask.- Returns:
- Result of the CancelExportTask operation returned by the service.
-
cancelImportTask
Description copied from interface:AmazonEC2
Cancels an in-process import virtual machine or import snapshot task.
- Specified by:
cancelImportTask
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelImportTask.- Returns:
- Result of the CancelImportTask operation returned by the service.
-
cancelImportTask
Description copied from interface:AmazonEC2
Simplified method form for invoking the CancelImportTask operation.- Specified by:
cancelImportTask
in interfaceAmazonEC2
- See Also:
-
cancelReservedInstancesListing
public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest request) Description copied from interface:AmazonEC2
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
cancelReservedInstancesListing
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelReservedInstancesListing.- Returns:
- Result of the CancelReservedInstancesListing operation returned by the service.
-
cancelSpotFleetRequests
public CancelSpotFleetRequestsResult cancelSpotFleetRequests(CancelSpotFleetRequestsRequest request) Description copied from interface:AmazonEC2
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 thecancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.- Specified by:
cancelSpotFleetRequests
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelSpotFleetRequests.- Returns:
- Result of the CancelSpotFleetRequests operation returned by the service.
-
cancelSpotInstanceRequests
public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest request) Description copied from interface:AmazonEC2
Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.
Canceling a Spot instance request does not terminate running Spot instances associated with the request.
- Specified by:
cancelSpotInstanceRequests
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CancelSpotInstanceRequests.- Returns:
- Result of the CancelSpotInstanceRequests operation returned by the service.
-
confirmProductInstance
Description copied from interface:AmazonEC2
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 needs to verify whether another user's instance is eligible for support.
- Specified by:
confirmProductInstance
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ConfirmProductInstance.- Returns:
- Result of the ConfirmProductInstance operation returned by the service.
-
copyImage
Description copied from interface:AmazonEC2
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.
For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.
-
copySnapshot
Description copied from interface:AmazonEC2
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). The snapshot is copied to the regional endpoint that you send the HTTP request to.
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the
Encrypted
flag is specified during 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 non-default CMK with theKmsKeyId
parameter.For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
copySnapshot
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CopySnapshot.- Returns:
- Result of the CopySnapshot operation returned by the service.
-
createCustomerGateway
Description copied from interface:AmazonEC2
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 may 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).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the
us-east-1
region, and 9059, which is reserved in theeu-west-1
region.For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
- Specified by:
createCustomerGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateCustomerGateway.- Returns:
- Result of the CreateCustomerGateway operation returned by the service.
-
createDhcpOptions
Description copied from interface:AmazonEC2
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. -
domain-name
- If you're using AmazonProvidedDNS in "us-east-1", specify "ec2.internal". If you're using AmazonProvidedDNS in another region, specify "region.compute.internal" (for example, "ap-northeast-1.compute.internal"). Otherwise, specify a domain name (for example, "MyCompany.com"). 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 toAmazonProvidedDNS
or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.- Specified by:
createDhcpOptions
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateDhcpOptions.- Returns:
- Result of the CreateDhcpOptions operation returned by the service.
-
-
createFlowLogs
Description copied from interface:AmazonEC2
Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.
In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.
- Specified by:
createFlowLogs
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateFlowLogs.- Returns:
- Result of the CreateFlowLogs operation returned by the service.
-
createImage
Description copied from interface:AmazonEC2
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.
- Specified by:
createImage
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateImage.- Returns:
- Result of the CreateImage operation returned by the service.
-
createInstanceExportTask
public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest request) Description copied from interface:AmazonEC2
Exports a running or stopped instance to an S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createInstanceExportTask
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateInstanceExportTask.- Returns:
- Result of the CreateInstanceExportTask operation returned by the service.
-
createInternetGateway
Description copied from interface:AmazonEC2
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.
- Specified by:
createInternetGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateInternetGateway.- Returns:
- Result of the CreateInternetGateway operation returned by the service.
-
createInternetGateway
Description copied from interface:AmazonEC2
Simplified method form for invoking the CreateInternetGateway operation.- Specified by:
createInternetGateway
in interfaceAmazonEC2
- See Also:
-
createKeyPair
Description copied from interface:AmazonEC2
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#8 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. To create a key pair that is available in all regions, use ImportKeyPair.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createKeyPair
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateKeyPair.- Returns:
- Result of the CreateKeyPair operation returned by the service.
-
createNatGateway
Description copied from interface:AmazonEC2
Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createNatGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateNatGateway.- Returns:
- Result of the CreateNatGateway operation returned by the service.
-
createNetworkAcl
Description copied from interface:AmazonEC2
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createNetworkAcl
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateNetworkAcl.- Returns:
- Result of the CreateNetworkAcl operation returned by the service.
-
createNetworkAclEntry
Description copied from interface:AmazonEC2
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createNetworkAclEntry
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateNetworkAclEntry.- Returns:
- Result of the CreateNetworkAclEntry operation returned by the service.
-
createNetworkInterface
Description copied from interface:AmazonEC2
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createNetworkInterface
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateNetworkInterface.- Returns:
- Result of the CreateNetworkInterface operation returned by the service.
-
createPlacementGroup
Description copied from interface:AmazonEC2
Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.
For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createPlacementGroup
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreatePlacementGroup.- Returns:
- Result of the CreatePlacementGroup operation returned by the service.
-
createReservedInstancesListing
public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest request) Description copied from interface:AmazonEC2
Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createReservedInstancesListing
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateReservedInstancesListing.- Returns:
- Result of the CreateReservedInstancesListing operation returned by the service.
-
createRoute
Description copied from interface:AmazonEC2
Creates a route in a route table within a VPC.
You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.
When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for
192.0.2.3
, and the route table includes the following two routes:-
192.0.2.0/24
(goes to some target A) -
192.0.2.0/28
(goes to some target B)
Both routes apply to the traffic destined for
192.0.2.3
. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createRoute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateRoute.- Returns:
- Result of the CreateRoute operation returned by the service.
-
-
createRouteTable
Description copied from interface:AmazonEC2
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createRouteTable
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateRouteTable.- Returns:
- Result of the CreateRouteTable operation returned by the service.
-
createSecurityGroup
Description copied from interface:AmazonEC2
Creates a security group.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
EC2-Classic: You can have up to 500 security groups.
EC2-VPC: You can create up to 500 security groups per VPC.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
- Specified by:
createSecurityGroup
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateSecurityGroup.- Returns:
- Result of the CreateSecurityGroup operation returned by the service.
-
createSnapshot
Description copied from interface:AmazonEC2
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is
pending
.To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createSnapshot
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateSnapshot.- Returns:
- Result of the CreateSnapshot operation returned by the service.
-
createSpotDatafeedSubscription
public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest request) Description copied from interface:AmazonEC2
Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createSpotDatafeedSubscription
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateSpotDatafeedSubscription.- Returns:
- Result of the CreateSpotDatafeedSubscription operation returned by the service.
-
createSubnet
Description copied from interface:AmazonEC2
Creates a subnet in an existing VPC.
When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).
AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createSubnet
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateSubnet.- Returns:
- Result of the CreateSubnet operation returned by the service.
-
createTags
Description copied from interface:AmazonEC2
Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createTags
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateTags.- Returns:
- Result of the CreateTags operation returned by the service.
-
createVolume
Description copied from interface:AmazonEC2
Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the
Encrypted
parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
createVolume
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVolume.- Returns:
- Result of the CreateVolume operation returned by the service.
-
createVpc
Description copied from interface:AmazonEC2
Creates a VPC with the specified CIDR block.
The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.
-
createVpcEndpoint
Description copied from interface:AmazonEC2
Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
Currently, only endpoints to Amazon S3 are supported.
- Specified by:
createVpcEndpoint
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVpcEndpoint.- Returns:
- Result of the CreateVpcEndpoint operation returned by the service.
-
createVpcPeeringConnection
public CreateVpcPeeringConnectionResult createVpcPeeringConnection(CreateVpcPeeringConnectionRequest request) Description copied from interface:AmazonEC2
Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.
The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
A
CreateVpcPeeringConnection
request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status offailed
.- Specified by:
createVpcPeeringConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVpcPeeringConnection.- Returns:
- Result of the CreateVpcPeeringConnection operation returned by the service.
-
createVpcPeeringConnection
Description copied from interface:AmazonEC2
Simplified method form for invoking the CreateVpcPeeringConnection operation.- Specified by:
createVpcPeeringConnection
in interfaceAmazonEC2
- See Also:
-
createVpnConnection
Description copied from interface:AmazonEC2
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is
ipsec.1
.The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createVpnConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVpnConnection.- Returns:
- Result of the CreateVpnConnection operation returned by the service.
-
createVpnConnectionRoute
public CreateVpnConnectionRouteResult createVpnConnectionRoute(CreateVpnConnectionRouteRequest request) Description copied from interface:AmazonEC2
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createVpnConnectionRoute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVpnConnectionRoute.- Returns:
- Result of the CreateVpnConnectionRoute operation returned by the service.
-
createVpnGateway
Description copied from interface:AmazonEC2
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
createVpnGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for CreateVpnGateway.- Returns:
- Result of the CreateVpnGateway operation returned by the service.
-
deleteCustomerGateway
Description copied from interface:AmazonEC2
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
- Specified by:
deleteCustomerGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteCustomerGateway.- Returns:
- Result of the DeleteCustomerGateway operation returned by the service.
-
deleteDhcpOptions
Description copied from interface:AmazonEC2
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
- Specified by:
deleteDhcpOptions
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteDhcpOptions.- Returns:
- Result of the DeleteDhcpOptions operation returned by the service.
-
deleteFlowLogs
Description copied from interface:AmazonEC2
Deletes one or more flow logs.
- Specified by:
deleteFlowLogs
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteFlowLogs.- Returns:
- Result of the DeleteFlowLogs operation returned by the service.
-
deleteInternetGateway
Description copied from interface:AmazonEC2
Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
- Specified by:
deleteInternetGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteInternetGateway.- Returns:
- Result of the DeleteInternetGateway operation returned by the service.
-
deleteKeyPair
Description copied from interface:AmazonEC2
Deletes the specified key pair, by removing the public key from Amazon EC2.
- Specified by:
deleteKeyPair
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteKeyPair.- Returns:
- Result of the DeleteKeyPair operation returned by the service.
-
deleteNatGateway
Description copied from interface:AmazonEC2
Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
- Specified by:
deleteNatGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteNatGateway.- Returns:
- Result of the DeleteNatGateway operation returned by the service.
-
deleteNetworkAcl
Description copied from interface:AmazonEC2
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
- Specified by:
deleteNetworkAcl
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteNetworkAcl.- Returns:
- Result of the DeleteNetworkAcl operation returned by the service.
-
deleteNetworkAclEntry
Description copied from interface:AmazonEC2
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
- Specified by:
deleteNetworkAclEntry
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteNetworkAclEntry.- Returns:
- Result of the DeleteNetworkAclEntry operation returned by the service.
-
deleteNetworkInterface
Description copied from interface:AmazonEC2
Deletes the specified network interface. You must detach the network interface before you can delete it.
- Specified by:
deleteNetworkInterface
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteNetworkInterface.- Returns:
- Result of the DeleteNetworkInterface operation returned by the service.
-
deletePlacementGroup
Description copied from interface:AmazonEC2
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
deletePlacementGroup
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeletePlacementGroup.- Returns:
- Result of the DeletePlacementGroup operation returned by the service.
-
deleteRoute
Description copied from interface:AmazonEC2
Deletes the specified route from the specified route table.
- Specified by:
deleteRoute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteRoute.- Returns:
- Result of the DeleteRoute operation returned by the service.
-
deleteRouteTable
Description copied from interface:AmazonEC2
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
- Specified by:
deleteRouteTable
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteRouteTable.- Returns:
- Result of the DeleteRouteTable operation returned by the service.
-
deleteSecurityGroup
Description copied from interface:AmazonEC2
Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with
InvalidGroup.InUse
in EC2-Classic orDependencyViolation
in EC2-VPC.- Specified by:
deleteSecurityGroup
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteSecurityGroup.- Returns:
- Result of the DeleteSecurityGroup operation returned by the service.
-
deleteSnapshot
Description copied from interface:AmazonEC2
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
deleteSnapshot
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteSnapshot.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
-
deleteSpotDatafeedSubscription
public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest request) Description copied from interface:AmazonEC2
Deletes the data feed for Spot instances.
- Specified by:
deleteSpotDatafeedSubscription
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteSpotDatafeedSubscription.- Returns:
- Result of the DeleteSpotDatafeedSubscription operation returned by the service.
-
deleteSpotDatafeedSubscription
Description copied from interface:AmazonEC2
Simplified method form for invoking the DeleteSpotDatafeedSubscription operation.- Specified by:
deleteSpotDatafeedSubscription
in interfaceAmazonEC2
- See Also:
-
deleteSubnet
Description copied from interface:AmazonEC2
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
- Specified by:
deleteSubnet
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteSubnet.- Returns:
- Result of the DeleteSubnet operation returned by the service.
-
deleteTags
Description copied from interface:AmazonEC2
Deletes the specified set of tags from the specified set of resources. This call is designed to follow a
DescribeTags
request.For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
deleteTags
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteTags.- Returns:
- Result of the DeleteTags operation returned by the service.
-
deleteVolume
Description copied from interface:AmazonEC2
Deletes the specified EBS volume. The volume must be in the
available
state (not attached to an instance).The volume may remain in the
deleting
state for several minutes.For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
deleteVolume
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVolume.- Returns:
- Result of the DeleteVolume operation returned by the service.
-
deleteVpc
Description copied from interface:AmazonEC2
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
-
deleteVpcEndpoints
Description copied from interface:AmazonEC2
Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.
- Specified by:
deleteVpcEndpoints
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVpcEndpoints.- Returns:
- Result of the DeleteVpcEndpoints operation returned by the service.
-
deleteVpcPeeringConnection
public DeleteVpcPeeringConnectionResult deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest request) Description copied from interface:AmazonEC2
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the
active
state. The owner of the requester VPC can delete a VPC peering connection in thepending-acceptance
state.- Specified by:
deleteVpcPeeringConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVpcPeeringConnection.- Returns:
- Result of the DeleteVpcPeeringConnection operation returned by the service.
-
deleteVpnConnection
Description copied from interface:AmazonEC2
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.
- Specified by:
deleteVpnConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVpnConnection.- Returns:
- Result of the DeleteVpnConnection operation returned by the service.
-
deleteVpnConnectionRoute
public DeleteVpnConnectionRouteResult deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest request) Description copied from interface:AmazonEC2
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
- Specified by:
deleteVpnConnectionRoute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVpnConnectionRoute.- Returns:
- Result of the DeleteVpnConnectionRoute operation returned by the service.
-
deleteVpnGateway
Description copied from interface:AmazonEC2
Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
- Specified by:
deleteVpnGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeleteVpnGateway.- Returns:
- Result of the DeleteVpnGateway operation returned by the service.
-
deregisterImage
Description copied from interface:AmazonEC2
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
This command does not delete the AMI.
- Specified by:
deregisterImage
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DeregisterImage.- Returns:
- Result of the DeregisterImage operation returned by the service.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request) Description copied from interface:AmazonEC2
Describes attributes of your AWS account. The following are the supported account attributes:
-
supported-platforms
: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. -
default-vpc
: The ID of the default VPC for your account, ornone
. -
max-instances
: The maximum number of On-Demand instances that you can run. -
vpc-max-security-groups-per-interface
: The maximum number of security groups that you can assign to a network interface. -
max-elastic-ips
: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. -
vpc-max-elastic-ips
: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
- Specified by:
describeAccountAttributes
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeAccountAttributes.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
-
describeAccountAttributes
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeAccountAttributes operation.- Specified by:
describeAccountAttributes
in interfaceAmazonEC2
- See Also:
-
describeAddresses
Description copied from interface:AmazonEC2
Describes one or more of your Elastic IP addresses.
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.
- Specified by:
describeAddresses
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeAddresses.- Returns:
- Result of the DescribeAddresses operation returned by the service.
-
describeAddresses
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeAddresses operation.- Specified by:
describeAddresses
in interfaceAmazonEC2
- See Also:
-
describeAvailabilityZones
public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest request) Description copied from interface:AmazonEC2
Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeAvailabilityZones
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeAvailabilityZones.- Returns:
- Result of the DescribeAvailabilityZones operation returned by the service.
-
describeAvailabilityZones
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeAvailabilityZones operation.- Specified by:
describeAvailabilityZones
in interfaceAmazonEC2
- See Also:
-
describeBundleTasks
Description copied from interface:AmazonEC2
Describes one or more of your bundling tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use
RegisterImage
with the Amazon S3 bucket name and image manifest name you provided to the bundle task.- Specified by:
describeBundleTasks
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeBundleTasks.- Returns:
- Result of the DescribeBundleTasks operation returned by the service.
-
describeBundleTasks
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeBundleTasks operation.- Specified by:
describeBundleTasks
in interfaceAmazonEC2
- See Also:
-
describeClassicLinkInstances
public DescribeClassicLinkInstancesResult describeClassicLinkInstances(DescribeClassicLinkInstancesRequest request) Description copied from interface:AmazonEC2
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.
- Specified by:
describeClassicLinkInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeClassicLinkInstances.- Returns:
- Result of the DescribeClassicLinkInstances operation returned by the service.
-
describeClassicLinkInstances
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeClassicLinkInstances operation.- Specified by:
describeClassicLinkInstances
in interfaceAmazonEC2
- See Also:
-
describeConversionTasks
public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest request) Description copied from interface:AmazonEC2
Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
- Specified by:
describeConversionTasks
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeConversionTasks.- Returns:
- Result of the DescribeConversionTasks operation returned by the service.
-
describeConversionTasks
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeConversionTasks operation.- Specified by:
describeConversionTasks
in interfaceAmazonEC2
- See Also:
-
describeCustomerGateways
public DescribeCustomerGatewaysResult describeCustomerGateways(DescribeCustomerGatewaysRequest request) Description copied from interface:AmazonEC2
Describes one or more of your VPN customer gateways.
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeCustomerGateways
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeCustomerGateways.- Returns:
- Result of the DescribeCustomerGateways operation returned by the service.
-
describeCustomerGateways
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeCustomerGateways operation.- Specified by:
describeCustomerGateways
in interfaceAmazonEC2
- See Also:
-
describeDhcpOptions
Description copied from interface:AmazonEC2
Describes one or more of your DHCP options sets.
For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeDhcpOptions
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeDhcpOptions.- Returns:
- Result of the DescribeDhcpOptions operation returned by the service.
-
describeDhcpOptions
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeDhcpOptions operation.- Specified by:
describeDhcpOptions
in interfaceAmazonEC2
- See Also:
-
describeExportTasks
Description copied from interface:AmazonEC2
Describes one or more of your export tasks.
- Specified by:
describeExportTasks
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeExportTasks.- Returns:
- Result of the DescribeExportTasks operation returned by the service.
-
describeExportTasks
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeExportTasks operation.- Specified by:
describeExportTasks
in interfaceAmazonEC2
- See Also:
-
describeFlowLogs
Description copied from interface:AmazonEC2
Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
- Specified by:
describeFlowLogs
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeFlowLogs.- Returns:
- Result of the DescribeFlowLogs operation returned by the service.
-
describeFlowLogs
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeFlowLogs operation.- Specified by:
describeFlowLogs
in interfaceAmazonEC2
- See Also:
-
describeHosts
Description copied from interface:AmazonEC2
Describes one or more of your Dedicated hosts.
The results describe only the Dedicated hosts in the region you're currently using. All listed instances consume capacity on your Dedicated host. Dedicated hosts that have recently been released will be listed with the state
released
.- Specified by:
describeHosts
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeHosts.- Returns:
- Result of the DescribeHosts operation returned by the service.
-
describeHosts
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeHosts operation.- Specified by:
describeHosts
in interfaceAmazonEC2
- See Also:
-
describeIdFormat
Description copied from interface:AmazonEC2
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. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs:
instance
|reservation
|snapshot
|volume
.These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant
Describe
command for the resource type.- Specified by:
describeIdFormat
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeIdFormat.- Returns:
- Result of the DescribeIdFormat operation returned by the service.
-
describeIdFormat
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeIdFormat operation.- Specified by:
describeIdFormat
in interfaceAmazonEC2
- See Also:
-
describeImageAttribute
Description copied from interface:AmazonEC2
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
- Specified by:
describeImageAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeImageAttribute.- Returns:
- Result of the DescribeImageAttribute operation returned by the service.
-
describeImages
Description copied from interface:AmazonEC2
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
Deregistered images are included in the returned results for an unspecified interval after deregistration.
- Specified by:
describeImages
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeImages.- Returns:
- Result of the DescribeImages operation returned by the service.
-
describeImages
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeImages operation.- Specified by:
describeImages
in interfaceAmazonEC2
- See Also:
-
describeImportImageTasks
public DescribeImportImageTasksResult describeImportImageTasks(DescribeImportImageTasksRequest request) Description copied from interface:AmazonEC2
Displays details about an import virtual machine or import snapshot tasks that are already created.
- Specified by:
describeImportImageTasks
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeImportImageTasks.- Returns:
- Result of the DescribeImportImageTasks operation returned by the service.
-
describeImportImageTasks
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeImportImageTasks operation.- Specified by:
describeImportImageTasks
in interfaceAmazonEC2
- See Also:
-
describeImportSnapshotTasks
public DescribeImportSnapshotTasksResult describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest request) Description copied from interface:AmazonEC2
Describes your import snapshot tasks.
- Specified by:
describeImportSnapshotTasks
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeImportSnapshotTasks.- Returns:
- Result of the DescribeImportSnapshotTasks operation returned by the service.
-
describeImportSnapshotTasks
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeImportSnapshotTasks operation.- Specified by:
describeImportSnapshotTasks
in interfaceAmazonEC2
- See Also:
-
describeInstanceAttribute
public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request) Description copied from interface:AmazonEC2
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are:
instanceType
|kernel
|ramdisk
|userData
|disableApiTermination
|instanceInitiatedShutdownBehavior
|rootDeviceName
|blockDeviceMapping
|productCodes
|sourceDestCheck
|groupSet
|ebsOptimized
|sriovNetSupport
- Specified by:
describeInstanceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeInstanceAttribute.- Returns:
- Result of the DescribeInstanceAttribute operation returned by the service.
-
describeInstanceStatus
Description copied from interface:AmazonEC2
Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.
Instance status includes the following components:
-
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.
-
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.
-
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeInstanceStatus
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeInstanceStatus.- Returns:
- Result of the DescribeInstanceStatus operation returned by the service.
-
-
describeInstanceStatus
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeInstanceStatus operation.- Specified by:
describeInstanceStatus
in interfaceAmazonEC2
- See Also:
-
describeInstances
Description copied from interface:AmazonEC2
Describes one or more of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
- Specified by:
describeInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeInstances.- Returns:
- Result of the DescribeInstances operation returned by the service.
-
describeInstances
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeInstances operation.- Specified by:
describeInstances
in interfaceAmazonEC2
- See Also:
-
describeInternetGateways
public DescribeInternetGatewaysResult describeInternetGateways(DescribeInternetGatewaysRequest request) Description copied from interface:AmazonEC2
Describes one or more of your Internet gateways.
- Specified by:
describeInternetGateways
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeInternetGateways.- Returns:
- Result of the DescribeInternetGateways operation returned by the service.
-
describeInternetGateways
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeInternetGateways operation.- Specified by:
describeInternetGateways
in interfaceAmazonEC2
- See Also:
-
describeKeyPairs
Description copied from interface:AmazonEC2
Describes one or more of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeKeyPairs
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeKeyPairs.- Returns:
- Result of the DescribeKeyPairs operation returned by the service.
-
describeKeyPairs
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeKeyPairs operation.- Specified by:
describeKeyPairs
in interfaceAmazonEC2
- See Also:
-
describeMovingAddresses
public DescribeMovingAddressesResult describeMovingAddresses(DescribeMovingAddressesRequest request) Description copied from interface:AmazonEC2
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
- Specified by:
describeMovingAddresses
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeMovingAddresses.- Returns:
- Result of the DescribeMovingAddresses operation returned by the service.
-
describeMovingAddresses
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeMovingAddresses operation.- Specified by:
describeMovingAddresses
in interfaceAmazonEC2
- See Also:
-
describeNatGateways
Description copied from interface:AmazonEC2
Describes one or more of the your NAT gateways.
- Specified by:
describeNatGateways
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeNatGateways.- Returns:
- Result of the DescribeNatGateways operation returned by the service.
-
describeNetworkAcls
Description copied from interface:AmazonEC2
Describes one or more of your network ACLs.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeNetworkAcls
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeNetworkAcls.- Returns:
- Result of the DescribeNetworkAcls operation returned by the service.
-
describeNetworkAcls
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeNetworkAcls operation.- Specified by:
describeNetworkAcls
in interfaceAmazonEC2
- See Also:
-
describeNetworkInterfaceAttribute
public DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest request) Description copied from interface:AmazonEC2
Describes a network interface attribute. You can specify only one attribute at a time.
- Specified by:
describeNetworkInterfaceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeNetworkInterfaceAttribute.- Returns:
- Result of the DescribeNetworkInterfaceAttribute operation returned by the service.
-
describeNetworkInterfaces
public DescribeNetworkInterfacesResult describeNetworkInterfaces(DescribeNetworkInterfacesRequest request) Description copied from interface:AmazonEC2
Describes one or more of your network interfaces.
- Specified by:
describeNetworkInterfaces
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeNetworkInterfaces.- Returns:
- Result of the DescribeNetworkInterfaces operation returned by the service.
-
describeNetworkInterfaces
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeNetworkInterfaces operation.- Specified by:
describeNetworkInterfaces
in interfaceAmazonEC2
- See Also:
-
describePlacementGroups
public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest request) Description copied from interface:AmazonEC2
Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describePlacementGroups
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribePlacementGroups.- Returns:
- Result of the DescribePlacementGroups operation returned by the service.
-
describePlacementGroups
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribePlacementGroups operation.- Specified by:
describePlacementGroups
in interfaceAmazonEC2
- See Also:
-
describePrefixLists
Description copied from interface:AmazonEC2
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. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.
- Specified by:
describePrefixLists
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribePrefixLists.- Returns:
- Result of the DescribePrefixLists operation returned by the service.
-
describePrefixLists
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribePrefixLists operation.- Specified by:
describePrefixLists
in interfaceAmazonEC2
- See Also:
-
describeRegions
Description copied from interface:AmazonEC2
Describes one or more regions that are currently available to you.
For a list of the regions supported by Amazon EC2, see Regions and Endpoints.
- Specified by:
describeRegions
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeRegions.- Returns:
- Result of the DescribeRegions operation returned by the service.
-
describeRegions
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeRegions operation.- Specified by:
describeRegions
in interfaceAmazonEC2
- See Also:
-
describeReservedInstances
public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request) Description copied from interface:AmazonEC2
Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeReservedInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeReservedInstances.- Returns:
- Result of the DescribeReservedInstances operation returned by the service.
-
describeReservedInstances
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeReservedInstances operation.- Specified by:
describeReservedInstances
in interfaceAmazonEC2
- See Also:
-
describeReservedInstancesListings
public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest request) Description copied from interface:AmazonEC2
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeReservedInstancesListings
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeReservedInstancesListings.- Returns:
- Result of the DescribeReservedInstancesListings operation returned by the service.
-
describeReservedInstancesListings
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeReservedInstancesListings operation.- Specified by:
describeReservedInstancesListings
in interfaceAmazonEC2
- See Also:
-
describeReservedInstancesModifications
public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest request) Description copied from interface:AmazonEC2
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeReservedInstancesModifications
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeReservedInstancesModifications.- Returns:
- Result of the DescribeReservedInstancesModifications operation returned by the service.
-
describeReservedInstancesModifications
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeReservedInstancesModifications operation.- Specified by:
describeReservedInstancesModifications
in interfaceAmazonEC2
- See Also:
-
describeReservedInstancesOfferings
public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest request) Description copied from interface:AmazonEC2
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeReservedInstancesOfferings
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeReservedInstancesOfferings.- Returns:
- Result of the DescribeReservedInstancesOfferings operation returned by the service.
-
describeReservedInstancesOfferings
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeReservedInstancesOfferings operation.- Specified by:
describeReservedInstancesOfferings
in interfaceAmazonEC2
- See Also:
-
describeRouteTables
Description copied from interface:AmazonEC2
Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeRouteTables
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeRouteTables.- Returns:
- Result of the DescribeRouteTables operation returned by the service.
-
describeRouteTables
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeRouteTables operation.- Specified by:
describeRouteTables
in interfaceAmazonEC2
- See Also:
-
describeScheduledInstanceAvailability
public DescribeScheduledInstanceAvailabilityResult describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest request) Description copied from interface:AmazonEC2
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
- Specified by:
describeScheduledInstanceAvailability
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeScheduledInstanceAvailability.- Returns:
- Result of the DescribeScheduledInstanceAvailability operation returned by the service.
-
describeScheduledInstances
public DescribeScheduledInstancesResult describeScheduledInstances(DescribeScheduledInstancesRequest request) Description copied from interface:AmazonEC2
Describes one or more of your Scheduled Instances.
- Specified by:
describeScheduledInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeScheduledInstances.- Returns:
- Result of the DescribeScheduledInstances operation returned by the service.
-
describeSecurityGroupReferences
public DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest request) Description copied from interface:AmazonEC2
[EC2-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.
- Specified by:
describeSecurityGroupReferences
in interfaceAmazonEC2
- Returns:
- Result of the DescribeSecurityGroupReferences operation returned by the service.
-
describeSecurityGroups
Description copied from interface:AmazonEC2
Describes one or more of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeSecurityGroups
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSecurityGroups.- Returns:
- Result of the DescribeSecurityGroups operation returned by the service.
-
describeSecurityGroups
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSecurityGroups operation.- Specified by:
describeSecurityGroups
in interfaceAmazonEC2
- See Also:
-
describeSnapshotAttribute
public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest request) Description copied from interface:AmazonEC2
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeSnapshotAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSnapshotAttribute.- Returns:
- Result of the DescribeSnapshotAttribute operation returned by the service.
-
describeSnapshots
Description copied from interface:AmazonEC2
Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
The create volume permissions fall into the following categories:
-
public: The owner of the snapshot granted create volume permissions for the snapshot to the
all
group. All AWS accounts have create volume permissions for these snapshots. -
explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
-
implicit: An AWS account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners,
amazon
for snapshots owned by Amazon, orself
for snapshots that you own.If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots),
self
for snapshots for which you own or have explicit permissions, orall
for public snapshots.If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The
MaxResults
parameter sets the maximum number of results returned in a single page. If the list of results exceeds yourMaxResults
value, then that number of results is returned along with aNextToken
value that can be passed to a subsequentDescribeSnapshots
request to retrieve the remaining results.For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeSnapshots
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSnapshots.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
-
-
describeSnapshots
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSnapshots operation.- Specified by:
describeSnapshots
in interfaceAmazonEC2
- See Also:
-
describeSpotDatafeedSubscription
public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest request) Description copied from interface:AmazonEC2
Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeSpotDatafeedSubscription
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotDatafeedSubscription.- Returns:
- Result of the DescribeSpotDatafeedSubscription operation returned by the service.
-
describeSpotDatafeedSubscription
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSpotDatafeedSubscription operation.- Specified by:
describeSpotDatafeedSubscription
in interfaceAmazonEC2
- See Also:
-
describeSpotFleetInstances
public DescribeSpotFleetInstancesResult describeSpotFleetInstances(DescribeSpotFleetInstancesRequest request) Description copied from interface:AmazonEC2
Describes the running instances for the specified Spot fleet.
- Specified by:
describeSpotFleetInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotFleetInstances.- Returns:
- Result of the DescribeSpotFleetInstances operation returned by the service.
-
describeSpotFleetRequestHistory
public DescribeSpotFleetRequestHistoryResult describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest request) Description copied from interface:AmazonEC2
Describes the events for the specified Spot fleet request during the specified time.
Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.
- Specified by:
describeSpotFleetRequestHistory
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotFleetRequestHistory.- Returns:
- Result of the DescribeSpotFleetRequestHistory operation returned by the service.
-
describeSpotFleetRequests
public DescribeSpotFleetRequestsResult describeSpotFleetRequests(DescribeSpotFleetRequestsRequest request) Description copied from interface:AmazonEC2
Describes your Spot fleet requests.
- Specified by:
describeSpotFleetRequests
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotFleetRequests.- Returns:
- Result of the DescribeSpotFleetRequests operation returned by the service.
-
describeSpotFleetRequests
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSpotFleetRequests operation.- Specified by:
describeSpotFleetRequests
in interfaceAmazonEC2
- See Also:
-
describeSpotInstanceRequests
public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest request) Description copied from interface:AmazonEC2
Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.
You can use
DescribeSpotInstanceRequests
to find a running Spot instance by examining the response. If the status of the Spot instance isfulfilled
, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle isspot
.- Specified by:
describeSpotInstanceRequests
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotInstanceRequests.- Returns:
- Result of the DescribeSpotInstanceRequests operation returned by the service.
-
describeSpotInstanceRequests
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSpotInstanceRequests operation.- Specified by:
describeSpotInstanceRequests
in interfaceAmazonEC2
- See Also:
-
describeSpotPriceHistory
public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest request) Description copied from interface:AmazonEC2
Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.
When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
- Specified by:
describeSpotPriceHistory
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSpotPriceHistory.- Returns:
- Result of the DescribeSpotPriceHistory operation returned by the service.
-
describeSpotPriceHistory
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSpotPriceHistory operation.- Specified by:
describeSpotPriceHistory
in interfaceAmazonEC2
- See Also:
-
describeStaleSecurityGroups
public DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest request) Description copied from interface:AmazonEC2
[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.
- Specified by:
describeStaleSecurityGroups
in interfaceAmazonEC2
- Returns:
- Result of the DescribeStaleSecurityGroups operation returned by the service.
-
describeSubnets
Description copied from interface:AmazonEC2
Describes one or more of your subnets.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeSubnets
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeSubnets.- Returns:
- Result of the DescribeSubnets operation returned by the service.
-
describeSubnets
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeSubnets operation.- Specified by:
describeSubnets
in interfaceAmazonEC2
- See Also:
-
describeTags
Description copied from interface:AmazonEC2
Describes one or more of the tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeTags
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeTags.- Returns:
- Result of the DescribeTags operation returned by the service.
-
describeTags
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeTags operation.- Specified by:
describeTags
in interfaceAmazonEC2
- See Also:
-
describeVolumeAttribute
public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest request) Description copied from interface:AmazonEC2
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeVolumeAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVolumeAttribute.- Returns:
- Result of the DescribeVolumeAttribute operation returned by the service.
-
describeVolumeStatus
Description copied from interface:AmazonEC2
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The
DescribeVolumeStatus
operation provides the following information about the specified volumes:Status: Reflects the current status of the volume. The possible values are
ok
,impaired
,warning
, orinsufficient-data
. If all checks pass, the overall status of the volume isok
. If the check fails, the overall status isimpaired
. If the status isinsufficient-data
, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an
impaired
status, then the volume event might bepotential-data-inconsistency
. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is
impaired
and the volume event showspotential-data-inconsistency
, then the action showsenable-volume-io
. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the
error
state (for example, when a volume is incapable of accepting I/O.)- Specified by:
describeVolumeStatus
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVolumeStatus.- Returns:
- Result of the DescribeVolumeStatus operation returned by the service.
-
describeVolumeStatus
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVolumeStatus operation.- Specified by:
describeVolumeStatus
in interfaceAmazonEC2
- See Also:
-
describeVolumes
Description copied from interface:AmazonEC2
Describes the specified EBS volumes.
If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The
MaxResults
parameter sets the maximum number of results returned in a single page. If the list of results exceeds yourMaxResults
value, then that number of results is returned along with aNextToken
value that can be passed to a subsequentDescribeVolumes
request to retrieve the remaining results.For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeVolumes
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVolumes.- Returns:
- Result of the DescribeVolumes operation returned by the service.
-
describeVolumes
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVolumes operation.- Specified by:
describeVolumes
in interfaceAmazonEC2
- See Also:
-
describeVpcAttribute
Description copied from interface:AmazonEC2
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
- Specified by:
describeVpcAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcAttribute.- Returns:
- Result of the DescribeVpcAttribute operation returned by the service.
-
describeVpcClassicLink
Description copied from interface:AmazonEC2
Describes the ClassicLink status of one or more VPCs.
- Specified by:
describeVpcClassicLink
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcClassicLink.- Returns:
- Result of the DescribeVpcClassicLink operation returned by the service.
-
describeVpcClassicLink
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpcClassicLink operation.- Specified by:
describeVpcClassicLink
in interfaceAmazonEC2
- See Also:
-
describeVpcClassicLinkDnsSupport
public DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest request) Description copied from interface:AmazonEC2
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
describeVpcClassicLinkDnsSupport
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcClassicLinkDnsSupport.- Returns:
- Result of the DescribeVpcClassicLinkDnsSupport operation returned by the service.
-
describeVpcEndpointServices
public DescribeVpcEndpointServicesResult describeVpcEndpointServices(DescribeVpcEndpointServicesRequest request) Description copied from interface:AmazonEC2
Describes all supported AWS services that can be specified when creating a VPC endpoint.
- Specified by:
describeVpcEndpointServices
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcEndpointServices.- Returns:
- Result of the DescribeVpcEndpointServices operation returned by the service.
-
describeVpcEndpointServices
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpcEndpointServices operation.- Specified by:
describeVpcEndpointServices
in interfaceAmazonEC2
- See Also:
-
describeVpcEndpoints
Description copied from interface:AmazonEC2
Describes one or more of your VPC endpoints.
- Specified by:
describeVpcEndpoints
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcEndpoints.- Returns:
- Result of the DescribeVpcEndpoints operation returned by the service.
-
describeVpcEndpoints
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpcEndpoints operation.- Specified by:
describeVpcEndpoints
in interfaceAmazonEC2
- See Also:
-
describeVpcPeeringConnections
public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest request) Description copied from interface:AmazonEC2
Describes one or more of your VPC peering connections.
- Specified by:
describeVpcPeeringConnections
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcPeeringConnections.- Returns:
- Result of the DescribeVpcPeeringConnections operation returned by the service.
-
describeVpcPeeringConnections
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpcPeeringConnections operation.- Specified by:
describeVpcPeeringConnections
in interfaceAmazonEC2
- See Also:
-
describeVpcs
Description copied from interface:AmazonEC2
Describes one or more of your VPCs.
- Specified by:
describeVpcs
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpcs.- Returns:
- Result of the DescribeVpcs operation returned by the service.
-
describeVpcs
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpcs operation.- Specified by:
describeVpcs
in interfaceAmazonEC2
- See Also:
-
describeVpnConnections
Description copied from interface:AmazonEC2
Describes one or more of your VPN connections.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeVpnConnections
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpnConnections.- Returns:
- Result of the DescribeVpnConnections operation returned by the service.
-
describeVpnConnections
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpnConnections operation.- Specified by:
describeVpnConnections
in interfaceAmazonEC2
- See Also:
-
describeVpnGateways
Description copied from interface:AmazonEC2
Describes one or more of your virtual private gateways.
For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.
- Specified by:
describeVpnGateways
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DescribeVpnGateways.- Returns:
- Result of the DescribeVpnGateways operation returned by the service.
-
describeVpnGateways
Description copied from interface:AmazonEC2
Simplified method form for invoking the DescribeVpnGateways operation.- Specified by:
describeVpnGateways
in interfaceAmazonEC2
- See Also:
-
detachClassicLinkVpc
Description copied from interface:AmazonEC2
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
- Specified by:
detachClassicLinkVpc
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DetachClassicLinkVpc.- Returns:
- Result of the DetachClassicLinkVpc operation returned by the service.
-
detachInternetGateway
Description copied from interface:AmazonEC2
Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.
- Specified by:
detachInternetGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DetachInternetGateway.- Returns:
- Result of the DetachInternetGateway operation returned by the service.
-
detachNetworkInterface
Description copied from interface:AmazonEC2
Detaches a network interface from an instance.
- Specified by:
detachNetworkInterface
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DetachNetworkInterface.- Returns:
- Result of the DetachNetworkInterface operation returned by the service.
-
detachVolume
Description copied from interface:AmazonEC2
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.
If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
detachVolume
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DetachVolume.- Returns:
- Result of the DetachVolume operation returned by the service.
-
detachVpnGateway
Description copied from interface:AmazonEC2
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to
detached
before you can delete the VPC or attach a different VPC to the virtual private gateway.- Specified by:
detachVpnGateway
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DetachVpnGateway.- Returns:
- Result of the DetachVpnGateway operation returned by the service.
-
disableVgwRoutePropagation
public DisableVgwRoutePropagationResult disableVgwRoutePropagation(DisableVgwRoutePropagationRequest request) Description copied from interface:AmazonEC2
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
- Specified by:
disableVgwRoutePropagation
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DisableVgwRoutePropagation.- Returns:
- Result of the DisableVgwRoutePropagation operation returned by the service.
-
disableVpcClassicLink
Description copied from interface:AmazonEC2
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
- Specified by:
disableVpcClassicLink
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DisableVpcClassicLink.- Returns:
- Result of the DisableVpcClassicLink operation returned by the service.
-
disableVpcClassicLinkDnsSupport
public DisableVpcClassicLinkDnsSupportResult disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest request) Description copied from interface:AmazonEC2
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
disableVpcClassicLinkDnsSupport
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DisableVpcClassicLinkDnsSupport.- Returns:
- Result of the DisableVpcClassicLinkDnsSupport operation returned by the service.
-
disassociateAddress
Description copied from interface:AmazonEC2
Disassociates an Elastic IP address from the instance or network interface it's associated with.
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.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
- Specified by:
disassociateAddress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DisassociateAddress.- Returns:
- Result of the DisassociateAddress operation returned by the service.
-
disassociateRouteTable
Description copied from interface:AmazonEC2
Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
disassociateRouteTable
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for DisassociateRouteTable.- Returns:
- Result of the DisassociateRouteTable operation returned by the service.
-
enableVgwRoutePropagation
public EnableVgwRoutePropagationResult enableVgwRoutePropagation(EnableVgwRoutePropagationRequest request) Description copied from interface:AmazonEC2
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
- Specified by:
enableVgwRoutePropagation
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for EnableVgwRoutePropagation.- Returns:
- Result of the EnableVgwRoutePropagation operation returned by the service.
-
enableVolumeIO
Description copied from interface:AmazonEC2
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
- Specified by:
enableVolumeIO
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for EnableVolumeIO.- Returns:
- Result of the EnableVolumeIO operation returned by the service.
-
enableVpcClassicLink
Description copied from interface:AmazonEC2
Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the
10.0.0.0/8
IP address range, excluding local routes for VPCs in the10.0.0.0/16
and10.1.0.0/16
IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.- Specified by:
enableVpcClassicLink
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for EnableVpcClassicLink.- Returns:
- Result of the EnableVpcClassicLink operation returned by the service.
-
enableVpcClassicLinkDnsSupport
public EnableVpcClassicLinkDnsSupportResult enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest request) Description copied from interface:AmazonEC2
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
enableVpcClassicLinkDnsSupport
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for EnableVpcClassicLinkDnsSupport.- Returns:
- Result of the EnableVpcClassicLinkDnsSupport operation returned by the service.
-
getConsoleOutput
Description copied from interface:AmazonEC2
Gets the console output for the specified instance.
Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.
Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.
For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.
For Windows instances, the instance console output includes output from the EC2Config service.
- Specified by:
getConsoleOutput
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for GetConsoleOutput.- Returns:
- Result of the GetConsoleOutput operation returned by the service.
-
getPasswordData
Description copied from interface:AmazonEC2
Retrieves the encrypted administrator password for an instance running Windows.
The Windows password is generated at boot if the
EC2Config
service plugin,Ec2SetPassword
, is enabled. This usually only happens the first time an AMI is launched, and thenEc2SetPassword
is automatically disabled. The password is not generated for rebundled AMIs unlessEc2SetPassword
is enabled before bundling.The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
- Specified by:
getPasswordData
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for GetPasswordData.- Returns:
- Result of the GetPasswordData operation returned by the service.
-
importImage
Description copied from interface:AmazonEC2
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
- Specified by:
importImage
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ImportImage.- Returns:
- Result of the ImportImage operation returned by the service.
-
importImage
Description copied from interface:AmazonEC2
Simplified method form for invoking the ImportImage operation.- Specified by:
importImage
in interfaceAmazonEC2
- See Also:
-
importInstance
Description copied from interface:AmazonEC2
Creates an import instance task using metadata from the specified disk image.
ImportInstance
only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using theec2-import-volume
command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.For information about the import manifest referenced by this API action, see VM Import Manifest.
- Specified by:
importInstance
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ImportInstance.- Returns:
- Result of the ImportInstance operation returned by the service.
-
importKeyPair
Description copied from interface:AmazonEC2
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
importKeyPair
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ImportKeyPair.- Returns:
- Result of the ImportKeyPair operation returned by the service.
-
importSnapshot
Description copied from interface:AmazonEC2
Imports a disk into an EBS snapshot.
- Specified by:
importSnapshot
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ImportSnapshot.- Returns:
- Result of the ImportSnapshot operation returned by the service.
-
importSnapshot
Description copied from interface:AmazonEC2
Simplified method form for invoking the ImportSnapshot operation.- Specified by:
importSnapshot
in interfaceAmazonEC2
- See Also:
-
importVolume
Description copied from interface:AmazonEC2
Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the
ec2-import-volume
command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.For information about the import manifest referenced by this API action, see VM Import Manifest.
- Specified by:
importVolume
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ImportVolume.- Returns:
- Result of the ImportVolume operation returned by the service.
-
modifyHosts
Description copied from interface:AmazonEC2
Modify the auto-placement setting of a Dedicated host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of
host
, but without targeting a specific host ID, onto any available Dedicated host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.- Specified by:
modifyHosts
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyHosts.- Returns:
- Result of the ModifyHosts operation returned by the service.
-
modifyIdFormat
Description copied from interface:AmazonEC2
Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs:
instance
|reservation
|snapshot
|volume
.This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user or as an IAM role that has permission to use this action, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Controlling Access to Longer ID Settings in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant
Describe
command for the resource type.- Specified by:
modifyIdFormat
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters of ModifyIdFormat.- Returns:
- Result of the ModifyIdFormat operation returned by the service.
-
modifyImageAttribute
Description copied from interface:AmazonEC2
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
- Specified by:
modifyImageAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyImageAttribute.- Returns:
- Result of the ModifyImageAttribute operation returned by the service.
-
modifyInstanceAttribute
public ModifyInstanceAttributeResult modifyInstanceAttribute(ModifyInstanceAttributeRequest request) Description copied from interface:AmazonEC2
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
modifyInstanceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyInstanceAttribute.- Returns:
- Result of the ModifyInstanceAttribute operation returned by the service.
-
modifyInstancePlacement
public ModifyInstancePlacementResult modifyInstancePlacement(ModifyInstancePlacementRequest request) Description copied from interface:AmazonEC2
Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.
Instance affinity is disabled by default. When instance affinity is
host
and it is not associated with a specific Dedicated host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.
You can modify the tenancy of a stopped instance with a tenancy of
host
ordedicated
.Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.
- Specified by:
modifyInstancePlacement
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyInstancePlacement.- Returns:
- Result of the ModifyInstancePlacement operation returned by the service.
-
modifyNetworkInterfaceAttribute
public ModifyNetworkInterfaceAttributeResult modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest request) Description copied from interface:AmazonEC2
Modifies the specified network interface attribute. You can specify only one attribute at a time.
- Specified by:
modifyNetworkInterfaceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyNetworkInterfaceAttribute.- Returns:
- Result of the ModifyNetworkInterfaceAttribute operation returned by the service.
-
modifyReservedInstances
public ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest request) Description copied from interface:AmazonEC2
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
modifyReservedInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyReservedInstances.- Returns:
- Result of the ModifyReservedInstances operation returned by the service.
-
modifySnapshotAttribute
public ModifySnapshotAttributeResult modifySnapshotAttribute(ModifySnapshotAttributeRequest request) Description copied from interface:AmazonEC2
Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
Snapshots with AWS Marketplace product codes cannot be made public.
- Specified by:
modifySnapshotAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifySnapshotAttribute.- Returns:
- Result of the ModifySnapshotAttribute operation returned by the service.
-
modifySpotFleetRequest
Description copied from interface:AmazonEC2
Modifies the specified Spot fleet request.
While the Spot fleet request is being modified, it is in the
modifying
state.To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is
lowestPrice
, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy isdiversified
, the Spot fleet distributes the instances across the Spot pools.To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is
lowestPrice
, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy isdiversified
, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.- Specified by:
modifySpotFleetRequest
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifySpotFleetRequest.- Returns:
- Result of the ModifySpotFleetRequest operation returned by the service.
-
modifySubnetAttribute
Description copied from interface:AmazonEC2
Modifies a subnet attribute.
- Specified by:
modifySubnetAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifySubnetAttribute.- Returns:
- Result of the ModifySubnetAttribute operation returned by the service.
-
modifyVolumeAttribute
Description copied from interface:AmazonEC2
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
- Specified by:
modifyVolumeAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyVolumeAttribute.- Returns:
- Result of the ModifyVolumeAttribute operation returned by the service.
-
modifyVpcAttribute
Description copied from interface:AmazonEC2
Modifies the specified attribute of the specified VPC.
- Specified by:
modifyVpcAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyVpcAttribute.- Returns:
- Result of the ModifyVpcAttribute operation returned by the service.
-
modifyVpcEndpoint
Description copied from interface:AmazonEC2
Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.
- Specified by:
modifyVpcEndpoint
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ModifyVpcEndpoint.- Returns:
- Result of the ModifyVpcEndpoint operation returned by the service.
-
modifyVpcPeeringConnectionOptions
public ModifyVpcPeeringConnectionOptionsResult modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest request) Description copied from interface:AmazonEC2
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
-
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
-
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
If the peered VPCs are in different accounts, each owner must initiate a separate request to enable or disable communication in either direction, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
- Specified by:
modifyVpcPeeringConnectionOptions
in interfaceAmazonEC2
- Returns:
- Result of the ModifyVpcPeeringConnectionOptions operation returned by the service.
-
-
monitorInstances
Description copied from interface:AmazonEC2
Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
monitorInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for MonitorInstances.- Returns:
- Result of the MonitorInstances operation returned by the service.
-
moveAddressToVpc
Description copied from interface:AmazonEC2
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. You cannot migrate an Elastic IP address that's associated with a reverse DNS record. Contact AWS account and billing support to remove the reverse DNS record.
- Specified by:
moveAddressToVpc
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for MoveAddressToVpc.- Returns:
- Result of the MoveAddressToVpc operation returned by the service.
-
purchaseReservedInstancesOffering
public PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest request) Description copied from interface:AmazonEC2
Purchases a Reserved Instance for use with your account. With Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
purchaseReservedInstancesOffering
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for PurchaseReservedInstancesOffering.- Returns:
- Result of the PurchaseReservedInstancesOffering operation returned by the service.
-
purchaseScheduledInstances
public PurchaseScheduledInstancesResult purchaseScheduledInstances(PurchaseScheduledInstancesRequest request) Description copied from interface:AmazonEC2
Purchases one or more Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
- Specified by:
purchaseScheduledInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for PurchaseScheduledInstances.- Returns:
- Result of the PurchaseScheduledInstances operation returned by the service.
-
rebootInstances
Description copied from interface:AmazonEC2
Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
rebootInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RebootInstances.- Returns:
- Result of the RebootInstances operation returned by the service.
-
registerImage
Description copied from interface:AmazonEC2
Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use
RegisterImage
to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2
billingProduct
code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.
To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
- Specified by:
registerImage
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RegisterImage.- Returns:
- Result of the RegisterImage operation returned by the service.
-
rejectVpcPeeringConnection
public RejectVpcPeeringConnectionResult rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest request) Description copied from interface:AmazonEC2
Rejects a VPC peering connection request. The VPC peering connection must be in the
pending-acceptance
state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.- Specified by:
rejectVpcPeeringConnection
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RejectVpcPeeringConnection.- Returns:
- Result of the RejectVpcPeeringConnection operation returned by the service.
-
releaseAddress
Description copied from interface:AmazonEC2
Releases the specified Elastic IP address.
After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an
AuthFailure
error if the address is already allocated to another AWS account.[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (
InvalidIPAddress.InUse
).- Specified by:
releaseAddress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReleaseAddress.- Returns:
- Result of the ReleaseAddress operation returned by the service.
-
releaseHosts
Description copied from interface:AmazonEC2
When you no longer want to use a Dedicated host it can be released. On-Demand billing is stopped and the host goes into
released
state. The host ID of Dedicated hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.When Dedicated hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.
Released hosts will still appear in a DescribeHosts response.
- Specified by:
releaseHosts
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReleaseHosts.- Returns:
- Result of the ReleaseHosts operation returned by the service.
-
replaceNetworkAclAssociation
public ReplaceNetworkAclAssociationResult replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest request) Description copied from interface:AmazonEC2
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
- Specified by:
replaceNetworkAclAssociation
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReplaceNetworkAclAssociation.- Returns:
- Result of the ReplaceNetworkAclAssociation operation returned by the service.
-
replaceNetworkAclEntry
Description copied from interface:AmazonEC2
Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
- Specified by:
replaceNetworkAclEntry
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReplaceNetworkAclEntry.- Returns:
- Result of the ReplaceNetworkAclEntry operation returned by the service.
-
replaceRoute
Description copied from interface:AmazonEC2
Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
- Specified by:
replaceRoute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReplaceRoute.- Returns:
- Result of the ReplaceRoute operation returned by the service.
-
replaceRouteTableAssociation
public ReplaceRouteTableAssociationResult replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest request) Description copied from interface:AmazonEC2
Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
- Specified by:
replaceRouteTableAssociation
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReplaceRouteTableAssociation.- Returns:
- Result of the ReplaceRouteTableAssociation operation returned by the service.
-
reportInstanceStatus
Description copied from interface:AmazonEC2
Submits feedback about the status of an instance. The instance must be in the
running
state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.Use of this action does not change the value returned by DescribeInstanceStatus.
- Specified by:
reportInstanceStatus
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ReportInstanceStatus.- Returns:
- Result of the ReportInstanceStatus operation returned by the service.
-
requestSpotFleet
Description copied from interface:AmazonEC2
Creates a Spot fleet request.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.
For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
requestSpotFleet
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RequestSpotFleet.- Returns:
- Result of the RequestSpotFleet operation returned by the service.
-
requestSpotInstances
Description copied from interface:AmazonEC2
Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
requestSpotInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RequestSpotInstances.- Returns:
- Result of the RequestSpotInstances operation returned by the service.
-
resetImageAttribute
Description copied from interface:AmazonEC2
Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
- Specified by:
resetImageAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ResetImageAttribute.- Returns:
- Result of the ResetImageAttribute operation returned by the service.
-
resetInstanceAttribute
Description copied from interface:AmazonEC2
Resets an attribute of an instance to its default value. To reset the
kernel
orramdisk
, the instance must be in a stopped state. To reset thesourceDestCheck
, the instance can be either running or stopped.The
sourceDestCheck
attribute controls whether source/destination checking is enabled. The default value istrue
, which means checking is enabled. This value must befalse
for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.- Specified by:
resetInstanceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ResetInstanceAttribute.- Returns:
- Result of the ResetInstanceAttribute operation returned by the service.
-
resetNetworkInterfaceAttribute
public ResetNetworkInterfaceAttributeResult resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest request) Description copied from interface:AmazonEC2
Resets a network interface attribute. You can specify only one attribute at a time.
- Specified by:
resetNetworkInterfaceAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ResetNetworkInterfaceAttribute.- Returns:
- Result of the ResetNetworkInterfaceAttribute operation returned by the service.
-
resetSnapshotAttribute
Description copied from interface:AmazonEC2
Resets permission settings for the specified snapshot.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
resetSnapshotAttribute
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for ResetSnapshotAttribute.- Returns:
- Result of the ResetSnapshotAttribute operation returned by the service.
-
restoreAddressToClassic
public RestoreAddressToClassicResult restoreAddressToClassic(RestoreAddressToClassicRequest request) Description copied from interface:AmazonEC2
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. You cannot restore an Elastic IP address that's associated with a reverse DNS record. Contact AWS account and billing support to remove the reverse DNS record.
- Specified by:
restoreAddressToClassic
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RestoreAddressToClassic.- Returns:
- Result of the RestoreAddressToClassic operation returned by the service.
-
revokeSecurityGroupEgress
public RevokeSecurityGroupEgressResult revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest request) Description copied from interface:AmazonEC2
[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
- Specified by:
revokeSecurityGroupEgress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RevokeSecurityGroupEgress.- Returns:
- Result of the RevokeSecurityGroupEgress operation returned by the service.
-
revokeSecurityGroupIngress
public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest request) Description copied from interface:AmazonEC2
Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
- Specified by:
revokeSecurityGroupIngress
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RevokeSecurityGroupIngress.- Returns:
- Result of the RevokeSecurityGroupIngress operation returned by the service.
-
revokeSecurityGroupIngress
Description copied from interface:AmazonEC2
Simplified method form for invoking the RevokeSecurityGroupIngress operation.- Specified by:
revokeSecurityGroupIngress
in interfaceAmazonEC2
- See Also:
-
runInstances
Description copied from interface:AmazonEC2
Launches the specified number of instances using an AMI for which you have permissions.
When you launch an instance, it enters the
pending
state. After the instance is ready for you, it enters therunning
state. To check the state of your instance, call DescribeInstances.To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.
[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.
If any of the AMIs have a product code attached for which the user has not subscribed,
RunInstances
fails.Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request,
RunInstances
fails. For more information, see Instance Types Available Only in a VPC.For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
runInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RunInstances.- Returns:
- Result of the RunInstances operation returned by the service.
-
runScheduledInstances
Description copied from interface:AmazonEC2
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
runScheduledInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for RunScheduledInstances.- Returns:
- Result of the RunScheduledInstances operation returned by the service.
-
startInstances
Description copied from interface:AmazonEC2
Starts an Amazon EBS-backed AMI that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
startInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for StartInstances.- Returns:
- Result of the StartInstances operation returned by the service.
-
stopInstances
Description copied from interface:AmazonEC2
Stops an Amazon EBS-backed instance.
We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
You can't start or stop Spot instances, and you can't stop instance store-backed instances.
When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
stopInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for StopInstances.- Returns:
- Result of the StopInstances operation returned by the service.
-
terminateInstances
Description copied from interface:AmazonEC2
Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the
DeleteOnTermination
block device mapping parameter set totrue
are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
terminateInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for TerminateInstances.- Returns:
- Result of the TerminateInstances operation returned by the service.
-
unassignPrivateIpAddresses
public UnassignPrivateIpAddressesResult unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest request) Description copied from interface:AmazonEC2
Unassigns one or more secondary private IP addresses from a network interface.
- Specified by:
unassignPrivateIpAddresses
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for UnassignPrivateIpAddresses.- Returns:
- Result of the UnassignPrivateIpAddresses operation returned by the service.
-
unmonitorInstances
Description copied from interface:AmazonEC2
Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
- Specified by:
unmonitorInstances
in interfaceAmazonEC2
- Parameters:
request
- Contains the parameters for UnmonitorInstances.- Returns:
- Result of the UnmonitorInstances operation returned by the service.
-
dryRun
public <X extends AmazonWebServiceRequest> DryRunResult<X> dryRun(DryRunSupportedRequest<X> request) throws AmazonServiceException, AmazonClientException Description copied from interface:AmazonEC2
Checks whether you have the required permissions for the provided Amazon EC2 operation, without actually running it. The returned DryRunResult object contains the information of whether the dry-run was successful. This method will throw exception when the service response does not clearly indicate whether you have the permission.- Specified by:
dryRun
in interfaceAmazonEC2
- Parameters:
request
- The request object for any Amazon EC2 operation supported with dry-run.- Returns:
- A DryRunResult object that contains the information of whether the dry-run was successful.
- Throws:
AmazonServiceException
- If an error response is returned by Amazon EC2 indicating either a problem with the data in the request, or a server side issue.AmazonClientException
- If any internal errors are encountered inside the client while attempting to make the request or handle the response. Or if the service response does not clearly indicate whether you have the permission.
-
shutdown
public void shutdown()Description copied from interface:AmazonEC2
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests. -
getCachedResponseMetadata
Description copied from interface:AmazonEC2
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonEC2
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-