AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface EC2Client extends AutoCloseable
builder()
method.
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 | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AcceptReservedInstancesExchangeQuoteResponse |
acceptReservedInstancesExchangeQuote(AcceptReservedInstancesExchangeQuoteRequest acceptReservedInstancesExchangeQuoteRequest) |
Accepts the Convertible Reserved Instance exchange quote described in the
GetReservedInstancesExchangeQuote call.
|
default AcceptVpcPeeringConnectionResponse |
acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest acceptVpcPeeringConnectionRequest) |
Accept a VPC peering connection request.
|
default AllocateAddressResponse |
allocateAddress(AllocateAddressRequest allocateAddressRequest) |
Acquires an Elastic IP address.
|
default AllocateHostsResponse |
allocateHosts(AllocateHostsRequest allocateHostsRequest) |
Allocates a Dedicated Host to your account.
|
default AssignIpv6AddressesResponse |
assignIpv6Addresses(AssignIpv6AddressesRequest assignIpv6AddressesRequest) |
Assigns one or more IPv6 addresses to the specified network interface.
|
default AssignPrivateIpAddressesResponse |
assignPrivateIpAddresses(AssignPrivateIpAddressesRequest assignPrivateIpAddressesRequest) |
Assigns one or more secondary private IP addresses to the specified network interface.
|
default AssociateAddressResponse |
associateAddress(AssociateAddressRequest associateAddressRequest) |
Associates an Elastic IP address with an instance or a network interface.
|
default AssociateDhcpOptionsResponse |
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.
|
default AssociateIamInstanceProfileResponse |
associateIamInstanceProfile(AssociateIamInstanceProfileRequest associateIamInstanceProfileRequest) |
Associates an IAM instance profile with a running or stopped instance.
|
default AssociateRouteTableResponse |
associateRouteTable(AssociateRouteTableRequest associateRouteTableRequest) |
Associates a subnet with a route table.
|
default AssociateSubnetCidrBlockResponse |
associateSubnetCidrBlock(AssociateSubnetCidrBlockRequest associateSubnetCidrBlockRequest) |
Associates a CIDR block with your subnet.
|
default AssociateVpcCidrBlockResponse |
associateVpcCidrBlock(AssociateVpcCidrBlockRequest associateVpcCidrBlockRequest) |
Associates a CIDR block with your VPC.
|
default AttachClassicLinkVpcResponse |
attachClassicLinkVpc(AttachClassicLinkVpcRequest attachClassicLinkVpcRequest) |
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups.
|
default AttachInternetGatewayResponse |
attachInternetGateway(AttachInternetGatewayRequest attachInternetGatewayRequest) |
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.
|
default AttachNetworkInterfaceResponse |
attachNetworkInterface(AttachNetworkInterfaceRequest attachNetworkInterfaceRequest) |
Attaches a network interface to an instance.
|
default AttachVolumeResponse |
attachVolume(AttachVolumeRequest attachVolumeRequest) |
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device
name.
|
default AttachVpnGatewayResponse |
attachVpnGateway(AttachVpnGatewayRequest attachVpnGatewayRequest) |
Attaches a virtual private gateway to a VPC.
|
default AuthorizeSecurityGroupEgressResponse |
authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest authorizeSecurityGroupEgressRequest) |
[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.
|
default AuthorizeSecurityGroupIngressResponse |
authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest) |
Adds one or more ingress rules to a security group.
|
static EC2ClientBuilder |
builder() |
Create a builder that can be used to configure and create a
EC2Client . |
default BundleInstanceResponse |
bundleInstance(BundleInstanceRequest bundleInstanceRequest) |
Bundles an Amazon instance store-backed Windows instance.
|
default CancelBundleTaskResponse |
cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest) |
Cancels a bundling operation for an instance store-backed Windows instance.
|
default CancelConversionTaskResponse |
cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest) |
Cancels an active conversion task.
|
default CancelExportTaskResponse |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) |
Cancels an active export task.
|
default CancelImportTaskResponse |
cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest) |
Cancels an in-process import virtual machine or import snapshot task.
|
default CancelReservedInstancesListingResponse |
cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest) |
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
|
default CancelSpotFleetRequestsResponse |
cancelSpotFleetRequests(CancelSpotFleetRequestsRequest cancelSpotFleetRequestsRequest) |
Cancels the specified Spot fleet requests.
|
default CancelSpotInstanceRequestsResponse |
cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest) |
Cancels one or more Spot instance requests.
|
default ConfirmProductInstanceResponse |
confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest) |
Determines whether a product code is associated with an instance.
|
default CopyImageResponse |
copyImage(CopyImageRequest copyImageRequest) |
Initiates the copy of an AMI from the specified source region to the current region.
|
default CopySnapshotResponse |
copySnapshot(CopySnapshotRequest copySnapshotRequest) |
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.
|
static EC2Client |
create() |
Create a
EC2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateCustomerGatewayResponse |
createCustomerGateway(CreateCustomerGatewayRequest createCustomerGatewayRequest) |
Provides information to AWS about your VPN customer gateway device.
|
default CreateDhcpOptionsResponse |
createDhcpOptions(CreateDhcpOptionsRequest createDhcpOptionsRequest) |
Creates a set of DHCP options for your VPC.
|
default CreateEgressOnlyInternetGatewayResponse |
createEgressOnlyInternetGateway(CreateEgressOnlyInternetGatewayRequest createEgressOnlyInternetGatewayRequest) |
[IPv6 only] Creates an egress-only Internet gateway for your VPC.
|
default CreateFlowLogsResponse |
createFlowLogs(CreateFlowLogsRequest createFlowLogsRequest) |
Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC.
|
default CreateFpgaImageResponse |
createFpgaImage(CreateFpgaImageRequest createFpgaImageRequest) |
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
|
default CreateImageResponse |
createImage(CreateImageRequest createImageRequest) |
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
|
default CreateInstanceExportTaskResponse |
createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest) |
Exports a running or stopped instance to an S3 bucket.
|
default CreateInternetGatewayResponse |
createInternetGateway(CreateInternetGatewayRequest createInternetGatewayRequest) |
Creates an Internet gateway for use with a VPC.
|
default CreateKeyPairResponse |
createKeyPair(CreateKeyPairRequest createKeyPairRequest) |
Creates a 2048-bit RSA key pair with the specified name.
|
default CreateNatGatewayResponse |
createNatGateway(CreateNatGatewayRequest createNatGatewayRequest) |
Creates a NAT gateway in the specified subnet.
|
default CreateNetworkAclResponse |
createNetworkAcl(CreateNetworkAclRequest createNetworkAclRequest) |
Creates a network ACL in a VPC.
|
default CreateNetworkAclEntryResponse |
createNetworkAclEntry(CreateNetworkAclEntryRequest createNetworkAclEntryRequest) |
Creates an entry (a rule) in a network ACL with the specified rule number.
|
default CreateNetworkInterfaceResponse |
createNetworkInterface(CreateNetworkInterfaceRequest createNetworkInterfaceRequest) |
Creates a network interface in the specified subnet.
|
default CreatePlacementGroupResponse |
createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest) |
Creates a placement group that you launch cluster instances into.
|
default CreateReservedInstancesListingResponse |
createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest) |
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.
|
default CreateRouteResponse |
createRoute(CreateRouteRequest createRouteRequest) |
Creates a route in a route table within a VPC.
|
default CreateRouteTableResponse |
createRouteTable(CreateRouteTableRequest createRouteTableRequest) |
Creates a route table for the specified VPC.
|
default CreateSecurityGroupResponse |
createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) |
Creates a security group.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest) |
Creates a snapshot of an EBS volume and stores it in Amazon S3.
|
default CreateSpotDatafeedSubscriptionResponse |
createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest) |
Creates a data feed for Spot instances, enabling you to view Spot instance usage logs.
|
default CreateSubnetResponse |
createSubnet(CreateSubnetRequest createSubnetRequest) |
Creates a subnet in an existing VPC.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest) |
Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources.
|
default CreateVolumeResponse |
createVolume(CreateVolumeRequest createVolumeRequest) |
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
|
default CreateVpcResponse |
createVpc(CreateVpcRequest createVpcRequest) |
Creates a VPC with the specified IPv4 CIDR block.
|
default CreateVpcEndpointResponse |
createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) |
Creates a VPC endpoint for a specified AWS service.
|
default CreateVpcPeeringConnectionResponse |
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.
|
default CreateVpnConnectionResponse |
createVpnConnection(CreateVpnConnectionRequest createVpnConnectionRequest) |
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway.
|
default CreateVpnConnectionRouteResponse |
createVpnConnectionRoute(CreateVpnConnectionRouteRequest createVpnConnectionRouteRequest) |
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN
customer gateway.
|
default CreateVpnGatewayResponse |
createVpnGateway(CreateVpnGatewayRequest createVpnGatewayRequest) |
Creates a virtual private gateway.
|
default DeleteCustomerGatewayResponse |
deleteCustomerGateway(DeleteCustomerGatewayRequest deleteCustomerGatewayRequest) |
Deletes the specified customer gateway.
|
default DeleteDhcpOptionsResponse |
deleteDhcpOptions(DeleteDhcpOptionsRequest deleteDhcpOptionsRequest) |
Deletes the specified set of DHCP options.
|
default DeleteEgressOnlyInternetGatewayResponse |
deleteEgressOnlyInternetGateway(DeleteEgressOnlyInternetGatewayRequest deleteEgressOnlyInternetGatewayRequest) |
Deletes an egress-only Internet gateway.
|
default DeleteFlowLogsResponse |
deleteFlowLogs(DeleteFlowLogsRequest deleteFlowLogsRequest) |
Deletes one or more flow logs.
|
default DeleteInternetGatewayResponse |
deleteInternetGateway(DeleteInternetGatewayRequest deleteInternetGatewayRequest) |
Deletes the specified Internet gateway.
|
default DeleteKeyPairResponse |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) |
Deletes the specified key pair, by removing the public key from Amazon EC2.
|
default DeleteNatGatewayResponse |
deleteNatGateway(DeleteNatGatewayRequest deleteNatGatewayRequest) |
Deletes the specified NAT gateway.
|
default DeleteNetworkAclResponse |
deleteNetworkAcl(DeleteNetworkAclRequest deleteNetworkAclRequest) |
Deletes the specified network ACL.
|
default DeleteNetworkAclEntryResponse |
deleteNetworkAclEntry(DeleteNetworkAclEntryRequest deleteNetworkAclEntryRequest) |
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
|
default DeleteNetworkInterfaceResponse |
deleteNetworkInterface(DeleteNetworkInterfaceRequest deleteNetworkInterfaceRequest) |
Deletes the specified network interface.
|
default DeletePlacementGroupResponse |
deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest) |
Deletes the specified placement group.
|
default DeleteRouteResponse |
deleteRoute(DeleteRouteRequest deleteRouteRequest) |
Deletes the specified route from the specified route table.
|
default DeleteRouteTableResponse |
deleteRouteTable(DeleteRouteTableRequest deleteRouteTableRequest) |
Deletes the specified route table.
|
default DeleteSecurityGroupResponse |
deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) |
Deletes a security group.
|
default DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) |
Deletes the specified snapshot.
|
default DeleteSpotDatafeedSubscriptionResponse |
deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest) |
Deletes the data feed for Spot instances.
|
default DeleteSubnetResponse |
deleteSubnet(DeleteSubnetRequest deleteSubnetRequest) |
Deletes the specified subnet.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest) |
Deletes the specified set of tags from the specified set of resources.
|
default DeleteVolumeResponse |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest) |
Deletes the specified EBS volume.
|
default DeleteVpcResponse |
deleteVpc(DeleteVpcRequest deleteVpcRequest) |
Deletes the specified VPC.
|
default DeleteVpcEndpointsResponse |
deleteVpcEndpoints(DeleteVpcEndpointsRequest deleteVpcEndpointsRequest) |
Deletes one or more specified VPC endpoints.
|
default DeleteVpcPeeringConnectionResponse |
deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) |
Deletes a VPC peering connection.
|
default DeleteVpnConnectionResponse |
deleteVpnConnection(DeleteVpnConnectionRequest deleteVpnConnectionRequest) |
Deletes the specified VPN connection.
|
default DeleteVpnConnectionRouteResponse |
deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest deleteVpnConnectionRouteRequest) |
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway
and a VPN customer gateway.
|
default DeleteVpnGatewayResponse |
deleteVpnGateway(DeleteVpnGatewayRequest deleteVpnGatewayRequest) |
Deletes the specified virtual private gateway.
|
default DeregisterImageResponse |
deregisterImage(DeregisterImageRequest deregisterImageRequest) |
Deregisters the specified AMI.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) |
Describes attributes of your AWS account.
|
default DescribeAddressesResponse |
describeAddresses(DescribeAddressesRequest describeAddressesRequest) |
Describes one or more of your Elastic IP addresses.
|
default DescribeAvailabilityZonesResponse |
describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest) |
Describes one or more of the Availability Zones that are available to you.
|
default DescribeBundleTasksResponse |
describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest) |
Describes one or more of your bundling tasks.
|
default DescribeClassicLinkInstancesResponse |
describeClassicLinkInstances(DescribeClassicLinkInstancesRequest describeClassicLinkInstancesRequest) |
Describes one or more of your linked EC2-Classic instances.
|
default DescribeConversionTasksResponse |
describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest) |
Describes one or more of your conversion tasks.
|
default DescribeCustomerGatewaysResponse |
describeCustomerGateways(DescribeCustomerGatewaysRequest describeCustomerGatewaysRequest) |
Describes one or more of your VPN customer gateways.
|
default DescribeDhcpOptionsResponse |
describeDhcpOptions(DescribeDhcpOptionsRequest describeDhcpOptionsRequest) |
Describes one or more of your DHCP options sets.
|
default DescribeEgressOnlyInternetGatewaysResponse |
describeEgressOnlyInternetGateways(DescribeEgressOnlyInternetGatewaysRequest describeEgressOnlyInternetGatewaysRequest) |
Describes one or more of your egress-only Internet gateways.
|
default DescribeExportTasksResponse |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) |
Describes one or more of your export tasks.
|
default DescribeFlowLogsResponse |
describeFlowLogs(DescribeFlowLogsRequest describeFlowLogsRequest) |
Describes one or more flow logs.
|
default DescribeFpgaImagesResponse |
describeFpgaImages(DescribeFpgaImagesRequest describeFpgaImagesRequest) |
Describes one or more available Amazon FPGA Images (AFIs).
|
default DescribeHostReservationOfferingsResponse |
describeHostReservationOfferings(DescribeHostReservationOfferingsRequest describeHostReservationOfferingsRequest) |
Describes the Dedicated Host Reservations that are available to purchase.
|
default DescribeHostReservationsResponse |
describeHostReservations(DescribeHostReservationsRequest describeHostReservationsRequest) |
Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.
|
default DescribeHostsResponse |
describeHosts(DescribeHostsRequest describeHostsRequest) |
Describes one or more of your Dedicated Hosts.
|
default DescribeIamInstanceProfileAssociationsResponse |
describeIamInstanceProfileAssociations(DescribeIamInstanceProfileAssociationsRequest describeIamInstanceProfileAssociationsRequest) |
Describes your IAM instance profile associations.
|
default DescribeIdentityIdFormatResponse |
describeIdentityIdFormat(DescribeIdentityIdFormatRequest describeIdentityIdFormatRequest) |
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user.
|
default DescribeIdFormatResponse |
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.
|
default DescribeImageAttributeResponse |
describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest) |
Describes the specified attribute of the specified AMI.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest) |
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you.
|
default DescribeImportImageTasksResponse |
describeImportImageTasks(DescribeImportImageTasksRequest describeImportImageTasksRequest) |
Displays details about an import virtual machine or import snapshot tasks that are already created.
|
default DescribeImportSnapshotTasksResponse |
describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest describeImportSnapshotTasksRequest) |
Describes your import snapshot tasks.
|
default DescribeInstanceAttributeResponse |
describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) |
Describes the specified attribute of the specified instance.
|
default DescribeInstancesResponse |
describeInstances(DescribeInstancesRequest describeInstancesRequest) |
Describes one or more of your instances.
|
default DescribeInstanceStatusResponse |
describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest) |
Describes the status of one or more instances.
|
default DescribeInternetGatewaysResponse |
describeInternetGateways(DescribeInternetGatewaysRequest describeInternetGatewaysRequest) |
Describes one or more of your Internet gateways.
|
default DescribeKeyPairsResponse |
describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest) |
Describes one or more of your key pairs.
|
default DescribeMovingAddressesResponse |
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.
|
default DescribeNatGatewaysResponse |
describeNatGateways(DescribeNatGatewaysRequest describeNatGatewaysRequest) |
Describes one or more of the your NAT gateways.
|
default DescribeNetworkAclsResponse |
describeNetworkAcls(DescribeNetworkAclsRequest describeNetworkAclsRequest) |
Describes one or more of your network ACLs.
|
default DescribeNetworkInterfaceAttributeResponse |
describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest describeNetworkInterfaceAttributeRequest) |
Describes a network interface attribute.
|
default DescribeNetworkInterfacesResponse |
describeNetworkInterfaces(DescribeNetworkInterfacesRequest describeNetworkInterfacesRequest) |
Describes one or more of your network interfaces.
|
default DescribePlacementGroupsResponse |
describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest) |
Describes one or more of your placement groups.
|
default DescribePrefixListsResponse |
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.
|
default DescribeRegionsResponse |
describeRegions(DescribeRegionsRequest describeRegionsRequest) |
Describes one or more regions that are currently available to you.
|
default DescribeReservedInstancesResponse |
describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) |
Describes one or more of the Reserved Instances that you purchased.
|
default DescribeReservedInstancesListingsResponse |
describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest) |
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
|
default DescribeReservedInstancesModificationsResponse |
describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest) |
Describes the modifications made to your Reserved Instances.
|
default DescribeReservedInstancesOfferingsResponse |
describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest) |
Describes Reserved Instance offerings that are available for purchase.
|
default DescribeRouteTablesResponse |
describeRouteTables(DescribeRouteTablesRequest describeRouteTablesRequest) |
Describes one or more of your route tables.
|
default DescribeScheduledInstanceAvailabilityResponse |
describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest describeScheduledInstanceAvailabilityRequest) |
Finds available schedules that meet the specified criteria.
|
default DescribeScheduledInstancesResponse |
describeScheduledInstances(DescribeScheduledInstancesRequest describeScheduledInstancesRequest) |
Describes one or more of your Scheduled Instances.
|
default DescribeSecurityGroupReferencesResponse |
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.
|
default DescribeSecurityGroupsResponse |
describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest) |
Describes one or more of your security groups.
|
default DescribeSnapshotAttributeResponse |
describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest) |
Describes the specified attribute of the specified snapshot.
|
default DescribeSnapshotsResponse |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) |
Describes one or more of the EBS snapshots available to you.
|
default DescribeSpotDatafeedSubscriptionResponse |
describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest) |
Describes the data feed for Spot instances.
|
default DescribeSpotFleetInstancesResponse |
describeSpotFleetInstances(DescribeSpotFleetInstancesRequest describeSpotFleetInstancesRequest) |
Describes the running instances for the specified Spot fleet.
|
default DescribeSpotFleetRequestHistoryResponse |
describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest describeSpotFleetRequestHistoryRequest) |
Describes the events for the specified Spot fleet request during the specified time.
|
default DescribeSpotFleetRequestsResponse |
describeSpotFleetRequests(DescribeSpotFleetRequestsRequest describeSpotFleetRequestsRequest) |
Describes your Spot fleet requests.
|
default DescribeSpotInstanceRequestsResponse |
describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest) |
Describes the Spot instance requests that belong to your account.
|
default DescribeSpotPriceHistoryResponse |
describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest) |
Describes the Spot price history.
|
default DescribeStaleSecurityGroupsResponse |
describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest describeStaleSecurityGroupsRequest) |
[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.
|
default DescribeSubnetsResponse |
describeSubnets(DescribeSubnetsRequest describeSubnetsRequest) |
Describes one or more of your subnets.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest) |
Describes one or more of the tags for your EC2 resources.
|
default DescribeVolumeAttributeResponse |
describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest) |
Describes the specified attribute of the specified volume.
|
default DescribeVolumesResponse |
describeVolumes(DescribeVolumesRequest describeVolumesRequest) |
Describes the specified EBS volumes.
|
default DescribeVolumesModificationsResponse |
describeVolumesModifications(DescribeVolumesModificationsRequest describeVolumesModificationsRequest) |
Reports the current modification status of EBS volumes.
|
default DescribeVolumeStatusResponse |
describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest) |
Describes the status of the specified volumes.
|
default DescribeVpcAttributeResponse |
describeVpcAttribute(DescribeVpcAttributeRequest describeVpcAttributeRequest) |
Describes the specified attribute of the specified VPC.
|
default DescribeVpcClassicLinkResponse |
describeVpcClassicLink(DescribeVpcClassicLinkRequest describeVpcClassicLinkRequest) |
Describes the ClassicLink status of one or more VPCs.
|
default DescribeVpcClassicLinkDnsSupportResponse |
describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest describeVpcClassicLinkDnsSupportRequest) |
Describes the ClassicLink DNS support status of one or more VPCs.
|
default DescribeVpcEndpointsResponse |
describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) |
Describes one or more of your VPC endpoints.
|
default DescribeVpcEndpointServicesResponse |
describeVpcEndpointServices(DescribeVpcEndpointServicesRequest describeVpcEndpointServicesRequest) |
Describes all supported AWS services that can be specified when creating a VPC endpoint.
|
default DescribeVpcPeeringConnectionsResponse |
describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) |
Describes one or more of your VPC peering connections.
|
default DescribeVpcsResponse |
describeVpcs(DescribeVpcsRequest describeVpcsRequest) |
Describes one or more of your VPCs.
|
default DescribeVpnConnectionsResponse |
describeVpnConnections(DescribeVpnConnectionsRequest describeVpnConnectionsRequest) |
Describes one or more of your VPN connections.
|
default DescribeVpnGatewaysResponse |
describeVpnGateways(DescribeVpnGatewaysRequest describeVpnGatewaysRequest) |
Describes one or more of your virtual private gateways.
|
default DetachClassicLinkVpcResponse |
detachClassicLinkVpc(DetachClassicLinkVpcRequest detachClassicLinkVpcRequest) |
Unlinks (detaches) a linked EC2-Classic instance from a VPC.
|
default DetachInternetGatewayResponse |
detachInternetGateway(DetachInternetGatewayRequest detachInternetGatewayRequest) |
Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.
|
default DetachNetworkInterfaceResponse |
detachNetworkInterface(DetachNetworkInterfaceRequest detachNetworkInterfaceRequest) |
Detaches a network interface from an instance.
|
default DetachVolumeResponse |
detachVolume(DetachVolumeRequest detachVolumeRequest) |
Detaches an EBS volume from an instance.
|
default DetachVpnGatewayResponse |
detachVpnGateway(DetachVpnGatewayRequest detachVpnGatewayRequest) |
Detaches a virtual private gateway from a VPC.
|
default DisableVgwRoutePropagationResponse |
disableVgwRoutePropagation(DisableVgwRoutePropagationRequest disableVgwRoutePropagationRequest) |
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
|
default DisableVpcClassicLinkResponse |
disableVpcClassicLink(DisableVpcClassicLinkRequest disableVpcClassicLinkRequest) |
Disables ClassicLink for a VPC.
|
default DisableVpcClassicLinkDnsSupportResponse |
disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest disableVpcClassicLinkDnsSupportRequest) |
Disables ClassicLink DNS support for a VPC.
|
default DisassociateAddressResponse |
disassociateAddress(DisassociateAddressRequest disassociateAddressRequest) |
Disassociates an Elastic IP address from the instance or network interface it's associated with.
|
default DisassociateIamInstanceProfileResponse |
disassociateIamInstanceProfile(DisassociateIamInstanceProfileRequest disassociateIamInstanceProfileRequest) |
Disassociates an IAM instance profile from a running or stopped instance.
|
default DisassociateRouteTableResponse |
disassociateRouteTable(DisassociateRouteTableRequest disassociateRouteTableRequest) |
Disassociates a subnet from a route table.
|
default DisassociateSubnetCidrBlockResponse |
disassociateSubnetCidrBlock(DisassociateSubnetCidrBlockRequest disassociateSubnetCidrBlockRequest) |
Disassociates a CIDR block from a subnet.
|
default DisassociateVpcCidrBlockResponse |
disassociateVpcCidrBlock(DisassociateVpcCidrBlockRequest disassociateVpcCidrBlockRequest) |
Disassociates a CIDR block from a VPC.
|
default EnableVgwRoutePropagationResponse |
enableVgwRoutePropagation(EnableVgwRoutePropagationRequest enableVgwRoutePropagationRequest) |
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
|
default EnableVolumeIOResponse |
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.
|
default EnableVpcClassicLinkResponse |
enableVpcClassicLink(EnableVpcClassicLinkRequest enableVpcClassicLinkRequest) |
Enables a VPC for ClassicLink.
|
default EnableVpcClassicLinkDnsSupportResponse |
enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest enableVpcClassicLinkDnsSupportRequest) |
Enables a VPC to support DNS hostname resolution for ClassicLink.
|
default GetConsoleOutputResponse |
getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest) |
Gets the console output for the specified instance.
|
default GetConsoleScreenshotResponse |
getConsoleScreenshot(GetConsoleScreenshotRequest getConsoleScreenshotRequest) |
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
|
default GetHostReservationPurchasePreviewResponse |
getHostReservationPurchasePreview(GetHostReservationPurchasePreviewRequest getHostReservationPurchasePreviewRequest) |
Preview a reservation purchase with configurations that match those of your Dedicated Host.
|
default GetPasswordDataResponse |
getPasswordData(GetPasswordDataRequest getPasswordDataRequest) |
Retrieves the encrypted administrator password for an instance running Windows.
|
default GetReservedInstancesExchangeQuoteResponse |
getReservedInstancesExchangeQuote(GetReservedInstancesExchangeQuoteRequest getReservedInstancesExchangeQuoteRequest) |
Returns details about the values and term of your specified Convertible Reserved Instances.
|
default ImportImageResponse |
importImage(ImportImageRequest importImageRequest) |
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
|
default ImportInstanceResponse |
importInstance(ImportInstanceRequest importInstanceRequest) |
Creates an import instance task using metadata from the specified disk image.
|
default ImportKeyPairResponse |
importKeyPair(ImportKeyPairRequest importKeyPairRequest) |
Imports the public key from an RSA key pair that you created with a third-party tool.
|
default ImportSnapshotResponse |
importSnapshot(ImportSnapshotRequest importSnapshotRequest) |
Imports a disk into an EBS snapshot.
|
default ImportVolumeResponse |
importVolume(ImportVolumeRequest importVolumeRequest) |
Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
|
default ModifyHostsResponse |
modifyHosts(ModifyHostsRequest modifyHostsRequest) |
Modify the auto-placement setting of a Dedicated Host.
|
default ModifyIdentityIdFormatResponse |
modifyIdentityIdFormat(ModifyIdentityIdFormatRequest modifyIdentityIdFormatRequest) |
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all
IAM users, IAM roles, and the root user for an account.
|
default ModifyIdFormatResponse |
modifyIdFormat(ModifyIdFormatRequest modifyIdFormatRequest) |
Modifies the ID format for the specified resource on a per-region basis.
|
default ModifyImageAttributeResponse |
modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest) |
Modifies the specified attribute of the specified AMI.
|
default ModifyInstanceAttributeResponse |
modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest) |
Modifies the specified attribute of the specified instance.
|
default ModifyInstancePlacementResponse |
modifyInstancePlacement(ModifyInstancePlacementRequest modifyInstancePlacementRequest) |
Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.
|
default ModifyNetworkInterfaceAttributeResponse |
modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest modifyNetworkInterfaceAttributeRequest) |
Modifies the specified network interface attribute.
|
default ModifyReservedInstancesResponse |
modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest) |
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of
your Standard Reserved Instances.
|
default ModifySnapshotAttributeResponse |
modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest) |
Adds or removes permission settings for the specified snapshot.
|
default ModifySpotFleetRequestResponse |
modifySpotFleetRequest(ModifySpotFleetRequestRequest modifySpotFleetRequestRequest) |
Modifies the specified Spot fleet request.
|
default ModifySubnetAttributeResponse |
modifySubnetAttribute(ModifySubnetAttributeRequest modifySubnetAttributeRequest) |
Modifies a subnet attribute.
|
default ModifyVolumeResponse |
modifyVolume(ModifyVolumeRequest modifyVolumeRequest) |
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS
capacity.
|
default ModifyVolumeAttributeResponse |
modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest) |
Modifies a volume attribute.
|
default ModifyVpcAttributeResponse |
modifyVpcAttribute(ModifyVpcAttributeRequest modifyVpcAttributeRequest) |
Modifies the specified attribute of the specified VPC.
|
default ModifyVpcEndpointResponse |
modifyVpcEndpoint(ModifyVpcEndpointRequest modifyVpcEndpointRequest) |
Modifies attributes of a specified VPC endpoint.
|
default ModifyVpcPeeringConnectionOptionsResponse |
modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest modifyVpcPeeringConnectionOptionsRequest) |
Modifies the VPC peering connection options on one side of a VPC peering connection.
|
default MonitorInstancesResponse |
monitorInstances(MonitorInstancesRequest monitorInstancesRequest) |
Enables detailed monitoring for a running instance.
|
default MoveAddressToVpcResponse |
moveAddressToVpc(MoveAddressToVpcRequest moveAddressToVpcRequest) |
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.
|
default PurchaseHostReservationResponse |
purchaseHostReservation(PurchaseHostReservationRequest purchaseHostReservationRequest) |
Purchase a reservation with configurations that match those of your Dedicated Host.
|
default PurchaseReservedInstancesOfferingResponse |
purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest) |
Purchases a Reserved Instance for use with your account.
|
default PurchaseScheduledInstancesResponse |
purchaseScheduledInstances(PurchaseScheduledInstancesRequest purchaseScheduledInstancesRequest) |
Purchases one or more Scheduled Instances with the specified schedule.
|
default RebootInstancesResponse |
rebootInstances(RebootInstancesRequest rebootInstancesRequest) |
Requests a reboot of one or more instances.
|
default RegisterImageResponse |
registerImage(RegisterImageRequest registerImageRequest) |
Registers an AMI.
|
default RejectVpcPeeringConnectionResponse |
rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest rejectVpcPeeringConnectionRequest) |
Rejects a VPC peering connection request.
|
default ReleaseAddressResponse |
releaseAddress(ReleaseAddressRequest releaseAddressRequest) |
Releases the specified Elastic IP address.
|
default ReleaseHostsResponse |
releaseHosts(ReleaseHostsRequest releaseHostsRequest) |
When you no longer want to use an On-Demand Dedicated Host it can be released.
|
default ReplaceIamInstanceProfileAssociationResponse |
replaceIamInstanceProfileAssociation(ReplaceIamInstanceProfileAssociationRequest replaceIamInstanceProfileAssociationRequest) |
Replaces an IAM instance profile for the specified running instance.
|
default ReplaceNetworkAclAssociationResponse |
replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest replaceNetworkAclAssociationRequest) |
Changes which network ACL a subnet is associated with.
|
default ReplaceNetworkAclEntryResponse |
replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest replaceNetworkAclEntryRequest) |
Replaces an entry (rule) in a network ACL.
|
default ReplaceRouteResponse |
replaceRoute(ReplaceRouteRequest replaceRouteRequest) |
Replaces an existing route within a route table in a VPC.
|
default ReplaceRouteTableAssociationResponse |
replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest replaceRouteTableAssociationRequest) |
Changes the route table associated with a given subnet in a VPC.
|
default ReportInstanceStatusResponse |
reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest) |
Submits feedback about the status of an instance.
|
default RequestSpotFleetResponse |
requestSpotFleet(RequestSpotFleetRequest requestSpotFleetRequest) |
Creates a Spot fleet request.
|
default RequestSpotInstancesResponse |
requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest) |
Creates a Spot instance request.
|
default ResetImageAttributeResponse |
resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest) |
Resets an attribute of an AMI to its default value.
|
default ResetInstanceAttributeResponse |
resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest) |
Resets an attribute of an instance to its default value.
|
default ResetNetworkInterfaceAttributeResponse |
resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest resetNetworkInterfaceAttributeRequest) |
Resets a network interface attribute.
|
default ResetSnapshotAttributeResponse |
resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest) |
Resets permission settings for the specified snapshot.
|
default RestoreAddressToClassicResponse |
restoreAddressToClassic(RestoreAddressToClassicRequest restoreAddressToClassicRequest) |
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic
platform.
|
default RevokeSecurityGroupEgressResponse |
revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest revokeSecurityGroupEgressRequest) |
[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.
|
default RevokeSecurityGroupIngressResponse |
revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest) |
Removes one or more ingress rules from a security group.
|
default RunInstancesResponse |
runInstances(RunInstancesRequest runInstancesRequest) |
Launches the specified number of instances using an AMI for which you have permissions.
|
default RunScheduledInstancesResponse |
runScheduledInstances(RunScheduledInstancesRequest runScheduledInstancesRequest) |
Launches the specified Scheduled Instances.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartInstancesResponse |
startInstances(StartInstancesRequest startInstancesRequest) |
Starts an Amazon EBS-backed AMI that you've previously stopped.
|
default StopInstancesResponse |
stopInstances(StopInstancesRequest stopInstancesRequest) |
Stops an Amazon EBS-backed instance.
|
default TerminateInstancesResponse |
terminateInstances(TerminateInstancesRequest terminateInstancesRequest) |
Shuts down one or more instances.
|
default UnassignIpv6AddressesResponse |
unassignIpv6Addresses(UnassignIpv6AddressesRequest unassignIpv6AddressesRequest) |
Unassigns one or more IPv6 addresses from a network interface.
|
default UnassignPrivateIpAddressesResponse |
unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest unassignPrivateIpAddressesRequest) |
Unassigns one or more secondary private IP addresses from a network interface.
|
default UnmonitorInstancesResponse |
unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest) |
Disables detailed monitoring for a running instance.
|
EC2ClientWaiters |
waiters() |
close
static final String SERVICE_NAME
static EC2Client create()
EC2Client
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static EC2ClientBuilder builder()
EC2Client
.default AcceptReservedInstancesExchangeQuoteResponse acceptReservedInstancesExchangeQuote(AcceptReservedInstancesExchangeQuoteRequest acceptReservedInstancesExchangeQuoteRequest) throws SdkBaseException, SdkClientException, EC2Exception
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
acceptReservedInstancesExchangeQuoteRequest
- Contains the parameters for accepting the quote.SdkBaseException
SdkClientException
EC2Exception
default AcceptVpcPeeringConnectionResponse acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest acceptVpcPeeringConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the
pending-acceptance
state, and you must be the owner of the peer VPC. Use
DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
acceptVpcPeeringConnectionRequest
- Contains the parameters for AcceptVpcPeeringConnection.SdkBaseException
SdkClientException
EC2Exception
default AllocateAddressResponse allocateAddress(AllocateAddressRequest allocateAddressRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AllocateAddress.SdkBaseException
SdkClientException
EC2Exception
default AllocateHostsResponse allocateHosts(AllocateHostsRequest allocateHostsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AllocateHosts.SdkBaseException
SdkClientException
EC2Exception
default AssignIpv6AddressesResponse assignIpv6Addresses(AssignIpv6AddressesRequest assignIpv6AddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
assignIpv6AddressesRequest
- SdkBaseException
SdkClientException
EC2Exception
default AssignPrivateIpAddressesResponse assignPrivateIpAddresses(AssignPrivateIpAddressesRequest assignPrivateIpAddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AssignPrivateIpAddresses.SdkBaseException
SdkClientException
EC2Exception
default AssociateAddressResponse associateAddress(AssociateAddressRequest associateAddressRequest) throws SdkBaseException, SdkClientException, EC2Exception
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. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
associateAddressRequest
- Contains the parameters for AssociateAddress.SdkBaseException
SdkClientException
EC2Exception
default AssociateDhcpOptionsResponse associateDhcpOptions(AssociateDhcpOptionsRequest associateDhcpOptionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AssociateDhcpOptions.SdkBaseException
SdkClientException
EC2Exception
default AssociateIamInstanceProfileResponse associateIamInstanceProfile(AssociateIamInstanceProfileRequest associateIamInstanceProfileRequest) throws SdkBaseException, SdkClientException, EC2Exception
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
associateIamInstanceProfileRequest
- SdkBaseException
SdkClientException
EC2Exception
default AssociateRouteTableResponse associateRouteTable(AssociateRouteTableRequest associateRouteTableRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AssociateRouteTable.SdkBaseException
SdkClientException
EC2Exception
default AssociateSubnetCidrBlockResponse associateSubnetCidrBlock(AssociateSubnetCidrBlockRequest associateSubnetCidrBlockRequest) throws SdkBaseException, SdkClientException, EC2Exception
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
associateSubnetCidrBlockRequest
- SdkBaseException
SdkClientException
EC2Exception
default AssociateVpcCidrBlockResponse associateVpcCidrBlock(AssociateVpcCidrBlockRequest associateVpcCidrBlockRequest) throws SdkBaseException, SdkClientException, EC2Exception
Associates a CIDR block with your VPC. You can only associate a single Amazon-provided IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56.
associateVpcCidrBlockRequest
- SdkBaseException
SdkClientException
EC2Exception
default AttachClassicLinkVpcResponse attachClassicLinkVpc(AttachClassicLinkVpcRequest attachClassicLinkVpcRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AttachClassicLinkVpc.SdkBaseException
SdkClientException
EC2Exception
default AttachInternetGatewayResponse attachInternetGateway(AttachInternetGatewayRequest attachInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AttachInternetGateway.SdkBaseException
SdkClientException
EC2Exception
default AttachNetworkInterfaceResponse attachNetworkInterface(AttachNetworkInterfaceRequest attachNetworkInterfaceRequest) throws SdkBaseException, SdkClientException, EC2Exception
Attaches a network interface to an instance.
attachNetworkInterfaceRequest
- Contains the parameters for AttachNetworkInterface.SdkBaseException
SdkClientException
EC2Exception
default AttachVolumeResponse attachVolume(AttachVolumeRequest attachVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for AttachVolume.SdkBaseException
SdkClientException
EC2Exception
default AttachVpnGatewayResponse attachVpnGateway(AttachVpnGatewayRequest attachVpnGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
attachVpnGatewayRequest
- Contains the parameters for AttachVpnGateway.SdkBaseException
SdkClientException
EC2Exception
default AuthorizeSecurityGroupEgressResponse authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest authorizeSecurityGroupEgressRequest) throws SdkBaseException, SdkClientException, EC2Exception
[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 IPv4 or IPv6 CIDR 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. For more information about security group limits, see Amazon VPC Limits.
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
- Contains the parameters for AuthorizeSecurityGroupEgress.SdkBaseException
SdkClientException
EC2Exception
default AuthorizeSecurityGroupIngressResponse authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest) throws SdkBaseException, SdkClientException, EC2Exception
Adds one or more ingress rules to a security group.
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 IPv4 CIDR 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. You can have up to 100 rules per group.
[EC2-VPC] This action gives one or more IPv4 or IPv6 CIDR 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 or a peer VPC in a VPC peering connection. For more information about VPC security group limits, see Amazon VPC Limits.
authorizeSecurityGroupIngressRequest
- Contains the parameters for AuthorizeSecurityGroupIngress.SdkBaseException
SdkClientException
EC2Exception
default BundleInstanceResponse bundleInstance(BundleInstanceRequest bundleInstanceRequest) throws SdkBaseException, SdkClientException, EC2Exception
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
For more information, see Creating an Instance Store-Backed Windows AMI.
bundleInstanceRequest
- Contains the parameters for BundleInstance.SdkBaseException
SdkClientException
EC2Exception
default CancelBundleTaskResponse cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest) throws SdkBaseException, SdkClientException, EC2Exception
Cancels a bundling operation for an instance store-backed Windows instance.
cancelBundleTaskRequest
- Contains the parameters for CancelBundleTask.SdkBaseException
SdkClientException
EC2Exception
default CancelConversionTaskResponse cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest) throws SdkBaseException, SdkClientException, EC2Exception
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
cancelConversionTaskRequest
- Contains the parameters for CancelConversionTask.SdkBaseException
SdkClientException
EC2Exception
default CancelExportTaskResponse cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CancelExportTask.SdkBaseException
SdkClientException
EC2Exception
default CancelImportTaskResponse cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest) throws SdkBaseException, SdkClientException, EC2Exception
Cancels an in-process import virtual machine or import snapshot task.
cancelImportTaskRequest
- Contains the parameters for CancelImportTask.SdkBaseException
SdkClientException
EC2Exception
default CancelReservedInstancesListingResponse cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CancelReservedInstancesListing.SdkBaseException
SdkClientException
EC2Exception
default CancelSpotFleetRequestsResponse cancelSpotFleetRequests(CancelSpotFleetRequestsRequest cancelSpotFleetRequestsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CancelSpotFleetRequests.SdkBaseException
SdkClientException
EC2Exception
default CancelSpotInstanceRequestsResponse cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.
Canceling a Spot instance request does not terminate running Spot instances associated with the request.
cancelSpotInstanceRequestsRequest
- Contains the parameters for CancelSpotInstanceRequests.SdkBaseException
SdkClientException
EC2Exception
default ConfirmProductInstanceResponse confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ConfirmProductInstance.SdkBaseException
SdkClientException
EC2Exception
default CopyImageResponse copyImage(CopyImageRequest copyImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
copyImageRequest
- Contains the parameters for CopyImage.SdkBaseException
SdkClientException
EC2Exception
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
copySnapshotRequest
- Contains the parameters for CopySnapshot.SdkBaseException
SdkClientException
EC2Exception
default CreateCustomerGatewayResponse createCustomerGateway(CreateCustomerGatewayRequest createCustomerGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is
reserved in the us-east-1
region, and 9059, which is reserved in 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.
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
- Contains the parameters for CreateCustomerGateway.SdkBaseException
SdkClientException
EC2Exception
default CreateDhcpOptionsResponse createDhcpOptions(CreateDhcpOptionsRequest createDhcpOptionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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. If you want your instance to receive a custom DNS
hostname as specified in domain-name
, you must set domain-name-servers
to a custom DNS
server.
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
). This value is used to complete unqualified DNS
hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces.
However, Windows and other Linux operating systems treat the value as a single domain, which results in
unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating
systems, specify only one domain name.
ntp-servers
- The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers
- The IP addresses of up to four NetBIOS name servers.
netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2
(broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide
(AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set
the domain-name-servers
option either to AmazonProvidedDNS
or to a domain name server
of your choice. For more information about DHCP options, see DHCP Options Sets in the
Amazon Virtual Private Cloud User Guide.
createDhcpOptionsRequest
- Contains the parameters for CreateDhcpOptions.SdkBaseException
SdkClientException
EC2Exception
default CreateEgressOnlyInternetGatewayResponse createEgressOnlyInternetGateway(CreateEgressOnlyInternetGatewayRequest createEgressOnlyInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
[IPv6 only] Creates an egress-only Internet gateway for your VPC. An egress-only Internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the Internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
createEgressOnlyInternetGatewayRequest
- SdkBaseException
SdkClientException
EC2Exception
default CreateFlowLogsResponse createFlowLogs(CreateFlowLogsRequest createFlowLogsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateFlowLogs.SdkBaseException
SdkClientException
EC2Exception
default CreateFpgaImageResponse createFpgaImage(CreateFpgaImageRequest createFpgaImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on one or more FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
createFpgaImageRequest
- SdkBaseException
SdkClientException
EC2Exception
default CreateImageResponse createImage(CreateImageRequest createImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateImage.SdkBaseException
SdkClientException
EC2Exception
default CreateInstanceExportTaskResponse createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
createInstanceExportTaskRequest
- Contains the parameters for CreateInstanceExportTask.SdkBaseException
SdkClientException
EC2Exception
default CreateInternetGatewayResponse createInternetGateway(CreateInternetGatewayRequest createInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateInternetGateway.SdkBaseException
SdkClientException
EC2Exception
default CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateKeyPair.SdkBaseException
SdkClientException
EC2Exception
default CreateNatGatewayResponse createNatGateway(CreateNatGatewayRequest createNatGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateNatGateway.SdkBaseException
SdkClientException
EC2Exception
default CreateNetworkAclResponse createNetworkAcl(CreateNetworkAclRequest createNetworkAclRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateNetworkAcl.SdkBaseException
SdkClientException
EC2Exception
default CreateNetworkAclEntryResponse createNetworkAclEntry(CreateNetworkAclEntryRequest createNetworkAclEntryRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateNetworkAclEntry.SdkBaseException
SdkClientException
EC2Exception
default CreateNetworkInterfaceResponse createNetworkInterface(CreateNetworkInterfaceRequest createNetworkInterfaceRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
createNetworkInterfaceRequest
- Contains the parameters for CreateNetworkInterface.SdkBaseException
SdkClientException
EC2Exception
default CreatePlacementGroupResponse createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreatePlacementGroup.SdkBaseException
SdkClientException
EC2Exception
default CreateReservedInstancesListingResponse createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances with a capacity reservation can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances and Standard Reserved Instances with a regional benefit cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard 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 Standard 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 Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard 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
- Contains the parameters for CreateReservedInstancesListing.SdkBaseException
SdkClientException
EC2Exception
default CreateRouteResponse createRoute(CreateRouteRequest createRouteRequest) throws SdkBaseException, SdkClientException, EC2Exception
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, network interface, or egress-only Internet gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is
destined for the IPv4 address 192.0.2.3
, and the route table includes the following two IPv4 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
- Contains the parameters for CreateRoute.SdkBaseException
SdkClientException
EC2Exception
default CreateRouteTableResponse createRouteTable(CreateRouteTableRequest createRouteTableRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateRouteTable.SdkBaseException
SdkClientException
EC2Exception
default CreateSecurityGroupResponse createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates a security group.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
EC2-Classic: You can have up to 500 security groups.
EC2-VPC: You can create up to 500 security groups per VPC.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
createSecurityGroupRequest
- Contains the parameters for CreateSecurityGroup.SdkBaseException
SdkClientException
EC2Exception
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateSnapshot.SdkBaseException
SdkClientException
EC2Exception
default CreateSpotDatafeedSubscriptionResponse createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateSpotDatafeedSubscription.SdkBaseException
SdkClientException
EC2Exception
default CreateSubnetResponse createSubnet(CreateSubnetRequest createSubnetRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 IPv4 CIDR block can be the same as the VPC's IPv4 CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
AWS reserves both the first four and the last IPv4 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
- Contains the parameters for CreateSubnet.SdkBaseException
SdkClientException
EC2Exception
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 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
- Contains the parameters for CreateTags.SdkBaseException
SdkClientException
EC2Exception
default CreateVolumeResponse createVolume(CreateVolumeRequest createVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources.
For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
createVolumeRequest
- Contains the parameters for CreateVolume.SdkBaseException
SdkClientException
EC2Exception
default CreateVpcResponse createVpc(CreateVpcRequest createVpcRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.
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 Elastic Compute Cloud User Guide.
createVpcRequest
- Contains the parameters for CreateVpc.SdkBaseException
SdkClientException
EC2Exception
default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
Use DescribeVpcEndpointServices to get a list of supported AWS services.
createVpcEndpointRequest
- Contains the parameters for CreateVpcEndpoint.SdkBaseException
SdkClientException
EC2Exception
default CreateVpcPeeringConnectionResponse createVpcPeeringConnection(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
If you try to create a VPC peering connection between VPCs that have overlapping CIDR blocks, the VPC peering
connection status goes to failed
.
createVpcPeeringConnectionRequest
- Contains the parameters for CreateVpcPeeringConnection.SdkBaseException
SdkClientException
EC2Exception
default CreateVpnConnectionResponse createVpnConnection(CreateVpnConnectionRequest createVpnConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only
supported connection type is ipsec.1
.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
createVpnConnectionRequest
- Contains the parameters for CreateVpnConnection.SdkBaseException
SdkClientException
EC2Exception
default CreateVpnConnectionRouteResponse createVpnConnectionRoute(CreateVpnConnectionRouteRequest createVpnConnectionRouteRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateVpnConnectionRoute.SdkBaseException
SdkClientException
EC2Exception
default CreateVpnGatewayResponse createVpnGateway(CreateVpnGatewayRequest createVpnGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for CreateVpnGateway.SdkBaseException
SdkClientException
EC2Exception
default DeleteCustomerGatewayResponse deleteCustomerGateway(DeleteCustomerGatewayRequest deleteCustomerGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
deleteCustomerGatewayRequest
- Contains the parameters for DeleteCustomerGateway.SdkBaseException
SdkClientException
EC2Exception
default DeleteDhcpOptionsResponse deleteDhcpOptions(DeleteDhcpOptionsRequest deleteDhcpOptionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteDhcpOptions.SdkBaseException
SdkClientException
EC2Exception
default DeleteEgressOnlyInternetGatewayResponse deleteEgressOnlyInternetGateway(DeleteEgressOnlyInternetGatewayRequest deleteEgressOnlyInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes an egress-only Internet gateway.
deleteEgressOnlyInternetGatewayRequest
- SdkBaseException
SdkClientException
EC2Exception
default DeleteFlowLogsResponse deleteFlowLogs(DeleteFlowLogsRequest deleteFlowLogsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes one or more flow logs.
deleteFlowLogsRequest
- Contains the parameters for DeleteFlowLogs.SdkBaseException
SdkClientException
EC2Exception
default DeleteInternetGatewayResponse deleteInternetGateway(DeleteInternetGatewayRequest deleteInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
deleteInternetGatewayRequest
- Contains the parameters for DeleteInternetGateway.SdkBaseException
SdkClientException
EC2Exception
default DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified key pair, by removing the public key from Amazon EC2.
deleteKeyPairRequest
- Contains the parameters for DeleteKeyPair.SdkBaseException
SdkClientException
EC2Exception
default DeleteNatGatewayResponse deleteNatGateway(DeleteNatGatewayRequest deleteNatGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteNatGateway.SdkBaseException
SdkClientException
EC2Exception
default DeleteNetworkAclResponse deleteNetworkAcl(DeleteNetworkAclRequest deleteNetworkAclRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteNetworkAcl.SdkBaseException
SdkClientException
EC2Exception
default DeleteNetworkAclEntryResponse deleteNetworkAclEntry(DeleteNetworkAclEntryRequest deleteNetworkAclEntryRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
deleteNetworkAclEntryRequest
- Contains the parameters for DeleteNetworkAclEntry.SdkBaseException
SdkClientException
EC2Exception
default DeleteNetworkInterfaceResponse deleteNetworkInterface(DeleteNetworkInterfaceRequest deleteNetworkInterfaceRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified network interface. You must detach the network interface before you can delete it.
deleteNetworkInterfaceRequest
- Contains the parameters for DeleteNetworkInterface.SdkBaseException
SdkClientException
EC2Exception
default DeletePlacementGroupResponse deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeletePlacementGroup.SdkBaseException
SdkClientException
EC2Exception
default DeleteRouteResponse deleteRoute(DeleteRouteRequest deleteRouteRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified route from the specified route table.
deleteRouteRequest
- Contains the parameters for DeleteRoute.SdkBaseException
SdkClientException
EC2Exception
default DeleteRouteTableResponse deleteRouteTable(DeleteRouteTableRequest deleteRouteTableRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteRouteTable.SdkBaseException
SdkClientException
EC2Exception
default DeleteSecurityGroupResponse deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteSecurityGroup.SdkBaseException
SdkClientException
EC2Exception
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteSnapshot.SdkBaseException
SdkClientException
EC2Exception
default DeleteSpotDatafeedSubscriptionResponse deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the data feed for Spot instances.
deleteSpotDatafeedSubscriptionRequest
- Contains the parameters for DeleteSpotDatafeedSubscription.SdkBaseException
SdkClientException
EC2Exception
default DeleteSubnetResponse deleteSubnet(DeleteSubnetRequest deleteSubnetRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
deleteSubnetRequest
- Contains the parameters for DeleteSubnet.SdkBaseException
SdkClientException
EC2Exception
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteTags.SdkBaseException
SdkClientException
EC2Exception
default DeleteVolumeResponse deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Deletes the specified EBS volume. The volume must be in the available
state (not attached to an
instance).
The volume may remain in the deleting
state for several minutes.
For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
deleteVolumeRequest
- Contains the parameters for DeleteVolume.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpcResponse deleteVpc(DeleteVpcRequest deleteVpcRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpc.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpcEndpointsResponse deleteVpcEndpoints(DeleteVpcEndpointsRequest deleteVpcEndpointsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpcEndpoints.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpcPeeringConnectionResponse deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpcPeeringConnection.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpnConnectionResponse deleteVpnConnection(DeleteVpnConnectionRequest deleteVpnConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpnConnection.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpnConnectionRouteResponse deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest deleteVpnConnectionRouteRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpnConnectionRoute.SdkBaseException
SdkClientException
EC2Exception
default DeleteVpnGatewayResponse deleteVpnGateway(DeleteVpnGatewayRequest deleteVpnGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeleteVpnGateway.SdkBaseException
SdkClientException
EC2Exception
default DeregisterImageResponse deregisterImage(DeregisterImageRequest deregisterImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DeregisterImage.SdkBaseException
SdkClientException
EC2Exception
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeAccountAttributes.SdkBaseException
SdkClientException
EC2Exception
default DescribeAddressesResponse describeAddresses(DescribeAddressesRequest describeAddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeAddresses.SdkBaseException
SdkClientException
EC2Exception
default DescribeAvailabilityZonesResponse describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeAvailabilityZones.SdkBaseException
SdkClientException
EC2Exception
default DescribeBundleTasksResponse describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your bundling tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can
still register an AMI from it. Just use RegisterImage
with the Amazon S3 bucket name and image
manifest name you provided to the bundle task.
describeBundleTasksRequest
- Contains the parameters for DescribeBundleTasks.SdkBaseException
SdkClientException
EC2Exception
default DescribeClassicLinkInstancesResponse describeClassicLinkInstances(DescribeClassicLinkInstancesRequest describeClassicLinkInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeClassicLinkInstances.SdkBaseException
SdkClientException
EC2Exception
default DescribeConversionTasksResponse describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
describeConversionTasksRequest
- Contains the parameters for DescribeConversionTasks.SdkBaseException
SdkClientException
EC2Exception
default DescribeCustomerGatewaysResponse describeCustomerGateways(DescribeCustomerGatewaysRequest describeCustomerGatewaysRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeCustomerGateways.SdkBaseException
SdkClientException
EC2Exception
default DescribeDhcpOptionsResponse describeDhcpOptions(DescribeDhcpOptionsRequest describeDhcpOptionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeDhcpOptions.SdkBaseException
SdkClientException
EC2Exception
default DescribeEgressOnlyInternetGatewaysResponse describeEgressOnlyInternetGateways(DescribeEgressOnlyInternetGatewaysRequest describeEgressOnlyInternetGatewaysRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your egress-only Internet gateways.
describeEgressOnlyInternetGatewaysRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your export tasks.
describeExportTasksRequest
- Contains the parameters for DescribeExportTasks.SdkBaseException
SdkClientException
EC2Exception
default DescribeFlowLogsResponse describeFlowLogs(DescribeFlowLogsRequest describeFlowLogsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeFlowLogs.SdkBaseException
SdkClientException
EC2Exception
default DescribeFpgaImagesResponse describeFpgaImages(DescribeFpgaImagesRequest describeFpgaImagesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more available Amazon FPGA Images (AFIs). These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
describeFpgaImagesRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeHostReservationOfferingsResponse describeHostReservationOfferings(DescribeHostReservationOfferingsRequest describeHostReservationOfferingsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the Dedicated Host Reservations that are available to purchase.
The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.
describeHostReservationOfferingsRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeHostReservationsResponse describeHostReservations(DescribeHostReservationsRequest describeHostReservationsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.
describeHostReservationsRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeHostsResponse describeHosts(DescribeHostsRequest describeHostsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeHosts.SdkBaseException
SdkClientException
EC2Exception
default DescribeIamInstanceProfileAssociationsResponse describeIamInstanceProfileAssociations(DescribeIamInstanceProfileAssociationsRequest describeIamInstanceProfileAssociationsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes your IAM instance profile associations.
describeIamInstanceProfileAssociationsRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeIdFormatResponse describeIdFormat(DescribeIdFormatRequest describeIdFormatRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeIdFormat.SdkBaseException
SdkClientException
EC2Exception
default DescribeIdentityIdFormatResponse describeIdentityIdFormat(DescribeIdentityIdFormatRequest describeIdentityIdFormatRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that 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. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: instance
| reservation
|
snapshot
| volume
.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
describeIdentityIdFormatRequest
- Contains the parameters for DescribeIdentityIdFormat.SdkBaseException
SdkClientException
EC2Exception
default DescribeImageAttributeResponse describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
describeImageAttributeRequest
- Contains the parameters for DescribeImageAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
Deregistered images are included in the returned results for an unspecified interval after deregistration.
describeImagesRequest
- Contains the parameters for DescribeImages.SdkBaseException
SdkClientException
EC2Exception
default DescribeImportImageTasksResponse describeImportImageTasks(DescribeImportImageTasksRequest describeImportImageTasksRequest) throws SdkBaseException, SdkClientException, EC2Exception
Displays details about an import virtual machine or import snapshot tasks that are already created.
describeImportImageTasksRequest
- Contains the parameters for DescribeImportImageTasks.SdkBaseException
SdkClientException
EC2Exception
default DescribeImportSnapshotTasksResponse describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest describeImportSnapshotTasksRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes your import snapshot tasks.
describeImportSnapshotTasksRequest
- Contains the parameters for DescribeImportSnapshotTasks.SdkBaseException
SdkClientException
EC2Exception
default DescribeInstanceAttributeResponse describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeInstanceAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeInstanceStatusResponse describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeInstanceStatus.SdkBaseException
SdkClientException
EC2Exception
default DescribeInstancesResponse describeInstances(DescribeInstancesRequest describeInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
describeInstancesRequest
- Contains the parameters for DescribeInstances.SdkBaseException
SdkClientException
EC2Exception
default DescribeInternetGatewaysResponse describeInternetGateways(DescribeInternetGatewaysRequest describeInternetGatewaysRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your Internet gateways.
describeInternetGatewaysRequest
- Contains the parameters for DescribeInternetGateways.SdkBaseException
SdkClientException
EC2Exception
default DescribeKeyPairsResponse describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeKeyPairs.SdkBaseException
SdkClientException
EC2Exception
default DescribeMovingAddressesResponse describeMovingAddresses(DescribeMovingAddressesRequest describeMovingAddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeMovingAddresses.SdkBaseException
SdkClientException
EC2Exception
default DescribeNatGatewaysResponse describeNatGateways(DescribeNatGatewaysRequest describeNatGatewaysRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of the your NAT gateways.
describeNatGatewaysRequest
- Contains the parameters for DescribeNatGateways.SdkBaseException
SdkClientException
EC2Exception
default DescribeNetworkAclsResponse describeNetworkAcls(DescribeNetworkAclsRequest describeNetworkAclsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeNetworkAcls.SdkBaseException
SdkClientException
EC2Exception
default DescribeNetworkInterfaceAttributeResponse describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest describeNetworkInterfaceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes a network interface attribute. You can specify only one attribute at a time.
describeNetworkInterfaceAttributeRequest
- Contains the parameters for DescribeNetworkInterfaceAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeNetworkInterfacesResponse describeNetworkInterfaces(DescribeNetworkInterfacesRequest describeNetworkInterfacesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your network interfaces.
describeNetworkInterfacesRequest
- Contains the parameters for DescribeNetworkInterfaces.SdkBaseException
SdkClientException
EC2Exception
default DescribePlacementGroupsResponse describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribePlacementGroups.SdkBaseException
SdkClientException
EC2Exception
default DescribePrefixListsResponse describePrefixLists(DescribePrefixListsRequest describePrefixListsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribePrefixLists.SdkBaseException
SdkClientException
EC2Exception
default DescribeRegionsResponse describeRegions(DescribeRegionsRequest describeRegionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeRegions.SdkBaseException
SdkClientException
EC2Exception
default DescribeReservedInstancesResponse describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeReservedInstances.SdkBaseException
SdkClientException
EC2Exception
default DescribeReservedInstancesListingsResponse describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeReservedInstancesListings.SdkBaseException
SdkClientException
EC2Exception
default DescribeReservedInstancesModificationsResponse describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeReservedInstancesModifications.SdkBaseException
SdkClientException
EC2Exception
default DescribeReservedInstancesOfferingsResponse describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeReservedInstancesOfferings.SdkBaseException
SdkClientException
EC2Exception
default DescribeRouteTablesResponse describeRouteTables(DescribeRouteTablesRequest describeRouteTablesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeRouteTables.SdkBaseException
SdkClientException
EC2Exception
default DescribeScheduledInstanceAvailabilityResponse describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest describeScheduledInstanceAvailabilityRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeScheduledInstanceAvailability.SdkBaseException
SdkClientException
EC2Exception
default DescribeScheduledInstancesResponse describeScheduledInstances(DescribeScheduledInstancesRequest describeScheduledInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your Scheduled Instances.
describeScheduledInstancesRequest
- Contains the parameters for DescribeScheduledInstances.SdkBaseException
SdkClientException
EC2Exception
default DescribeSecurityGroupReferencesResponse describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest describeSecurityGroupReferencesRequest) throws SdkBaseException, SdkClientException, EC2Exception
[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
- SdkBaseException
SdkClientException
EC2Exception
default DescribeSecurityGroupsResponse describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeSecurityGroups.SdkBaseException
SdkClientException
EC2Exception
default DescribeSnapshotAttributeResponse describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeSnapshotAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 using the OwnerIds
option, 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
- Contains the parameters for DescribeSnapshots.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotDatafeedSubscriptionResponse describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.
describeSpotDatafeedSubscriptionRequest
- Contains the parameters for DescribeSpotDatafeedSubscription.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotFleetInstancesResponse describeSpotFleetInstances(DescribeSpotFleetInstancesRequest describeSpotFleetInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the running instances for the specified Spot fleet.
describeSpotFleetInstancesRequest
- Contains the parameters for DescribeSpotFleetInstances.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotFleetRequestHistoryResponse describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest describeSpotFleetRequestHistoryRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeSpotFleetRequestHistory.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotFleetRequestsResponse describeSpotFleetRequests(DescribeSpotFleetRequestsRequest describeSpotFleetRequestsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes your Spot fleet requests.
Spot fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
describeSpotFleetRequestsRequest
- Contains the parameters for DescribeSpotFleetRequests.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotInstanceRequestsResponse describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
.
Spot instance requests are deleted 4 hours after they are canceled and their instances are terminated.
describeSpotInstanceRequestsRequest
- Contains the parameters for DescribeSpotInstanceRequests.SdkBaseException
SdkClientException
EC2Exception
default DescribeSpotPriceHistoryResponse describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the Spot price history. 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
- Contains the parameters for DescribeSpotPriceHistory.SdkBaseException
SdkClientException
EC2Exception
default DescribeStaleSecurityGroupsResponse describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest describeStaleSecurityGroupsRequest) throws SdkBaseException, SdkClientException, EC2Exception
[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
- SdkBaseException
SdkClientException
EC2Exception
default DescribeSubnetsResponse describeSubnets(DescribeSubnetsRequest describeSubnetsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeSubnets.SdkBaseException
SdkClientException
EC2Exception
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeTags.SdkBaseException
SdkClientException
EC2Exception
default DescribeVolumeAttributeResponse describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeVolumeAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeVolumeStatusResponse describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
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
- Contains the parameters for DescribeVolumeStatus.SdkBaseException
SdkClientException
EC2Exception
default DescribeVolumesResponse describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeVolumes.SdkBaseException
SdkClientException
EC2Exception
default DescribeVolumesModificationsResponse describeVolumesModifications(DescribeVolumesModificationsRequest describeVolumesModificationsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Reports the current modification status of EBS volumes.
Current-generation EBS volumes support modification of attributes including type, size, and (for io1
volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the
API or the console to modify a volume, the status of the modification may be modifying
,
optimizing
, completed
, or failed
. If a volume has never been modified,
then certain elements of the returned VolumeModification
objects are null.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications".
describeVolumesModificationsRequest
- SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcAttributeResponse describeVpcAttribute(DescribeVpcAttributeRequest describeVpcAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
describeVpcAttributeRequest
- Contains the parameters for DescribeVpcAttribute.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcClassicLinkResponse describeVpcClassicLink(DescribeVpcClassicLinkRequest describeVpcClassicLinkRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes the ClassicLink status of one or more VPCs.
describeVpcClassicLinkRequest
- Contains the parameters for DescribeVpcClassicLink.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcClassicLinkDnsSupportResponse describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest describeVpcClassicLinkDnsSupportRequest) throws SdkBaseException, SdkClientException, EC2Exception
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, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
describeVpcClassicLinkDnsSupportRequest
- Contains the parameters for DescribeVpcClassicLinkDnsSupport.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcEndpointServicesResponse describeVpcEndpointServices(DescribeVpcEndpointServicesRequest describeVpcEndpointServicesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes all supported AWS services that can be specified when creating a VPC endpoint.
describeVpcEndpointServicesRequest
- Contains the parameters for DescribeVpcEndpointServices.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your VPC endpoints.
describeVpcEndpointsRequest
- Contains the parameters for DescribeVpcEndpoints.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcPeeringConnectionsResponse describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your VPC peering connections.
describeVpcPeeringConnectionsRequest
- Contains the parameters for DescribeVpcPeeringConnections.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpcsResponse describeVpcs(DescribeVpcsRequest describeVpcsRequest) throws SdkBaseException, SdkClientException, EC2Exception
Describes one or more of your VPCs.
describeVpcsRequest
- Contains the parameters for DescribeVpcs.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpnConnectionsResponse describeVpnConnections(DescribeVpnConnectionsRequest describeVpnConnectionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeVpnConnections.SdkBaseException
SdkClientException
EC2Exception
default DescribeVpnGatewaysResponse describeVpnGateways(DescribeVpnGatewaysRequest describeVpnGatewaysRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DescribeVpnGateways.SdkBaseException
SdkClientException
EC2Exception
default DetachClassicLinkVpcResponse detachClassicLinkVpc(DetachClassicLinkVpcRequest detachClassicLinkVpcRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DetachClassicLinkVpc.SdkBaseException
SdkClientException
EC2Exception
default DetachInternetGatewayResponse detachInternetGateway(DetachInternetGatewayRequest detachInternetGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 or public IPv4 addresses.
detachInternetGatewayRequest
- Contains the parameters for DetachInternetGateway.SdkBaseException
SdkClientException
EC2Exception
default DetachNetworkInterfaceResponse detachNetworkInterface(DetachNetworkInterfaceRequest detachNetworkInterfaceRequest) throws SdkBaseException, SdkClientException, EC2Exception
Detaches a network interface from an instance.
detachNetworkInterfaceRequest
- Contains the parameters for DetachNetworkInterface.SdkBaseException
SdkClientException
EC2Exception
default DetachVolumeResponse detachVolume(DetachVolumeRequest detachVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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 can result in the volume becoming stuck in the
busy
state while detaching. If this happens, detachment can be delayed indefinitely until you
unmount the volume, force detachment, reboot the instance, or all three. If an 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
- Contains the parameters for DetachVolume.SdkBaseException
SdkClientException
EC2Exception
default DetachVpnGatewayResponse detachVpnGateway(DetachVpnGatewayRequest detachVpnGatewayRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DetachVpnGateway.SdkBaseException
SdkClientException
EC2Exception
default DisableVgwRoutePropagationResponse disableVgwRoutePropagation(DisableVgwRoutePropagationRequest disableVgwRoutePropagationRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
disableVgwRoutePropagationRequest
- Contains the parameters for DisableVgwRoutePropagation.SdkBaseException
SdkClientException
EC2Exception
default DisableVpcClassicLinkResponse disableVpcClassicLink(DisableVpcClassicLinkRequest disableVpcClassicLinkRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
disableVpcClassicLinkRequest
- Contains the parameters for DisableVpcClassicLink.SdkBaseException
SdkClientException
EC2Exception
default DisableVpcClassicLinkDnsSupportResponse disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest disableVpcClassicLinkDnsSupportRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DisableVpcClassicLinkDnsSupport.SdkBaseException
SdkClientException
EC2Exception
default DisassociateAddressResponse disassociateAddress(DisassociateAddressRequest disassociateAddressRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DisassociateAddress.SdkBaseException
SdkClientException
EC2Exception
default DisassociateIamInstanceProfileResponse disassociateIamInstanceProfile(DisassociateIamInstanceProfileRequest disassociateIamInstanceProfileRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
disassociateIamInstanceProfileRequest
- SdkBaseException
SdkClientException
EC2Exception
default DisassociateRouteTableResponse disassociateRouteTable(DisassociateRouteTableRequest disassociateRouteTableRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for DisassociateRouteTable.SdkBaseException
SdkClientException
EC2Exception
default DisassociateSubnetCidrBlockResponse disassociateSubnetCidrBlock(DisassociateSubnetCidrBlockRequest disassociateSubnetCidrBlockRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
disassociateSubnetCidrBlockRequest
- SdkBaseException
SdkClientException
EC2Exception
default DisassociateVpcCidrBlockResponse disassociateVpcCidrBlock(DisassociateVpcCidrBlockRequest disassociateVpcCidrBlockRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disassociates a CIDR block from a VPC. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
disassociateVpcCidrBlockRequest
- SdkBaseException
SdkClientException
EC2Exception
default EnableVgwRoutePropagationResponse enableVgwRoutePropagation(EnableVgwRoutePropagationRequest enableVgwRoutePropagationRequest) throws SdkBaseException, SdkClientException, EC2Exception
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
enableVgwRoutePropagationRequest
- Contains the parameters for EnableVgwRoutePropagation.SdkBaseException
SdkClientException
EC2Exception
default EnableVolumeIOResponse enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest) throws SdkBaseException, SdkClientException, EC2Exception
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
enableVolumeIORequest
- Contains the parameters for EnableVolumeIO.SdkBaseException
SdkClientException
EC2Exception
default EnableVpcClassicLinkResponse enableVpcClassicLink(EnableVpcClassicLinkRequest enableVpcClassicLinkRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for EnableVpcClassicLink.SdkBaseException
SdkClientException
EC2Exception
default EnableVpcClassicLinkDnsSupportResponse enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest enableVpcClassicLinkDnsSupportRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for EnableVpcClassicLinkDnsSupport.SdkBaseException
SdkClientException
EC2Exception
default GetConsoleOutputResponse getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for GetConsoleOutput.SdkBaseException
SdkClientException
EC2Exception
default GetConsoleScreenshotResponse getConsoleScreenshot(GetConsoleScreenshotRequest getConsoleScreenshotRequest) throws SdkBaseException, SdkClientException, EC2Exception
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
getConsoleScreenshotRequest
- Contains the parameters for the request.SdkBaseException
SdkClientException
EC2Exception
default GetHostReservationPurchasePreviewResponse getHostReservationPurchasePreview(GetHostReservationPurchasePreviewRequest getHostReservationPurchasePreviewRequest) throws SdkBaseException, SdkClientException, EC2Exception
Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
getHostReservationPurchasePreviewRequest
- SdkBaseException
SdkClientException
EC2Exception
default GetPasswordDataResponse getPasswordData(GetPasswordDataRequest getPasswordDataRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for GetPasswordData.SdkBaseException
SdkClientException
EC2Exception
default GetReservedInstancesExchangeQuoteResponse getReservedInstancesExchangeQuote(GetReservedInstancesExchangeQuoteRequest getReservedInstancesExchangeQuoteRequest) throws SdkBaseException, SdkClientException, EC2Exception
Returns details about the values and term of your specified Convertible Reserved Instances. When a target configuration is specified, it returns information about whether the exchange is valid and can be performed.
getReservedInstancesExchangeQuoteRequest
- Contains the parameters for GetReservedInstanceExchangeQuote.SdkBaseException
SdkClientException
EC2Exception
default ImportImageResponse importImage(ImportImageRequest importImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.
importImageRequest
- Contains the parameters for ImportImage.SdkBaseException
SdkClientException
EC2Exception
default ImportInstanceResponse importInstance(ImportInstanceRequest importInstanceRequest) throws SdkBaseException, SdkClientException, EC2Exception
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. For more information, see Importing a
Virtual Machine Using the Amazon EC2 CLI.
For information about the import manifest referenced by this API action, see VM Import Manifest.
importInstanceRequest
- Contains the parameters for ImportInstance.SdkBaseException
SdkClientException
EC2Exception
default ImportKeyPairResponse importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ImportKeyPair.SdkBaseException
SdkClientException
EC2Exception
default ImportSnapshotResponse importSnapshot(ImportSnapshotRequest importSnapshotRequest) throws SdkBaseException, SdkClientException, EC2Exception
Imports a disk into an EBS snapshot.
importSnapshotRequest
- Contains the parameters for ImportSnapshot.SdkBaseException
SdkClientException
EC2Exception
default ImportVolumeResponse importVolume(ImportVolumeRequest importVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
For information about the import manifest referenced by this API action, see VM Import Manifest.
importVolumeRequest
- Contains the parameters for ImportVolume.SdkBaseException
SdkClientException
EC2Exception
default ModifyHostsResponse modifyHosts(ModifyHostsRequest modifyHostsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifyHosts.SdkBaseException
SdkClientException
EC2Exception
default ModifyIdFormatResponse modifyIdFormat(ModifyIdFormatRequest modifyIdFormatRequest) throws SdkBaseException, SdkClientException, EC2Exception
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, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and
provided that they have permission to use the relevant Describe
command for the resource type.
modifyIdFormatRequest
- Contains the parameters of ModifyIdFormat.SdkBaseException
SdkClientException
EC2Exception
default ModifyIdentityIdFormatResponse modifyIdentityIdFormat(ModifyIdentityIdFormatRequest modifyIdentityIdFormatRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. 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
. For more information, see Resource IDs in the Amazon
Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and
provided that they have permission to use the relevant Describe
command for the resource type.
modifyIdentityIdFormatRequest
- Contains the parameters of ModifyIdentityIdFormat.SdkBaseException
SdkClientException
EC2Exception
default ModifyImageAttributeResponse modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.
modifyImageAttributeRequest
- Contains the parameters for ModifyImageAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyInstanceAttributeResponse modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifyInstanceAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyInstancePlacementResponse modifyInstancePlacement(ModifyInstancePlacementRequest modifyInstancePlacementRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifyInstancePlacement.SdkBaseException
SdkClientException
EC2Exception
default ModifyNetworkInterfaceAttributeResponse modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest modifyNetworkInterfaceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies the specified network interface attribute. You can specify only one attribute at a time.
modifyNetworkInterfaceAttributeRequest
- Contains the parameters for ModifyNetworkInterfaceAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyReservedInstancesResponse modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard 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
- Contains the parameters for ModifyReservedInstances.SdkBaseException
SdkClientException
EC2Exception
default ModifySnapshotAttributeResponse modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
modifySnapshotAttributeRequest
- Contains the parameters for ModifySnapshotAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifySpotFleetRequestResponse modifySpotFleetRequest(ModifySpotFleetRequestRequest modifySpotFleetRequestRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifySpotFleetRequest.SdkBaseException
SdkClientException
EC2Exception
default ModifySubnetAttributeResponse modifySubnetAttribute(ModifySubnetAttributeRequest modifySubnetAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies a subnet attribute. You can only modify one attribute at a time.
modifySubnetAttributeRequest
- Contains the parameters for ModifySubnetAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyVolumeResponse modifyVolume(ModifyVolumeRequest modifyVolumeRequest) throws SdkBaseException, SdkClientException, EC2Exception
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications.
With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.
modifyVolumeRequest
- SdkBaseException
SdkClientException
EC2Exception
default ModifyVolumeAttributeResponse modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifyVolumeAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyVpcAttributeResponse modifyVpcAttribute(ModifyVpcAttributeRequest modifyVpcAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Modifies the specified attribute of the specified VPC.
modifyVpcAttributeRequest
- Contains the parameters for ModifyVpcAttribute.SdkBaseException
SdkClientException
EC2Exception
default ModifyVpcEndpointResponse modifyVpcEndpoint(ModifyVpcEndpointRequest modifyVpcEndpointRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ModifyVpcEndpoint.SdkBaseException
SdkClientException
EC2Exception
default ModifyVpcPeeringConnectionOptionsResponse modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest modifyVpcPeeringConnectionOptionsRequest) throws SdkBaseException, SdkClientException, EC2Exception
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.
Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, 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
- SdkBaseException
SdkClientException
EC2Exception
default MonitorInstancesResponse monitorInstances(MonitorInstancesRequest monitorInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
To disable detailed monitoring, see .
monitorInstancesRequest
- Contains the parameters for MonitorInstances.SdkBaseException
SdkClientException
EC2Exception
default MoveAddressToVpcResponse moveAddressToVpc(MoveAddressToVpcRequest moveAddressToVpcRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for MoveAddressToVpc.SdkBaseException
SdkClientException
EC2Exception
default PurchaseHostReservationResponse purchaseHostReservation(PurchaseHostReservationRequest purchaseHostReservationRequest) throws SdkBaseException, SdkClientException, EC2Exception
Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
purchaseHostReservationRequest
- SdkBaseException
SdkClientException
EC2Exception
default PurchaseReservedInstancesOfferingResponse purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest) throws SdkBaseException, SdkClientException, EC2Exception
Purchases a Reserved Instance for use with your account. With Reserved Instances, you 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
- Contains the parameters for PurchaseReservedInstancesOffering.SdkBaseException
SdkClientException
EC2Exception
default PurchaseScheduledInstancesResponse purchaseScheduledInstances(PurchaseScheduledInstancesRequest purchaseScheduledInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for PurchaseScheduledInstances.SdkBaseException
SdkClientException
EC2Exception
default RebootInstancesResponse rebootInstances(RebootInstancesRequest rebootInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RebootInstances.SdkBaseException
SdkClientException
EC2Exception
default RegisterImageResponse registerImage(RegisterImageRequest registerImageRequest) throws SdkBaseException, SdkClientException, EC2Exception
Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage
to create an Amazon EBS-backed Linux AMI from a snapshot of a root
device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux
Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the 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. To create an AMI that must retain billing codes, 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.
registerImageRequest
- Contains the parameters for RegisterImage.SdkBaseException
SdkClientException
EC2Exception
default RejectVpcPeeringConnectionResponse rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest rejectVpcPeeringConnectionRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RejectVpcPeeringConnection.SdkBaseException
SdkClientException
EC2Exception
default ReleaseAddressResponse releaseAddress(ReleaseAddressRequest releaseAddressRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ReleaseAddress.SdkBaseException
SdkClientException
EC2Exception
default ReleaseHostsResponse releaseHosts(ReleaseHostsRequest releaseHostsRequest) throws SdkBaseException, SdkClientException, EC2Exception
When you no longer want to use an On-Demand 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
- Contains the parameters for ReleaseHosts.SdkBaseException
SdkClientException
EC2Exception
default ReplaceIamInstanceProfileAssociationResponse replaceIamInstanceProfileAssociation(ReplaceIamInstanceProfileAssociationRequest replaceIamInstanceProfileAssociationRequest) throws SdkBaseException, SdkClientException, EC2Exception
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
replaceIamInstanceProfileAssociationRequest
- SdkBaseException
SdkClientException
EC2Exception
default ReplaceNetworkAclAssociationResponse replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest replaceNetworkAclAssociationRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ReplaceNetworkAclAssociation.SdkBaseException
SdkClientException
EC2Exception
default ReplaceNetworkAclEntryResponse replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest replaceNetworkAclEntryRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ReplaceNetworkAclEntry.SdkBaseException
SdkClientException
EC2Exception
default ReplaceRouteResponse replaceRoute(ReplaceRouteRequest replaceRouteRequest) throws SdkBaseException, SdkClientException, EC2Exception
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, network interface, or egress-only Internet gateway.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
replaceRouteRequest
- Contains the parameters for ReplaceRoute.SdkBaseException
SdkClientException
EC2Exception
default ReplaceRouteTableAssociationResponse replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest replaceRouteTableAssociationRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ReplaceRouteTableAssociation.SdkBaseException
SdkClientException
EC2Exception
default ReportInstanceStatusResponse reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ReportInstanceStatus.SdkBaseException
SdkClientException
EC2Exception
default RequestSpotFleetResponse requestSpotFleet(RequestSpotFleetRequest requestSpotFleetRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RequestSpotFleet.SdkBaseException
SdkClientException
EC2Exception
default RequestSpotInstancesResponse requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RequestSpotInstances.SdkBaseException
SdkClientException
EC2Exception
default ResetImageAttributeResponse resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
resetImageAttributeRequest
- Contains the parameters for ResetImageAttribute.SdkBaseException
SdkClientException
EC2Exception
default ResetInstanceAttributeResponse resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ResetInstanceAttribute.SdkBaseException
SdkClientException
EC2Exception
default ResetNetworkInterfaceAttributeResponse resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest resetNetworkInterfaceAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
Resets a network interface attribute. You can specify only one attribute at a time.
resetNetworkInterfaceAttributeRequest
- Contains the parameters for ResetNetworkInterfaceAttribute.SdkBaseException
SdkClientException
EC2Exception
default ResetSnapshotAttributeResponse resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for ResetSnapshotAttribute.SdkBaseException
SdkClientException
EC2Exception
default RestoreAddressToClassicResponse restoreAddressToClassic(RestoreAddressToClassicRequest restoreAddressToClassicRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RestoreAddressToClassic.SdkBaseException
SdkClientException
EC2Exception
default RevokeSecurityGroupEgressResponse revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest revokeSecurityGroupEgressRequest) throws SdkBaseException, SdkClientException, EC2Exception
[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 IPv4 or IPv6 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
- Contains the parameters for RevokeSecurityGroupEgress.SdkBaseException
SdkClientException
EC2Exception
default RevokeSecurityGroupIngressResponse revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RevokeSecurityGroupIngress.SdkBaseException
SdkClientException
EC2Exception
default RunInstancesResponse runInstances(RunInstancesRequest runInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance Types.
If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
To ensure faster instance launches, break up large requests into smaller batches. For example, create 5 separate launch requests for 100 instances each instead of 1 launch request for 500 instances.
An instance is ready for you to use when it's in the running
state. You can check the state of your
instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or
both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.
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.
For 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
- Contains the parameters for RunInstances.SdkBaseException
SdkClientException
EC2Exception
default RunScheduledInstancesResponse runScheduledInstances(RunScheduledInstancesRequest runScheduledInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for RunScheduledInstances.SdkBaseException
SdkClientException
EC2Exception
default StartInstancesResponse startInstances(StartInstancesRequest startInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for StartInstances.SdkBaseException
SdkClientException
EC2Exception
default StopInstancesResponse stopInstances(StopInstancesRequest stopInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
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
- Contains the parameters for StopInstances.SdkBaseException
SdkClientException
EC2Exception
default TerminateInstancesResponse terminateInstances(TerminateInstancesRequest terminateInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
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
- Contains the parameters for TerminateInstances.SdkBaseException
SdkClientException
EC2Exception
default UnassignIpv6AddressesResponse unassignIpv6Addresses(UnassignIpv6AddressesRequest unassignIpv6AddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Unassigns one or more IPv6 addresses from a network interface.
unassignIpv6AddressesRequest
- SdkBaseException
SdkClientException
EC2Exception
default UnassignPrivateIpAddressesResponse unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest unassignPrivateIpAddressesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Unassigns one or more secondary private IP addresses from a network interface.
unassignPrivateIpAddressesRequest
- Contains the parameters for UnassignPrivateIpAddresses.SdkBaseException
SdkClientException
EC2Exception
default UnmonitorInstancesResponse unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest) throws SdkBaseException, SdkClientException, EC2Exception
Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
unmonitorInstancesRequest
- Contains the parameters for UnmonitorInstances.SdkBaseException
SdkClientException
EC2Exception
static ServiceMetadata serviceMetadata()
EC2ClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.