@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonEC2 extends Object implements AmazonEC2
AmazonEC2. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonEC2() |
public void setEndpoint(String endpoint)
AmazonEC2
Callers can pass in just the endpoint (ex: "ec2.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ec2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonEC2endpoint - The endpoint (ex: "ec2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ec2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonEC2AmazonEC2.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonEC2region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for accessing a given
region. Must not be null and must be a region where the service is available.Region#getRegion(com.amazonaws.regions.Regions),
Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AcceptReservedInstancesExchangeQuoteResult acceptReservedInstancesExchangeQuote(AcceptReservedInstancesExchangeQuoteRequest request)
AmazonEC2Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
acceptReservedInstancesExchangeQuote in interface AmazonEC2request - Contains the parameters for accepting the quote.public AcceptTransitGatewayMulticastDomainAssociationsResult acceptTransitGatewayMulticastDomainAssociations(AcceptTransitGatewayMulticastDomainAssociationsRequest request)
AmazonEC2Accepts a request to associate subnets with a transit gateway multicast domain.
acceptTransitGatewayMulticastDomainAssociations in interface AmazonEC2public AcceptTransitGatewayPeeringAttachmentResult acceptTransitGatewayPeeringAttachment(AcceptTransitGatewayPeeringAttachmentRequest request)
AmazonEC2
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance state.
acceptTransitGatewayPeeringAttachment in interface AmazonEC2public AcceptTransitGatewayVpcAttachmentResult acceptTransitGatewayVpcAttachment(AcceptTransitGatewayVpcAttachmentRequest request)
AmazonEC2Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use
DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use
RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
acceptTransitGatewayVpcAttachment in interface AmazonEC2public AcceptVpcEndpointConnectionsResult acceptVpcEndpointConnections(AcceptVpcEndpointConnectionsRequest request)
AmazonEC2Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
acceptVpcEndpointConnections in interface AmazonEC2public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest request)
AmazonEC2
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the
pending-acceptance state, and you must be the owner of the peer VPC. Use
DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
acceptVpcPeeringConnection in interface AmazonEC2public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection()
AmazonEC2acceptVpcPeeringConnection in interface AmazonEC2AmazonEC2.acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest)public AdvertiseByoipCidrResult advertiseByoipCidr(AdvertiseByoipCidrRequest request)
AmazonEC2Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.
It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
advertiseByoipCidr in interface AmazonEC2public AllocateAddressResult allocateAddress(AllocateAddressRequest request)
AmazonEC2Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
allocateAddress in interface AmazonEC2public AllocateAddressResult allocateAddress()
AmazonEC2allocateAddress in interface AmazonEC2AmazonEC2.allocateAddress(AllocateAddressRequest)public AllocateHostsResult allocateHosts(AllocateHostsRequest request)
AmazonEC2Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
allocateHosts in interface AmazonEC2public ApplySecurityGroupsToClientVpnTargetNetworkResult applySecurityGroupsToClientVpnTargetNetwork(ApplySecurityGroupsToClientVpnTargetNetworkRequest request)
AmazonEC2Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
applySecurityGroupsToClientVpnTargetNetwork in interface AmazonEC2public AssignIpv6AddressesResult assignIpv6Addresses(AssignIpv6AddressesRequest request)
AmazonEC2Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
assignIpv6Addresses in interface AmazonEC2public AssignPrivateIpAddressesResult assignPrivateIpAddresses(AssignPrivateIpAddressesRequest request)
AmazonEC2Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to
another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the
remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
assignPrivateIpAddresses in interface AmazonEC2request - Contains the parameters for AssignPrivateIpAddresses.public AssociateAddressResult associateAddress(AssociateAddressRequest request)
AmazonEC2Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
associateAddress in interface AmazonEC2public AssociateClientVpnTargetNetworkResult associateClientVpnTargetNetwork(AssociateClientVpnTargetNetworkRequest request)
AmazonEC2Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
associateClientVpnTargetNetwork in interface AmazonEC2public AssociateDhcpOptionsResult associateDhcpOptions(AssociateDhcpOptionsRequest request)
AmazonEC2Associates 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.
associateDhcpOptions in interface AmazonEC2public AssociateEnclaveCertificateIamRoleResult associateEnclaveCertificateIamRole(AssociateEnclaveCertificateIamRoleRequest request)
AmazonEC2Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see AWS Certificate Manager for Nitro Enclaves in the AWS Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, places the certificate, certificate chain, and encrypted private key in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS-managed KMS customer master (CMK) that has an attached attestation-based CMK policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call
s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the
AWS KMS CMK, you must grant it permission to call kms:Decrypt on AWS KMS CMK returned by the
command. For more information, see Grant the role
permission to access the certificate and encryption key in the AWS Nitro Enclaves User Guide.
associateEnclaveCertificateIamRole in interface AmazonEC2public AssociateIamInstanceProfileResult associateIamInstanceProfile(AssociateIamInstanceProfileRequest request)
AmazonEC2Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
associateIamInstanceProfile in interface AmazonEC2public AssociateRouteTableResult associateRouteTable(AssociateRouteTableRequest request)
AmazonEC2Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
associateRouteTable in interface AmazonEC2public AssociateSubnetCidrBlockResult associateSubnetCidrBlock(AssociateSubnetCidrBlockRequest request)
AmazonEC2Associates 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.
associateSubnetCidrBlock in interface AmazonEC2public AssociateTransitGatewayMulticastDomainResult associateTransitGatewayMulticastDomain(AssociateTransitGatewayMulticastDomainRequest request)
AmazonEC2Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
associateTransitGatewayMulticastDomain in interface AmazonEC2public AssociateTransitGatewayRouteTableResult associateTransitGatewayRouteTable(AssociateTransitGatewayRouteTableRequest request)
AmazonEC2Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
associateTransitGatewayRouteTable in interface AmazonEC2public AssociateVpcCidrBlockResult associateVpcCidrBlock(AssociateVpcCidrBlockRequest request)
AmazonEC2Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
associateVpcCidrBlock in interface AmazonEC2public AttachClassicLinkVpcResult attachClassicLinkVpc(AttachClassicLinkVpcRequest request)
AmazonEC2
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You
cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the
running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it
to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
attachClassicLinkVpc in interface AmazonEC2public AttachInternetGatewayResult attachInternetGateway(AttachInternetGatewayRequest request)
AmazonEC2Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
attachInternetGateway in interface AmazonEC2public AttachNetworkInterfaceResult attachNetworkInterface(AttachNetworkInterfaceRequest request)
AmazonEC2Attaches a network interface to an instance.
attachNetworkInterface in interface AmazonEC2request - Contains the parameters for AttachNetworkInterface.public AttachVolumeResult attachVolume(AttachVolumeRequest request)
AmazonEC2Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use.
If a volume has an AWS Marketplace product code:
The volume can be attached only to a stopped instance.
AWS Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
attachVolume in interface AmazonEC2public AttachVpnGatewayResult attachVpnGateway(AttachVpnGatewayRequest request)
AmazonEC2Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
attachVpnGateway in interface AmazonEC2request - Contains the parameters for AttachVpnGateway.public AuthorizeClientVpnIngressResult authorizeClientVpnIngress(AuthorizeClientVpnIngressRequest request)
AmazonEC2Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
authorizeClientVpnIngress in interface AmazonEC2public AuthorizeSecurityGroupEgressResult authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest request)
AmazonEC2[VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
authorizeSecurityGroupEgress in interface AmazonEC2public AuthorizeSecurityGroupIngressResult authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest request)
AmazonEC2Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
authorizeSecurityGroupIngress in interface AmazonEC2public BundleInstanceResult bundleInstance(BundleInstanceRequest request)
AmazonEC2Bundles 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.
bundleInstance in interface AmazonEC2request - Contains the parameters for BundleInstance.public CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest request)
AmazonEC2Cancels a bundling operation for an instance store-backed Windows instance.
cancelBundleTask in interface AmazonEC2request - Contains the parameters for CancelBundleTask.public CancelCapacityReservationResult cancelCapacityReservation(CancelCapacityReservationRequest request)
AmazonEC2
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity
Reservation's state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
cancelCapacityReservation in interface AmazonEC2public CancelConversionTaskResult cancelConversionTask(CancelConversionTaskRequest request)
AmazonEC2Cancels 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.
cancelConversionTask in interface AmazonEC2public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
AmazonEC2Cancels 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.
cancelExportTask in interface AmazonEC2public CancelImportTaskResult cancelImportTask(CancelImportTaskRequest request)
AmazonEC2Cancels an in-process import virtual machine or import snapshot task.
cancelImportTask in interface AmazonEC2public CancelImportTaskResult cancelImportTask()
AmazonEC2cancelImportTask in interface AmazonEC2AmazonEC2.cancelImportTask(CancelImportTaskRequest)public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest request)
AmazonEC2Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
cancelReservedInstancesListing in interface AmazonEC2request - Contains the parameters for CancelReservedInstancesListing.public CancelSpotFleetRequestsResult cancelSpotFleetRequests(CancelSpotFleetRequestsRequest request)
AmazonEC2Cancels 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.
cancelSpotFleetRequests in interface AmazonEC2request - Contains the parameters for CancelSpotFleetRequests.public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest request)
AmazonEC2Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
cancelSpotInstanceRequests in interface AmazonEC2request - Contains the parameters for CancelSpotInstanceRequests.public ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest request)
AmazonEC2Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
confirmProductInstance in interface AmazonEC2public CopyFpgaImageResult copyFpgaImage(CopyFpgaImageRequest request)
AmazonEC2Copies the specified Amazon FPGA Image (AFI) to the current Region.
copyFpgaImage in interface AmazonEC2public CopyImageResult copyImage(CopyImageRequest request)
AmazonEC2Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an AWS Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and
specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are
encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted
during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
copyImage in interface AmazonEC2request - Contains the parameters for CopyImage.public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
AmazonEC2Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
copySnapshot in interface AmazonEC2public CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest request)
AmazonEC2Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
createCapacityReservation in interface AmazonEC2public CreateCarrierGatewayResult createCarrierGateway(CreateCarrierGatewayRequest request)
AmazonEC2Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.
createCarrierGateway in interface AmazonEC2public CreateClientVpnEndpointResult createClientVpnEndpoint(CreateClientVpnEndpointRequest request)
AmazonEC2Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
createClientVpnEndpoint in interface AmazonEC2public CreateClientVpnRouteResult createClientVpnRoute(CreateClientVpnRouteRequest request)
AmazonEC2Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
createClientVpnRoute in interface AmazonEC2public CreateCustomerGatewayResult createCustomerGateway(CreateCustomerGatewayRequest request)
AmazonEC2Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:
7224 - reserved in the us-east-1 Region
9059 - reserved in the eu-west-1 Region
17943 - reserved in the ap-southeast-1 Region
10124 - reserved in the ap-northeast-1 Region
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.
createCustomerGateway in interface AmazonEC2request - Contains the parameters for CreateCustomerGateway.public CreateDefaultSubnetResult createDefaultSubnet(CreateDefaultSubnetRequest request)
AmazonEC2
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your
default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default
Subnet in the Amazon Virtual Private Cloud User Guide.
createDefaultSubnet in interface AmazonEC2public CreateDefaultVpcResult createDefaultVpc(CreateDefaultVpcRequest request)
AmazonEC2
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability
Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in
the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC
yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
createDefaultVpc in interface AmazonEC2public CreateDhcpOptionsResult createDhcpOptions(CreateDhcpOptionsRequest request)
AmazonEC2Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The
default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the
IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as
specified 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, ExampleCompany.com). This value is used to complete unqualified
DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces.
However, Windows and other Linux operating systems treat the value as a single domain, which results in
unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating
systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2
(broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide
(AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set
the domain-name-servers option either to AmazonProvidedDNS or to a domain name server
of your choice. For more information, see DHCP Options Sets in the
Amazon Virtual Private Cloud User Guide.
createDhcpOptions in interface AmazonEC2public CreateEgressOnlyInternetGatewayResult createEgressOnlyInternetGateway(CreateEgressOnlyInternetGatewayRequest request)
AmazonEC2[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.
createEgressOnlyInternetGateway in interface AmazonEC2public CreateFleetResult createFleet(CreateFleetRequest request)
AmazonEC2Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.
createFleet in interface AmazonEC2public CreateFlowLogsResult createFlowLogs(CreateFlowLogsRequest request)
AmazonEC2Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
createFlowLogs in interface AmazonEC2public CreateFpgaImageResult createFpgaImage(CreateFpgaImageRequest request)
AmazonEC2Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
createFpgaImage in interface AmazonEC2public CreateImageResult createImage(CreateImageRequest request)
AmazonEC2Creates 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.
createImage in interface AmazonEC2public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest request)
AmazonEC2Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
createInstanceExportTask in interface AmazonEC2public CreateInternetGatewayResult createInternetGateway(CreateInternetGatewayRequest request)
AmazonEC2Creates 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.
createInternetGateway in interface AmazonEC2public CreateInternetGatewayResult createInternetGateway()
AmazonEC2createInternetGateway in interface AmazonEC2AmazonEC2.createInternetGateway(CreateInternetGatewayRequest)public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
AmazonEC2Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
createKeyPair in interface AmazonEC2public CreateLaunchTemplateResult createLaunchTemplate(CreateLaunchTemplateRequest request)
AmazonEC2Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.
createLaunchTemplate in interface AmazonEC2public CreateLaunchTemplateVersionResult createLaunchTemplateVersion(CreateLaunchTemplateVersionRequest request)
AmazonEC2Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
createLaunchTemplateVersion in interface AmazonEC2public CreateLocalGatewayRouteResult createLocalGatewayRoute(CreateLocalGatewayRouteRequest request)
AmazonEC2Creates a static route for the specified local gateway route table.
createLocalGatewayRoute in interface AmazonEC2public CreateLocalGatewayRouteTableVpcAssociationResult createLocalGatewayRouteTableVpcAssociation(CreateLocalGatewayRouteTableVpcAssociationRequest request)
AmazonEC2Associates the specified VPC with the specified local gateway route table.
createLocalGatewayRouteTableVpcAssociation in interface AmazonEC2public CreateManagedPrefixListResult createManagedPrefixList(CreateManagedPrefixListRequest request)
AmazonEC2Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.
createManagedPrefixList in interface AmazonEC2public CreateNatGatewayResult createNatGateway(CreateNatGatewayRequest request)
AmazonEC2Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.
createNatGateway in interface AmazonEC2public CreateNetworkAclResult createNetworkAcl(CreateNetworkAclRequest request)
AmazonEC2Creates 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, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
createNetworkAcl in interface AmazonEC2public CreateNetworkAclEntryResult createNetworkAclEntry(CreateNetworkAclEntryRequest request)
AmazonEC2Creates 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.
createNetworkAclEntry in interface AmazonEC2public CreateNetworkInsightsPathResult createNetworkInsightsPath(CreateNetworkInsightsPathRequest request)
AmazonEC2Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
createNetworkInsightsPath in interface AmazonEC2public CreateNetworkInterfaceResult createNetworkInterface(CreateNetworkInterfaceRequest request)
AmazonEC2Creates 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.
createNetworkInterface in interface AmazonEC2request - Contains the parameters for CreateNetworkInterface.public CreateNetworkInterfacePermissionResult createNetworkInterfacePermission(CreateNetworkInterfacePermissionRequest request)
AmazonEC2Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single AWS account only, and only one account at a time.
createNetworkInterfacePermission in interface AmazonEC2request - Contains the parameters for CreateNetworkInterfacePermission.public CreatePlacementGroupResult createPlacementGroup(CreatePlacementGroupRequest request)
AmazonEC2Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that
benefit from low network latency, high network throughput. A spread placement group places instances
on distinct hardware. A partition placement group places groups of instances in different
partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
createPlacementGroup in interface AmazonEC2public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest request)
AmazonEC2Creates 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 can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances 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 EC2 User Guide.
createReservedInstancesListing in interface AmazonEC2request - Contains the parameters for CreateReservedInstancesListing.public CreateRouteResult createRoute(CreateRouteRequest request)
AmazonEC2Creates 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, egress-only internet gateway, or transit 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.
createRoute in interface AmazonEC2public CreateRouteTableResult createRouteTable(CreateRouteTableRequest request)
AmazonEC2Creates 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, see Route Tables in the Amazon Virtual Private Cloud User Guide.
createRouteTable in interface AmazonEC2public CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest request)
AmazonEC2Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. 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.
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.
For more information about VPC security group limits, see Amazon VPC Limits.
createSecurityGroup in interface AmazonEC2public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
AmazonEC2Creates 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.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
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 might 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.
You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
createSnapshot in interface AmazonEC2public CreateSnapshotsResult createSnapshots(CreateSnapshotsRequest request)
AmazonEC2Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
createSnapshots in interface AmazonEC2public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest request)
AmazonEC2Creates 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 EC2 User Guide for Linux Instances.
createSpotDatafeedSubscription in interface AmazonEC2request - Contains the parameters for CreateSpotDatafeedSubscription.public CreateSubnetResult createSubnet(CreateSubnetRequest request)
AmazonEC2Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
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.
When you stop an instance in a subnet, it retains its private IPv4 address. 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.
createSubnet in interface AmazonEC2public CreateTagsResult createTags(CreateTagsRequest request)
AmazonEC2Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. 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.
createTags in interface AmazonEC2public CreateTrafficMirrorFilterResult createTrafficMirrorFilter(CreateTrafficMirrorFilterRequest request)
AmazonEC2Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
createTrafficMirrorFilter in interface AmazonEC2public CreateTrafficMirrorFilterRuleResult createTrafficMirrorFilterRule(CreateTrafficMirrorFilterRuleRequest request)
AmazonEC2Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
createTrafficMirrorFilterRule in interface AmazonEC2public CreateTrafficMirrorSessionResult createTrafficMirrorSession(CreateTrafficMirrorSessionRequest request)
AmazonEC2Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
createTrafficMirrorSession in interface AmazonEC2public CreateTrafficMirrorTargetResult createTrafficMirrorTarget(CreateTrafficMirrorTargetRequest request)
AmazonEC2Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, or a Network Load Balancer.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
createTrafficMirrorTarget in interface AmazonEC2public CreateTransitGatewayResult createTransitGateway(CreateTransitGatewayRequest request)
AmazonEC2Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After
the transit gateway enters the available state, you can attach your VPCs and VPN connections to the
transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
createTransitGateway in interface AmazonEC2public CreateTransitGatewayConnectResult createTransitGatewayConnect(CreateTransitGatewayConnectRequest request)
AmazonEC2Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.
createTransitGatewayConnect in interface AmazonEC2public CreateTransitGatewayConnectPeerResult createTransitGatewayConnectPeer(CreateTransitGatewayConnectPeerRequest request)
AmazonEC2Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
createTransitGatewayConnectPeer in interface AmazonEC2public CreateTransitGatewayMulticastDomainResult createTransitGatewayMulticastDomain(CreateTransitGatewayMulticastDomainRequest request)
AmazonEC2Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
createTransitGatewayMulticastDomain in interface AmazonEC2public CreateTransitGatewayPeeringAttachmentResult createTransitGatewayPeeringAttachment(CreateTransitGatewayPeeringAttachmentRequest request)
AmazonEC2Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
createTransitGatewayPeeringAttachment in interface AmazonEC2public CreateTransitGatewayPrefixListReferenceResult createTransitGatewayPrefixListReference(CreateTransitGatewayPrefixListReferenceRequest request)
AmazonEC2Creates a reference (route) to a prefix list in a specified transit gateway route table.
createTransitGatewayPrefixListReference in interface AmazonEC2public CreateTransitGatewayRouteResult createTransitGatewayRoute(CreateTransitGatewayRouteRequest request)
AmazonEC2Creates a static route for the specified transit gateway route table.
createTransitGatewayRoute in interface AmazonEC2public CreateTransitGatewayRouteTableResult createTransitGatewayRouteTable(CreateTransitGatewayRouteTableRequest request)
AmazonEC2Creates a route table for the specified transit gateway.
createTransitGatewayRouteTable in interface AmazonEC2public CreateTransitGatewayVpcAttachmentResult createTransitGatewayVpcAttachment(CreateTransitGatewayVpcAttachmentRequest request)
AmazonEC2Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
createTransitGatewayVpcAttachment in interface AmazonEC2public CreateVolumeResult createVolume(CreateVolumeRequest request)
AmazonEC2Creates an EBS volume that can be attached to an instance in the same Availability Zone.
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. Encrypted volumes must 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 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
createVolume in interface AmazonEC2public CreateVpcResult createVpc(CreateVpcRequest request)
AmazonEC2Creates 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). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, 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.
createVpc in interface AmazonEC2public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
AmazonEC2Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
A gateway endpoint serves as a target for a route in your route table for traffic destined for the
AWS service. You can specify an endpoint policy to attach to the endpoint, which will control access to the
service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for
communicating with the specified service. You can specify the subnets in which to create an endpoint, and the
security groups to associate with the endpoint network interface.
A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for
communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.
Use DescribeVpcEndpointServices to get a list of supported services.
createVpcEndpoint in interface AmazonEC2request - Contains the parameters for CreateVpcEndpoint.public CreateVpcEndpointConnectionNotificationResult createVpcEndpointConnectionNotification(CreateVpcEndpointConnectionNotificationRequest request)
AmazonEC2Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
createVpcEndpointConnectionNotification in interface AmazonEC2public CreateVpcEndpointServiceConfigurationResult createVpcEndpointServiceConfiguration(CreateVpcEndpointServiceConfigurationRequest request)
AmazonEC2Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.
To create an endpoint service configuration, you must first create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.
If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
createVpcEndpointServiceConfiguration in interface AmazonEC2public CreateVpcPeeringConnectionResult createVpcPeeringConnection(CreateVpcPeeringConnectionRequest request)
AmazonEC2Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter 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 create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering
connection has a status of failed.
createVpcPeeringConnection in interface AmazonEC2public CreateVpcPeeringConnectionResult createVpcPeeringConnection()
AmazonEC2createVpcPeeringConnection in interface AmazonEC2AmazonEC2.createVpcPeeringConnection(CreateVpcPeeringConnectionRequest)public CreateVpnConnectionResult createVpnConnection(CreateVpnConnectionRequest request)
AmazonEC2
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway.
The 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 device.
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, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnConnection in interface AmazonEC2request - Contains the parameters for CreateVpnConnection.public CreateVpnConnectionRouteResult createVpnConnectionRoute(CreateVpnConnectionRouteRequest request)
AmazonEC2Creates 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, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnConnectionRoute in interface AmazonEC2request - Contains the parameters for CreateVpnConnectionRoute.public CreateVpnGatewayResult createVpnGateway(CreateVpnGatewayRequest request)
AmazonEC2Creates 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, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnGateway in interface AmazonEC2request - Contains the parameters for CreateVpnGateway.public DeleteCarrierGatewayResult deleteCarrierGateway(DeleteCarrierGatewayRequest request)
AmazonEC2Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
deleteCarrierGateway in interface AmazonEC2public DeleteClientVpnEndpointResult deleteClientVpnEndpoint(DeleteClientVpnEndpointRequest request)
AmazonEC2Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
deleteClientVpnEndpoint in interface AmazonEC2public DeleteClientVpnRouteResult deleteClientVpnRoute(DeleteClientVpnRouteRequest request)
AmazonEC2Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
deleteClientVpnRoute in interface AmazonEC2public DeleteCustomerGatewayResult deleteCustomerGateway(DeleteCustomerGatewayRequest request)
AmazonEC2Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
deleteCustomerGateway in interface AmazonEC2request - Contains the parameters for DeleteCustomerGateway.public DeleteDhcpOptionsResult deleteDhcpOptions(DeleteDhcpOptionsRequest request)
AmazonEC2Deletes 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.
deleteDhcpOptions in interface AmazonEC2public DeleteEgressOnlyInternetGatewayResult deleteEgressOnlyInternetGateway(DeleteEgressOnlyInternetGatewayRequest request)
AmazonEC2Deletes an egress-only internet gateway.
deleteEgressOnlyInternetGateway in interface AmazonEC2public DeleteFleetsResult deleteFleets(DeleteFleetsRequest request)
AmazonEC2Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the
instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the
deleted_running state, and the instances continue to run until they are interrupted or you terminate
them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted
instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no
instant fleets are deleted and an error is returned. There is no restriction on the number of fleets
of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Deleting an EC2 Fleet in the Amazon EC2 User Guide.
deleteFleets in interface AmazonEC2public DeleteFlowLogsResult deleteFlowLogs(DeleteFlowLogsRequest request)
AmazonEC2Deletes one or more flow logs.
deleteFlowLogs in interface AmazonEC2public DeleteFpgaImageResult deleteFpgaImage(DeleteFpgaImageRequest request)
AmazonEC2Deletes the specified Amazon FPGA Image (AFI).
deleteFpgaImage in interface AmazonEC2public DeleteInternetGatewayResult deleteInternetGateway(DeleteInternetGatewayRequest request)
AmazonEC2Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
deleteInternetGateway in interface AmazonEC2public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
AmazonEC2Deletes the specified key pair, by removing the public key from Amazon EC2.
deleteKeyPair in interface AmazonEC2public DeleteLaunchTemplateResult deleteLaunchTemplate(DeleteLaunchTemplateRequest request)
AmazonEC2Deletes a launch template. Deleting a launch template deletes all of its versions.
deleteLaunchTemplate in interface AmazonEC2public DeleteLaunchTemplateVersionsResult deleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest request)
AmazonEC2Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
deleteLaunchTemplateVersions in interface AmazonEC2public DeleteLocalGatewayRouteResult deleteLocalGatewayRoute(DeleteLocalGatewayRouteRequest request)
AmazonEC2Deletes the specified route from the specified local gateway route table.
deleteLocalGatewayRoute in interface AmazonEC2public DeleteLocalGatewayRouteTableVpcAssociationResult deleteLocalGatewayRouteTableVpcAssociation(DeleteLocalGatewayRouteTableVpcAssociationRequest request)
AmazonEC2Deletes the specified association between a VPC and local gateway route table.
deleteLocalGatewayRouteTableVpcAssociation in interface AmazonEC2public DeleteManagedPrefixListResult deleteManagedPrefixList(DeleteManagedPrefixListRequest request)
AmazonEC2Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
deleteManagedPrefixList in interface AmazonEC2public DeleteNatGatewayResult deleteNatGateway(DeleteNatGatewayRequest request)
AmazonEC2Deletes 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.
deleteNatGateway in interface AmazonEC2public DeleteNetworkAclResult deleteNetworkAcl(DeleteNetworkAclRequest request)
AmazonEC2Deletes 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.
deleteNetworkAcl in interface AmazonEC2public DeleteNetworkAclEntryResult deleteNetworkAclEntry(DeleteNetworkAclEntryRequest request)
AmazonEC2Deletes the specified ingress or egress entry (rule) from the specified network ACL.
deleteNetworkAclEntry in interface AmazonEC2public DeleteNetworkInsightsAnalysisResult deleteNetworkInsightsAnalysis(DeleteNetworkInsightsAnalysisRequest request)
AmazonEC2Deletes the specified network insights analysis.
deleteNetworkInsightsAnalysis in interface AmazonEC2public DeleteNetworkInsightsPathResult deleteNetworkInsightsPath(DeleteNetworkInsightsPathRequest request)
AmazonEC2Deletes the specified path.
deleteNetworkInsightsPath in interface AmazonEC2public DeleteNetworkInterfaceResult deleteNetworkInterface(DeleteNetworkInterfaceRequest request)
AmazonEC2Deletes the specified network interface. You must detach the network interface before you can delete it.
deleteNetworkInterface in interface AmazonEC2request - Contains the parameters for DeleteNetworkInterface.public DeleteNetworkInterfacePermissionResult deleteNetworkInterfacePermission(DeleteNetworkInterfacePermissionRequest request)
AmazonEC2Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
deleteNetworkInterfacePermission in interface AmazonEC2request - Contains the parameters for DeleteNetworkInterfacePermission.public DeletePlacementGroupResult deletePlacementGroup(DeletePlacementGroupRequest request)
AmazonEC2Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.
deletePlacementGroup in interface AmazonEC2public DeleteQueuedReservedInstancesResult deleteQueuedReservedInstances(DeleteQueuedReservedInstancesRequest request)
AmazonEC2Deletes the queued purchases for the specified Reserved Instances.
deleteQueuedReservedInstances in interface AmazonEC2public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
AmazonEC2Deletes the specified route from the specified route table.
deleteRoute in interface AmazonEC2public DeleteRouteTableResult deleteRouteTable(DeleteRouteTableRequest request)
AmazonEC2Deletes 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.
deleteRouteTable in interface AmazonEC2public DeleteSecurityGroupResult deleteSecurityGroup(DeleteSecurityGroupRequest request)
AmazonEC2Deletes 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.
deleteSecurityGroup in interface AmazonEC2public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
AmazonEC2Deletes 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.
deleteSnapshot in interface AmazonEC2public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest request)
AmazonEC2Deletes the data feed for Spot Instances.
deleteSpotDatafeedSubscription in interface AmazonEC2request - Contains the parameters for DeleteSpotDatafeedSubscription.public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription()
AmazonEC2deleteSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest)public DeleteSubnetResult deleteSubnet(DeleteSubnetRequest request)
AmazonEC2Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
deleteSubnet in interface AmazonEC2public DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonEC2Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
deleteTags in interface AmazonEC2public DeleteTrafficMirrorFilterResult deleteTrafficMirrorFilter(DeleteTrafficMirrorFilterRequest request)
AmazonEC2Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
deleteTrafficMirrorFilter in interface AmazonEC2public DeleteTrafficMirrorFilterRuleResult deleteTrafficMirrorFilterRule(DeleteTrafficMirrorFilterRuleRequest request)
AmazonEC2Deletes the specified Traffic Mirror rule.
deleteTrafficMirrorFilterRule in interface AmazonEC2public DeleteTrafficMirrorSessionResult deleteTrafficMirrorSession(DeleteTrafficMirrorSessionRequest request)
AmazonEC2Deletes the specified Traffic Mirror session.
deleteTrafficMirrorSession in interface AmazonEC2public DeleteTrafficMirrorTargetResult deleteTrafficMirrorTarget(DeleteTrafficMirrorTargetRequest request)
AmazonEC2Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
deleteTrafficMirrorTarget in interface AmazonEC2public DeleteTransitGatewayResult deleteTransitGateway(DeleteTransitGatewayRequest request)
AmazonEC2Deletes the specified transit gateway.
deleteTransitGateway in interface AmazonEC2public DeleteTransitGatewayConnectResult deleteTransitGatewayConnect(DeleteTransitGatewayConnectRequest request)
AmazonEC2Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
deleteTransitGatewayConnect in interface AmazonEC2public DeleteTransitGatewayConnectPeerResult deleteTransitGatewayConnectPeer(DeleteTransitGatewayConnectPeerRequest request)
AmazonEC2Deletes the specified Connect peer.
deleteTransitGatewayConnectPeer in interface AmazonEC2public DeleteTransitGatewayMulticastDomainResult deleteTransitGatewayMulticastDomain(DeleteTransitGatewayMulticastDomainRequest request)
AmazonEC2Deletes the specified transit gateway multicast domain.
deleteTransitGatewayMulticastDomain in interface AmazonEC2public DeleteTransitGatewayPeeringAttachmentResult deleteTransitGatewayPeeringAttachment(DeleteTransitGatewayPeeringAttachmentRequest request)
AmazonEC2Deletes a transit gateway peering attachment.
deleteTransitGatewayPeeringAttachment in interface AmazonEC2public DeleteTransitGatewayPrefixListReferenceResult deleteTransitGatewayPrefixListReference(DeleteTransitGatewayPrefixListReferenceRequest request)
AmazonEC2Deletes a reference (route) to a prefix list in a specified transit gateway route table.
deleteTransitGatewayPrefixListReference in interface AmazonEC2public DeleteTransitGatewayRouteResult deleteTransitGatewayRoute(DeleteTransitGatewayRouteRequest request)
AmazonEC2Deletes the specified route from the specified transit gateway route table.
deleteTransitGatewayRoute in interface AmazonEC2public DeleteTransitGatewayRouteTableResult deleteTransitGatewayRouteTable(DeleteTransitGatewayRouteTableRequest request)
AmazonEC2Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
deleteTransitGatewayRouteTable in interface AmazonEC2public DeleteTransitGatewayVpcAttachmentResult deleteTransitGatewayVpcAttachment(DeleteTransitGatewayVpcAttachmentRequest request)
AmazonEC2Deletes the specified VPC attachment.
deleteTransitGatewayVpcAttachment in interface AmazonEC2public DeleteVolumeResult deleteVolume(DeleteVolumeRequest request)
AmazonEC2
Deletes the specified EBS volume. The volume must be in the available state (not attached to an
instance).
The volume can 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.
deleteVolume in interface AmazonEC2public DeleteVpcResult deleteVpc(DeleteVpcRequest request)
AmazonEC2Deletes 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.
deleteVpc in interface AmazonEC2public DeleteVpcEndpointConnectionNotificationsResult deleteVpcEndpointConnectionNotifications(DeleteVpcEndpointConnectionNotificationsRequest request)
AmazonEC2Deletes one or more VPC endpoint connection notifications.
deleteVpcEndpointConnectionNotifications in interface AmazonEC2public DeleteVpcEndpointServiceConfigurationsResult deleteVpcEndpointServiceConfigurations(DeleteVpcEndpointServiceConfigurationsRequest request)
AmazonEC2
Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service
configuration, you must reject any Available or PendingAcceptance interface endpoint
connections that are attached to the service.
deleteVpcEndpointServiceConfigurations in interface AmazonEC2public DeleteVpcEndpointsResult deleteVpcEndpoints(DeleteVpcEndpointsRequest request)
AmazonEC2Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
Gateway endpoint,
Gateway Load Balancer endpoint,
Interface endpoint
The following rules apply when you delete a VPC endpoint:
When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete the endpoint network interfaces.
deleteVpcEndpoints in interface AmazonEC2request - Contains the parameters for DeleteVpcEndpoints.public DeleteVpcPeeringConnectionResult deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest request)
AmazonEC2
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter 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. You cannot delete a VPC peering
connection that's in the failed state.
deleteVpcPeeringConnection in interface AmazonEC2public DeleteVpnConnectionResult deleteVpnConnection(DeleteVpnConnectionRequest request)
AmazonEC2Deletes 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 device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.
deleteVpnConnection in interface AmazonEC2request - Contains the parameters for DeleteVpnConnection.public DeleteVpnConnectionRouteResult deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest request)
AmazonEC2Deletes 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.
deleteVpnConnectionRoute in interface AmazonEC2request - Contains the parameters for DeleteVpnConnectionRoute.public DeleteVpnGatewayResult deleteVpnGateway(DeleteVpnGatewayRequest request)
AmazonEC2Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. 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.
deleteVpnGateway in interface AmazonEC2request - Contains the parameters for DeleteVpnGateway.public DeprovisionByoipCidrResult deprovisionByoipCidr(DeprovisionByoipCidrRequest request)
AmazonEC2Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
deprovisionByoipCidr in interface AmazonEC2public DeregisterImageResult deregisterImage(DeregisterImageRequest request)
AmazonEC2Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
deregisterImage in interface AmazonEC2request - Contains the parameters for DeregisterImage.public DeregisterInstanceEventNotificationAttributesResult deregisterInstanceEventNotificationAttributes(DeregisterInstanceEventNotificationAttributesRequest request)
AmazonEC2Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
deregisterInstanceEventNotificationAttributes in interface AmazonEC2public DeregisterTransitGatewayMulticastGroupMembersResult deregisterTransitGatewayMulticastGroupMembers(DeregisterTransitGatewayMulticastGroupMembersRequest request)
AmazonEC2Deregisters the specified members (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupMembers in interface AmazonEC2public DeregisterTransitGatewayMulticastGroupSourcesResult deregisterTransitGatewayMulticastGroupSources(DeregisterTransitGatewayMulticastGroupSourcesRequest request)
AmazonEC2Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupSources in interface AmazonEC2public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
AmazonEC2Describes 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: This attribute is no longer supported. The returned value does not reflect your
actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
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.
describeAccountAttributes in interface AmazonEC2public DescribeAccountAttributesResult describeAccountAttributes()
AmazonEC2describeAccountAttributes in interface AmazonEC2AmazonEC2.describeAccountAttributes(DescribeAccountAttributesRequest)public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
AmazonEC2Describes the specified Elastic IP addresses or all 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.
describeAddresses in interface AmazonEC2public DescribeAddressesResult describeAddresses()
AmazonEC2describeAddresses in interface AmazonEC2AmazonEC2.describeAddresses(DescribeAddressesRequest)public DescribeAddressesAttributeResult describeAddressesAttribute(DescribeAddressesAttributeRequest request)
AmazonEC2Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.
describeAddressesAttribute in interface AmazonEC2public DescribeAggregateIdFormatResult describeAggregateIdFormat(DescribeAggregateIdFormatRequest request)
AmazonEC2Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
describeAggregateIdFormat in interface AmazonEC2public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest request)
AmazonEC2Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions, Zones and Outposts in the Amazon Elastic Compute Cloud User Guide.
describeAvailabilityZones in interface AmazonEC2public DescribeAvailabilityZonesResult describeAvailabilityZones()
AmazonEC2describeAvailabilityZones in interface AmazonEC2AmazonEC2.describeAvailabilityZones(DescribeAvailabilityZonesRequest)public DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest request)
AmazonEC2Describes the specified bundle tasks or all of your bundle 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.
describeBundleTasks in interface AmazonEC2public DescribeBundleTasksResult describeBundleTasks()
AmazonEC2describeBundleTasks in interface AmazonEC2AmazonEC2.describeBundleTasks(DescribeBundleTasksRequest)public DescribeByoipCidrsResult describeByoipCidrs(DescribeByoipCidrsRequest request)
AmazonEC2Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
describeByoipCidrs in interface AmazonEC2public DescribeCapacityReservationsResult describeCapacityReservations(DescribeCapacityReservationsRequest request)
AmazonEC2Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.
describeCapacityReservations in interface AmazonEC2public DescribeCarrierGatewaysResult describeCarrierGateways(DescribeCarrierGatewaysRequest request)
AmazonEC2Describes one or more of your carrier gateways.
describeCarrierGateways in interface AmazonEC2public DescribeClassicLinkInstancesResult describeClassicLinkInstances(DescribeClassicLinkInstancesRequest request)
AmazonEC2Describes 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.
describeClassicLinkInstances in interface AmazonEC2public DescribeClassicLinkInstancesResult describeClassicLinkInstances()
AmazonEC2describeClassicLinkInstances in interface AmazonEC2AmazonEC2.describeClassicLinkInstances(DescribeClassicLinkInstancesRequest)public DescribeClientVpnAuthorizationRulesResult describeClientVpnAuthorizationRules(DescribeClientVpnAuthorizationRulesRequest request)
AmazonEC2Describes the authorization rules for a specified Client VPN endpoint.
describeClientVpnAuthorizationRules in interface AmazonEC2public DescribeClientVpnConnectionsResult describeClientVpnConnections(DescribeClientVpnConnectionsRequest request)
AmazonEC2Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
describeClientVpnConnections in interface AmazonEC2public DescribeClientVpnEndpointsResult describeClientVpnEndpoints(DescribeClientVpnEndpointsRequest request)
AmazonEC2Describes one or more Client VPN endpoints in the account.
describeClientVpnEndpoints in interface AmazonEC2public DescribeClientVpnRoutesResult describeClientVpnRoutes(DescribeClientVpnRoutesRequest request)
AmazonEC2Describes the routes for the specified Client VPN endpoint.
describeClientVpnRoutes in interface AmazonEC2public DescribeClientVpnTargetNetworksResult describeClientVpnTargetNetworks(DescribeClientVpnTargetNetworksRequest request)
AmazonEC2Describes the target networks associated with the specified Client VPN endpoint.
describeClientVpnTargetNetworks in interface AmazonEC2public DescribeCoipPoolsResult describeCoipPools(DescribeCoipPoolsRequest request)
AmazonEC2Describes the specified customer-owned address pools or all of your customer-owned address pools.
describeCoipPools in interface AmazonEC2public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest request)
AmazonEC2Describes the specified conversion tasks or all 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.
describeConversionTasks in interface AmazonEC2public DescribeConversionTasksResult describeConversionTasks()
AmazonEC2describeConversionTasks in interface AmazonEC2AmazonEC2.describeConversionTasks(DescribeConversionTasksRequest)public DescribeCustomerGatewaysResult describeCustomerGateways(DescribeCustomerGatewaysRequest request)
AmazonEC2Describes one or more of your VPN customer gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
describeCustomerGateways in interface AmazonEC2request - Contains the parameters for DescribeCustomerGateways.public DescribeCustomerGatewaysResult describeCustomerGateways()
AmazonEC2describeCustomerGateways in interface AmazonEC2AmazonEC2.describeCustomerGateways(DescribeCustomerGatewaysRequest)public DescribeDhcpOptionsResult describeDhcpOptions(DescribeDhcpOptionsRequest request)
AmazonEC2Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
describeDhcpOptions in interface AmazonEC2public DescribeDhcpOptionsResult describeDhcpOptions()
AmazonEC2describeDhcpOptions in interface AmazonEC2AmazonEC2.describeDhcpOptions(DescribeDhcpOptionsRequest)public DescribeEgressOnlyInternetGatewaysResult describeEgressOnlyInternetGateways(DescribeEgressOnlyInternetGatewaysRequest request)
AmazonEC2Describes one or more of your egress-only internet gateways.
describeEgressOnlyInternetGateways in interface AmazonEC2public DescribeElasticGpusResult describeElasticGpus(DescribeElasticGpusRequest request)
AmazonEC2Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
describeElasticGpus in interface AmazonEC2public DescribeExportImageTasksResult describeExportImageTasks(DescribeExportImageTasksRequest request)
AmazonEC2Describes the specified export image tasks or all of your export image tasks.
describeExportImageTasks in interface AmazonEC2public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
AmazonEC2Describes the specified export instance tasks or all of your export instance tasks.
describeExportTasks in interface AmazonEC2public DescribeExportTasksResult describeExportTasks()
AmazonEC2describeExportTasks in interface AmazonEC2AmazonEC2.describeExportTasks(DescribeExportTasksRequest)public DescribeFastSnapshotRestoresResult describeFastSnapshotRestores(DescribeFastSnapshotRestoresRequest request)
AmazonEC2Describes the state of fast snapshot restores for your snapshots.
describeFastSnapshotRestores in interface AmazonEC2public DescribeFleetHistoryResult describeFleetHistory(DescribeFleetHistoryRequest request)
AmazonEC2Describes the events for the specified EC2 Fleet during the specified time.
EC2 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. EC2 Fleet events are available for 48 hours.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
describeFleetHistory in interface AmazonEC2public DescribeFleetInstancesResult describeFleetInstances(DescribeFleetInstancesRequest request)
AmazonEC2Describes the running instances for the specified EC2 Fleet.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
describeFleetInstances in interface AmazonEC2public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
AmazonEC2Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
describeFleets in interface AmazonEC2public DescribeFlowLogsResult describeFlowLogs(DescribeFlowLogsRequest request)
AmazonEC2Describes 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.
describeFlowLogs in interface AmazonEC2public DescribeFlowLogsResult describeFlowLogs()
AmazonEC2describeFlowLogs in interface AmazonEC2AmazonEC2.describeFlowLogs(DescribeFlowLogsRequest)public DescribeFpgaImageAttributeResult describeFpgaImageAttribute(DescribeFpgaImageAttributeRequest request)
AmazonEC2Describes the specified attribute of the specified Amazon FPGA Image (AFI).
describeFpgaImageAttribute in interface AmazonEC2public DescribeFpgaImagesResult describeFpgaImages(DescribeFpgaImagesRequest request)
AmazonEC2Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
describeFpgaImages in interface AmazonEC2public DescribeHostReservationOfferingsResult describeHostReservationOfferings(DescribeHostReservationOfferingsRequest request)
AmazonEC2Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
describeHostReservationOfferings in interface AmazonEC2public DescribeHostReservationsResult describeHostReservations(DescribeHostReservationsRequest request)
AmazonEC2Describes reservations that are associated with Dedicated Hosts in your account.
describeHostReservations in interface AmazonEC2public DescribeHostsResult describeHosts(DescribeHostsRequest request)
AmazonEC2Describes the specified Dedicated Hosts or all 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 are listed with the state
released.
describeHosts in interface AmazonEC2public DescribeHostsResult describeHosts()
AmazonEC2describeHosts in interface AmazonEC2AmazonEC2.describeHosts(DescribeHostsRequest)public DescribeIamInstanceProfileAssociationsResult describeIamInstanceProfileAssociations(DescribeIamInstanceProfileAssociationsRequest request)
AmazonEC2Describes your IAM instance profile associations.
describeIamInstanceProfileAssociations in interface AmazonEC2public DescribeIdFormatResult describeIdFormat(DescribeIdFormatRequest request)
AmazonEC2Describes 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: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
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.
describeIdFormat in interface AmazonEC2public DescribeIdFormatResult describeIdFormat()
AmazonEC2describeIdFormat in interface AmazonEC2AmazonEC2.describeIdFormat(DescribeIdFormatRequest)public DescribeIdentityIdFormatResult describeIdentityIdFormat(DescribeIdentityIdFormatRequest request)
AmazonEC2Describes 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: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
describeIdentityIdFormat in interface AmazonEC2public DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest request)
AmazonEC2Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
describeImageAttribute in interface AmazonEC2request - Contains the parameters for DescribeImageAttribute.public DescribeImagesResult describeImages(DescribeImagesRequest request)
AmazonEC2Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results in an error indicating that the AMI ID cannot be found.
describeImages in interface AmazonEC2public DescribeImagesResult describeImages()
AmazonEC2describeImages in interface AmazonEC2AmazonEC2.describeImages(DescribeImagesRequest)public DescribeImportImageTasksResult describeImportImageTasks(DescribeImportImageTasksRequest request)
AmazonEC2Displays details about an import virtual machine or import snapshot tasks that are already created.
describeImportImageTasks in interface AmazonEC2public DescribeImportImageTasksResult describeImportImageTasks()
AmazonEC2describeImportImageTasks in interface AmazonEC2AmazonEC2.describeImportImageTasks(DescribeImportImageTasksRequest)public DescribeImportSnapshotTasksResult describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest request)
AmazonEC2Describes your import snapshot tasks.
describeImportSnapshotTasks in interface AmazonEC2public DescribeImportSnapshotTasksResult describeImportSnapshotTasks()
AmazonEC2describeImportSnapshotTasks in interface AmazonEC2AmazonEC2.describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest)public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
AmazonEC2
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid
attribute values are: instanceType | kernel | ramdisk |
userData | disableApiTermination | instanceInitiatedShutdownBehavior |
rootDeviceName | blockDeviceMapping | productCodes |
sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
describeInstanceAttribute in interface AmazonEC2public DescribeInstanceCreditSpecificationsResult describeInstanceCreditSpecifications(DescribeInstanceCreditSpecificationsRequest request)
AmazonEC2
Describes the credit option for CPU usage of the specified burstable performance instances. The credit options
are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the
unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a
with the unlimited credit option. For example, if you resize a T2 instance, while it is configured
as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or
unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance
that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
describeInstanceCreditSpecifications in interface AmazonEC2public DescribeInstanceEventNotificationAttributesResult describeInstanceEventNotificationAttributes(DescribeInstanceEventNotificationAttributesRequest request)
AmazonEC2Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
describeInstanceEventNotificationAttributes in interface AmazonEC2public DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest request)
AmazonEC2Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
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 EC2 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 EC2 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 EC2 User Guide.
describeInstanceStatus in interface AmazonEC2public DescribeInstanceStatusResult describeInstanceStatus()
AmazonEC2describeInstanceStatus in interface AmazonEC2AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest)public DescribeInstanceTypeOfferingsResult describeInstanceTypeOfferings(DescribeInstanceTypeOfferingsRequest request)
AmazonEC2Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
describeInstanceTypeOfferings in interface AmazonEC2public DescribeInstanceTypesResult describeInstanceTypes(DescribeInstanceTypesRequest request)
AmazonEC2Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
describeInstanceTypes in interface AmazonEC2public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
AmazonEC2Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
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 output.
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.
describeInstances in interface AmazonEC2public DescribeInstancesResult describeInstances()
AmazonEC2describeInstances in interface AmazonEC2AmazonEC2.describeInstances(DescribeInstancesRequest)public DescribeInternetGatewaysResult describeInternetGateways(DescribeInternetGatewaysRequest request)
AmazonEC2Describes one or more of your internet gateways.
describeInternetGateways in interface AmazonEC2public DescribeInternetGatewaysResult describeInternetGateways()
AmazonEC2describeInternetGateways in interface AmazonEC2AmazonEC2.describeInternetGateways(DescribeInternetGatewaysRequest)public DescribeIpv6PoolsResult describeIpv6Pools(DescribeIpv6PoolsRequest request)
AmazonEC2Describes your IPv6 address pools.
describeIpv6Pools in interface AmazonEC2public DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest request)
AmazonEC2Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
describeKeyPairs in interface AmazonEC2public DescribeKeyPairsResult describeKeyPairs()
AmazonEC2describeKeyPairs in interface AmazonEC2AmazonEC2.describeKeyPairs(DescribeKeyPairsRequest)public DescribeLaunchTemplateVersionsResult describeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest request)
AmazonEC2Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.
describeLaunchTemplateVersions in interface AmazonEC2public DescribeLaunchTemplatesResult describeLaunchTemplates(DescribeLaunchTemplatesRequest request)
AmazonEC2Describes one or more launch templates.
describeLaunchTemplates in interface AmazonEC2public DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest request)
AmazonEC2Describes the associations between virtual interface groups and local gateway route tables.
describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations in interface AmazonEC2public DescribeLocalGatewayRouteTableVpcAssociationsResult describeLocalGatewayRouteTableVpcAssociations(DescribeLocalGatewayRouteTableVpcAssociationsRequest request)
AmazonEC2Describes the specified associations between VPCs and local gateway route tables.
describeLocalGatewayRouteTableVpcAssociations in interface AmazonEC2public DescribeLocalGatewayRouteTablesResult describeLocalGatewayRouteTables(DescribeLocalGatewayRouteTablesRequest request)
AmazonEC2Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
describeLocalGatewayRouteTables in interface AmazonEC2public DescribeLocalGatewayVirtualInterfaceGroupsResult describeLocalGatewayVirtualInterfaceGroups(DescribeLocalGatewayVirtualInterfaceGroupsRequest request)
AmazonEC2Describes the specified local gateway virtual interface groups.
describeLocalGatewayVirtualInterfaceGroups in interface AmazonEC2public DescribeLocalGatewayVirtualInterfacesResult describeLocalGatewayVirtualInterfaces(DescribeLocalGatewayVirtualInterfacesRequest request)
AmazonEC2Describes the specified local gateway virtual interfaces.
describeLocalGatewayVirtualInterfaces in interface AmazonEC2public DescribeLocalGatewaysResult describeLocalGateways(DescribeLocalGatewaysRequest request)
AmazonEC2Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
describeLocalGateways in interface AmazonEC2public DescribeManagedPrefixListsResult describeManagedPrefixLists(DescribeManagedPrefixListsRequest request)
AmazonEC2Describes your managed prefix lists and any AWS-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
describeManagedPrefixLists in interface AmazonEC2public DescribeMovingAddressesResult describeMovingAddresses(DescribeMovingAddressesRequest request)
AmazonEC2Describes 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.
describeMovingAddresses in interface AmazonEC2public DescribeMovingAddressesResult describeMovingAddresses()
AmazonEC2describeMovingAddresses in interface AmazonEC2AmazonEC2.describeMovingAddresses(DescribeMovingAddressesRequest)public DescribeNatGatewaysResult describeNatGateways(DescribeNatGatewaysRequest request)
AmazonEC2Describes one or more of your NAT gateways.
describeNatGateways in interface AmazonEC2public DescribeNetworkAclsResult describeNetworkAcls(DescribeNetworkAclsRequest request)
AmazonEC2Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
describeNetworkAcls in interface AmazonEC2public DescribeNetworkAclsResult describeNetworkAcls()
AmazonEC2describeNetworkAcls in interface AmazonEC2AmazonEC2.describeNetworkAcls(DescribeNetworkAclsRequest)public DescribeNetworkInsightsAnalysesResult describeNetworkInsightsAnalyses(DescribeNetworkInsightsAnalysesRequest request)
AmazonEC2Describes one or more of your network insights analyses.
describeNetworkInsightsAnalyses in interface AmazonEC2public DescribeNetworkInsightsPathsResult describeNetworkInsightsPaths(DescribeNetworkInsightsPathsRequest request)
AmazonEC2Describes one or more of your paths.
describeNetworkInsightsPaths in interface AmazonEC2public DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest request)
AmazonEC2Describes a network interface attribute. You can specify only one attribute at a time.
describeNetworkInterfaceAttribute in interface AmazonEC2request - Contains the parameters for DescribeNetworkInterfaceAttribute.public DescribeNetworkInterfacePermissionsResult describeNetworkInterfacePermissions(DescribeNetworkInterfacePermissionsRequest request)
AmazonEC2Describes the permissions for your network interfaces.
describeNetworkInterfacePermissions in interface AmazonEC2request - Contains the parameters for DescribeNetworkInterfacePermissions.public DescribeNetworkInterfacesResult describeNetworkInterfaces(DescribeNetworkInterfacesRequest request)
AmazonEC2Describes one or more of your network interfaces.
describeNetworkInterfaces in interface AmazonEC2request - Contains the parameters for DescribeNetworkInterfaces.public DescribeNetworkInterfacesResult describeNetworkInterfaces()
AmazonEC2describeNetworkInterfaces in interface AmazonEC2AmazonEC2.describeNetworkInterfaces(DescribeNetworkInterfacesRequest)public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest request)
AmazonEC2Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
describePlacementGroups in interface AmazonEC2public DescribePlacementGroupsResult describePlacementGroups()
AmazonEC2describePlacementGroups in interface AmazonEC2AmazonEC2.describePlacementGroups(DescribePlacementGroupsRequest)public DescribePrefixListsResult describePrefixLists(DescribePrefixListsRequest request)
AmazonEC2Describes 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.
We recommend that you use DescribeManagedPrefixLists instead.
describePrefixLists in interface AmazonEC2public DescribePrefixListsResult describePrefixLists()
AmazonEC2describePrefixLists in interface AmazonEC2AmazonEC2.describePrefixLists(DescribePrefixListsRequest)public DescribePrincipalIdFormatResult describePrincipalIdFormat(DescribePrincipalIdFormatRequest request)
AmazonEC2Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
describePrincipalIdFormat in interface AmazonEC2public DescribePublicIpv4PoolsResult describePublicIpv4Pools(DescribePublicIpv4PoolsRequest request)
AmazonEC2Describes the specified IPv4 address pools.
describePublicIpv4Pools in interface AmazonEC2public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
AmazonEC2Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.
For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.
describeRegions in interface AmazonEC2public DescribeRegionsResult describeRegions()
AmazonEC2describeRegions in interface AmazonEC2AmazonEC2.describeRegions(DescribeRegionsRequest)public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)
AmazonEC2Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
describeReservedInstances in interface AmazonEC2request - Contains the parameters for DescribeReservedInstances.public DescribeReservedInstancesResult describeReservedInstances()
AmazonEC2describeReservedInstances in interface AmazonEC2AmazonEC2.describeReservedInstances(DescribeReservedInstancesRequest)public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest request)
AmazonEC2Describes 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 EC2 User Guide.
describeReservedInstancesListings in interface AmazonEC2request - Contains the parameters for DescribeReservedInstancesListings.public DescribeReservedInstancesListingsResult describeReservedInstancesListings()
AmazonEC2describeReservedInstancesListings in interface AmazonEC2AmazonEC2.describeReservedInstancesListings(DescribeReservedInstancesListingsRequest)public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest request)
AmazonEC2Describes 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 EC2 User Guide.
describeReservedInstancesModifications in interface AmazonEC2request - Contains the parameters for DescribeReservedInstancesModifications.public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications()
AmazonEC2describeReservedInstancesModifications in interface AmazonEC2AmazonEC2.describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest)public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest request)
AmazonEC2Describes 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 EC2 User Guide.
describeReservedInstancesOfferings in interface AmazonEC2request - Contains the parameters for DescribeReservedInstancesOfferings.public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings()
AmazonEC2describeReservedInstancesOfferings in interface AmazonEC2AmazonEC2.describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest)public DescribeRouteTablesResult describeRouteTables(DescribeRouteTablesRequest request)
AmazonEC2Describes 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, see Route Tables in the Amazon Virtual Private Cloud User Guide.
describeRouteTables in interface AmazonEC2public DescribeRouteTablesResult describeRouteTables()
AmazonEC2describeRouteTables in interface AmazonEC2AmazonEC2.describeRouteTables(DescribeRouteTablesRequest)public DescribeScheduledInstanceAvailabilityResult describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest request)
AmazonEC2Finds 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.
describeScheduledInstanceAvailability in interface AmazonEC2request - Contains the parameters for DescribeScheduledInstanceAvailability.public DescribeScheduledInstancesResult describeScheduledInstances(DescribeScheduledInstancesRequest request)
AmazonEC2Describes the specified Scheduled Instances or all your Scheduled Instances.
describeScheduledInstances in interface AmazonEC2request - Contains the parameters for DescribeScheduledInstances.public DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest request)
AmazonEC2[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.
describeSecurityGroupReferences in interface AmazonEC2public DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest request)
AmazonEC2Describes the specified security groups or all 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.
describeSecurityGroups in interface AmazonEC2public DescribeSecurityGroupsResult describeSecurityGroups()
AmazonEC2describeSecurityGroups in interface AmazonEC2AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest)public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest request)
AmazonEC2Describes 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.
describeSnapshotAttribute in interface AmazonEC2public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
AmazonEC2Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have 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 filtered 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, we recommend that you 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.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
describeSnapshots in interface AmazonEC2public DescribeSnapshotsResult describeSnapshots()
AmazonEC2describeSnapshots in interface AmazonEC2AmazonEC2.describeSnapshots(DescribeSnapshotsRequest)public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest request)
AmazonEC2Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
describeSpotDatafeedSubscription in interface AmazonEC2request - Contains the parameters for DescribeSpotDatafeedSubscription.public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription()
AmazonEC2describeSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest)public DescribeSpotFleetInstancesResult describeSpotFleetInstances(DescribeSpotFleetInstancesRequest request)
AmazonEC2Describes the running instances for the specified Spot Fleet.
describeSpotFleetInstances in interface AmazonEC2request - Contains the parameters for DescribeSpotFleetInstances.public DescribeSpotFleetRequestHistoryResult describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest request)
AmazonEC2Describes 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. Spot Fleet events are available for 48 hours.
describeSpotFleetRequestHistory in interface AmazonEC2request - Contains the parameters for DescribeSpotFleetRequestHistory.public DescribeSpotFleetRequestsResult describeSpotFleetRequests(DescribeSpotFleetRequestsRequest request)
AmazonEC2Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
describeSpotFleetRequests in interface AmazonEC2request - Contains the parameters for DescribeSpotFleetRequests.public DescribeSpotFleetRequestsResult describeSpotFleetRequests()
AmazonEC2describeSpotFleetRequests in interface AmazonEC2AmazonEC2.describeSpotFleetRequests(DescribeSpotFleetRequestsRequest)public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest request)
AmazonEC2Describes the specified Spot Instance requests.
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.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results
returned. This paginates the output, which makes the list more manageable and returns the results faster. 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 DescribeSpotInstanceRequests request
to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
describeSpotInstanceRequests in interface AmazonEC2request - Contains the parameters for DescribeSpotInstanceRequests.public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests()
AmazonEC2describeSpotInstanceRequests in interface AmazonEC2AmazonEC2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest)public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest request)
AmazonEC2Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
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.
describeSpotPriceHistory in interface AmazonEC2request - Contains the parameters for DescribeSpotPriceHistory.public DescribeSpotPriceHistoryResult describeSpotPriceHistory()
AmazonEC2describeSpotPriceHistory in interface AmazonEC2AmazonEC2.describeSpotPriceHistory(DescribeSpotPriceHistoryRequest)public DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest request)
AmazonEC2[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.
describeStaleSecurityGroups in interface AmazonEC2public DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest request)
AmazonEC2Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
describeSubnets in interface AmazonEC2public DescribeSubnetsResult describeSubnets()
AmazonEC2describeSubnets in interface AmazonEC2AmazonEC2.describeSubnets(DescribeSubnetsRequest)public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonEC2Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
describeTags in interface AmazonEC2public DescribeTagsResult describeTags()
AmazonEC2describeTags in interface AmazonEC2AmazonEC2.describeTags(DescribeTagsRequest)public DescribeTrafficMirrorFiltersResult describeTrafficMirrorFilters(DescribeTrafficMirrorFiltersRequest request)
AmazonEC2Describes one or more Traffic Mirror filters.
describeTrafficMirrorFilters in interface AmazonEC2public DescribeTrafficMirrorSessionsResult describeTrafficMirrorSessions(DescribeTrafficMirrorSessionsRequest request)
AmazonEC2Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
describeTrafficMirrorSessions in interface AmazonEC2public DescribeTrafficMirrorTargetsResult describeTrafficMirrorTargets(DescribeTrafficMirrorTargetsRequest request)
AmazonEC2Information about one or more Traffic Mirror targets.
describeTrafficMirrorTargets in interface AmazonEC2public DescribeTransitGatewayAttachmentsResult describeTransitGatewayAttachments(DescribeTransitGatewayAttachmentsRequest request)
AmazonEC2Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
describeTransitGatewayAttachments in interface AmazonEC2public DescribeTransitGatewayConnectPeersResult describeTransitGatewayConnectPeers(DescribeTransitGatewayConnectPeersRequest request)
AmazonEC2Describes one or more Connect peers.
describeTransitGatewayConnectPeers in interface AmazonEC2public DescribeTransitGatewayConnectsResult describeTransitGatewayConnects(DescribeTransitGatewayConnectsRequest request)
AmazonEC2Describes one or more Connect attachments.
describeTransitGatewayConnects in interface AmazonEC2public DescribeTransitGatewayMulticastDomainsResult describeTransitGatewayMulticastDomains(DescribeTransitGatewayMulticastDomainsRequest request)
AmazonEC2Describes one or more transit gateway multicast domains.
describeTransitGatewayMulticastDomains in interface AmazonEC2public DescribeTransitGatewayPeeringAttachmentsResult describeTransitGatewayPeeringAttachments(DescribeTransitGatewayPeeringAttachmentsRequest request)
AmazonEC2Describes your transit gateway peering attachments.
describeTransitGatewayPeeringAttachments in interface AmazonEC2public DescribeTransitGatewayRouteTablesResult describeTransitGatewayRouteTables(DescribeTransitGatewayRouteTablesRequest request)
AmazonEC2Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
describeTransitGatewayRouteTables in interface AmazonEC2public DescribeTransitGatewayVpcAttachmentsResult describeTransitGatewayVpcAttachments(DescribeTransitGatewayVpcAttachmentsRequest request)
AmazonEC2Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
describeTransitGatewayVpcAttachments in interface AmazonEC2public DescribeTransitGatewaysResult describeTransitGateways(DescribeTransitGatewaysRequest request)
AmazonEC2Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
describeTransitGateways in interface AmazonEC2public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest request)
AmazonEC2Describes 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.
describeVolumeAttribute in interface AmazonEC2public DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest request)
AmazonEC2Describes 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 might still be taking place on your volume at the time.
We recommend that you retry the request. For more information about volume status, see Monitoring the status of
your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might 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 might have inconsistent data.
Actions: Reflect the actions you might 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.)
describeVolumeStatus in interface AmazonEC2public DescribeVolumeStatusResult describeVolumeStatus()
AmazonEC2describeVolumeStatus in interface AmazonEC2AmazonEC2.describeVolumeStatus(DescribeVolumeStatusRequest)public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
AmazonEC2Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you 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.
describeVolumes in interface AmazonEC2public DescribeVolumesResult describeVolumes()
AmazonEC2describeVolumes in interface AmazonEC2AmazonEC2.describeVolumes(DescribeVolumesRequest)public DescribeVolumesModificationsResult describeVolumesModifications(DescribeVolumesModificationsRequest request)
AmazonEC2Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
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 in the Amazon Elastic Compute Cloud User Guide.
describeVolumesModifications in interface AmazonEC2public DescribeVpcAttributeResult describeVpcAttribute(DescribeVpcAttributeRequest request)
AmazonEC2Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
describeVpcAttribute in interface AmazonEC2public DescribeVpcClassicLinkResult describeVpcClassicLink(DescribeVpcClassicLinkRequest request)
AmazonEC2Describes the ClassicLink status of one or more VPCs.
describeVpcClassicLink in interface AmazonEC2public DescribeVpcClassicLinkResult describeVpcClassicLink()
AmazonEC2describeVpcClassicLink in interface AmazonEC2AmazonEC2.describeVpcClassicLink(DescribeVpcClassicLinkRequest)public DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest request)
AmazonEC2Describes 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.
describeVpcClassicLinkDnsSupport in interface AmazonEC2public DescribeVpcEndpointConnectionNotificationsResult describeVpcEndpointConnectionNotifications(DescribeVpcEndpointConnectionNotificationsRequest request)
AmazonEC2Describes the connection notifications for VPC endpoints and VPC endpoint services.
describeVpcEndpointConnectionNotifications in interface AmazonEC2public DescribeVpcEndpointConnectionsResult describeVpcEndpointConnections(DescribeVpcEndpointConnectionsRequest request)
AmazonEC2Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
describeVpcEndpointConnections in interface AmazonEC2public DescribeVpcEndpointServiceConfigurationsResult describeVpcEndpointServiceConfigurations(DescribeVpcEndpointServiceConfigurationsRequest request)
AmazonEC2Describes the VPC endpoint service configurations in your account (your services).
describeVpcEndpointServiceConfigurations in interface AmazonEC2public DescribeVpcEndpointServicePermissionsResult describeVpcEndpointServicePermissions(DescribeVpcEndpointServicePermissionsRequest request)
AmazonEC2Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
describeVpcEndpointServicePermissions in interface AmazonEC2public DescribeVpcEndpointServicesResult describeVpcEndpointServices(DescribeVpcEndpointServicesRequest request)
AmazonEC2Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the
consumer views the VPC endpoint service information, the response only includes the common Availability Zones.
For example, when the service provider account uses us-east-1a and us-east-1c and the
consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint
services in the common Availability Zone, us-east-1a.
describeVpcEndpointServices in interface AmazonEC2request - Contains the parameters for DescribeVpcEndpointServices.public DescribeVpcEndpointServicesResult describeVpcEndpointServices()
AmazonEC2describeVpcEndpointServices in interface AmazonEC2AmazonEC2.describeVpcEndpointServices(DescribeVpcEndpointServicesRequest)public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
AmazonEC2Describes one or more of your VPC endpoints.
describeVpcEndpoints in interface AmazonEC2request - Contains the parameters for DescribeVpcEndpoints.public DescribeVpcEndpointsResult describeVpcEndpoints()
AmazonEC2describeVpcEndpoints in interface AmazonEC2AmazonEC2.describeVpcEndpoints(DescribeVpcEndpointsRequest)public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest request)
AmazonEC2Describes one or more of your VPC peering connections.
describeVpcPeeringConnections in interface AmazonEC2public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections()
AmazonEC2describeVpcPeeringConnections in interface AmazonEC2AmazonEC2.describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest)public DescribeVpcsResult describeVpcs(DescribeVpcsRequest request)
AmazonEC2Describes one or more of your VPCs.
describeVpcs in interface AmazonEC2public DescribeVpcsResult describeVpcs()
AmazonEC2describeVpcs in interface AmazonEC2AmazonEC2.describeVpcs(DescribeVpcsRequest)public DescribeVpnConnectionsResult describeVpnConnections(DescribeVpnConnectionsRequest request)
AmazonEC2Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
describeVpnConnections in interface AmazonEC2request - Contains the parameters for DescribeVpnConnections.public DescribeVpnConnectionsResult describeVpnConnections()
AmazonEC2describeVpnConnections in interface AmazonEC2AmazonEC2.describeVpnConnections(DescribeVpnConnectionsRequest)public DescribeVpnGatewaysResult describeVpnGateways(DescribeVpnGatewaysRequest request)
AmazonEC2Describes one or more of your virtual private gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
describeVpnGateways in interface AmazonEC2request - Contains the parameters for DescribeVpnGateways.public DescribeVpnGatewaysResult describeVpnGateways()
AmazonEC2describeVpnGateways in interface AmazonEC2AmazonEC2.describeVpnGateways(DescribeVpnGatewaysRequest)public DetachClassicLinkVpcResult detachClassicLinkVpc(DetachClassicLinkVpcRequest request)
AmazonEC2Unlinks (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.
detachClassicLinkVpc in interface AmazonEC2public DetachInternetGatewayResult detachInternetGateway(DetachInternetGatewayRequest request)
AmazonEC2Detaches 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.
detachInternetGateway in interface AmazonEC2public DetachNetworkInterfaceResult detachNetworkInterface(DetachNetworkInterfaceRequest request)
AmazonEC2Detaches a network interface from an instance.
detachNetworkInterface in interface AmazonEC2request - Contains the parameters for DetachNetworkInterface.public DetachVolumeResult detachVolume(DetachVolumeRequest request)
AmazonEC2
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your
operating system before detaching the volume. Failure to do so 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.
detachVolume in interface AmazonEC2public DetachVpnGatewayResult detachVpnGateway(DetachVpnGatewayRequest request)
AmazonEC2Detaches 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.
detachVpnGateway in interface AmazonEC2request - Contains the parameters for DetachVpnGateway.public DisableEbsEncryptionByDefaultResult disableEbsEncryptionByDefault(DisableEbsEncryptionByDefaultRequest request)
AmazonEC2Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
disableEbsEncryptionByDefault in interface AmazonEC2public DisableFastSnapshotRestoresResult disableFastSnapshotRestores(DisableFastSnapshotRestoresRequest request)
AmazonEC2Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
disableFastSnapshotRestores in interface AmazonEC2public DisableTransitGatewayRouteTablePropagationResult disableTransitGatewayRouteTablePropagation(DisableTransitGatewayRouteTablePropagationRequest request)
AmazonEC2Disables the specified resource attachment from propagating routes to the specified propagation route table.
disableTransitGatewayRouteTablePropagation in interface AmazonEC2public DisableVgwRoutePropagationResult disableVgwRoutePropagation(DisableVgwRoutePropagationRequest request)
AmazonEC2Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
disableVgwRoutePropagation in interface AmazonEC2request - Contains the parameters for DisableVgwRoutePropagation.public DisableVpcClassicLinkResult disableVpcClassicLink(DisableVpcClassicLinkRequest request)
AmazonEC2Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
disableVpcClassicLink in interface AmazonEC2public DisableVpcClassicLinkDnsSupportResult disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest request)
AmazonEC2Disables 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, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
disableVpcClassicLinkDnsSupport in interface AmazonEC2public DisassociateAddressResult disassociateAddress(DisassociateAddressRequest request)
AmazonEC2Disassociates 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.
disassociateAddress in interface AmazonEC2public DisassociateClientVpnTargetNetworkResult disassociateClientVpnTargetNetwork(DisassociateClientVpnTargetNetworkRequest request)
AmazonEC2Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to pending-associate
disassociateClientVpnTargetNetwork in interface AmazonEC2public DisassociateEnclaveCertificateIamRoleResult disassociateEnclaveCertificateIamRole(DisassociateEnclaveCertificateIamRoleRequest request)
AmazonEC2Disassociates an IAM role from an AWS Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the AWS Key Management Service (KMS) customer master key (CMK) used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
disassociateEnclaveCertificateIamRole in interface AmazonEC2public DisassociateIamInstanceProfileResult disassociateIamInstanceProfile(DisassociateIamInstanceProfileRequest request)
AmazonEC2Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
disassociateIamInstanceProfile in interface AmazonEC2public DisassociateRouteTableResult disassociateRouteTable(DisassociateRouteTableRequest request)
AmazonEC2Disassociates a subnet or gateway 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.
disassociateRouteTable in interface AmazonEC2public DisassociateSubnetCidrBlockResult disassociateSubnetCidrBlock(DisassociateSubnetCidrBlockRequest request)
AmazonEC2Disassociates 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.
disassociateSubnetCidrBlock in interface AmazonEC2public DisassociateTransitGatewayMulticastDomainResult disassociateTransitGatewayMulticastDomain(DisassociateTransitGatewayMulticastDomainRequest request)
AmazonEC2Disassociates the specified subnets from the transit gateway multicast domain.
disassociateTransitGatewayMulticastDomain in interface AmazonEC2public DisassociateTransitGatewayRouteTableResult disassociateTransitGatewayRouteTable(DisassociateTransitGatewayRouteTableRequest request)
AmazonEC2Disassociates a resource attachment from a transit gateway route table.
disassociateTransitGatewayRouteTable in interface AmazonEC2public DisassociateVpcCidrBlockResult disassociateVpcCidrBlock(DisassociateVpcCidrBlockRequest request)
AmazonEC2Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
disassociateVpcCidrBlock in interface AmazonEC2public EnableEbsEncryptionByDefaultResult enableEbsEncryptionByDefault(EnableEbsEncryptionByDefaultRequest request)
AmazonEC2Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are are always encrypted, either using the default CMK or the CMK that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
enableEbsEncryptionByDefault in interface AmazonEC2public EnableFastSnapshotRestoresResult enableFastSnapshotRestores(EnableFastSnapshotRestoresRequest request)
AmazonEC2Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the
current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot
restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
enableFastSnapshotRestores in interface AmazonEC2public EnableTransitGatewayRouteTablePropagationResult enableTransitGatewayRouteTablePropagation(EnableTransitGatewayRouteTablePropagationRequest request)
AmazonEC2Enables the specified attachment to propagate routes to the specified propagation route table.
enableTransitGatewayRouteTablePropagation in interface AmazonEC2public EnableVgwRoutePropagationResult enableVgwRoutePropagation(EnableVgwRoutePropagationRequest request)
AmazonEC2Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
enableVgwRoutePropagation in interface AmazonEC2request - Contains the parameters for EnableVgwRoutePropagation.public EnableVolumeIOResult enableVolumeIO(EnableVolumeIORequest request)
AmazonEC2Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
enableVolumeIO in interface AmazonEC2public EnableVpcClassicLinkResult enableVpcClassicLink(EnableVpcClassicLinkRequest request)
AmazonEC2
Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow
communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC 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.
enableVpcClassicLink in interface AmazonEC2public EnableVpcClassicLinkDnsSupportResult enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest request)
AmazonEC2Enables 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, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
enableVpcClassicLinkDnsSupport in interface AmazonEC2public ExportClientVpnClientCertificateRevocationListResult exportClientVpnClientCertificateRevocationList(ExportClientVpnClientCertificateRevocationListRequest request)
AmazonEC2Downloads the client certificate revocation list for the specified Client VPN endpoint.
exportClientVpnClientCertificateRevocationList in interface AmazonEC2public ExportClientVpnClientConfigurationResult exportClientVpnClientConfiguration(ExportClientVpnClientConfigurationRequest request)
AmazonEC2Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
exportClientVpnClientConfiguration in interface AmazonEC2public ExportImageResult exportImage(ExportImageRequest request)
AmazonEC2Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM Directory from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
exportImage in interface AmazonEC2public ExportTransitGatewayRoutesResult exportTransitGatewayRoutes(ExportTransitGatewayRoutesRequest request)
AmazonEC2Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
exportTransitGatewayRoutes in interface AmazonEC2public GetAssociatedEnclaveCertificateIamRolesResult getAssociatedEnclaveCertificateIamRoles(GetAssociatedEnclaveCertificateIamRolesRequest request)
AmazonEC2Returns the IAM roles that are associated with the specified AWS Certificate Manager (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the AWS Key Management Service (KMS) customer master key (CMK) that's used to encrypt the private key.
getAssociatedEnclaveCertificateIamRoles in interface AmazonEC2public GetAssociatedIpv6PoolCidrsResult getAssociatedIpv6PoolCidrs(GetAssociatedIpv6PoolCidrsRequest request)
AmazonEC2Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
getAssociatedIpv6PoolCidrs in interface AmazonEC2public GetCapacityReservationUsageResult getCapacityReservationUsage(GetCapacityReservationUsageRequest request)
AmazonEC2Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
getCapacityReservationUsage in interface AmazonEC2public GetCoipPoolUsageResult getCoipPoolUsage(GetCoipPoolUsageRequest request)
AmazonEC2Describes the allocations from the specified customer-owned address pool.
getCoipPoolUsage in interface AmazonEC2public GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest request)
AmazonEC2Gets the console output for the specified instance. 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. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
getConsoleOutput in interface AmazonEC2public GetConsoleScreenshotResult getConsoleScreenshot(GetConsoleScreenshotRequest request)
AmazonEC2Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
getConsoleScreenshot in interface AmazonEC2public GetDefaultCreditSpecificationResult getDefaultCreditSpecification(GetDefaultCreditSpecificationRequest request)
AmazonEC2Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
getDefaultCreditSpecification in interface AmazonEC2public GetEbsDefaultKmsKeyIdResult getEbsDefaultKmsKeyId(GetEbsDefaultKmsKeyIdRequest request)
AmazonEC2Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region. You can change the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
getEbsDefaultKmsKeyId in interface AmazonEC2public GetEbsEncryptionByDefaultResult getEbsEncryptionByDefault(GetEbsEncryptionByDefaultRequest request)
AmazonEC2Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
getEbsEncryptionByDefault in interface AmazonEC2public GetGroupsForCapacityReservationResult getGroupsForCapacityReservation(GetGroupsForCapacityReservationRequest request)
AmazonEC2Lists the resource groups to which a Capacity Reservation has been added.
getGroupsForCapacityReservation in interface AmazonEC2public GetHostReservationPurchasePreviewResult getHostReservationPurchasePreview(GetHostReservationPurchasePreviewRequest request)
AmazonEC2Preview 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.
getHostReservationPurchasePreview in interface AmazonEC2public GetLaunchTemplateDataResult getLaunchTemplateData(GetLaunchTemplateDataRequest request)
AmazonEC2Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance
configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests,
DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or,
you can allow describe* depending on your instance requirements.
getLaunchTemplateData in interface AmazonEC2public GetManagedPrefixListAssociationsResult getManagedPrefixListAssociations(GetManagedPrefixListAssociationsRequest request)
AmazonEC2Gets information about the resources that are associated with the specified managed prefix list.
getManagedPrefixListAssociations in interface AmazonEC2public GetManagedPrefixListEntriesResult getManagedPrefixListEntries(GetManagedPrefixListEntriesRequest request)
AmazonEC2Gets information about the entries for a specified managed prefix list.
getManagedPrefixListEntries in interface AmazonEC2public GetPasswordDataResult getPasswordData(GetPasswordDataRequest request)
AmazonEC2Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts
(Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more
information, see EC2Config and EC2Launch in the Amazon EC2
User Guide.
For the EC2Config service, 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.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
getPasswordData in interface AmazonEC2public GetReservedInstancesExchangeQuoteResult getReservedInstancesExchangeQuote(GetReservedInstancesExchangeQuoteRequest request)
AmazonEC2Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
getReservedInstancesExchangeQuote in interface AmazonEC2request - Contains the parameters for GetReservedInstanceExchangeQuote.public GetTransitGatewayAttachmentPropagationsResult getTransitGatewayAttachmentPropagations(GetTransitGatewayAttachmentPropagationsRequest request)
AmazonEC2Lists the route tables to which the specified resource attachment propagates routes.
getTransitGatewayAttachmentPropagations in interface AmazonEC2public GetTransitGatewayMulticastDomainAssociationsResult getTransitGatewayMulticastDomainAssociations(GetTransitGatewayMulticastDomainAssociationsRequest request)
AmazonEC2Gets information about the associations for the transit gateway multicast domain.
getTransitGatewayMulticastDomainAssociations in interface AmazonEC2public GetTransitGatewayPrefixListReferencesResult getTransitGatewayPrefixListReferences(GetTransitGatewayPrefixListReferencesRequest request)
AmazonEC2Gets information about the prefix list references in a specified transit gateway route table.
getTransitGatewayPrefixListReferences in interface AmazonEC2public GetTransitGatewayRouteTableAssociationsResult getTransitGatewayRouteTableAssociations(GetTransitGatewayRouteTableAssociationsRequest request)
AmazonEC2Gets information about the associations for the specified transit gateway route table.
getTransitGatewayRouteTableAssociations in interface AmazonEC2public GetTransitGatewayRouteTablePropagationsResult getTransitGatewayRouteTablePropagations(GetTransitGatewayRouteTablePropagationsRequest request)
AmazonEC2Gets information about the route table propagations for the specified transit gateway route table.
getTransitGatewayRouteTablePropagations in interface AmazonEC2public ImportClientVpnClientCertificateRevocationListResult importClientVpnClientCertificateRevocationList(ImportClientVpnClientCertificateRevocationListRequest request)
AmazonEC2Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
importClientVpnClientCertificateRevocationList in interface AmazonEC2public ImportImageResult importImage(ImportImageRequest request)
AmazonEC2Import 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.
importImage in interface AmazonEC2public ImportImageResult importImage()
AmazonEC2importImage in interface AmazonEC2AmazonEC2.importImage(ImportImageRequest)public ImportInstanceResult importInstance(ImportInstanceRequest request)
AmazonEC2
Creates an import instance task using metadata from the specified disk image. ImportInstance only
supports single-volume VMs. To import multi-volume VMs, use ImportImage. 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.
importInstance in interface AmazonEC2public ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
AmazonEC2Imports 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.
importKeyPair in interface AmazonEC2public ImportSnapshotResult importSnapshot(ImportSnapshotRequest request)
AmazonEC2Imports a disk into an EBS snapshot.
importSnapshot in interface AmazonEC2public ImportSnapshotResult importSnapshot()
AmazonEC2importSnapshot in interface AmazonEC2AmazonEC2.importSnapshot(ImportSnapshotRequest)public ImportVolumeResult importVolume(ImportVolumeRequest request)
AmazonEC2Creates 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.
importVolume in interface AmazonEC2public ModifyAddressAttributeResult modifyAddressAttribute(ModifyAddressAttributeRequest request)
AmazonEC2Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.
modifyAddressAttribute in interface AmazonEC2public ModifyAvailabilityZoneGroupResult modifyAvailabilityZoneGroup(ModifyAvailabilityZoneGroupRequest request)
AmazonEC2Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use
DescribeAvailabilityZones to view the value for GroupName.
modifyAvailabilityZoneGroup in interface AmazonEC2public ModifyCapacityReservationResult modifyCapacityReservation(ModifyCapacityReservationRequest request)
AmazonEC2Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
modifyCapacityReservation in interface AmazonEC2public ModifyClientVpnEndpointResult modifyClientVpnEndpoint(ModifyClientVpnEndpointRequest request)
AmazonEC2Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
modifyClientVpnEndpoint in interface AmazonEC2public ModifyDefaultCreditSpecificationResult modifyDefaultCreditSpecification(ModifyDefaultCreditSpecificationRequest request)
AmazonEC2Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS Region level
and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes.
But if instances are launched during this operation, they might not get the new credit option until the zone is
updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and
check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
modifyDefaultCreditSpecification in interface AmazonEC2public ModifyEbsDefaultKmsKeyIdResult modifyEbsDefaultKmsKeyId(ModifyEbsDefaultKmsKeyIdRequest request)
AmazonEC2Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
AWS creates a unique AWS managed CMK in each Region for use with encryption by default. If you change the default CMK to a symmetric customer managed CMK, it is used instead of the AWS managed CMK. To reset the default CMK to the AWS managed CMK for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric CMKs.
If you delete or disable the customer managed CMK that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
modifyEbsDefaultKmsKeyId in interface AmazonEC2public ModifyFleetResult modifyFleet(ModifyFleetRequest request)
AmazonEC2Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances
according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is
lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price.
If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot
Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from
Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that
exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the
fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2
Fleet terminates the instances with the highest price per unit. If the allocation strategy is
capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the
least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet
terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the
fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate
manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
modifyFleet in interface AmazonEC2public ModifyFpgaImageAttributeResult modifyFpgaImageAttribute(ModifyFpgaImageAttributeRequest request)
AmazonEC2Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
modifyFpgaImageAttribute in interface AmazonEC2public ModifyHostsResult modifyHosts(ModifyHostsRequest request)
AmazonEC2
Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you
launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated
Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host
ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a
suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
modifyHosts in interface AmazonEC2public ModifyIdFormatResult modifyIdFormat(ModifyIdFormatRequest request)
AmazonEC2Modifies 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.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period.
Resources currently in their opt-in period include: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | route-table | route-table-association |
security-group | subnet | subnet-cidr-block-association | vpc
| vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
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.
modifyIdFormat in interface AmazonEC2public ModifyIdentityIdFormatResult modifyIdentityIdFormat(ModifyIdentityIdFormatRequest request)
AmazonEC2Modifies 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.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period.
Resources currently in their opt-in period include: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | route-table | route-table-association |
security-group | subnet | subnet-cidr-block-association | vpc
| vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
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.
modifyIdentityIdFormat in interface AmazonEC2public ModifyImageAttributeResult modifyImageAttribute(ModifyImageAttributeRequest request)
AmazonEC2
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use
the Attribute parameter to specify the attribute or one of the following parameters:
Description, LaunchPermission, or ProductCode.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
modifyImageAttribute in interface AmazonEC2request - Contains the parameters for ModifyImageAttribute.public ModifyInstanceAttributeResult modifyInstanceAttribute(ModifyInstanceAttributeRequest request)
AmazonEC2Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon EC2 User Guide.
modifyInstanceAttribute in interface AmazonEC2public ModifyInstanceCapacityReservationAttributesResult modifyInstanceCapacityReservationAttributes(ModifyInstanceCapacityReservationAttributesRequest request)
AmazonEC2
Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to
target a specific Capacity Reservation, run in any open Capacity Reservation with matching
attributes, or run On-Demand Instance capacity.
modifyInstanceCapacityReservationAttributes in interface AmazonEC2public ModifyInstanceCreditSpecificationResult modifyInstanceCreditSpecification(ModifyInstanceCreditSpecificationRequest request)
AmazonEC2
Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit
options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
modifyInstanceCreditSpecification in interface AmazonEC2public ModifyInstanceEventStartTimeResult modifyInstanceEventStartTime(ModifyInstanceEventStartTimeRequest request)
AmazonEC2Modifies the start time for a scheduled Amazon EC2 instance event.
modifyInstanceEventStartTime in interface AmazonEC2public ModifyInstanceMetadataOptionsResult modifyInstanceMetadataOptions(ModifyInstanceMetadataOptionsRequest request)
AmazonEC2Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
modifyInstanceMetadataOptions in interface AmazonEC2public ModifyInstancePlacementResult modifyInstancePlacement(ModifyInstancePlacementRequest request)
AmazonEC2Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When
affinity is set to host and the instance is not associated with a specific Dedicated Host, the next
time the instance is launched, it is automatically associated with the host on which it lands. If the instance is
restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance from host to dedicated, or from
dedicated to host.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the
stopped state.
modifyInstancePlacement in interface AmazonEC2public ModifyLaunchTemplateResult modifyLaunchTemplate(ModifyLaunchTemplateRequest request)
AmazonEC2Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.
modifyLaunchTemplate in interface AmazonEC2public ModifyManagedPrefixListResult modifyManagedPrefixList(ModifyManagedPrefixListRequest request)
AmazonEC2Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
modifyManagedPrefixList in interface AmazonEC2public ModifyNetworkInterfaceAttributeResult modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest request)
AmazonEC2Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
modifyNetworkInterfaceAttribute in interface AmazonEC2request - Contains the parameters for ModifyNetworkInterfaceAttribute.public ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest request)
AmazonEC2Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
modifyReservedInstances in interface AmazonEC2request - Contains the parameters for ModifyReservedInstances.public ModifySnapshotAttributeResult modifySnapshotAttribute(ModifySnapshotAttributeRequest request)
AmazonEC2Adds 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 operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
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 about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide.
modifySnapshotAttribute in interface AmazonEC2public ModifySpotFleetRequestResult modifySpotFleetRequest(ModifySpotFleetRequestRequest request)
AmazonEC2Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
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 Instance pool with the lowest price.
If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot
Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from
Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests 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
capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the
least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet
terminates instances across the Spot Instance 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.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
modifySpotFleetRequest in interface AmazonEC2request - Contains the parameters for ModifySpotFleetRequest.public ModifySubnetAttributeResult modifySubnetAttribute(ModifySubnetAttributeRequest request)
AmazonEC2Modifies a subnet attribute. You can only modify one attribute at a time.
modifySubnetAttribute in interface AmazonEC2public ModifyTrafficMirrorFilterNetworkServicesResult modifyTrafficMirrorFilterNetworkServices(ModifyTrafficMirrorFilterNetworkServicesRequest request)
AmazonEC2Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices
to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter,
all traffic related to that network service will be mirrored. When you no longer want to mirror network services,
use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .
modifyTrafficMirrorFilterNetworkServices in interface AmazonEC2public ModifyTrafficMirrorFilterRuleResult modifyTrafficMirrorFilterRule(ModifyTrafficMirrorFilterRuleRequest request)
AmazonEC2Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
modifyTrafficMirrorFilterRule in interface AmazonEC2public ModifyTrafficMirrorSessionResult modifyTrafficMirrorSession(ModifyTrafficMirrorSessionRequest request)
AmazonEC2Modifies a Traffic Mirror session.
modifyTrafficMirrorSession in interface AmazonEC2public ModifyTransitGatewayResult modifyTransitGateway(ModifyTransitGatewayRequest request)
AmazonEC2Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.
modifyTransitGateway in interface AmazonEC2public ModifyTransitGatewayPrefixListReferenceResult modifyTransitGatewayPrefixListReference(ModifyTransitGatewayPrefixListReferenceRequest request)
AmazonEC2Modifies a reference (route) to a prefix list in a specified transit gateway route table.
modifyTransitGatewayPrefixListReference in interface AmazonEC2public ModifyTransitGatewayVpcAttachmentResult modifyTransitGatewayVpcAttachment(ModifyTransitGatewayVpcAttachmentRequest request)
AmazonEC2Modifies the specified VPC attachment.
modifyTransitGatewayVpcAttachment in interface AmazonEC2public ModifyVolumeResult modifyVolume(ModifyVolumeRequest request)
AmazonEC2You 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 might 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 DescribeVolumesModifications. For information about tracking status changes using either method, see Monitoring volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Amazon EBS Elastic Volumes (Linux) or Amazon EBS Elastic Volumes (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.
modifyVolume in interface AmazonEC2public ModifyVolumeAttributeResult modifyVolumeAttribute(ModifyVolumeAttributeRequest request)
AmazonEC2Modifies 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.
modifyVolumeAttribute in interface AmazonEC2public ModifyVpcAttributeResult modifyVpcAttribute(ModifyVpcAttributeRequest request)
AmazonEC2Modifies the specified attribute of the specified VPC.
modifyVpcAttribute in interface AmazonEC2public ModifyVpcEndpointResult modifyVpcEndpoint(ModifyVpcEndpointRequest request)
AmazonEC2Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
modifyVpcEndpoint in interface AmazonEC2request - Contains the parameters for ModifyVpcEndpoint.public ModifyVpcEndpointConnectionNotificationResult modifyVpcEndpointConnectionNotification(ModifyVpcEndpointConnectionNotificationRequest request)
AmazonEC2Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
modifyVpcEndpointConnectionNotification in interface AmazonEC2public ModifyVpcEndpointServiceConfigurationResult modifyVpcEndpointServiceConfiguration(ModifyVpcEndpointServiceConfigurationRequest request)
AmazonEC2Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
modifyVpcEndpointServiceConfiguration in interface AmazonEC2public ModifyVpcEndpointServicePermissionsResult modifyVpcEndpointServicePermissions(ModifyVpcEndpointServicePermissionsRequest request)
AmazonEC2Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
modifyVpcEndpointServicePermissions in interface AmazonEC2public ModifyVpcPeeringConnectionOptionsResult modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest request)
AmazonEC2Modifies 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 the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
modifyVpcPeeringConnectionOptions in interface AmazonEC2public ModifyVpcTenancyResult modifyVpcTenancy(ModifyVpcTenancyRequest request)
AmazonEC2
Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a
VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of
default, unless you specify otherwise during launch. The tenancy of any existing instances in the
VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
modifyVpcTenancy in interface AmazonEC2public ModifyVpnConnectionResult modifyVpnConnection(ModifyVpnConnectionRequest request)
AmazonEC2Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
modifyVpnConnection in interface AmazonEC2public ModifyVpnConnectionOptionsResult modifyVpnConnectionOptions(ModifyVpnConnectionOptionsRequest request)
AmazonEC2Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
modifyVpnConnectionOptions in interface AmazonEC2public ModifyVpnTunnelCertificateResult modifyVpnTunnelCertificate(ModifyVpnTunnelCertificateRequest request)
AmazonEC2Modifies the VPN tunnel endpoint certificate.
modifyVpnTunnelCertificate in interface AmazonEC2public ModifyVpnTunnelOptionsResult modifyVpnTunnelOptions(ModifyVpnTunnelOptionsRequest request)
AmazonEC2Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection in the AWS Site-to-Site VPN User Guide.
modifyVpnTunnelOptions in interface AmazonEC2public MonitorInstancesResult monitorInstances(MonitorInstancesRequest request)
AmazonEC2Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
To disable detailed monitoring, see .
monitorInstances in interface AmazonEC2public MoveAddressToVpcResult moveAddressToVpc(MoveAddressToVpcRequest request)
AmazonEC2Moves 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.
moveAddressToVpc in interface AmazonEC2public ProvisionByoipCidrResult provisionByoipCidr(ProvisionByoipCidrRequest request)
AmazonEC2Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address
range is not ready to use until its status changes from pending-provision to
provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate
an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address
from the address pool or the ID of the address pool.
provisionByoipCidr in interface AmazonEC2public PurchaseHostReservationResult purchaseHostReservation(PurchaseHostReservationRequest request)
AmazonEC2Purchase 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.
purchaseHostReservation in interface AmazonEC2public PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest request)
AmazonEC2Purchases 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.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
purchaseReservedInstancesOffering in interface AmazonEC2request - Contains the parameters for PurchaseReservedInstancesOffering.public PurchaseScheduledInstancesResult purchaseScheduledInstances(PurchaseScheduledInstancesRequest request)
AmazonEC2Purchases the 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.
purchaseScheduledInstances in interface AmazonEC2request - Contains the parameters for PurchaseScheduledInstances.public RebootInstancesResult rebootInstances(RebootInstancesRequest request)
AmazonEC2Requests a reboot of the specified 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 a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide.
rebootInstances in interface AmazonEC2public RegisterImageResult registerImage(RegisterImageRequest request)
AmazonEC2Registers 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.
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.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device
volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume
using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root
volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
AWS Marketplace product codes
If any snapshots have AWS Marketplace product codes, they are copied to the new AMI.
Windows and 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. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Obtaining billing information in the Amazon Elastic Compute Cloud User Guide.
registerImage in interface AmazonEC2request - Contains the parameters for RegisterImage.public RegisterInstanceEventNotificationAttributesResult registerInstanceEventNotificationAttributes(RegisterInstanceEventNotificationAttributesRequest request)
AmazonEC2Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use .
registerInstanceEventNotificationAttributes in interface AmazonEC2public RegisterTransitGatewayMulticastGroupMembersResult registerTransitGatewayMulticastGroupMembers(RegisterTransitGatewayMulticastGroupMembersRequest request)
AmazonEC2Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
registerTransitGatewayMulticastGroupMembers in interface AmazonEC2public RegisterTransitGatewayMulticastGroupSourcesResult registerTransitGatewayMulticastGroupSources(RegisterTransitGatewayMulticastGroupSourcesRequest request)
AmazonEC2Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
registerTransitGatewayMulticastGroupSources in interface AmazonEC2public RejectTransitGatewayMulticastDomainAssociationsResult rejectTransitGatewayMulticastDomainAssociations(RejectTransitGatewayMulticastDomainAssociationsRequest request)
AmazonEC2Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
rejectTransitGatewayMulticastDomainAssociations in interface AmazonEC2public RejectTransitGatewayPeeringAttachmentResult rejectTransitGatewayPeeringAttachment(RejectTransitGatewayPeeringAttachmentRequest request)
AmazonEC2Rejects a transit gateway peering attachment request.
rejectTransitGatewayPeeringAttachment in interface AmazonEC2public RejectTransitGatewayVpcAttachmentResult rejectTransitGatewayVpcAttachment(RejectTransitGatewayVpcAttachmentRequest request)
AmazonEC2Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use
DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use
AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
rejectTransitGatewayVpcAttachment in interface AmazonEC2public RejectVpcEndpointConnectionsResult rejectVpcEndpointConnections(RejectVpcEndpointConnectionsRequest request)
AmazonEC2Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
rejectVpcEndpointConnections in interface AmazonEC2public RejectVpcPeeringConnectionResult rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest request)
AmazonEC2
Rejects a VPC peering connection request. The VPC peering connection must be in the
pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your
outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC
peering connection request that you initiated, use DeleteVpcPeeringConnection.
rejectVpcPeeringConnection in interface AmazonEC2public ReleaseAddressResult releaseAddress(ReleaseAddressRequest request)
AmazonEC2Releases the specified Elastic IP address.
[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 can
release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. 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-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
releaseAddress in interface AmazonEC2public ReleaseHostsResult releaseHosts(ReleaseHostsRequest request)
AmazonEC2
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, for example, to modify the host. You must stop or terminate all instances
on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
releaseHosts in interface AmazonEC2public ReplaceIamInstanceProfileAssociationResult replaceIamInstanceProfileAssociation(ReplaceIamInstanceProfileAssociationRequest request)
AmazonEC2Replaces 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.
replaceIamInstanceProfileAssociation in interface AmazonEC2public ReplaceNetworkAclAssociationResult replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest request)
AmazonEC2Changes 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, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
replaceNetworkAclAssociation in interface AmazonEC2public ReplaceNetworkAclEntryResult replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest request)
AmazonEC2Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
replaceNetworkAclEntry in interface AmazonEC2public ReplaceRouteResult replaceRoute(ReplaceRouteRequest request)
AmazonEC2Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
replaceRoute in interface AmazonEC2public ReplaceRouteTableAssociationResult replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest request)
AmazonEC2Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
replaceRouteTableAssociation in interface AmazonEC2public ReplaceTransitGatewayRouteResult replaceTransitGatewayRoute(ReplaceTransitGatewayRouteRequest request)
AmazonEC2Replaces the specified route in the specified transit gateway route table.
replaceTransitGatewayRoute in interface AmazonEC2public ReportInstanceStatusResult reportInstanceStatus(ReportInstanceStatusRequest request)
AmazonEC2
Submits feedback about the status of an instance. The instance must be in the running state. If your
experience with the instance differs from the instance status returned by DescribeInstanceStatus, use
ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to
improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
reportInstanceStatus in interface AmazonEC2public RequestSpotFleetResult requestSpotFleet(RequestSpotFleetRequest request)
AmazonEC2Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
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 Instance 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.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other
resource types in a Spot Fleet request because only the spot-fleet-request and instance
resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.
requestSpotFleet in interface AmazonEC2request - Contains the parameters for RequestSpotFleet.public RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest request)
AmazonEC2Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
requestSpotInstances in interface AmazonEC2request - Contains the parameters for RequestSpotInstances.public ResetAddressAttributeResult resetAddressAttribute(ResetAddressAttributeRequest request)
AmazonEC2Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.
resetAddressAttribute in interface AmazonEC2public ResetEbsDefaultKmsKeyIdResult resetEbsDefaultKmsKeyId(ResetEbsDefaultKmsKeyIdRequest request)
AmazonEC2Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.
After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
resetEbsDefaultKmsKeyId in interface AmazonEC2public ResetFpgaImageAttributeResult resetFpgaImageAttribute(ResetFpgaImageAttributeRequest request)
AmazonEC2Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
resetFpgaImageAttribute in interface AmazonEC2public ResetImageAttributeResult resetImageAttribute(ResetImageAttributeRequest request)
AmazonEC2Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
resetImageAttribute in interface AmazonEC2request - Contains the parameters for ResetImageAttribute.public ResetInstanceAttributeResult resetInstanceAttribute(ResetInstanceAttributeRequest request)
AmazonEC2
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 VPC User Guide.
resetInstanceAttribute in interface AmazonEC2public ResetNetworkInterfaceAttributeResult resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest request)
AmazonEC2Resets a network interface attribute. You can specify only one attribute at a time.
resetNetworkInterfaceAttribute in interface AmazonEC2request - Contains the parameters for ResetNetworkInterfaceAttribute.public ResetSnapshotAttributeResult resetSnapshotAttribute(ResetSnapshotAttributeRequest request)
AmazonEC2Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide.
resetSnapshotAttribute in interface AmazonEC2public RestoreAddressToClassicResult restoreAddressToClassic(RestoreAddressToClassicRequest request)
AmazonEC2Restores 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.
restoreAddressToClassic in interface AmazonEC2public RestoreManagedPrefixListVersionResult restoreManagedPrefixListVersion(RestoreManagedPrefixListVersionRequest request)
AmazonEC2Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
restoreManagedPrefixListVersion in interface AmazonEC2public RevokeClientVpnIngressResult revokeClientVpnIngress(RevokeClientVpnIngressRequest request)
AmazonEC2Removes an ingress authorization rule from a Client VPN endpoint.
revokeClientVpnIngress in interface AmazonEC2public RevokeSecurityGroupEgressResult revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest request)
AmazonEC2[VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
AWS recommends that you use DescribeSecurityGroups to verify that the rule has been removed.
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. If the security group rule has a description, you do not have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
revokeSecurityGroupEgress in interface AmazonEC2public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest request)
AmazonEC2Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
[EC2-Classic , default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
AWS recommends that you use DescribeSecurityGroups to verify that the rule has been 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. If the security group rule has a description, you do not have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
revokeSecurityGroupIngress in interface AmazonEC2@Deprecated public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress()
AmazonEC2revokeSecurityGroupIngress in interface AmazonEC2AmazonEC2.revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest)public RunInstancesResult runInstances(RunInstancesRequest request)
AmazonEC2Launches 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.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
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.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
runInstances in interface AmazonEC2public RunScheduledInstancesResult runScheduledInstances(RunScheduledInstancesRequest request)
AmazonEC2Launches 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 EC2 User Guide.
runScheduledInstances in interface AmazonEC2request - Contains the parameters for RunScheduledInstances.public SearchLocalGatewayRoutesResult searchLocalGatewayRoutes(SearchLocalGatewayRoutesRequest request)
AmazonEC2Searches for routes in the specified local gateway route table.
searchLocalGatewayRoutes in interface AmazonEC2public SearchTransitGatewayMulticastGroupsResult searchTransitGatewayMulticastGroups(SearchTransitGatewayMulticastGroupsRequest request)
AmazonEC2Searches one or more transit gateway multicast groups and returns the group membership information.
searchTransitGatewayMulticastGroups in interface AmazonEC2public SearchTransitGatewayRoutesResult searchTransitGatewayRoutes(SearchTransitGatewayRoutesRequest request)
AmazonEC2Searches for routes in the specified transit gateway route table.
searchTransitGatewayRoutes in interface AmazonEC2public SendDiagnosticInterruptResult sendDiagnosticInterrupt(SendDiagnosticInterruptRequest request)
AmazonEC2Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).
sendDiagnosticInterrupt in interface AmazonEC2public StartInstancesResult startInstances(StartInstancesRequest request)
AmazonEC2Starts an Amazon EBS-backed instance 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 instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
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 EC2 User Guide.
startInstances in interface AmazonEC2public StartNetworkInsightsAnalysisResult startNetworkInsightsAnalysis(StartNetworkInsightsAnalysisRequest request)
AmazonEC2Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
startNetworkInsightsAnalysis in interface AmazonEC2public StartVpcEndpointServicePrivateDnsVerificationResult startVpcEndpointServicePrivateDnsVerification(StartVpcEndpointServicePrivateDnsVerificationRequest request)
AmazonEC2Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.
startVpcEndpointServicePrivateDnsVerification in interface AmazonEC2public StopInstancesResult stopInstances(StopInstancesRequest request)
AmazonEC2Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating 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, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate 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, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 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 EC2 User Guide.
stopInstances in interface AmazonEC2public TerminateClientVpnConnectionsResult terminateClientVpnConnections(TerminateClientVpnConnectionsRequest request)
AmazonEC2Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
terminateClientVpnConnections in interface AmazonEC2public TerminateInstancesResult terminateInstances(TerminateInstancesRequest request)
AmazonEC2Shuts down the specified 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 EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
terminateInstances in interface AmazonEC2public UnassignIpv6AddressesResult unassignIpv6Addresses(UnassignIpv6AddressesRequest request)
AmazonEC2Unassigns one or more IPv6 addresses from a network interface.
unassignIpv6Addresses in interface AmazonEC2public UnassignPrivateIpAddressesResult unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest request)
AmazonEC2Unassigns one or more secondary private IP addresses from a network interface.
unassignPrivateIpAddresses in interface AmazonEC2request - Contains the parameters for UnassignPrivateIpAddresses.public UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest request)
AmazonEC2Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
unmonitorInstances in interface AmazonEC2public UpdateSecurityGroupRuleDescriptionsEgressResult updateSecurityGroupRuleDescriptionsEgress(UpdateSecurityGroupRuleDescriptionsEgressRequest request)
AmazonEC2[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.
You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
updateSecurityGroupRuleDescriptionsEgress in interface AmazonEC2public UpdateSecurityGroupRuleDescriptionsIngressResult updateSecurityGroupRuleDescriptionsIngress(UpdateSecurityGroupRuleDescriptionsIngressRequest request)
AmazonEC2Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.
You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
updateSecurityGroupRuleDescriptionsIngress in interface AmazonEC2public WithdrawByoipCidrResult withdrawByoipCidr(WithdrawByoipCidrRequest request)
AmazonEC2Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays.
withdrawByoipCidr in interface AmazonEC2public <X extends AmazonWebServiceRequest> DryRunResult<X> dryRun(DryRunSupportedRequest<X> request) throws AmazonServiceException, AmazonClientException
AmazonEC2dryRun in interface AmazonEC2request - The request object for any Amazon EC2 operation supported with dry-run.AmazonServiceException - If an error response is returned by Amazon EC2 indicating either a problem with the data in the request,
or a server side issue.AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle
the response. Or if the service response does not clearly indicate whether you have the permission.public void shutdown()
AmazonEC2public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonEC2Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonEC2request - The originally executed request.public AmazonEC2Waiters waiters()
Copyright © 2021. All rights reserved.