public interface AmazonEC2
Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.
Modifier and Type | Method and Description |
---|---|
AcceptVpcPeeringConnectionResult |
acceptVpcPeeringConnection()
Accept a VPC peering connection request.
|
AcceptVpcPeeringConnectionResult |
acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest acceptVpcPeeringConnectionRequest)
Accept a VPC peering connection request.
|
AllocateAddressResult |
allocateAddress()
Acquires an Elastic IP address.
|
AllocateAddressResult |
allocateAddress(AllocateAddressRequest allocateAddressRequest)
Acquires an Elastic IP address.
|
AllocateHostsResult |
allocateHosts(AllocateHostsRequest allocateHostsRequest)
Allocates a Dedicated host to your account.
|
void |
assignPrivateIpAddresses(AssignPrivateIpAddressesRequest assignPrivateIpAddressesRequest)
Assigns one or more secondary private IP addresses to the specified
network interface.
|
AssociateAddressResult |
associateAddress(AssociateAddressRequest associateAddressRequest)
Associates an Elastic IP address with an instance or a network
interface.
|
void |
associateDhcpOptions(AssociateDhcpOptionsRequest associateDhcpOptionsRequest)
Associates a set of DHCP options (that you've previously created)
with the specified VPC, or associates no DHCP options with the VPC.
|
AssociateRouteTableResult |
associateRouteTable(AssociateRouteTableRequest associateRouteTableRequest)
Associates a subnet with a route table.
|
AttachClassicLinkVpcResult |
attachClassicLinkVpc(AttachClassicLinkVpcRequest attachClassicLinkVpcRequest)
Links an EC2-Classic instance to a ClassicLink-enabled VPC through
one or more of the VPC's security groups.
|
void |
attachInternetGateway(AttachInternetGatewayRequest attachInternetGatewayRequest)
Attaches an Internet gateway to a VPC, enabling connectivity between
the Internet and the VPC.
|
AttachNetworkInterfaceResult |
attachNetworkInterface(AttachNetworkInterfaceRequest attachNetworkInterfaceRequest)
Attaches a network interface to an instance.
|
AttachVolumeResult |
attachVolume(AttachVolumeRequest attachVolumeRequest)
Attaches an EBS volume to a running or stopped instance and exposes
it to the instance with the specified device name.
|
AttachVpnGatewayResult |
attachVpnGateway(AttachVpnGatewayRequest attachVpnGatewayRequest)
Attaches a virtual private gateway to a VPC.
|
void |
authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest authorizeSecurityGroupEgressRequest)
[EC2-VPC only] Adds one or more egress rules to a security group for
use with a VPC.
|
void |
authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest)
Adds one or more ingress rules to a security group.
|
BundleInstanceResult |
bundleInstance(BundleInstanceRequest bundleInstanceRequest)
Bundles an Amazon instance store-backed Windows instance.
|
CancelBundleTaskResult |
cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest)
Cancels a bundling operation for an instance store-backed Windows
instance.
|
void |
cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest)
Cancels an active conversion task.
|
void |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels an active export task.
|
CancelImportTaskResult |
cancelImportTask()
Cancels an in-process import virtual machine or import snapshot task.
|
CancelImportTaskResult |
cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest)
Cancels an in-process import virtual machine or import snapshot task.
|
CancelReservedInstancesListingResult |
cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest)
Cancels the specified Reserved Instance listing in the Reserved
Instance Marketplace.
|
CancelSpotFleetRequestsResult |
cancelSpotFleetRequests(CancelSpotFleetRequestsRequest cancelSpotFleetRequestsRequest)
Cancels the specified Spot fleet requests.
|
CancelSpotInstanceRequestsResult |
cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest)
Cancels one or more Spot instance requests.
|
ConfirmProductInstanceResult |
confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest)
Determines whether a product code is associated with an instance.
|
CopyImageResult |
copyImage(CopyImageRequest copyImageRequest)
Initiates the copy of an AMI from the specified source region to the
current region.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
Copies a point-in-time snapshot of an EBS volume and stores it in
Amazon S3.
|
CreateCustomerGatewayResult |
createCustomerGateway(CreateCustomerGatewayRequest createCustomerGatewayRequest)
Provides information to AWS about your VPN customer gateway device.
|
CreateDhcpOptionsResult |
createDhcpOptions(CreateDhcpOptionsRequest createDhcpOptionsRequest)
Creates a set of DHCP options for your VPC.
|
CreateFlowLogsResult |
createFlowLogs(CreateFlowLogsRequest createFlowLogsRequest)
Creates one or more flow logs to capture IP traffic for a specific
network interface, subnet, or VPC.
|
CreateImageResult |
createImage(CreateImageRequest createImageRequest)
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance
that is either running or stopped.
|
CreateInstanceExportTaskResult |
createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest)
Exports a running or stopped instance to an S3 bucket.
|
CreateInternetGatewayResult |
createInternetGateway()
Creates an Internet gateway for use with a VPC.
|
CreateInternetGatewayResult |
createInternetGateway(CreateInternetGatewayRequest createInternetGatewayRequest)
Creates an Internet gateway for use with a VPC.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates a 2048-bit RSA key pair with the specified name.
|
CreateNatGatewayResult |
createNatGateway(CreateNatGatewayRequest createNatGatewayRequest)
Creates a NAT gateway in the specified subnet.
|
CreateNetworkAclResult |
createNetworkAcl(CreateNetworkAclRequest createNetworkAclRequest)
Creates a network ACL in a VPC.
|
void |
createNetworkAclEntry(CreateNetworkAclEntryRequest createNetworkAclEntryRequest)
Creates an entry (a rule) in a network ACL with the specified rule
number.
|
CreateNetworkInterfaceResult |
createNetworkInterface(CreateNetworkInterfaceRequest createNetworkInterfaceRequest)
Creates a network interface in the specified subnet.
|
void |
createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest)
Creates a placement group that you launch cluster instances into.
|
CreateReservedInstancesListingResult |
createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest)
Creates a listing for Amazon EC2 Reserved Instances to be sold in the
Reserved Instance Marketplace.
|
CreateRouteResult |
createRoute(CreateRouteRequest createRouteRequest)
Creates a route in a route table within a VPC.
|
CreateRouteTableResult |
createRouteTable(CreateRouteTableRequest createRouteTableRequest)
Creates a route table for the specified VPC.
|
CreateSecurityGroupResult |
createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest)
Creates a security group.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of an EBS volume and stores it in Amazon S3.
|
CreateSpotDatafeedSubscriptionResult |
createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest)
Creates a data feed for Spot instances, enabling you to view Spot
instance usage logs.
|
CreateSubnetResult |
createSubnet(CreateSubnetRequest createSubnetRequest)
Creates a subnet in an existing VPC.
|
void |
createTags(CreateTagsRequest createTagsRequest)
Adds or overwrites one or more tags for the specified Amazon EC2
resource or resources.
|
CreateVolumeResult |
createVolume(CreateVolumeRequest createVolumeRequest)
Creates an EBS volume that can be attached to an instance in the same
Availability Zone.
|
CreateVpcResult |
createVpc(CreateVpcRequest createVpcRequest)
Creates a VPC with the specified CIDR block.
|
CreateVpcEndpointResult |
createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
Creates a VPC endpoint for a specified AWS service.
|
CreateVpcPeeringConnectionResult |
createVpcPeeringConnection()
Requests a VPC peering connection between two VPCs: a requester VPC
that you own and a peer VPC with which to create the connection.
|
CreateVpcPeeringConnectionResult |
createVpcPeeringConnection(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest)
Requests a VPC peering connection between two VPCs: a requester VPC
that you own and a peer VPC with which to create the connection.
|
CreateVpnConnectionResult |
createVpnConnection(CreateVpnConnectionRequest createVpnConnectionRequest)
Creates a VPN connection between an existing virtual private gateway
and a VPN customer gateway.
|
void |
createVpnConnectionRoute(CreateVpnConnectionRouteRequest createVpnConnectionRouteRequest)
Creates a static route associated with a VPN connection between an
existing virtual private gateway and a VPN customer gateway.
|
CreateVpnGatewayResult |
createVpnGateway(CreateVpnGatewayRequest createVpnGatewayRequest)
Creates a virtual private gateway.
|
void |
deleteCustomerGateway(DeleteCustomerGatewayRequest deleteCustomerGatewayRequest)
Deletes the specified customer gateway.
|
void |
deleteDhcpOptions(DeleteDhcpOptionsRequest deleteDhcpOptionsRequest)
Deletes the specified set of DHCP options.
|
DeleteFlowLogsResult |
deleteFlowLogs(DeleteFlowLogsRequest deleteFlowLogsRequest)
Deletes one or more flow logs.
|
void |
deleteInternetGateway(DeleteInternetGatewayRequest deleteInternetGatewayRequest)
Deletes the specified Internet gateway.
|
void |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes the specified key pair, by removing the public key from
Amazon EC2.
|
DeleteNatGatewayResult |
deleteNatGateway(DeleteNatGatewayRequest deleteNatGatewayRequest)
Deletes the specified NAT gateway.
|
void |
deleteNetworkAcl(DeleteNetworkAclRequest deleteNetworkAclRequest)
Deletes the specified network ACL.
|
void |
deleteNetworkAclEntry(DeleteNetworkAclEntryRequest deleteNetworkAclEntryRequest)
Deletes the specified ingress or egress entry (rule) from the
specified network ACL.
|
void |
deleteNetworkInterface(DeleteNetworkInterfaceRequest deleteNetworkInterfaceRequest)
Deletes the specified network interface.
|
void |
deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest)
Deletes the specified placement group.
|
void |
deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes the specified route from the specified route table.
|
void |
deleteRouteTable(DeleteRouteTableRequest deleteRouteTableRequest)
Deletes the specified route table.
|
void |
deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest)
Deletes a security group.
|
void |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes the specified snapshot.
|
void |
deleteSpotDatafeedSubscription()
Deletes the data feed for Spot instances.
|
void |
deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest)
Deletes the data feed for Spot instances.
|
void |
deleteSubnet(DeleteSubnetRequest deleteSubnetRequest)
Deletes the specified subnet.
|
void |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified set of tags from the specified set of
resources.
|
void |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes the specified EBS volume.
|
void |
deleteVpc(DeleteVpcRequest deleteVpcRequest)
Deletes the specified VPC.
|
DeleteVpcEndpointsResult |
deleteVpcEndpoints(DeleteVpcEndpointsRequest deleteVpcEndpointsRequest)
Deletes one or more specified VPC endpoints.
|
DeleteVpcPeeringConnectionResult |
deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest)
Deletes a VPC peering connection.
|
void |
deleteVpnConnection(DeleteVpnConnectionRequest deleteVpnConnectionRequest)
Deletes the specified VPN connection.
|
void |
deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest deleteVpnConnectionRouteRequest)
Deletes the specified static route associated with a VPN connection
between an existing virtual private gateway and a VPN customer
gateway.
|
void |
deleteVpnGateway(DeleteVpnGatewayRequest deleteVpnGatewayRequest)
Deletes the specified virtual private gateway.
|
void |
deregisterImage(DeregisterImageRequest deregisterImageRequest)
Deregisters the specified AMI.
|
DescribeAccountAttributesResult |
describeAccountAttributes()
Describes attributes of your AWS account.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Describes attributes of your AWS account.
|
DescribeAddressesResult |
describeAddresses()
Describes one or more of your Elastic IP addresses.
|
DescribeAddressesResult |
describeAddresses(DescribeAddressesRequest describeAddressesRequest)
Describes one or more of your Elastic IP addresses.
|
DescribeAvailabilityZonesResult |
describeAvailabilityZones()
Describes one or more of the Availability Zones that are available to
you.
|
DescribeAvailabilityZonesResult |
describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest)
Describes one or more of the Availability Zones that are available to
you.
|
DescribeBundleTasksResult |
describeBundleTasks()
Describes one or more of your bundling tasks.
|
DescribeBundleTasksResult |
describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest)
Describes one or more of your bundling tasks.
|
DescribeClassicLinkInstancesResult |
describeClassicLinkInstances()
Describes one or more of your linked EC2-Classic instances.
|
DescribeClassicLinkInstancesResult |
describeClassicLinkInstances(DescribeClassicLinkInstancesRequest describeClassicLinkInstancesRequest)
Describes one or more of your linked EC2-Classic instances.
|
DescribeConversionTasksResult |
describeConversionTasks()
Describes one or more of your conversion tasks.
|
DescribeConversionTasksResult |
describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest)
Describes one or more of your conversion tasks.
|
DescribeCustomerGatewaysResult |
describeCustomerGateways()
Describes one or more of your VPN customer gateways.
|
DescribeCustomerGatewaysResult |
describeCustomerGateways(DescribeCustomerGatewaysRequest describeCustomerGatewaysRequest)
Describes one or more of your VPN customer gateways.
|
DescribeDhcpOptionsResult |
describeDhcpOptions()
Describes one or more of your DHCP options sets.
|
DescribeDhcpOptionsResult |
describeDhcpOptions(DescribeDhcpOptionsRequest describeDhcpOptionsRequest)
Describes one or more of your DHCP options sets.
|
DescribeExportTasksResult |
describeExportTasks()
Describes one or more of your export tasks.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Describes one or more of your export tasks.
|
DescribeFlowLogsResult |
describeFlowLogs()
Describes one or more flow logs.
|
DescribeFlowLogsResult |
describeFlowLogs(DescribeFlowLogsRequest describeFlowLogsRequest)
Describes one or more flow logs.
|
DescribeHostsResult |
describeHosts()
Describes one or more of your Dedicated hosts.
|
DescribeHostsResult |
describeHosts(DescribeHostsRequest describeHostsRequest)
Describes one or more of your Dedicated hosts.
|
DescribeIdFormatResult |
describeIdFormat()
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.
|
DescribeIdFormatResult |
describeIdFormat(DescribeIdFormatRequest describeIdFormatRequest)
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.
|
DescribeImageAttributeResult |
describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest)
Describes the specified attribute of the specified AMI.
|
DescribeImagesResult |
describeImages()
Describes one or more of the images (AMIs, AKIs, and ARIs) available
to you.
|
DescribeImagesResult |
describeImages(DescribeImagesRequest describeImagesRequest)
Describes one or more of the images (AMIs, AKIs, and ARIs) available
to you.
|
DescribeImportImageTasksResult |
describeImportImageTasks()
Displays details about an import virtual machine or import snapshot
tasks that are already created.
|
DescribeImportImageTasksResult |
describeImportImageTasks(DescribeImportImageTasksRequest describeImportImageTasksRequest)
Displays details about an import virtual machine or import snapshot
tasks that are already created.
|
DescribeImportSnapshotTasksResult |
describeImportSnapshotTasks()
Describes your import snapshot tasks.
|
DescribeImportSnapshotTasksResult |
describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest describeImportSnapshotTasksRequest)
Describes your import snapshot tasks.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
Describes the specified attribute of the specified instance.
|
DescribeInstancesResult |
describeInstances()
Describes one or more of your instances.
|
DescribeInstancesResult |
describeInstances(DescribeInstancesRequest describeInstancesRequest)
Describes one or more of your instances.
|
DescribeInstanceStatusResult |
describeInstanceStatus()
Describes the status of one or more instances.
|
DescribeInstanceStatusResult |
describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest)
Describes the status of one or more instances.
|
DescribeInternetGatewaysResult |
describeInternetGateways()
Describes one or more of your Internet gateways.
|
DescribeInternetGatewaysResult |
describeInternetGateways(DescribeInternetGatewaysRequest describeInternetGatewaysRequest)
Describes one or more of your Internet gateways.
|
DescribeKeyPairsResult |
describeKeyPairs()
Describes one or more of your key pairs.
|
DescribeKeyPairsResult |
describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest)
Describes one or more of your key pairs.
|
DescribeMovingAddressesResult |
describeMovingAddresses()
Describes your Elastic IP addresses that are being moved to the
EC2-VPC platform, or that are being restored to the EC2-Classic
platform.
|
DescribeMovingAddressesResult |
describeMovingAddresses(DescribeMovingAddressesRequest describeMovingAddressesRequest)
Describes your Elastic IP addresses that are being moved to the
EC2-VPC platform, or that are being restored to the EC2-Classic
platform.
|
DescribeNatGatewaysResult |
describeNatGateways()
Describes one or more of the your NAT gateways.
|
DescribeNatGatewaysResult |
describeNatGateways(DescribeNatGatewaysRequest describeNatGatewaysRequest)
Describes one or more of the your NAT gateways.
|
DescribeNetworkAclsResult |
describeNetworkAcls()
Describes one or more of your network ACLs.
|
DescribeNetworkAclsResult |
describeNetworkAcls(DescribeNetworkAclsRequest describeNetworkAclsRequest)
Describes one or more of your network ACLs.
|
DescribeNetworkInterfaceAttributeResult |
describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest describeNetworkInterfaceAttributeRequest)
Describes a network interface attribute.
|
DescribeNetworkInterfacesResult |
describeNetworkInterfaces()
Describes one or more of your network interfaces.
|
DescribeNetworkInterfacesResult |
describeNetworkInterfaces(DescribeNetworkInterfacesRequest describeNetworkInterfacesRequest)
Describes one or more of your network interfaces.
|
DescribePlacementGroupsResult |
describePlacementGroups()
Describes one or more of your placement groups.
|
DescribePlacementGroupsResult |
describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest)
Describes one or more of your placement groups.
|
DescribePrefixListsResult |
describePrefixLists()
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.
|
DescribePrefixListsResult |
describePrefixLists(DescribePrefixListsRequest describePrefixListsRequest)
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.
|
DescribeRegionsResult |
describeRegions()
Describes one or more regions that are currently available to you.
|
DescribeRegionsResult |
describeRegions(DescribeRegionsRequest describeRegionsRequest)
Describes one or more regions that are currently available to you.
|
DescribeReservedInstancesResult |
describeReservedInstances()
Describes one or more of the Reserved Instances that you purchased.
|
DescribeReservedInstancesResult |
describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)
Describes one or more of the Reserved Instances that you purchased.
|
DescribeReservedInstancesListingsResult |
describeReservedInstancesListings()
Describes your account's Reserved Instance listings in the Reserved
Instance Marketplace.
|
DescribeReservedInstancesListingsResult |
describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest)
Describes your account's Reserved Instance listings in the Reserved
Instance Marketplace.
|
DescribeReservedInstancesModificationsResult |
describeReservedInstancesModifications()
Describes the modifications made to your Reserved Instances.
|
DescribeReservedInstancesModificationsResult |
describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest)
Describes the modifications made to your Reserved Instances.
|
DescribeReservedInstancesOfferingsResult |
describeReservedInstancesOfferings()
Describes Reserved Instance offerings that are available for
purchase.
|
DescribeReservedInstancesOfferingsResult |
describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest)
Describes Reserved Instance offerings that are available for
purchase.
|
DescribeRouteTablesResult |
describeRouteTables()
Describes one or more of your route tables.
|
DescribeRouteTablesResult |
describeRouteTables(DescribeRouteTablesRequest describeRouteTablesRequest)
Describes one or more of your route tables.
|
DescribeScheduledInstanceAvailabilityResult |
describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest describeScheduledInstanceAvailabilityRequest)
Finds available schedules that meet the specified criteria.
|
DescribeScheduledInstancesResult |
describeScheduledInstances()
Describes one or more of your Scheduled Instances.
|
DescribeScheduledInstancesResult |
describeScheduledInstances(DescribeScheduledInstancesRequest describeScheduledInstancesRequest)
Describes one or more of your Scheduled Instances.
|
DescribeSecurityGroupReferencesResult |
describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest describeSecurityGroupReferencesRequest)
[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.
|
DescribeSecurityGroupsResult |
describeSecurityGroups()
Describes one or more of your security groups.
|
DescribeSecurityGroupsResult |
describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest)
Describes one or more of your security groups.
|
DescribeSnapshotAttributeResult |
describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest)
Describes the specified attribute of the specified snapshot.
|
DescribeSnapshotsResult |
describeSnapshots()
Describes one or more of the EBS snapshots available to you.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Describes one or more of the EBS snapshots available to you.
|
DescribeSpotDatafeedSubscriptionResult |
describeSpotDatafeedSubscription()
Describes the data feed for Spot instances.
|
DescribeSpotDatafeedSubscriptionResult |
describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest)
Describes the data feed for Spot instances.
|
DescribeSpotFleetInstancesResult |
describeSpotFleetInstances(DescribeSpotFleetInstancesRequest describeSpotFleetInstancesRequest)
Describes the running instances for the specified Spot fleet.
|
DescribeSpotFleetRequestHistoryResult |
describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest describeSpotFleetRequestHistoryRequest)
Describes the events for the specified Spot fleet request during the
specified time.
|
DescribeSpotFleetRequestsResult |
describeSpotFleetRequests()
Describes your Spot fleet requests.
|
DescribeSpotFleetRequestsResult |
describeSpotFleetRequests(DescribeSpotFleetRequestsRequest describeSpotFleetRequestsRequest)
Describes your Spot fleet requests.
|
DescribeSpotInstanceRequestsResult |
describeSpotInstanceRequests()
Describes the Spot instance requests that belong to your account.
|
DescribeSpotInstanceRequestsResult |
describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest)
Describes the Spot instance requests that belong to your account.
|
DescribeSpotPriceHistoryResult |
describeSpotPriceHistory()
Describes the Spot price history.
|
DescribeSpotPriceHistoryResult |
describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest)
Describes the Spot price history.
|
DescribeStaleSecurityGroupsResult |
describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest describeStaleSecurityGroupsRequest)
[EC2-VPC only] Describes the stale security group rules for security
groups in a specified VPC.
|
DescribeSubnetsResult |
describeSubnets()
Describes one or more of your subnets.
|
DescribeSubnetsResult |
describeSubnets(DescribeSubnetsRequest describeSubnetsRequest)
Describes one or more of your subnets.
|
DescribeTagsResult |
describeTags()
Describes one or more of the tags for your EC2 resources.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes one or more of the tags for your EC2 resources.
|
DescribeVolumeAttributeResult |
describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest)
Describes the specified attribute of the specified volume.
|
DescribeVolumesResult |
describeVolumes()
Describes the specified EBS volumes.
|
DescribeVolumesResult |
describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes the specified EBS volumes.
|
DescribeVolumeStatusResult |
describeVolumeStatus()
Describes the status of the specified volumes.
|
DescribeVolumeStatusResult |
describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest)
Describes the status of the specified volumes.
|
DescribeVpcAttributeResult |
describeVpcAttribute(DescribeVpcAttributeRequest describeVpcAttributeRequest)
Describes the specified attribute of the specified VPC.
|
DescribeVpcClassicLinkResult |
describeVpcClassicLink()
Describes the ClassicLink status of one or more VPCs.
|
DescribeVpcClassicLinkResult |
describeVpcClassicLink(DescribeVpcClassicLinkRequest describeVpcClassicLinkRequest)
Describes the ClassicLink status of one or more VPCs.
|
DescribeVpcClassicLinkDnsSupportResult |
describeVpcClassicLinkDnsSupport()
Describes the ClassicLink DNS support status of one or more VPCs.
|
DescribeVpcClassicLinkDnsSupportResult |
describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest describeVpcClassicLinkDnsSupportRequest)
Describes the ClassicLink DNS support status of one or more VPCs.
|
DescribeVpcEndpointsResult |
describeVpcEndpoints()
Describes one or more of your VPC endpoints.
|
DescribeVpcEndpointsResult |
describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)
Describes one or more of your VPC endpoints.
|
DescribeVpcEndpointServicesResult |
describeVpcEndpointServices()
Describes all supported AWS services that can be specified when
creating a VPC endpoint.
|
DescribeVpcEndpointServicesResult |
describeVpcEndpointServices(DescribeVpcEndpointServicesRequest describeVpcEndpointServicesRequest)
Describes all supported AWS services that can be specified when
creating a VPC endpoint.
|
DescribeVpcPeeringConnectionsResult |
describeVpcPeeringConnections()
Describes one or more of your VPC peering connections.
|
DescribeVpcPeeringConnectionsResult |
describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest)
Describes one or more of your VPC peering connections.
|
DescribeVpcsResult |
describeVpcs()
Describes one or more of your VPCs.
|
DescribeVpcsResult |
describeVpcs(DescribeVpcsRequest describeVpcsRequest)
Describes one or more of your VPCs.
|
DescribeVpnConnectionsResult |
describeVpnConnections()
Describes one or more of your VPN connections.
|
DescribeVpnConnectionsResult |
describeVpnConnections(DescribeVpnConnectionsRequest describeVpnConnectionsRequest)
Describes one or more of your VPN connections.
|
DescribeVpnGatewaysResult |
describeVpnGateways()
Describes one or more of your virtual private gateways.
|
DescribeVpnGatewaysResult |
describeVpnGateways(DescribeVpnGatewaysRequest describeVpnGatewaysRequest)
Describes one or more of your virtual private gateways.
|
DetachClassicLinkVpcResult |
detachClassicLinkVpc(DetachClassicLinkVpcRequest detachClassicLinkVpcRequest)
Unlinks (detaches) a linked EC2-Classic instance from a VPC.
|
void |
detachInternetGateway(DetachInternetGatewayRequest detachInternetGatewayRequest)
Detaches an Internet gateway from a VPC, disabling connectivity
between the Internet and the VPC.
|
void |
detachNetworkInterface(DetachNetworkInterfaceRequest detachNetworkInterfaceRequest)
Detaches a network interface from an instance.
|
DetachVolumeResult |
detachVolume(DetachVolumeRequest detachVolumeRequest)
Detaches an EBS volume from an instance.
|
void |
detachVpnGateway(DetachVpnGatewayRequest detachVpnGatewayRequest)
Detaches a virtual private gateway from a VPC.
|
void |
disableVgwRoutePropagation(DisableVgwRoutePropagationRequest disableVgwRoutePropagationRequest)
Disables a virtual private gateway (VGW) from propagating routes to a
specified route table of a VPC.
|
DisableVpcClassicLinkResult |
disableVpcClassicLink(DisableVpcClassicLinkRequest disableVpcClassicLinkRequest)
Disables ClassicLink for a VPC.
|
DisableVpcClassicLinkDnsSupportResult |
disableVpcClassicLinkDnsSupport()
Disables ClassicLink DNS support for a VPC.
|
DisableVpcClassicLinkDnsSupportResult |
disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest disableVpcClassicLinkDnsSupportRequest)
Disables ClassicLink DNS support for a VPC.
|
void |
disassociateAddress(DisassociateAddressRequest disassociateAddressRequest)
Disassociates an Elastic IP address from the instance or network
interface it's associated with.
|
void |
disassociateRouteTable(DisassociateRouteTableRequest disassociateRouteTableRequest)
Disassociates a subnet from a route table.
|
<X extends AmazonWebServiceRequest> |
dryRun(DryRunSupportedRequest<X> request)
Checks whether you have the required permissions for the provided
AmazonEC2 operation, without actually running it.
|
void |
enableVgwRoutePropagation(EnableVgwRoutePropagationRequest enableVgwRoutePropagationRequest)
Enables a virtual private gateway (VGW) to propagate routes to the
specified route table of a VPC.
|
void |
enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest)
Enables I/O operations for a volume that had I/O operations disabled
because the data on the volume was potentially inconsistent.
|
EnableVpcClassicLinkResult |
enableVpcClassicLink(EnableVpcClassicLinkRequest enableVpcClassicLinkRequest)
Enables a VPC for ClassicLink.
|
EnableVpcClassicLinkDnsSupportResult |
enableVpcClassicLinkDnsSupport()
Enables a VPC to support DNS hostname resolution for ClassicLink.
|
EnableVpcClassicLinkDnsSupportResult |
enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest enableVpcClassicLinkDnsSupportRequest)
Enables a VPC to support DNS hostname resolution for ClassicLink.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for
debugging issues where a service isn't acting as expected.
|
GetConsoleOutputResult |
getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest)
Gets the console output for the specified instance.
|
GetConsoleScreenshotResult |
getConsoleScreenshot(GetConsoleScreenshotRequest getConsoleScreenshotRequest)
Retrieve a JPG-format screenshot of a running instance to help with
troubleshooting.
|
GetPasswordDataResult |
getPasswordData(GetPasswordDataRequest getPasswordDataRequest)
Retrieves the encrypted administrator password for an instance
running Windows.
|
ImportImageResult |
importImage()
Import single or multi-volume disk images or EBS snapshots into an
Amazon Machine Image (AMI).
|
ImportImageResult |
importImage(ImportImageRequest importImageRequest)
Import single or multi-volume disk images or EBS snapshots into an
Amazon Machine Image (AMI).
|
ImportInstanceResult |
importInstance(ImportInstanceRequest importInstanceRequest)
Creates an import instance task using metadata from the specified
disk image.
|
ImportKeyPairResult |
importKeyPair(ImportKeyPairRequest importKeyPairRequest)
Imports the public key from an RSA key pair that you created with a
third-party tool.
|
ImportSnapshotResult |
importSnapshot()
Imports a disk into an EBS snapshot.
|
ImportSnapshotResult |
importSnapshot(ImportSnapshotRequest importSnapshotRequest)
Imports a disk into an EBS snapshot.
|
ImportVolumeResult |
importVolume(ImportVolumeRequest importVolumeRequest)
Creates an import volume task using metadata from the specified disk
image.
|
ModifyHostsResult |
modifyHosts(ModifyHostsRequest modifyHostsRequest)
Modify the auto-placement setting of a Dedicated host.
|
void |
modifyIdFormat(ModifyIdFormatRequest modifyIdFormatRequest)
Modifies the ID format for the specified resource on a per-region
basis.
|
void |
modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest)
Modifies the specified attribute of the specified AMI.
|
void |
modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest)
Modifies the specified attribute of the specified instance.
|
ModifyInstancePlacementResult |
modifyInstancePlacement(ModifyInstancePlacementRequest modifyInstancePlacementRequest)
Set the instance affinity value for a specific stopped instance and
modify the instance tenancy setting.
|
void |
modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest modifyNetworkInterfaceAttributeRequest)
Modifies the specified network interface attribute.
|
ModifyReservedInstancesResult |
modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest)
Modifies the Availability Zone, instance count, instance type, or
network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.
|
void |
modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest)
Adds or removes permission settings for the specified snapshot.
|
ModifySpotFleetRequestResult |
modifySpotFleetRequest(ModifySpotFleetRequestRequest modifySpotFleetRequestRequest)
Modifies the specified Spot fleet request.
|
void |
modifySubnetAttribute(ModifySubnetAttributeRequest modifySubnetAttributeRequest)
Modifies a subnet attribute.
|
void |
modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest)
Modifies a volume attribute.
|
void |
modifyVpcAttribute(ModifyVpcAttributeRequest modifyVpcAttributeRequest)
Modifies the specified attribute of the specified VPC.
|
ModifyVpcEndpointResult |
modifyVpcEndpoint(ModifyVpcEndpointRequest modifyVpcEndpointRequest)
Modifies attributes of a specified VPC endpoint.
|
ModifyVpcPeeringConnectionOptionsResult |
modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest modifyVpcPeeringConnectionOptionsRequest)
Modifies the VPC peering connection options on one side of a VPC
peering connection.
|
MonitorInstancesResult |
monitorInstances(MonitorInstancesRequest monitorInstancesRequest)
Enables monitoring for a running instance.
|
MoveAddressToVpcResult |
moveAddressToVpc(MoveAddressToVpcRequest moveAddressToVpcRequest)
Moves an Elastic IP address from the EC2-Classic platform to the
EC2-VPC platform.
|
PurchaseReservedInstancesOfferingResult |
purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest)
Purchases a Reserved Instance for use with your account.
|
PurchaseScheduledInstancesResult |
purchaseScheduledInstances(PurchaseScheduledInstancesRequest purchaseScheduledInstancesRequest)
Purchases one or more Scheduled Instances with the specified
schedule.
|
void |
rebootInstances(RebootInstancesRequest rebootInstancesRequest)
Requests a reboot of one or more instances.
|
RegisterImageResult |
registerImage(RegisterImageRequest registerImageRequest)
Registers an AMI.
|
RejectVpcPeeringConnectionResult |
rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest rejectVpcPeeringConnectionRequest)
Rejects a VPC peering connection request.
|
void |
releaseAddress(ReleaseAddressRequest releaseAddressRequest)
Releases the specified Elastic IP address.
|
ReleaseHostsResult |
releaseHosts(ReleaseHostsRequest releaseHostsRequest)
When you no longer want to use a Dedicated host it can be released.
|
ReplaceNetworkAclAssociationResult |
replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest replaceNetworkAclAssociationRequest)
Changes which network ACL a subnet is associated with.
|
void |
replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest replaceNetworkAclEntryRequest)
Replaces an entry (rule) in a network ACL.
|
void |
replaceRoute(ReplaceRouteRequest replaceRouteRequest)
Replaces an existing route within a route table in a VPC.
|
ReplaceRouteTableAssociationResult |
replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest replaceRouteTableAssociationRequest)
Changes the route table associated with a given subnet in a VPC.
|
void |
reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest)
Submits feedback about the status of an instance.
|
RequestSpotFleetResult |
requestSpotFleet(RequestSpotFleetRequest requestSpotFleetRequest)
Creates a Spot fleet request.
|
RequestSpotInstancesResult |
requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest)
Creates a Spot instance request.
|
void |
resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest)
Resets an attribute of an AMI to its default value.
|
void |
resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest)
Resets an attribute of an instance to its default value.
|
void |
resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest resetNetworkInterfaceAttributeRequest)
Resets a network interface attribute.
|
void |
resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest)
Resets permission settings for the specified snapshot.
|
RestoreAddressToClassicResult |
restoreAddressToClassic(RestoreAddressToClassicRequest restoreAddressToClassicRequest)
Restores an Elastic IP address that was previously moved to the
EC2-VPC platform back to the EC2-Classic platform.
|
void |
revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest revokeSecurityGroupEgressRequest)
[EC2-VPC only] Removes one or more egress rules from a security group
for EC2-VPC.
|
void |
revokeSecurityGroupIngress()
Removes one or more ingress rules from a security group.
|
void |
revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest)
Removes one or more ingress rules from a security group.
|
RunInstancesResult |
runInstances(RunInstancesRequest runInstancesRequest)
Launches the specified number of instances using an AMI for which you
have permissions.
|
RunScheduledInstancesResult |
runScheduledInstances(RunScheduledInstancesRequest runScheduledInstancesRequest)
Launches the specified Scheduled Instances.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client ("https://ec2.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
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.
|
StartInstancesResult |
startInstances(StartInstancesRequest startInstancesRequest)
Starts an Amazon EBS-backed AMI that you've previously stopped.
|
StopInstancesResult |
stopInstances(StopInstancesRequest stopInstancesRequest)
Stops an Amazon EBS-backed instance.
|
TerminateInstancesResult |
terminateInstances(TerminateInstancesRequest terminateInstancesRequest)
Shuts down one or more instances.
|
void |
unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest unassignPrivateIpAddressesRequest)
Unassigns one or more secondary private IP addresses from a network
interface.
|
UnmonitorInstancesResult |
unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest)
Disables monitoring for a running instance.
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
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.
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.java.lang.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
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.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region#getRegion(com.amazonaws.regions.Regions)
,
Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
void deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest) throws AmazonServiceException, AmazonClientException
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 .
deletePlacementGroupRequest
- Container for the necessary
parameters to execute the DeletePlacementGroup service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateDhcpOptionsResult createDhcpOptions(CreateDhcpOptionsRequest createDhcpOptionsRequest) throws AmazonServiceException, AmazonClientException
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 to
AmazonProvidedDNS
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 .
createDhcpOptionsRequest
- Container for the necessary parameters
to execute the CreateDhcpOptions service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpnConnectionResult createVpnConnection(CreateVpnConnectionRequest createVpnConnectionRequest) throws AmazonServiceException, AmazonClientException
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.
IMPORTANT: 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 .
createVpnConnectionRequest
- Container for the necessary
parameters to execute the CreateVpnConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void disassociateRouteTable(DisassociateRouteTableRequest disassociateRouteTableRequest) throws AmazonServiceException, AmazonClientException
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 .
disassociateRouteTableRequest
- Container for the necessary
parameters to execute the DisassociateRouteTable service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
modifyReservedInstancesRequest
- Container for the necessary
parameters to execute the ModifyReservedInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportSnapshotResult importSnapshot(ImportSnapshotRequest importSnapshotRequest) throws AmazonServiceException, AmazonClientException
Imports a disk into an EBS snapshot.
importSnapshotRequest
- Container for the necessary parameters to
execute the ImportSnapshot service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.TerminateInstancesResult terminateInstances(TerminateInstancesRequest terminateInstancesRequest) throws AmazonServiceException, AmazonClientException
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 to true
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 .
terminateInstancesRequest
- Container for the necessary
parameters to execute the TerminateInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest) throws AmazonServiceException, AmazonClientException
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.
confirmProductInstanceRequest
- Container for the necessary
parameters to execute the ConfirmProductInstance service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws AmazonServiceException, AmazonClientException
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 .
deleteSnapshotRequest
- Container for the necessary parameters to
execute the DeleteSnapshot service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest) throws AmazonServiceException, AmazonClientException
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.
describeReservedInstancesModificationsRequest
- Container for the
necessary parameters to execute the
DescribeReservedInstancesModifications service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportInstanceResult importInstance(ImportInstanceRequest importInstanceRequest) throws AmazonServiceException, AmazonClientException
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 the ec2-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 .
importInstanceRequest
- Container for the necessary parameters to
execute the ImportInstance service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest) throws AmazonServiceException, AmazonClientException
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 .
describeAvailabilityZonesRequest
- Container for the necessary
parameters to execute the DescribeAvailabilityZones service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AttachVolumeResult attachVolume(AttachVolumeRequest attachVolumeRequest) throws AmazonServiceException, AmazonClientException
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 .
attachVolumeRequest
- Container for the necessary parameters to
execute the AttachVolume service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DisableVpcClassicLinkDnsSupportResult disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest disableVpcClassicLinkDnsSupportRequest) throws AmazonServiceException, AmazonClientException
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.
disableVpcClassicLinkDnsSupportRequest
- Container for the
necessary parameters to execute the DisableVpcClassicLinkDnsSupport
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void attachInternetGateway(AttachInternetGatewayRequest attachInternetGatewayRequest) throws AmazonServiceException, AmazonClientException
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 .
attachInternetGatewayRequest
- Container for the necessary
parameters to execute the AttachInternetGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest describeStaleSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
[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.
describeStaleSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeStaleSecurityGroups service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void enableVgwRoutePropagation(EnableVgwRoutePropagationRequest enableVgwRoutePropagationRequest) throws AmazonServiceException, AmazonClientException
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
enableVgwRoutePropagationRequest
- Container for the necessary
parameters to execute the EnableVgwRoutePropagation service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AllocateHostsResult allocateHosts(AllocateHostsRequest allocateHostsRequest) throws AmazonServiceException, AmazonClientException
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.
allocateHostsRequest
- Container for the necessary parameters to
execute the AllocateHosts service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcClassicLinkResult describeVpcClassicLink(DescribeVpcClassicLinkRequest describeVpcClassicLinkRequest) throws AmazonServiceException, AmazonClientException
Describes the ClassicLink status of one or more VPCs.
describeVpcClassicLinkRequest
- Container for the necessary
parameters to execute the DescribeVpcClassicLink service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AttachVpnGatewayResult attachVpnGateway(AttachVpnGatewayRequest attachVpnGatewayRequest) throws AmazonServiceException, AmazonClientException
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 .
attachVpnGatewayRequest
- Container for the necessary parameters
to execute the AttachVpnGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws AmazonServiceException, AmazonClientException
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.
cancelExportTaskRequest
- Container for the necessary parameters
to execute the CancelExportTask service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
describeInstancesRequest
- Container for the necessary parameters
to execute the DescribeInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RunScheduledInstancesResult runScheduledInstances(RunScheduledInstancesRequest runScheduledInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
runScheduledInstancesRequest
- Container for the necessary
parameters to execute the RunScheduledInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportImageResult importImage(ImportImageRequest importImageRequest) throws AmazonServiceException, AmazonClientException
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
importImageRequest
- Container for the necessary parameters to
execute the ImportImage service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateImageResult createImage(CreateImageRequest createImageRequest) throws AmazonServiceException, AmazonClientException
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 .
createImageRequest
- Container for the necessary parameters to
execute the CreateImage service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified EBS volume. The volume must be in the
available
state (not attached to an instance).
NOTE: 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 .
deleteVolumeRequest
- Container for the necessary parameters to
execute the DeleteVolume service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeMovingAddressesResult describeMovingAddresses(DescribeMovingAddressesRequest describeMovingAddressesRequest) throws AmazonServiceException, AmazonClientException
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.
describeMovingAddressesRequest
- Container for the necessary
parameters to execute the DescribeMovingAddresses service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your VPC endpoints.
describeVpcEndpointsRequest
- Container for the necessary
parameters to execute the DescribeVpcEndpoints service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteSubnet(DeleteSubnetRequest deleteSubnetRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
deleteSubnetRequest
- Container for the necessary parameters to
execute the DeleteSubnet service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeClassicLinkInstancesResult describeClassicLinkInstances(DescribeClassicLinkInstancesRequest describeClassicLinkInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
describeClassicLinkInstancesRequest
- Container for the necessary
parameters to execute the DescribeClassicLinkInstances service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeReservedInstancesOfferingsRequest
- Container for the
necessary parameters to execute the DescribeReservedInstancesOfferings
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DeleteVpcPeeringConnectionResult deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) throws AmazonServiceException, AmazonClientException
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 the
pending-acceptance
state.
deleteVpcPeeringConnectionRequest
- Container for the necessary
parameters to execute the DeleteVpcPeeringConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RunInstancesResult runInstances(RunInstancesRequest runInstancesRequest) throws AmazonServiceException, AmazonClientException
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 the
running
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.
To tag your instance, ensure that it is running
as
CreateTags requires a resource ID. For more information about tagging,
see
Tagging Your Amazon EC2 Resources
.
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 .
runInstancesRequest
- Container for the necessary parameters to
execute the RunInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest) throws AmazonServiceException, AmazonClientException
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
enableVolumeIORequest
- Container for the necessary parameters to
execute the EnableVolumeIO service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotFleetRequestHistoryResult describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest describeSpotFleetRequestHistoryRequest) throws AmazonServiceException, AmazonClientException
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.
describeSpotFleetRequestHistoryRequest
- Container for the
necessary parameters to execute the DescribeSpotFleetRequestHistory
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest) throws AmazonServiceException, AmazonClientException
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 .
createSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the CreateSpotDatafeedSubscription
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RestoreAddressToClassicResult restoreAddressToClassic(RestoreAddressToClassicRequest restoreAddressToClassicRequest) throws AmazonServiceException, AmazonClientException
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.
restoreAddressToClassicRequest
- Container for the necessary
parameters to execute the RestoreAddressToClassic service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.
describeImagesRequest
- Container for the necessary parameters to
execute the DescribeImages service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcsResult describeVpcs(DescribeVpcsRequest describeVpcsRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your VPCs.
describeVpcsRequest
- Container for the necessary parameters to
execute the DescribeVpcs service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest authorizeSecurityGroupEgressRequest) throws AmazonServiceException, AmazonClientException
[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 .
IMPORTANT: 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.
authorizeSecurityGroupEgressRequest
- Container for the necessary
parameters to execute the AuthorizeSecurityGroupEgress service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CopySnapshotResult copySnapshot(CopySnapshotRequest copySnapshotRequest) throws AmazonServiceException, AmazonClientException
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 the KmsKeyId
parameter.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide .
copySnapshotRequest
- Container for the necessary parameters to
execute the CopySnapshot service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void detachVpnGateway(DetachVpnGatewayRequest detachVpnGatewayRequest) throws AmazonServiceException, AmazonClientException
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.
detachVpnGatewayRequest
- Container for the necessary parameters
to execute the DetachVpnGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
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
describeInstanceAttributeRequest
- Container for the necessary
parameters to execute the DescribeInstanceAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotFleetInstancesResult describeSpotFleetInstances(DescribeSpotFleetInstancesRequest describeSpotFleetInstancesRequest) throws AmazonServiceException, AmazonClientException
Describes the running instances for the specified Spot fleet.
describeSpotFleetInstancesRequest
- Container for the necessary
parameters to execute the DescribeSpotFleetInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateNetworkAclResult createNetworkAcl(CreateNetworkAclRequest createNetworkAclRequest) throws AmazonServiceException, AmazonClientException
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 .
createNetworkAclRequest
- Container for the necessary parameters
to execute the CreateNetworkAcl service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest) throws AmazonServiceException, AmazonClientException
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.
describeSpotPriceHistoryRequest
- Container for the necessary
parameters to execute the DescribeSpotPriceHistory service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImportImageTasksResult describeImportImageTasks(DescribeImportImageTasksRequest describeImportImageTasksRequest) throws AmazonServiceException, AmazonClientException
Displays details about an import virtual machine or import snapshot tasks that are already created.
describeImportImageTasksRequest
- Container for the necessary
parameters to execute the DescribeImportImageTasks service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInternetGatewaysResult describeInternetGateways(DescribeInternetGatewaysRequest describeInternetGatewaysRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your Internet gateways.
describeInternetGatewaysRequest
- Container for the necessary
parameters to execute the DescribeInternetGateways service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeHostsResult describeHosts(DescribeHostsRequest describeHostsRequest) throws AmazonServiceException, AmazonClientException
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
.
describeHostsRequest
- Container for the necessary parameters to
execute the DescribeHosts service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest describeSubnetsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeSubnetsRequest
- Container for the necessary parameters
to execute the DescribeSubnets service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.GetPasswordDataResult getPasswordData(GetPasswordDataRequest getPasswordDataRequest) throws AmazonServiceException, AmazonClientException
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 then Ec2SetPassword
is automatically
disabled. The password is not generated for rebundled AMIs unless
Ec2SetPassword
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.
getPasswordDataRequest
- Container for the necessary parameters
to execute the GetPasswordData service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest) throws AmazonServiceException, AmazonClientException
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 .
cancelConversionTaskRequest
- Container for the necessary
parameters to execute the CancelConversionTask service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteCustomerGateway(DeleteCustomerGatewayRequest deleteCustomerGatewayRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
deleteCustomerGatewayRequest
- Container for the necessary
parameters to execute the DeleteCustomerGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
Adds one or more ingress rules to a security group.
IMPORTANT: 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.
authorizeSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeSecurityGroupIngress
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void replaceRoute(ReplaceRouteRequest replaceRouteRequest) throws AmazonServiceException, AmazonClientException
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 .
replaceRouteRequest
- Container for the necessary parameters to
execute the ReplaceRoute service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.PurchaseScheduledInstancesResult purchaseScheduledInstances(PurchaseScheduledInstancesRequest purchaseScheduledInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
purchaseScheduledInstancesRequest
- Container for the necessary
parameters to execute the PurchaseScheduledInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeRouteTablesResult describeRouteTables(DescribeRouteTablesRequest describeRouteTablesRequest) throws AmazonServiceException, AmazonClientException
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 .
describeRouteTablesRequest
- Container for the necessary
parameters to execute the DescribeRouteTables service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest) throws AmazonServiceException, AmazonClientException
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.
modifyVolumeAttributeRequest
- Container for the necessary
parameters to execute the ModifyVolumeAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateNetworkInterfaceResult createNetworkInterface(CreateNetworkInterfaceRequest createNetworkInterfaceRequest) throws AmazonServiceException, AmazonClientException
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 .
createNetworkInterfaceRequest
- Container for the necessary
parameters to execute the CreateNetworkInterface service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AssociateAddressResult associateAddress(AssociateAddressRequest associateAddressRequest) throws AmazonServiceException, AmazonClientException
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.
associateAddressRequest
- Container for the necessary parameters
to execute the AssociateAddress service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest) throws AmazonServiceException, AmazonClientException
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 .
describeInstanceStatusRequest
- Container for the necessary
parameters to execute the DescribeInstanceStatus service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) throws AmazonServiceException, AmazonClientException
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.
createVpcEndpointRequest
- Container for the necessary parameters
to execute the CreateVpcEndpoint service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your export tasks.
describeExportTasksRequest
- Container for the necessary
parameters to execute the DescribeExportTasks service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.StartInstancesResult startInstances(StartInstancesRequest startInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
startInstancesRequest
- Container for the necessary parameters to
execute the StartInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeTagsRequest
- Container for the necessary parameters to
execute the DescribeTags service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ReplaceNetworkAclAssociationResult replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest replaceNetworkAclAssociationRequest) throws AmazonServiceException, AmazonClientException
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 .
replaceNetworkAclAssociationRequest
- Container for the necessary
parameters to execute the ReplaceNetworkAclAssociation service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws AmazonServiceException, AmazonClientException
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 .
createSnapshotRequest
- Container for the necessary parameters to
execute the CreateSnapshot service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AttachNetworkInterfaceResult attachNetworkInterface(AttachNetworkInterfaceRequest attachNetworkInterfaceRequest) throws AmazonServiceException, AmazonClientException
Attaches a network interface to an instance.
attachNetworkInterfaceRequest
- Container for the necessary
parameters to execute the AttachNetworkInterface service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeReservedInstancesListingsRequest
- Container for the
necessary parameters to execute the DescribeReservedInstancesListings
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteTags(DeleteTagsRequest deleteTagsRequest) throws AmazonServiceException, AmazonClientException
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 .
deleteTagsRequest
- Container for the necessary parameters to
execute the DeleteTags service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest describeNetworkInterfaceAttributeRequest) throws AmazonServiceException, AmazonClientException
Describes a network interface attribute. You can specify only one attribute at a time.
describeNetworkInterfaceAttributeRequest
- Container for the
necessary parameters to execute the DescribeNetworkInterfaceAttribute
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest) throws AmazonServiceException, AmazonClientException
Resets an attribute of an AMI to its default value.
NOTE: The productCodes attribute can't be reset.
resetImageAttributeRequest
- Container for the necessary
parameters to execute the ResetImageAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest) throws AmazonServiceException, AmazonClientException
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
describeImageAttributeRequest
- Container for the necessary
parameters to execute the DescribeImageAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest) throws AmazonServiceException, AmazonClientException
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 .
describePlacementGroupsRequest
- Container for the necessary
parameters to execute the DescribePlacementGroups service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
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 .
NOTE: Snapshots with AWS Marketplace product codes cannot be made public.
modifySnapshotAttributeRequest
- Container for the necessary
parameters to execute the ModifySnapshotAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
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 .
IMPORTANT: 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.
createSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateSecurityGroup service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest) throws AmazonServiceException, AmazonClientException
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 .
createReservedInstancesListingRequest
- Container for the
necessary parameters to execute the CreateReservedInstancesListing
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteNetworkInterface(DeleteNetworkInterfaceRequest deleteNetworkInterfaceRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified network interface. You must detach the network interface before you can delete it.
deleteNetworkInterfaceRequest
- Container for the necessary
parameters to execute the DeleteNetworkInterface service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ReplaceRouteTableAssociationResult replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest replaceRouteTableAssociationRequest) throws AmazonServiceException, AmazonClientException
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.
replaceRouteTableAssociationRequest
- Container for the necessary
parameters to execute the ReplaceRouteTableAssociation service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyIdFormat(ModifyIdFormatRequest modifyIdFormatRequest) throws AmazonServiceException, AmazonClientException
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.
modifyIdFormatRequest
- Container for the necessary parameters to
execute the ModifyIdFormat service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void detachInternetGateway(DetachInternetGatewayRequest detachInternetGatewayRequest) throws AmazonServiceException, AmazonClientException
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.
detachInternetGatewayRequest
- Container for the necessary
parameters to execute the DetachInternetGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest) throws AmazonServiceException, AmazonClientException
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 .
describeVolumeAttributeRequest
- Container for the necessary
parameters to execute the DescribeVolumeAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotFleetRequestsResult describeSpotFleetRequests(DescribeSpotFleetRequestsRequest describeSpotFleetRequestsRequest) throws AmazonServiceException, AmazonClientException
Describes your Spot fleet requests.
describeSpotFleetRequestsRequest
- Container for the necessary
parameters to execute the DescribeSpotFleetRequests service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest modifyNetworkInterfaceAttributeRequest) throws AmazonServiceException, AmazonClientException
Modifies the specified network interface attribute. You can specify only one attribute at a time.
modifyNetworkInterfaceAttributeRequest
- Container for the
necessary parameters to execute the ModifyNetworkInterfaceAttribute
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest unassignPrivateIpAddressesRequest) throws AmazonServiceException, AmazonClientException
Unassigns one or more secondary private IP addresses from a network interface.
unassignPrivateIpAddressesRequest
- Container for the necessary
parameters to execute the UnassignPrivateIpAddresses service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deregisterImage(DeregisterImageRequest deregisterImageRequest) throws AmazonServiceException, AmazonClientException
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.
deregisterImageRequest
- Container for the necessary parameters
to execute the DeregisterImage service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
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 .
modifyInstanceAttributeRequest
- Container for the necessary
parameters to execute the ModifyInstanceAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest) throws AmazonServiceException, AmazonClientException
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 .
createPlacementGroupRequest
- Container for the necessary
parameters to execute the CreatePlacementGroup service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNetworkAclsResult describeNetworkAcls(DescribeNetworkAclsRequest describeNetworkAclsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeNetworkAclsRequest
- Container for the necessary
parameters to execute the DescribeNetworkAcls service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest) throws AmazonServiceException, AmazonClientException
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.
getConsoleOutputRequest
- Container for the necessary parameters
to execute the GetConsoleOutput service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void detachNetworkInterface(DetachNetworkInterfaceRequest detachNetworkInterfaceRequest) throws AmazonServiceException, AmazonClientException
Detaches a network interface from an instance.
detachNetworkInterfaceRequest
- Container for the necessary
parameters to execute the DetachNetworkInterface service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest) throws AmazonServiceException, AmazonClientException
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 is fulfilled
, 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 is spot
.
describeSpotInstanceRequestsRequest
- Container for the necessary
parameters to execute the DescribeSpotInstanceRequests service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcAttributeResult describeVpcAttribute(DescribeVpcAttributeRequest describeVpcAttributeRequest) throws AmazonServiceException, AmazonClientException
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
describeVpcAttributeRequest
- Container for the necessary
parameters to execute the DescribeVpcAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws AmazonServiceException, AmazonClientException
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 .
importKeyPairRequest
- Container for the necessary parameters to
execute the ImportKeyPair service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateNatGatewayResult createNatGateway(CreateNatGatewayRequest createNatGatewayRequest) throws AmazonServiceException, AmazonClientException
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 .
createNatGatewayRequest
- Container for the necessary parameters
to execute the CreateNatGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateRouteResult createRoute(CreateRouteRequest createRouteRequest) throws AmazonServiceException, AmazonClientException
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 .
createRouteRequest
- Container for the necessary parameters to
execute the CreateRoute service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AllocateAddressResult allocateAddress(AllocateAddressRequest allocateAddressRequest) throws AmazonServiceException, AmazonClientException
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 .
allocateAddressRequest
- Container for the necessary parameters
to execute the AllocateAddress service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeScheduledInstancesResult describeScheduledInstances(DescribeScheduledInstancesRequest describeScheduledInstancesRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your Scheduled Instances.
describeScheduledInstancesRequest
- Container for the necessary
parameters to execute the DescribeScheduledInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DeleteNatGatewayResult deleteNatGateway(DeleteNatGatewayRequest deleteNatGatewayRequest) throws AmazonServiceException, AmazonClientException
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.
deleteNatGatewayRequest
- Container for the necessary parameters
to execute the DeleteNatGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void createNetworkAclEntry(CreateNetworkAclEntryRequest createNetworkAclEntryRequest) throws AmazonServiceException, AmazonClientException
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 .
createNetworkAclEntryRequest
- Container for the necessary
parameters to execute the CreateNetworkAclEntry service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.BundleInstanceResult bundleInstance(BundleInstanceRequest bundleInstanceRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: 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 .
bundleInstanceRequest
- Container for the necessary parameters to
execute the BundleInstance service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeSecurityGroups service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.StopInstancesResult stopInstances(StopInstancesRequest stopInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
stopInstancesRequest
- Container for the necessary parameters to
execute the StopInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeIdFormatResult describeIdFormat(DescribeIdFormatRequest describeIdFormatRequest) throws AmazonServiceException, AmazonClientException
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.
describeIdFormatRequest
- Container for the necessary parameters
to execute the DescribeIdFormat service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpnGatewayResult createVpnGateway(CreateVpnGatewayRequest createVpnGatewayRequest) throws AmazonServiceException, AmazonClientException
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 .
createVpnGatewayRequest
- Container for the necessary parameters
to execute the CreateVpnGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DetachVolumeResult detachVolume(DetachVolumeRequest detachVolumeRequest) throws AmazonServiceException, AmazonClientException
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 .
detachVolumeRequest
- Container for the necessary parameters to
execute the DetachVolume service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifyHostsResult modifyHosts(ModifyHostsRequest modifyHostsRequest) throws AmazonServiceException, AmazonClientException
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.
modifyHostsRequest
- Container for the necessary parameters to
execute the ModifyHosts service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RegisterImageResult registerImage(RegisterImageRequest registerImageRequest) throws AmazonServiceException, AmazonClientException
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 .
NOTE: 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 .
IMPORTANT: 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.
NOTE: You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
registerImageRequest
- Container for the necessary parameters to
execute the RegisterImage service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
Resets an attribute of an instance to its default value. To reset the
kernel
or ramdisk
, the instance must be in
a stopped state. To reset the sourceDestCheck
, the
instance can be either running or stopped.
The sourceDestCheck
attribute controls whether
source/destination checking is enabled. The default value is
true
, which means checking is enabled. This value must
be false
for a NAT instance to perform NAT. For more
information, see
NAT Instances
in the Amazon Virtual Private Cloud User Guide .
resetInstanceAttributeRequest
- Container for the necessary
parameters to execute the ResetInstanceAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws AmazonServiceException, AmazonClientException
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 .
createKeyPairRequest
- Container for the necessary parameters to
execute the CreateKeyPair service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AttachClassicLinkVpcResult attachClassicLinkVpc(AttachClassicLinkVpcRequest attachClassicLinkVpcRequest) throws AmazonServiceException, AmazonClientException
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.
attachClassicLinkVpcRequest
- Container for the necessary
parameters to execute the AttachClassicLinkVpc service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest) throws AmazonServiceException, AmazonClientException
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
NOTE: AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
modifyImageAttributeRequest
- Container for the necessary
parameters to execute the ModifyImageAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DisableVpcClassicLinkResult disableVpcClassicLink(DisableVpcClassicLinkRequest disableVpcClassicLinkRequest) throws AmazonServiceException, AmazonClientException
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
disableVpcClassicLinkRequest
- Container for the necessary
parameters to execute the DisableVpcClassicLink service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void disableVgwRoutePropagation(DisableVgwRoutePropagationRequest disableVgwRoutePropagationRequest) throws AmazonServiceException, AmazonClientException
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
disableVgwRoutePropagationRequest
- Container for the necessary
parameters to execute the DisableVgwRoutePropagation service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
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 .
resetSnapshotAttributeRequest
- Container for the necessary
parameters to execute the ResetSnapshotAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void assignPrivateIpAddresses(AssignPrivateIpAddressesRequest assignPrivateIpAddressesRequest) throws AmazonServiceException, AmazonClientException
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.
assignPrivateIpAddressesRequest
- Container for the necessary
parameters to execute the AssignPrivateIpAddresses service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.EnableVpcClassicLinkDnsSupportResult enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest enableVpcClassicLinkDnsSupportRequest) throws AmazonServiceException, AmazonClientException
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.
enableVpcClassicLinkDnsSupportRequest
- Container for the
necessary parameters to execute the EnableVpcClassicLinkDnsSupport
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifyVpcEndpointResult modifyVpcEndpoint(ModifyVpcEndpointRequest modifyVpcEndpointRequest) throws AmazonServiceException, AmazonClientException
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.
modifyVpcEndpointRequest
- Container for the necessary parameters
to execute the ModifyVpcEndpoint service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNetworkInterfacesResult describeNetworkInterfaces(DescribeNetworkInterfacesRequest describeNetworkInterfacesRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your network interfaces.
describeNetworkInterfacesRequest
- Container for the necessary
parameters to execute the DescribeNetworkInterfaces service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest) throws AmazonServiceException, AmazonClientException
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 .
IMPORTANT: Canceling a Spot instance request does not terminate running Spot instances associated with the request.
cancelSpotInstanceRequestsRequest
- Container for the necessary
parameters to execute the CancelSpotInstanceRequests service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.MonitorInstancesResult monitorInstances(MonitorInstancesRequest monitorInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
monitorInstancesRequest
- Container for the necessary parameters
to execute the MonitorInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest) throws AmazonServiceException, AmazonClientException
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 .
cancelReservedInstancesListingRequest
- Container for the
necessary parameters to execute the CancelReservedInstancesListing
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeKeyPairsRequest
- Container for the necessary parameters
to execute the DescribeKeyPairs service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AmazonServiceException, AmazonClientException
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, or none
.
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.
describeAccountAttributesRequest
- Container for the necessary
parameters to execute the DescribeAccountAttributes service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpnConnectionsResult describeVpnConnections(DescribeVpnConnectionsRequest describeVpnConnectionsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeVpnConnectionsRequest
- Container for the necessary
parameters to execute the DescribeVpnConnections service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
requestSpotInstancesRequest
- Container for the necessary
parameters to execute the RequestSpotInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelImportTaskResult cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest) throws AmazonServiceException, AmazonClientException
Cancels an in-process import virtual machine or import snapshot task.
cancelImportTaskRequest
- Container for the necessary parameters
to execute the CancelImportTask service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpnGatewaysResult describeVpnGateways(DescribeVpnGatewaysRequest describeVpnGatewaysRequest) throws AmazonServiceException, AmazonClientException
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 .
describeVpnGatewaysRequest
- Container for the necessary
parameters to execute the DescribeVpnGateways service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.GetConsoleScreenshotResult getConsoleScreenshot(GetConsoleScreenshotRequest getConsoleScreenshotRequest) throws AmazonServiceException, AmazonClientException
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is base64-encoded.
getConsoleScreenshotRequest
- Container for the necessary
parameters to execute the GetConsoleScreenshot service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateRouteTableResult createRouteTable(CreateRouteTableRequest createRouteTableRequest) throws AmazonServiceException, AmazonClientException
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 .
createRouteTableRequest
- Container for the necessary parameters
to execute the CreateRouteTable service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeScheduledInstanceAvailabilityResult describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest describeScheduledInstanceAvailabilityRequest) throws AmazonServiceException, AmazonClientException
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.
describeScheduledInstanceAvailabilityRequest
- Container for the
necessary parameters to execute the
DescribeScheduledInstanceAvailability service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest describeVpcClassicLinkDnsSupportRequest) throws AmazonServiceException, AmazonClientException
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.
describeVpcClassicLinkDnsSupportRequest
- Container for the
necessary parameters to execute the DescribeVpcClassicLinkDnsSupport
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
unmonitorInstancesRequest
- Container for the necessary
parameters to execute the UnmonitorInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteRouteTable(DeleteRouteTableRequest deleteRouteTableRequest) throws AmazonServiceException, AmazonClientException
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.
deleteRouteTableRequest
- Container for the necessary parameters
to execute the DeleteRouteTable service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifySpotFleetRequestResult modifySpotFleetRequest(ModifySpotFleetRequestRequest modifySpotFleetRequestRequest) throws AmazonServiceException, AmazonClientException
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 is diversified
, 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 is diversified
, 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.
modifySpotFleetRequestRequest
- Container for the necessary
parameters to execute the ModifySpotFleetRequest service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpcPeeringConnectionResult createVpcPeeringConnection(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest) throws AmazonServiceException, AmazonClientException
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 of failed
.
createVpcPeeringConnectionRequest
- Container for the necessary
parameters to execute the CreateVpcPeeringConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeDhcpOptionsResult describeDhcpOptions(DescribeDhcpOptionsRequest describeDhcpOptionsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeDhcpOptionsRequest
- Container for the necessary
parameters to execute the DescribeDhcpOptions service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifyVpcAttribute(ModifyVpcAttributeRequest modifyVpcAttributeRequest) throws AmazonServiceException, AmazonClientException
Modifies the specified attribute of the specified VPC.
modifyVpcAttributeRequest
- Container for the necessary
parameters to execute the ModifyVpcAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void modifySubnetAttribute(ModifySubnetAttributeRequest modifySubnetAttributeRequest) throws AmazonServiceException, AmazonClientException
Modifies a subnet attribute.
modifySubnetAttributeRequest
- Container for the necessary
parameters to execute the ModifySubnetAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest acceptVpcPeeringConnectionRequest) throws AmazonServiceException, AmazonClientException
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 the
DescribeVpcPeeringConnections
request to view your
outstanding VPC peering connection requests.
acceptVpcPeeringConnectionRequest
- Container for the necessary
parameters to execute the AcceptVpcPeeringConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CopyImageResult copyImage(CopyImageRequest copyImageRequest) throws AmazonServiceException, AmazonClientException
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 .
copyImageRequest
- Container for the necessary parameters to
execute the CopyImage service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteDhcpOptions(DeleteDhcpOptionsRequest deleteDhcpOptionsRequest) throws AmazonServiceException, AmazonClientException
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.
deleteDhcpOptionsRequest
- Container for the necessary parameters
to execute the DeleteDhcpOptions service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws AmazonServiceException, AmazonClientException
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 your MaxResults
value, then that number of results is returned along with a
NextToken
value that can be passed to a subsequent
DescribeVolumes
request to retrieve the remaining
results.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .
describeVolumesRequest
- Container for the necessary parameters
to execute the DescribeVolumes service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteNetworkAcl(DeleteNetworkAclRequest deleteNetworkAclRequest) throws AmazonServiceException, AmazonClientException
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.
deleteNetworkAclRequest
- Container for the necessary parameters
to execute the DeleteNetworkAcl service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteVpnConnection(DeleteVpnConnectionRequest deleteVpnConnectionRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVpnConnectionRequest
- Container for the necessary
parameters to execute the DeleteVpnConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelSpotFleetRequestsResult cancelSpotFleetRequests(CancelSpotFleetRequestsRequest cancelSpotFleetRequestsRequest) throws AmazonServiceException, AmazonClientException
Cancels the specified Spot fleet requests.
After you cancel a Spot fleet request, the Spot fleet launches no new
Spot instances. You must specify whether the Spot fleet should also
terminate its Spot instances. If you terminate the instances, the Spot
fleet request enters the cancelled_terminating
state.
Otherwise, the Spot fleet request enters the
cancelled_running
state and the instances continue to run
until they are interrupted or you terminate them manually.
cancelSpotFleetRequestsRequest
- Container for the necessary
parameters to execute the CancelSpotFleetRequests service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifyVpcPeeringConnectionOptionsResult modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest modifyVpcPeeringConnectionOptionsRequest) throws AmazonServiceException, AmazonClientException
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.
modifyVpcPeeringConnectionOptionsRequest
- Container for the
necessary parameters to execute the ModifyVpcPeeringConnectionOptions
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws AmazonServiceException, AmazonClientException
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, or
self
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, or
all
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 your MaxResults
value, then that number of results is returned along with a
NextToken
value that can be passed to a subsequent
DescribeSnapshots
request to retrieve the remaining
results.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide .
describeSnapshotsRequest
- Container for the necessary parameters
to execute the DescribeSnapshots service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribePrefixListsResult describePrefixLists(DescribePrefixListsRequest describePrefixListsRequest) throws AmazonServiceException, AmazonClientException
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.
describePrefixListsRequest
- Container for the necessary
parameters to execute the DescribePrefixLists service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest replaceNetworkAclEntryRequest) throws AmazonServiceException, AmazonClientException
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 .
replaceNetworkAclEntryRequest
- Container for the necessary
parameters to execute the ReplaceNetworkAclEntry service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateFlowLogsResult createFlowLogs(CreateFlowLogsRequest createFlowLogsRequest) throws AmazonServiceException, AmazonClientException
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.
createFlowLogsRequest
- Container for the necessary parameters to
execute the CreateFlowLogs service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteInternetGateway(DeleteInternetGatewayRequest deleteInternetGatewayRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
deleteInternetGatewayRequest
- Container for the necessary
parameters to execute the DeleteInternetGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest) throws AmazonServiceException, AmazonClientException
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
, or insufficient-data
. If all
checks pass, the overall status of the volume is ok
. If
the check fails, the overall status is impaired
. If the
status is insufficient-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 be
potential-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 shows
potential-data-inconsistency
, then the action shows
enable-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.
NOTE: 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.)
describeVolumeStatusRequest
- Container for the necessary
parameters to execute the DescribeVolumeStatus service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Deletes the data feed for Spot instances.
deleteSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the DeleteSpotDatafeedSubscription
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ModifyInstancePlacementResult modifyInstancePlacement(ModifyInstancePlacementRequest modifyInstancePlacementRequest) throws AmazonServiceException, AmazonClientException
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
or dedicated
.
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.
modifyInstancePlacementRequest
- Container for the necessary
parameters to execute the ModifyInstancePlacement service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest) throws AmazonServiceException, AmazonClientException
Cancels a bundling operation for an instance store-backed Windows instance.
cancelBundleTaskRequest
- Container for the necessary parameters
to execute the CancelBundleTask service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateInternetGatewayResult createInternetGateway(CreateInternetGatewayRequest createInternetGatewayRequest) throws AmazonServiceException, AmazonClientException
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 .
createInternetGatewayRequest
- Container for the necessary
parameters to execute the CreateInternetGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RequestSpotFleetResult requestSpotFleet(RequestSpotFleetRequest requestSpotFleetRequest) throws AmazonServiceException, AmazonClientException
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 .
requestSpotFleetRequest
- Container for the necessary parameters
to execute the RequestSpotFleet service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
describeReservedInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedInstances service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest describeSecurityGroupReferencesRequest) throws AmazonServiceException, AmazonClientException
[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.
describeSecurityGroupReferencesRequest
- Container for the
necessary parameters to execute the DescribeSecurityGroupReferences
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImportSnapshotTasksResult describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest describeImportSnapshotTasksRequest) throws AmazonServiceException, AmazonClientException
Describes your import snapshot tasks.
describeImportSnapshotTasksRequest
- Container for the necessary
parameters to execute the DescribeImportSnapshotTasks service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.EnableVpcClassicLinkResult enableVpcClassicLink(EnableVpcClassicLinkRequest enableVpcClassicLinkRequest) throws AmazonServiceException, AmazonClientException
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 the 10.0.0.0/16
and
10.1.0.0/16
IP address ranges. For more information, see
ClassicLink
in the Amazon Elastic Compute Cloud User Guide.
enableVpcClassicLinkRequest
- Container for the necessary
parameters to execute the EnableVpcClassicLink service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteVpc(DeleteVpcRequest deleteVpcRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVpcRequest
- Container for the necessary parameters to
execute the DeleteVpc service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeFlowLogsResult describeFlowLogs(DescribeFlowLogsRequest describeFlowLogsRequest) throws AmazonServiceException, AmazonClientException
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.
describeFlowLogsRequest
- Container for the necessary parameters
to execute the DescribeFlowLogs service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateSubnetResult createSubnet(CreateSubnetRequest createSubnetRequest) throws AmazonServiceException, AmazonClientException
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).
IMPORTANT: 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 .
createSubnetRequest
- Container for the necessary parameters to
execute the CreateSubnet service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest resetNetworkInterfaceAttributeRequest) throws AmazonServiceException, AmazonClientException
Resets a network interface attribute. You can specify only one attribute at a time.
resetNetworkInterfaceAttributeRequest
- Container for the
necessary parameters to execute the ResetNetworkInterfaceAttribute
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ReleaseHostsResult releaseHosts(ReleaseHostsRequest releaseHostsRequest) throws AmazonServiceException, AmazonClientException
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.
releaseHostsRequest
- Container for the necessary parameters to
execute the ReleaseHosts service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest) throws AmazonServiceException, AmazonClientException
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.
reportInstanceStatusRequest
- Container for the necessary
parameters to execute the ReportInstanceStatus service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNatGatewaysResult describeNatGateways(DescribeNatGatewaysRequest describeNatGatewaysRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of the your NAT gateways.
describeNatGatewaysRequest
- Container for the necessary
parameters to execute the DescribeNatGateways service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your VPC peering connections.
describeVpcPeeringConnectionsRequest
- Container for the
necessary parameters to execute the DescribeVpcPeeringConnections
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVolumeResult createVolume(CreateVolumeRequest createVolumeRequest) throws AmazonServiceException, AmazonClientException
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 .
createVolumeRequest
- Container for the necessary parameters to
execute the CreateVolume service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportVolumeResult importVolume(ImportVolumeRequest importVolumeRequest) throws AmazonServiceException, AmazonClientException
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 .
importVolumeRequest
- Container for the necessary parameters to
execute the ImportVolume service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest) throws AmazonServiceException, AmazonClientException
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 .
createInstanceExportTaskRequest
- Container for the necessary
parameters to execute the CreateInstanceExportTask service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified key pair, by removing the public key from Amazon EC2.
deleteKeyPairRequest
- Container for the necessary parameters to
execute the DeleteKeyPair service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAddressesResult describeAddresses(DescribeAddressesRequest describeAddressesRequest) throws AmazonServiceException, AmazonClientException
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 .
describeAddressesRequest
- Container for the necessary parameters
to execute the DescribeAddresses service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteRoute(DeleteRouteRequest deleteRouteRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified route from the specified route table.
deleteRouteRequest
- Container for the necessary parameters to
execute the DeleteRoute service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
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.
revokeSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeSecurityGroupIngress service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DeleteVpcEndpointsResult deleteVpcEndpoints(DeleteVpcEndpointsRequest deleteVpcEndpointsRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVpcEndpointsRequest
- Container for the necessary
parameters to execute the DeleteVpcEndpoints service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void releaseAddress(ReleaseAddressRequest releaseAddressRequest) throws AmazonServiceException, AmazonClientException
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
).
releaseAddressRequest
- Container for the necessary parameters to
execute the ReleaseAddress service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide .
describeSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the DescribeSpotDatafeedSubscription
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DeleteFlowLogsResult deleteFlowLogs(DeleteFlowLogsRequest deleteFlowLogsRequest) throws AmazonServiceException, AmazonClientException
Deletes one or more flow logs.
deleteFlowLogsRequest
- Container for the necessary parameters to
execute the DeleteFlowLogs service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeRegionsRequest
- Container for the necessary parameters
to execute the DescribeRegions service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteNetworkAclEntry(DeleteNetworkAclEntryRequest deleteNetworkAclEntryRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
deleteNetworkAclEntryRequest
- Container for the necessary
parameters to execute the DeleteNetworkAclEntry service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest) throws AmazonServiceException, AmazonClientException
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 .
describeConversionTasksRequest
- Container for the necessary
parameters to execute the DescribeConversionTasks service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest) throws AmazonServiceException, AmazonClientException
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 .
purchaseReservedInstancesOfferingRequest
- Container for the
necessary parameters to execute the PurchaseReservedInstancesOffering
service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void disassociateAddress(DisassociateAddressRequest disassociateAddressRequest) throws AmazonServiceException, AmazonClientException
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.
disassociateAddressRequest
- Container for the necessary
parameters to execute the DisassociateAddress service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
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 or
DependencyViolation
in EC2-VPC.
deleteSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteSecurityGroup service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void rebootInstances(RebootInstancesRequest rebootInstancesRequest) throws AmazonServiceException, AmazonClientException
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 .
rebootInstancesRequest
- Container for the necessary parameters
to execute the RebootInstances service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.RejectVpcPeeringConnectionResult rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest rejectVpcPeeringConnectionRequest) throws AmazonServiceException, AmazonClientException
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.
rejectVpcPeeringConnectionRequest
- Container for the necessary
parameters to execute the RejectVpcPeeringConnection service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcEndpointServicesResult describeVpcEndpointServices(DescribeVpcEndpointServicesRequest describeVpcEndpointServicesRequest) throws AmazonServiceException, AmazonClientException
Describes all supported AWS services that can be specified when creating a VPC endpoint.
describeVpcEndpointServicesRequest
- Container for the necessary
parameters to execute the DescribeVpcEndpointServices service method
on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void createTags(CreateTagsRequest createTagsRequest) throws AmazonServiceException, AmazonClientException
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 .
createTagsRequest
- Container for the necessary parameters to
execute the CreateTags service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void associateDhcpOptions(AssociateDhcpOptionsRequest associateDhcpOptionsRequest) throws AmazonServiceException, AmazonClientException
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 .
associateDhcpOptionsRequest
- Container for the necessary
parameters to execute the AssociateDhcpOptions service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void createVpnConnectionRoute(CreateVpnConnectionRouteRequest createVpnConnectionRouteRequest) throws AmazonServiceException, AmazonClientException
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 .
createVpnConnectionRouteRequest
- Container for the necessary
parameters to execute the CreateVpnConnectionRoute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DetachClassicLinkVpcResult detachClassicLinkVpc(DetachClassicLinkVpcRequest detachClassicLinkVpcRequest) throws AmazonServiceException, AmazonClientException
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.
detachClassicLinkVpcRequest
- Container for the necessary
parameters to execute the DetachClassicLinkVpc service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateCustomerGatewayResult createCustomerGateway(CreateCustomerGatewayRequest createCustomerGatewayRequest) throws AmazonServiceException, AmazonClientException
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).
NOTE: 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 the eu-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 .
IMPORTANT: 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.
createCustomerGatewayRequest
- Container for the necessary
parameters to execute the CreateCustomerGateway service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
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 .
describeSnapshotAttributeRequest
- Container for the necessary
parameters to execute the DescribeSnapshotAttribute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeCustomerGatewaysResult describeCustomerGateways(DescribeCustomerGatewaysRequest describeCustomerGatewaysRequest) throws AmazonServiceException, AmazonClientException
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 .
describeCustomerGatewaysRequest
- Container for the necessary
parameters to execute the DescribeCustomerGateways service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.MoveAddressToVpcResult moveAddressToVpc(MoveAddressToVpcRequest moveAddressToVpcRequest) throws AmazonServiceException, AmazonClientException
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.
moveAddressToVpcRequest
- Container for the necessary parameters
to execute the MoveAddressToVpc service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest deleteVpnConnectionRouteRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVpnConnectionRouteRequest
- Container for the necessary
parameters to execute the DeleteVpnConnectionRoute service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteVpnGateway(DeleteVpnGatewayRequest deleteVpnGatewayRequest) throws AmazonServiceException, AmazonClientException
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.
deleteVpnGatewayRequest
- Container for the necessary parameters
to execute the DeleteVpnGateway service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest revokeSecurityGroupEgressRequest) throws AmazonServiceException, AmazonClientException
[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.
revokeSecurityGroupEgressRequest
- Container for the necessary
parameters to execute the RevokeSecurityGroupEgress service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of your bundling tasks.
NOTE: 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.
describeBundleTasksRequest
- Container for the necessary
parameters to execute the DescribeBundleTasks service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpcResult createVpc(CreateVpcRequest createVpcRequest) throws AmazonServiceException, AmazonClientException
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 .
createVpcRequest
- Container for the necessary parameters to
execute the CreateVpc service method on AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AssociateRouteTableResult associateRouteTable(AssociateRouteTableRequest associateRouteTableRequest) throws AmazonServiceException, AmazonClientException
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 .
associateRouteTableRequest
- Container for the necessary
parameters to execute the AssociateRouteTable service method on
AmazonEC2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportSnapshotResult importSnapshot() throws AmazonServiceException, AmazonClientException
Imports a disk into an EBS snapshot.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesModificationsResult describeReservedInstancesModifications() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAvailabilityZonesResult describeAvailabilityZones() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DisableVpcClassicLinkDnsSupportResult disableVpcClassicLinkDnsSupport() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcClassicLinkResult describeVpcClassicLink() throws AmazonServiceException, AmazonClientException
Describes the ClassicLink status of one or more VPCs.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInstancesResult describeInstances() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.ImportImageResult importImage() throws AmazonServiceException, AmazonClientException
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeMovingAddressesResult describeMovingAddresses() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcEndpointsResult describeVpcEndpoints() throws AmazonServiceException, AmazonClientException
Describes one or more of your VPC endpoints.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeClassicLinkInstancesResult describeClassicLinkInstances() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImagesResult describeImages() throws AmazonServiceException, AmazonClientException
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.
NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcsResult describeVpcs() throws AmazonServiceException, AmazonClientException
Describes one or more of your VPCs.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotPriceHistoryResult describeSpotPriceHistory() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImportImageTasksResult describeImportImageTasks() throws AmazonServiceException, AmazonClientException
Displays details about an import virtual machine or import snapshot tasks that are already created.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInternetGatewaysResult describeInternetGateways() throws AmazonServiceException, AmazonClientException
Describes one or more of your Internet gateways.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeHostsResult describeHosts() throws AmazonServiceException, AmazonClientException
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
.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSubnetsResult describeSubnets() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeRouteTablesResult describeRouteTables() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeInstanceStatusResult describeInstanceStatus() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeExportTasksResult describeExportTasks() throws AmazonServiceException, AmazonClientException
Describes one or more of your export tasks.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeTagsResult describeTags() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesListingsResult describeReservedInstancesListings() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribePlacementGroupsResult describePlacementGroups() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotFleetRequestsResult describeSpotFleetRequests() throws AmazonServiceException, AmazonClientException
Describes your Spot fleet requests.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNetworkAclsResult describeNetworkAcls() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotInstanceRequestsResult describeSpotInstanceRequests() throws AmazonServiceException, AmazonClientException
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 is fulfilled
, 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 is spot
.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AllocateAddressResult allocateAddress() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeScheduledInstancesResult describeScheduledInstances() throws AmazonServiceException, AmazonClientException
Describes one or more of your Scheduled Instances.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSecurityGroupsResult describeSecurityGroups() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeIdFormatResult describeIdFormat() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.EnableVpcClassicLinkDnsSupportResult enableVpcClassicLinkDnsSupport() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNetworkInterfacesResult describeNetworkInterfaces() throws AmazonServiceException, AmazonClientException
Describes one or more of your network interfaces.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeKeyPairsResult describeKeyPairs() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAccountAttributesResult describeAccountAttributes() throws AmazonServiceException, AmazonClientException
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, or none
.
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpnConnectionsResult describeVpnConnections() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CancelImportTaskResult cancelImportTask() throws AmazonServiceException, AmazonClientException
Cancels an in-process import virtual machine or import snapshot task.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpnGatewaysResult describeVpnGateways() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateVpcPeeringConnectionResult createVpcPeeringConnection() throws AmazonServiceException, AmazonClientException
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 of failed
.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeDhcpOptionsResult describeDhcpOptions() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection() throws AmazonServiceException, AmazonClientException
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 the
DescribeVpcPeeringConnections
request to view your
outstanding VPC peering connection requests.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVolumesResult describeVolumes() throws AmazonServiceException, AmazonClientException
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 your MaxResults
value, then that number of results is returned along with a
NextToken
value that can be passed to a subsequent
DescribeVolumes
request to retrieve the remaining
results.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotsResult describeSnapshots() throws AmazonServiceException, AmazonClientException
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, or
self
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, or
all
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 your MaxResults
value, then that number of results is returned along with a
NextToken
value that can be passed to a subsequent
DescribeSnapshots
request to retrieve the remaining
results.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribePrefixListsResult describePrefixLists() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVolumeStatusResult describeVolumeStatus() throws AmazonServiceException, AmazonClientException
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
, or insufficient-data
. If all
checks pass, the overall status of the volume is ok
. If
the check fails, the overall status is impaired
. If the
status is insufficient-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 be
potential-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 shows
potential-data-inconsistency
, then the action shows
enable-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.
NOTE: 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.)
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void deleteSpotDatafeedSubscription() throws AmazonServiceException, AmazonClientException
Deletes the data feed for Spot instances.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.CreateInternetGatewayResult createInternetGateway() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeReservedInstancesResult describeReservedInstances() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeImportSnapshotTasksResult describeImportSnapshotTasks() throws AmazonServiceException, AmazonClientException
Describes your import snapshot tasks.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeFlowLogsResult describeFlowLogs() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeNatGatewaysResult describeNatGateways() throws AmazonServiceException, AmazonClientException
Describes one or more of the your NAT gateways.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections() throws AmazonServiceException, AmazonClientException
Describes one or more of your VPC peering connections.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeAddressesResult describeAddresses() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.void revokeSecurityGroupIngress() throws AmazonServiceException, AmazonClientException
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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription() throws AmazonServiceException, AmazonClientException
Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeRegionsResult describeRegions() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeConversionTasksResult describeConversionTasks() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeVpcEndpointServicesResult describeVpcEndpointServices() throws AmazonServiceException, AmazonClientException
Describes all supported AWS services that can be specified when creating a VPC endpoint.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeCustomerGatewaysResult describeCustomerGateways() throws AmazonServiceException, AmazonClientException
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 .
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.DescribeBundleTasksResult describeBundleTasks() throws AmazonServiceException, AmazonClientException
Describes one or more of your bundling tasks.
NOTE: 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.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server side issue.<X extends AmazonWebServiceRequest> DryRunResult<X> dryRun(DryRunSupportedRequest<X> request) throws AmazonServiceException, AmazonClientException
request
- The request object for any AmazonEC2 operation suppored with
dry-run.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.AmazonServiceException
- If an error response is returned by AmazonEC2 indicating
either a problem with the data in the request, or a server
side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.