@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonEC2Client extends AmazonWebServiceClient implements AmazonEC2
You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
protected Unmarshaller<AmazonServiceException,Node> |
defaultUnmarshaller |
protected List<Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions Even though this exceptionUnmarshallers is not used in
Clients, this is not removed since this was directly used by Client extended classes.
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonEC2Client()
Deprecated.
|
AmazonEC2Client(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonEC2ClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonEC2Client(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonEC2Client(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegionprotected static final ClientConfigurationFactory configFactory
protected final List<Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
protected Unmarshaller<AmazonServiceException,Node> defaultUnmarshaller
@Deprecated public AmazonEC2Client()
AmazonEC2ClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonEC2Client(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonEC2Client(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonEC2ClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonEC2Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonEC2ClientBuilder builder()
public AcceptAddressTransferResult acceptAddressTransfer(AcceptAddressTransferRequest request)
Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
acceptAddressTransfer in interface AmazonEC2acceptAddressTransferRequest - public AcceptReservedInstancesExchangeQuoteResult acceptReservedInstancesExchangeQuote(AcceptReservedInstancesExchangeQuoteRequest request)
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
acceptReservedInstancesExchangeQuote in interface AmazonEC2acceptReservedInstancesExchangeQuoteRequest - Contains the parameters for accepting the quote.public AcceptTransitGatewayMulticastDomainAssociationsResult acceptTransitGatewayMulticastDomainAssociations(AcceptTransitGatewayMulticastDomainAssociationsRequest request)
Accepts a request to associate subnets with a transit gateway multicast domain.
acceptTransitGatewayMulticastDomainAssociations in interface AmazonEC2acceptTransitGatewayMulticastDomainAssociationsRequest - public AcceptTransitGatewayPeeringAttachmentResult acceptTransitGatewayPeeringAttachment(AcceptTransitGatewayPeeringAttachmentRequest request)
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance state.
acceptTransitGatewayPeeringAttachment in interface AmazonEC2acceptTransitGatewayPeeringAttachmentRequest - public AcceptTransitGatewayVpcAttachmentResult acceptTransitGatewayVpcAttachment(AcceptTransitGatewayVpcAttachmentRequest request)
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use
DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use
RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
acceptTransitGatewayVpcAttachment in interface AmazonEC2acceptTransitGatewayVpcAttachmentRequest - public AcceptVpcEndpointConnectionsResult acceptVpcEndpointConnections(AcceptVpcEndpointConnectionsRequest request)
Accepts connection requests to your VPC endpoint service.
acceptVpcEndpointConnections in interface AmazonEC2acceptVpcEndpointConnectionsRequest - public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest request)
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the
pending-acceptance state, and you must be the owner of the peer VPC. Use
DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
acceptVpcPeeringConnection in interface AmazonEC2acceptVpcPeeringConnectionRequest - public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection()
AmazonEC2acceptVpcPeeringConnection in interface AmazonEC2AmazonEC2.acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest)public AdvertiseByoipCidrResult advertiseByoipCidr(AdvertiseByoipCidrRequest request)
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services 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 Amazon Web Services. To minimize down time, you can configure your Amazon Web Services 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 Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
advertiseByoipCidr in interface AmazonEC2advertiseByoipCidrRequest - public AllocateAddressResult allocateAddress(AllocateAddressRequest request)
Allocates an Elastic IP address to your Amazon Web Services 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 Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.
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 Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 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 AmazonEC2allocateAddressRequest - public AllocateAddressResult allocateAddress()
AmazonEC2allocateAddress in interface AmazonEC2AmazonEC2.allocateAddress(AllocateAddressRequest)public AllocateHostsResult allocateHosts(AllocateHostsRequest request)
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
allocateHosts in interface AmazonEC2allocateHostsRequest - public AllocateIpamPoolCidrResult allocateIpamPoolCidr(AllocateIpamPoolCidrRequest request)
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
allocateIpamPoolCidr in interface AmazonEC2allocateIpamPoolCidrRequest - public ApplySecurityGroupsToClientVpnTargetNetworkResult applySecurityGroupsToClientVpnTargetNetwork(ApplySecurityGroupsToClientVpnTargetNetworkRequest request)
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
applySecurityGroupsToClientVpnTargetNetwork in interface AmazonEC2applySecurityGroupsToClientVpnTargetNetworkRequest - public AssignIpv6AddressesResult assignIpv6Addresses(AssignIpv6AddressesRequest request)
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
assignIpv6Addresses in interface AmazonEC2assignIpv6AddressesRequest - public AssignPrivateIpAddressesResult assignPrivateIpAddresses(AssignPrivateIpAddressesRequest request)
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 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.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
assignPrivateIpAddresses in interface AmazonEC2assignPrivateIpAddressesRequest - Contains the parameters for AssignPrivateIpAddresses.public AssignPrivateNatGatewayAddressResult assignPrivateNatGatewayAddress(AssignPrivateNatGatewayAddressRequest request)
Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
assignPrivateNatGatewayAddress in interface AmazonEC2assignPrivateNatGatewayAddressRequest - public AssociateAddressResult associateAddress(AssociateAddressRequest request)
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
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.
[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 AmazonEC2associateAddressRequest - public AssociateClientVpnTargetNetworkResult associateClientVpnTargetNetwork(AssociateClientVpnTargetNetworkRequest request)
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
associateClientVpnTargetNetwork in interface AmazonEC2associateClientVpnTargetNetworkRequest - public AssociateDhcpOptionsResult associateDhcpOptions(AssociateDhcpOptionsRequest request)
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP option sets in the Amazon VPC User Guide.
associateDhcpOptions in interface AmazonEC2associateDhcpOptionsRequest - public AssociateEnclaveCertificateIamRoleResult associateEnclaveCertificateIamRole(AssociateEnclaveCertificateIamRoleRequest request)
Associates an Identity and Access Management (IAM) role with an 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 Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key 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
KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command.
For more information, see Grant the role
permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User
Guide.
associateEnclaveCertificateIamRole in interface AmazonEC2associateEnclaveCertificateIamRoleRequest - public AssociateIamInstanceProfileResult associateIamInstanceProfile(AssociateIamInstanceProfileRequest request)
Associates 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 AmazonEC2associateIamInstanceProfileRequest - public AssociateInstanceEventWindowResult associateInstanceEventWindow(AssociateInstanceEventWindowRequest request)
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
associateInstanceEventWindow in interface AmazonEC2associateInstanceEventWindowRequest - public AssociateIpamByoasnResult associateIpamByoasn(AssociateIpamByoasnRequest request)
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
associateIpamByoasn in interface AmazonEC2associateIpamByoasnRequest - public AssociateIpamResourceDiscoveryResult associateIpamResourceDiscovery(AssociateIpamResourceDiscoveryRequest request)
Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
associateIpamResourceDiscovery in interface AmazonEC2associateIpamResourceDiscoveryRequest - public AssociateNatGatewayAddressResult associateNatGatewayAddress(AssociateNatGatewayAddressRequest request)
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
associateNatGatewayAddress in interface AmazonEC2associateNatGatewayAddressRequest - public AssociateRouteTableResult associateRouteTable(AssociateRouteTableRequest request)
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon VPC User Guide.
associateRouteTable in interface AmazonEC2associateRouteTableRequest - public AssociateSubnetCidrBlockResult associateSubnetCidrBlock(AssociateSubnetCidrBlockRequest request)
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.
associateSubnetCidrBlock in interface AmazonEC2associateSubnetCidrBlockRequest - public AssociateTransitGatewayMulticastDomainResult associateTransitGatewayMulticastDomain(AssociateTransitGatewayMulticastDomainRequest request)
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
associateTransitGatewayMulticastDomain in interface AmazonEC2associateTransitGatewayMulticastDomainRequest - public AssociateTransitGatewayPolicyTableResult associateTransitGatewayPolicyTable(AssociateTransitGatewayPolicyTableRequest request)
Associates the specified transit gateway attachment with a transit gateway policy table.
associateTransitGatewayPolicyTable in interface AmazonEC2associateTransitGatewayPolicyTableRequest - public AssociateTransitGatewayRouteTableResult associateTransitGatewayRouteTable(AssociateTransitGatewayRouteTableRequest request)
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
associateTransitGatewayRouteTable in interface AmazonEC2associateTransitGatewayRouteTableRequest - public AssociateTrunkInterfaceResult associateTrunkInterface(AssociateTrunkInterfaceRequest request)
Associates a branch network interface with a trunk network interface.
Before you create the association, use CreateNetworkInterface command and set the interface type to trunk. You must also create a
network interface for each branch network interface that you want to associate with the trunk network interface.
associateTrunkInterface in interface AmazonEC2associateTrunkInterfaceRequest - public AssociateVpcCidrBlockResult associateVpcCidrBlock(AssociateVpcCidrBlockRequest request)
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
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 IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
associateVpcCidrBlock in interface AmazonEC2associateVpcCidrBlockRequest - public AttachClassicLinkVpcResult attachClassicLinkVpc(AttachClassicLinkVpcRequest request)
This action is deprecated.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC 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 AmazonEC2attachClassicLinkVpcRequest - public AttachInternetGatewayResult attachInternetGateway(AttachInternetGatewayRequest request)
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.
attachInternetGateway in interface AmazonEC2attachInternetGatewayRequest - public AttachNetworkInterfaceResult attachNetworkInterface(AttachNetworkInterfaceRequest request)
Attaches a network interface to an instance.
attachNetworkInterface in interface AmazonEC2attachNetworkInterfaceRequest - Contains the parameters for AttachNetworkInterface.public AttachVerifiedAccessTrustProviderResult attachVerifiedAccessTrustProvider(AttachVerifiedAccessTrustProviderRequest request)
Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
attachVerifiedAccessTrustProvider in interface AmazonEC2attachVerifiedAccessTrustProviderRequest - public AttachVolumeResult attachVolume(AttachVolumeRequest request)
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services 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 Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.
attachVolume in interface AmazonEC2attachVolumeRequest - public AttachVpnGatewayResult attachVpnGateway(AttachVpnGatewayRequest request)
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
attachVpnGateway in interface AmazonEC2attachVpnGatewayRequest - Contains the parameters for AttachVpnGateway.public AuthorizeClientVpnIngressResult authorizeClientVpnIngress(AuthorizeClientVpnIngressRequest request)
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
authorizeClientVpnIngress in interface AmazonEC2authorizeClientVpnIngressRequest - public AuthorizeSecurityGroupEgressResult authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest request)
Adds the specified outbound (egress) rules to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules.
You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
authorizeSecurityGroupEgress in interface AmazonEC2authorizeSecurityGroupEgressRequest - public AuthorizeSecurityGroupIngressResult authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest request)
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules.
You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
authorizeSecurityGroupIngress in interface AmazonEC2authorizeSecurityGroupIngressRequest - public BundleInstanceResult bundleInstance(BundleInstanceRequest request)
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
bundleInstance in interface AmazonEC2bundleInstanceRequest - Contains the parameters for BundleInstance.public CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest request)
Cancels a bundling operation for an instance store-backed Windows instance.
cancelBundleTask in interface AmazonEC2cancelBundleTaskRequest - Contains the parameters for CancelBundleTask.public CancelCapacityReservationResult cancelCapacityReservation(CancelCapacityReservationRequest request)
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity
Reservation's state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
cancelCapacityReservation in interface AmazonEC2cancelCapacityReservationRequest - public CancelCapacityReservationFleetsResult cancelCapacityReservationFleets(CancelCapacityReservationFleetsRequest request)
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet's status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
cancelCapacityReservationFleets in interface AmazonEC2cancelCapacityReservationFleetsRequest - public CancelConversionTaskResult cancelConversionTask(CancelConversionTaskRequest request)
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
cancelConversionTask in interface AmazonEC2cancelConversionTaskRequest - public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
cancelExportTask in interface AmazonEC2cancelExportTaskRequest - public CancelImageLaunchPermissionResult cancelImageLaunchPermission(CancelImageLaunchPermissionRequest request)
Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
cancelImageLaunchPermission in interface AmazonEC2cancelImageLaunchPermissionRequest - public CancelImportTaskResult cancelImportTask(CancelImportTaskRequest request)
Cancels an in-process import virtual machine or import snapshot task.
cancelImportTask in interface AmazonEC2cancelImportTaskRequest - public CancelImportTaskResult cancelImportTask()
AmazonEC2cancelImportTask in interface AmazonEC2AmazonEC2.cancelImportTask(CancelImportTaskRequest)public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest request)
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
cancelReservedInstancesListing in interface AmazonEC2cancelReservedInstancesListingRequest - Contains the parameters for CancelReservedInstancesListing.public CancelSpotFleetRequestsResult cancelSpotFleetRequests(CancelSpotFleetRequestsRequest request)
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to
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.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
cancelSpotFleetRequests in interface AmazonEC2cancelSpotFleetRequestsRequest - Contains the parameters for CancelSpotFleetRequests.public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest request)
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
cancelSpotInstanceRequests in interface AmazonEC2cancelSpotInstanceRequestsRequest - Contains the parameters for CancelSpotInstanceRequests.public ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest request)
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
confirmProductInstance in interface AmazonEC2confirmProductInstanceRequest - public CopyFpgaImageResult copyFpgaImage(CopyFpgaImageRequest request)
Copies the specified Amazon FPGA Image (AFI) to the current Region.
copyFpgaImage in interface AmazonEC2copyFpgaImageRequest - public CopyImageResult copyImage(CopyImageRequest request)
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an 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 to another partition, see CreateStoreImageTask.
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 EBS User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
copyImage in interface AmazonEC2copyImageRequest - Contains the parameters for CopyImage.public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
Copies 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 KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key 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 EBS 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 Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
copySnapshot in interface AmazonEC2copySnapshotRequest - public CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest request)
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
createCapacityReservation in interface AmazonEC2createCapacityReservationRequest - public CreateCapacityReservationFleetResult createCapacityReservationFleet(CreateCapacityReservationFleetRequest request)
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
createCapacityReservationFleet in interface AmazonEC2createCapacityReservationFleetRequest - public CreateCarrierGatewayResult createCarrierGateway(CreateCarrierGatewayRequest request)
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
createCarrierGateway in interface AmazonEC2createCarrierGatewayRequest - public CreateClientVpnEndpointResult createClientVpnEndpoint(CreateClientVpnEndpointRequest request)
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
createClientVpnEndpoint in interface AmazonEC2createClientVpnEndpointRequest - public CreateClientVpnRouteResult createClientVpnRoute(CreateClientVpnRouteRequest request)
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
createClientVpnRoute in interface AmazonEC2createClientVpnRouteRequest - public CreateCoipCidrResult createCoipCidr(CreateCoipCidrRequest request)
Creates a range of customer-owned IP addresses.
createCoipCidr in interface AmazonEC2createCoipCidrRequest - public CreateCoipPoolResult createCoipPool(CreateCoipPoolRequest request)
Creates a pool of customer-owned IP (CoIP) addresses.
createCoipPool in interface AmazonEC2createCoipPoolRequest - public CreateCustomerGatewayResult createCustomerGateway(CreateCustomerGatewayRequest request)
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’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. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services 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. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
createCustomerGateway in interface AmazonEC2createCustomerGatewayRequest - Contains the parameters for CreateCustomerGateway.public CreateDefaultSubnetResult createDefaultSubnet(CreateDefaultSubnetRequest request)
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your
default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default
subnet in the Amazon VPC User Guide.
createDefaultSubnet in interface AmazonEC2createDefaultSubnetRequest - public CreateDefaultVpcResult createDefaultVpc(CreateDefaultVpcRequest request)
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability
Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC
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.
createDefaultVpc in interface AmazonEC2createDefaultVpcRequest - public CreateDhcpOptionsResult createDhcpOptions(CreateDhcpOptionsRequest request)
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP option sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify
ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify
region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete
unqualified DNS hostnames.
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 option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify
multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your
instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS
server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4
addresses and four IPv6 addresses).
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 supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how
frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values
are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time
is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid
frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
createDhcpOptions in interface AmazonEC2createDhcpOptionsRequest - public CreateEgressOnlyInternetGatewayResult createEgressOnlyInternetGateway(CreateEgressOnlyInternetGatewayRequest request)
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
createEgressOnlyInternetGateway in interface AmazonEC2createEgressOnlyInternetGatewayRequest - public CreateFleetResult createFleet(CreateFleetRequest request)
Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.
A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
createFleet in interface AmazonEC2createFleetRequest - public CreateFlowLogsResult createFlowLogs(CreateFlowLogsRequest request)
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon VPC 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 VPC User Guide.
createFlowLogs in interface AmazonEC2createFlowLogsRequest - public CreateFpgaImageResult createFpgaImage(CreateFpgaImageRequest request)
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
createFpgaImage in interface AmazonEC2createFpgaImageRequest - public CreateImageResult createImage(CreateImageRequest request)
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or Amazon 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 Create an Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.
createImage in interface AmazonEC2createImageRequest - public CreateInstanceConnectEndpointResult createInstanceConnectEndpoint(CreateInstanceConnectEndpointRequest request)
Creates an EC2 Instance Connect Endpoint.
An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
createInstanceConnectEndpoint in interface AmazonEC2createInstanceConnectEndpointRequest - public CreateInstanceEventWindowResult createInstanceEventWindow(CreateInstanceEventWindowRequest request)
Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
createInstanceEventWindow in interface AmazonEC2createInstanceEventWindowRequest - public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest request)
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the prerequisites for your Amazon S3 bucket, 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 AmazonEC2createInstanceExportTaskRequest - public CreateInternetGatewayResult createInternetGateway(CreateInternetGatewayRequest request)
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information, see Internet gateways in the Amazon VPC User Guide.
createInternetGateway in interface AmazonEC2createInternetGatewayRequest - public CreateInternetGatewayResult createInternetGateway()
AmazonEC2createInternetGateway in interface AmazonEC2AmazonEC2.createInternetGateway(CreateInternetGatewayRequest)public CreateIpamResult createIpam(CreateIpamRequest request)
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
createIpam in interface AmazonEC2createIpamRequest - public CreateIpamExternalResourceVerificationTokenResult createIpamExternalResourceVerificationToken(CreateIpamExternalResourceVerificationTokenRequest request)
Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
createIpamExternalResourceVerificationToken in interface AmazonEC2createIpamExternalResourceVerificationTokenRequest - public CreateIpamPoolResult createIpamPool(CreateIpamPoolRequest request)
Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
createIpamPool in interface AmazonEC2createIpamPoolRequest - public CreateIpamResourceDiscoveryResult createIpamResourceDiscovery(CreateIpamResourceDiscoveryRequest request)
Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
createIpamResourceDiscovery in interface AmazonEC2createIpamResourceDiscoveryRequest - public CreateIpamScopeResult createIpamScope(CreateIpamScopeRequest request)
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
createIpamScope in interface AmazonEC2createIpamScopeRequest - public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. 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 or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services 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.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
createKeyPair in interface AmazonEC2createKeyPairRequest - public CreateLaunchTemplateResult createLaunchTemplate(CreateLaunchTemplateRequest request)
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon EC2 User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon EC2 User Guide.
createLaunchTemplate in interface AmazonEC2createLaunchTemplateRequest - public CreateLaunchTemplateVersionResult createLaunchTemplateVersion(CreateLaunchTemplateVersionRequest request)
Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon EC2 User Guide.
createLaunchTemplateVersion in interface AmazonEC2createLaunchTemplateVersionRequest - public CreateLocalGatewayRouteResult createLocalGatewayRoute(CreateLocalGatewayRouteRequest request)
Creates a static route for the specified local gateway route table. You must specify one of the following targets:
LocalGatewayVirtualInterfaceGroupId
NetworkInterfaceId
createLocalGatewayRoute in interface AmazonEC2createLocalGatewayRouteRequest - public CreateLocalGatewayRouteTableResult createLocalGatewayRouteTable(CreateLocalGatewayRouteTableRequest request)
Creates a local gateway route table.
createLocalGatewayRouteTable in interface AmazonEC2createLocalGatewayRouteTableRequest - public CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult createLocalGatewayRouteTableVirtualInterfaceGroupAssociation(CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest request)
Creates a local gateway route table virtual interface group association.
createLocalGatewayRouteTableVirtualInterfaceGroupAssociation in interface AmazonEC2createLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest - public CreateLocalGatewayRouteTableVpcAssociationResult createLocalGatewayRouteTableVpcAssociation(CreateLocalGatewayRouteTableVpcAssociationRequest request)
Associates the specified VPC with the specified local gateway route table.
createLocalGatewayRouteTableVpcAssociation in interface AmazonEC2createLocalGatewayRouteTableVpcAssociationRequest - public CreateManagedPrefixListResult createManagedPrefixList(CreateManagedPrefixListRequest request)
Creates 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.
createManagedPrefixList in interface AmazonEC2createManagedPrefixListRequest - public CreateNatGatewayResult createNatGateway(CreateNatGatewayRequest request)
Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon VPC User Guide.
When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
createNatGateway in interface AmazonEC2createNatGatewayRequest - public CreateNetworkAclResult createNetworkAcl(CreateNetworkAclRequest request)
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon VPC User Guide.
createNetworkAcl in interface AmazonEC2createNetworkAclRequest - public CreateNetworkAclEntryResult createNetworkAclEntry(CreateNetworkAclEntryRequest request)
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon VPC User Guide.
createNetworkAclEntry in interface AmazonEC2createNetworkAclEntryRequest - public CreateNetworkInsightsAccessScopeResult createNetworkInsightsAccessScope(CreateNetworkInsightsAccessScopeRequest request)
Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
createNetworkInsightsAccessScope in interface AmazonEC2createNetworkInsightsAccessScopeRequest - public CreateNetworkInsightsPathResult createNetworkInsightsPath(CreateNetworkInsightsPathRequest request)
Creates 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 the Reachability Analyzer Guide.
createNetworkInsightsPath in interface AmazonEC2createNetworkInsightsPathRequest - public CreateNetworkInterfaceResult createNetworkInterface(CreateNetworkInterfaceRequest request)
Creates a network interface in the specified subnet.
The number of IP addresses you can assign to a network interface varies by instance type.
For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.
createNetworkInterface in interface AmazonEC2createNetworkInterfaceRequest - public CreateNetworkInterfacePermissionResult createNetworkInterfacePermission(CreateNetworkInterfacePermissionRequest request)
Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
createNetworkInterfacePermission in interface AmazonEC2createNetworkInterfacePermissionRequest - Contains the parameters for CreateNetworkInterfacePermission.public CreatePlacementGroupResult createPlacementGroup(CreatePlacementGroupRequest request)
Creates 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 AmazonEC2createPlacementGroupRequest - public CreatePublicIpv4PoolResult createPublicIpv4Pool(CreatePublicIpv4PoolRequest request)
Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.
createPublicIpv4Pool in interface AmazonEC2createPublicIpv4PoolRequest - public CreateReplaceRootVolumeTaskResult createReplaceRootVolumeTask(CreateReplaceRootVolumeTaskRequest request)
Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the
original root volume's launch state, that is restored to a specific snapshot taken from the original root volume,
or that is restored from an AMI that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon EC2 User Guide.
createReplaceRootVolumeTask in interface AmazonEC2createReplaceRootVolumeTaskRequest - public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest request)
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances 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 Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
createReservedInstancesListing in interface AmazonEC2createReservedInstancesListingRequest - Contains the parameters for CreateReservedInstancesListing.public CreateRestoreImageTaskResult createRestoreImageTask(CreateRestoreImageTaskRequest request)
Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
createRestoreImageTask in interface AmazonEC2createRestoreImageTaskRequest - public CreateRouteResult createRoute(CreateRouteRequest request)
Creates a route in a route table within a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list.
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 VPC User Guide.
createRoute in interface AmazonEC2createRouteRequest - public CreateRouteTableResult createRouteTable(CreateRouteTableRequest request)
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon VPC User Guide.
createRouteTable in interface AmazonEC2createRouteTableRequest - public CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest request)
Creates 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't have two security groups for the same VPC with the same name.
You have 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 AmazonEC2createSecurityGroupRequest - public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
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 Amazon Web Services 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 Amazon 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.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you 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 Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.
createSnapshot in interface AmazonEC2createSnapshotRequest - public CreateSnapshotsResult createSnapshots(CreateSnapshotsRequest request)
Creates 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.
You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
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 AmazonEC2createSnapshotsRequest - public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest request)
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.
createSpotDatafeedSubscription in interface AmazonEC2createSpotDatafeedSubscriptionRequest - Contains the parameters for CreateSpotDatafeedSubscription.public CreateStoreImageTaskResult createStoreImageTask(CreateStoreImageTaskRequest request)
Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
createStoreImageTask in interface AmazonEC2createStoreImageTaskRequest - public CreateSubnetResult createSubnet(CreateSubnetRequest request)
Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.
The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.
If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it.
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, see Subnets in the Amazon VPC User Guide.
createSubnet in interface AmazonEC2createSubnetRequest - public CreateSubnetCidrReservationResult createSubnetCidrReservation(CreateSubnetCidrReservationRequest request)
Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon VPC User Guide and Assign prefixes to network interfaces in the Amazon EC2 User Guide.
createSubnetCidrReservation in interface AmazonEC2createSubnetCidrReservationRequest - public CreateTagsResult createTags(CreateTagsRequest request)
Adds 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 Tag your Amazon EC2 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 AmazonEC2createTagsRequest - public CreateTrafficMirrorFilterResult createTrafficMirrorFilter(CreateTrafficMirrorFilterRequest request)
Creates 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 AmazonEC2createTrafficMirrorFilterRequest - public CreateTrafficMirrorFilterRuleResult createTrafficMirrorFilterRule(CreateTrafficMirrorFilterRuleRequest request)
Creates 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 AmazonEC2createTrafficMirrorFilterRuleRequest - public CreateTrafficMirrorSessionResult createTrafficMirrorSession(CreateTrafficMirrorSessionRequest request)
Creates 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 AmazonEC2createTrafficMirrorSessionRequest - public CreateTrafficMirrorTargetResult createTrafficMirrorTarget(CreateTrafficMirrorTargetRequest request)
Creates 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, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
createTrafficMirrorTarget in interface AmazonEC2createTrafficMirrorTargetRequest - public CreateTransitGatewayResult createTransitGateway(CreateTransitGatewayRequest request)
Creates 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 AmazonEC2createTransitGatewayRequest - public CreateTransitGatewayConnectResult createTransitGatewayConnect(CreateTransitGatewayConnectRequest request)
Creates 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 Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
createTransitGatewayConnect in interface AmazonEC2createTransitGatewayConnectRequest - public CreateTransitGatewayConnectPeerResult createTransitGatewayConnectPeer(CreateTransitGatewayConnectPeerRequest request)
Creates 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 Amazon Web Services Transit Gateways Guide.
createTransitGatewayConnectPeer in interface AmazonEC2createTransitGatewayConnectPeerRequest - public CreateTransitGatewayMulticastDomainResult createTransitGatewayMulticastDomain(CreateTransitGatewayMulticastDomainRequest request)
Creates 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 AmazonEC2createTransitGatewayMulticastDomainRequest - public CreateTransitGatewayPeeringAttachmentResult createTransitGatewayPeeringAttachment(CreateTransitGatewayPeeringAttachmentRequest request)
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
createTransitGatewayPeeringAttachment in interface AmazonEC2createTransitGatewayPeeringAttachmentRequest - public CreateTransitGatewayPolicyTableResult createTransitGatewayPolicyTable(CreateTransitGatewayPolicyTableRequest request)
Creates a transit gateway policy table.
createTransitGatewayPolicyTable in interface AmazonEC2createTransitGatewayPolicyTableRequest - public CreateTransitGatewayPrefixListReferenceResult createTransitGatewayPrefixListReference(CreateTransitGatewayPrefixListReferenceRequest request)
Creates a reference (route) to a prefix list in a specified transit gateway route table.
createTransitGatewayPrefixListReference in interface AmazonEC2createTransitGatewayPrefixListReferenceRequest - public CreateTransitGatewayRouteResult createTransitGatewayRoute(CreateTransitGatewayRouteRequest request)
Creates a static route for the specified transit gateway route table.
createTransitGatewayRoute in interface AmazonEC2createTransitGatewayRouteRequest - public CreateTransitGatewayRouteTableResult createTransitGatewayRouteTable(CreateTransitGatewayRouteTableRequest request)
Creates a route table for the specified transit gateway.
createTransitGatewayRouteTable in interface AmazonEC2createTransitGatewayRouteTableRequest - public CreateTransitGatewayRouteTableAnnouncementResult createTransitGatewayRouteTableAnnouncement(CreateTransitGatewayRouteTableAnnouncementRequest request)
Advertises a new transit gateway route table.
createTransitGatewayRouteTableAnnouncement in interface AmazonEC2createTransitGatewayRouteTableAnnouncementRequest - public CreateTransitGatewayVpcAttachmentResult createTransitGatewayVpcAttachment(CreateTransitGatewayVpcAttachmentRequest request)
Attaches 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 AmazonEC2createTransitGatewayVpcAttachmentRequest - public CreateVerifiedAccessEndpointResult createVerifiedAccessEndpoint(CreateVerifiedAccessEndpointRequest request)
An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
createVerifiedAccessEndpoint in interface AmazonEC2createVerifiedAccessEndpointRequest - public CreateVerifiedAccessGroupResult createVerifiedAccessGroup(CreateVerifiedAccessGroupRequest request)
An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.
createVerifiedAccessGroup in interface AmazonEC2createVerifiedAccessGroupRequest - public CreateVerifiedAccessInstanceResult createVerifiedAccessInstance(CreateVerifiedAccessInstanceRequest request)
An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
createVerifiedAccessInstance in interface AmazonEC2createVerifiedAccessInstanceRequest - public CreateVerifiedAccessTrustProviderResult createVerifiedAccessTrustProvider(CreateVerifiedAccessTrustProviderRequest request)
A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
createVerifiedAccessTrustProvider in interface AmazonEC2createVerifiedAccessTrustProviderRequest - public CreateVolumeResult createVolume(CreateVolumeRequest request)
Creates 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 Amazon Web Services 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 EBS User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.
createVolume in interface AmazonEC2createVolumeRequest - public CreateVpcResult createVpc(CreateVpcRequest request)
Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC 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 that 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 option sets in the Amazon VPC 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 EC2 User Guide.
createVpc in interface AmazonEC2createVpcRequest - public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.
createVpcEndpoint in interface AmazonEC2createVpcEndpointRequest - public CreateVpcEndpointConnectionNotificationResult createVpcEndpointConnectionNotification(CreateVpcEndpointConnectionNotificationRequest request)
Creates 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 Creating an Amazon SNS topic in the Amazon SNS Developer Guide.
You can create a connection notification for interface endpoints only.
createVpcEndpointConnectionNotification in interface AmazonEC2createVpcEndpointConnectionNotificationRequest - public CreateVpcEndpointServiceConfigurationResult createVpcEndpointServiceConfiguration(CreateVpcEndpointServiceConfigurationRequest request)
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.
Before you create an endpoint service, you must 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.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
createVpcEndpointServiceConfiguration in interface AmazonEC2createVpcEndpointServiceConfigurationRequest - public CreateVpcPeeringConnectionResult createVpcPeeringConnection(CreateVpcPeeringConnectionRequest request)
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services 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 VPC peering limitations 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 AmazonEC2createVpcPeeringConnectionRequest - public CreateVpcPeeringConnectionResult createVpcPeeringConnection()
AmazonEC2createVpcPeeringConnection in interface AmazonEC2AmazonEC2.createVpcPeeringConnection(CreateVpcPeeringConnectionRequest)public CreateVpnConnectionResult createVpnConnection(CreateVpnConnectionRequest request)
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 Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
createVpnConnection in interface AmazonEC2createVpnConnectionRequest - Contains the parameters for CreateVpnConnection.public CreateVpnConnectionRouteResult createVpnConnectionRoute(CreateVpnConnectionRouteRequest request)
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
createVpnConnectionRoute in interface AmazonEC2createVpnConnectionRouteRequest - Contains the parameters for CreateVpnConnectionRoute.public CreateVpnGatewayResult createVpnGateway(CreateVpnGatewayRequest request)
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
createVpnGateway in interface AmazonEC2createVpnGatewayRequest - Contains the parameters for CreateVpnGateway.public DeleteCarrierGatewayResult deleteCarrierGateway(DeleteCarrierGatewayRequest request)
Deletes 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 AmazonEC2deleteCarrierGatewayRequest - public DeleteClientVpnEndpointResult deleteClientVpnEndpoint(DeleteClientVpnEndpointRequest request)
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
deleteClientVpnEndpoint in interface AmazonEC2deleteClientVpnEndpointRequest - public DeleteClientVpnRouteResult deleteClientVpnRoute(DeleteClientVpnRouteRequest request)
Deletes 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 AmazonEC2deleteClientVpnRouteRequest - public DeleteCoipCidrResult deleteCoipCidr(DeleteCoipCidrRequest request)
Deletes a range of customer-owned IP addresses.
deleteCoipCidr in interface AmazonEC2deleteCoipCidrRequest - public DeleteCoipPoolResult deleteCoipPool(DeleteCoipPoolRequest request)
Deletes a pool of customer-owned IP (CoIP) addresses.
deleteCoipPool in interface AmazonEC2deleteCoipPoolRequest - public DeleteCustomerGatewayResult deleteCustomerGateway(DeleteCustomerGatewayRequest request)
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
deleteCustomerGateway in interface AmazonEC2deleteCustomerGatewayRequest - Contains the parameters for DeleteCustomerGateway.public DeleteDhcpOptionsResult deleteDhcpOptions(DeleteDhcpOptionsRequest request)
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
deleteDhcpOptions in interface AmazonEC2deleteDhcpOptionsRequest - public DeleteEgressOnlyInternetGatewayResult deleteEgressOnlyInternetGateway(DeleteEgressOnlyInternetGatewayRequest request)
Deletes an egress-only internet gateway.
deleteEgressOnlyInternetGateway in interface AmazonEC2deleteEgressOnlyInternetGatewayRequest - public DeleteFleetsResult deleteFleets(DeleteFleetsRequest request)
Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should 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. Up to 1000
instances can be terminated in a single request to delete instant fleets. A deleted
instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant in a single request.
You can delete up to 100 fleets of type maintain or request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
deleteFleets in interface AmazonEC2deleteFleetsRequest - public DeleteFlowLogsResult deleteFlowLogs(DeleteFlowLogsRequest request)
Deletes one or more flow logs.
deleteFlowLogs in interface AmazonEC2deleteFlowLogsRequest - public DeleteFpgaImageResult deleteFpgaImage(DeleteFpgaImageRequest request)
Deletes the specified Amazon FPGA Image (AFI).
deleteFpgaImage in interface AmazonEC2deleteFpgaImageRequest - public DeleteInstanceConnectEndpointResult deleteInstanceConnectEndpoint(DeleteInstanceConnectEndpointRequest request)
Deletes the specified EC2 Instance Connect Endpoint.
deleteInstanceConnectEndpoint in interface AmazonEC2deleteInstanceConnectEndpointRequest - public DeleteInstanceEventWindowResult deleteInstanceEventWindow(DeleteInstanceEventWindowRequest request)
Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
deleteInstanceEventWindow in interface AmazonEC2deleteInstanceEventWindowRequest - public DeleteInternetGatewayResult deleteInternetGateway(DeleteInternetGatewayRequest request)
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
deleteInternetGateway in interface AmazonEC2deleteInternetGatewayRequest - public DeleteIpamResult deleteIpam(DeleteIpamRequest request)
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
deleteIpam in interface AmazonEC2deleteIpamRequest - public DeleteIpamExternalResourceVerificationTokenResult deleteIpamExternalResourceVerificationToken(DeleteIpamExternalResourceVerificationTokenRequest request)
Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
deleteIpamExternalResourceVerificationToken in interface AmazonEC2deleteIpamExternalResourceVerificationTokenRequest - public DeleteIpamPoolResult deleteIpamPool(DeleteIpamPoolRequest request)
Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
deleteIpamPool in interface AmazonEC2deleteIpamPoolRequest - public DeleteIpamResourceDiscoveryResult deleteIpamResourceDiscovery(DeleteIpamResourceDiscoveryRequest request)
Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
deleteIpamResourceDiscovery in interface AmazonEC2deleteIpamResourceDiscoveryRequest - public DeleteIpamScopeResult deleteIpamScope(DeleteIpamScopeRequest request)
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
deleteIpamScope in interface AmazonEC2deleteIpamScopeRequest - public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
Deletes the specified key pair, by removing the public key from Amazon EC2.
deleteKeyPair in interface AmazonEC2deleteKeyPairRequest - public DeleteLaunchTemplateResult deleteLaunchTemplate(DeleteLaunchTemplateRequest request)
Deletes a launch template. Deleting a launch template deletes all of its versions.
deleteLaunchTemplate in interface AmazonEC2deleteLaunchTemplateRequest - public DeleteLaunchTemplateVersionsResult deleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest request)
Deletes one or more versions of a launch template.
You can't 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.
You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the launch template and all of its versions.
For more information, see Delete a launch template version in the Amazon EC2 User Guide.
deleteLaunchTemplateVersions in interface AmazonEC2deleteLaunchTemplateVersionsRequest - public DeleteLocalGatewayRouteResult deleteLocalGatewayRoute(DeleteLocalGatewayRouteRequest request)
Deletes the specified route from the specified local gateway route table.
deleteLocalGatewayRoute in interface AmazonEC2deleteLocalGatewayRouteRequest - public DeleteLocalGatewayRouteTableResult deleteLocalGatewayRouteTable(DeleteLocalGatewayRouteTableRequest request)
Deletes a local gateway route table.
deleteLocalGatewayRouteTable in interface AmazonEC2deleteLocalGatewayRouteTableRequest - public DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation(DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest request)
Deletes a local gateway route table virtual interface group association.
deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation in interface AmazonEC2deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest - public DeleteLocalGatewayRouteTableVpcAssociationResult deleteLocalGatewayRouteTableVpcAssociation(DeleteLocalGatewayRouteTableVpcAssociationRequest request)
Deletes the specified association between a VPC and local gateway route table.
deleteLocalGatewayRouteTableVpcAssociation in interface AmazonEC2deleteLocalGatewayRouteTableVpcAssociationRequest - public DeleteManagedPrefixListResult deleteManagedPrefixList(DeleteManagedPrefixListRequest request)
Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
deleteManagedPrefixList in interface AmazonEC2deleteManagedPrefixListRequest - public DeleteNatGatewayResult deleteNatGateway(DeleteNatGatewayRequest request)
Deletes the specified NAT gateway. Deleting a public 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 AmazonEC2deleteNatGatewayRequest - public DeleteNetworkAclResult deleteNetworkAcl(DeleteNetworkAclRequest request)
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
deleteNetworkAcl in interface AmazonEC2deleteNetworkAclRequest - public DeleteNetworkAclEntryResult deleteNetworkAclEntry(DeleteNetworkAclEntryRequest request)
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
deleteNetworkAclEntry in interface AmazonEC2deleteNetworkAclEntryRequest - public DeleteNetworkInsightsAccessScopeResult deleteNetworkInsightsAccessScope(DeleteNetworkInsightsAccessScopeRequest request)
Deletes the specified Network Access Scope.
deleteNetworkInsightsAccessScope in interface AmazonEC2deleteNetworkInsightsAccessScopeRequest - public DeleteNetworkInsightsAccessScopeAnalysisResult deleteNetworkInsightsAccessScopeAnalysis(DeleteNetworkInsightsAccessScopeAnalysisRequest request)
Deletes the specified Network Access Scope analysis.
deleteNetworkInsightsAccessScopeAnalysis in interface AmazonEC2deleteNetworkInsightsAccessScopeAnalysisRequest - public DeleteNetworkInsightsAnalysisResult deleteNetworkInsightsAnalysis(DeleteNetworkInsightsAnalysisRequest request)
Deletes the specified network insights analysis.
deleteNetworkInsightsAnalysis in interface AmazonEC2deleteNetworkInsightsAnalysisRequest - public DeleteNetworkInsightsPathResult deleteNetworkInsightsPath(DeleteNetworkInsightsPathRequest request)
Deletes the specified path.
deleteNetworkInsightsPath in interface AmazonEC2deleteNetworkInsightsPathRequest - public DeleteNetworkInterfaceResult deleteNetworkInterface(DeleteNetworkInterfaceRequest request)
Deletes the specified network interface. You must detach the network interface before you can delete it.
deleteNetworkInterface in interface AmazonEC2deleteNetworkInterfaceRequest - Contains the parameters for DeleteNetworkInterface.public DeleteNetworkInterfacePermissionResult deleteNetworkInterfacePermission(DeleteNetworkInterfacePermissionRequest request)
Deletes 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 AmazonEC2deleteNetworkInterfacePermissionRequest - Contains the parameters for DeleteNetworkInterfacePermission.public DeletePlacementGroupResult deletePlacementGroup(DeletePlacementGroupRequest request)
Deletes 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 AmazonEC2deletePlacementGroupRequest - public DeletePublicIpv4PoolResult deletePublicIpv4Pool(DeletePublicIpv4PoolRequest request)
Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.
deletePublicIpv4Pool in interface AmazonEC2deletePublicIpv4PoolRequest - public DeleteQueuedReservedInstancesResult deleteQueuedReservedInstances(DeleteQueuedReservedInstancesRequest request)
Deletes the queued purchases for the specified Reserved Instances.
deleteQueuedReservedInstances in interface AmazonEC2deleteQueuedReservedInstancesRequest - public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
Deletes the specified route from the specified route table.
deleteRoute in interface AmazonEC2deleteRouteRequest - public DeleteRouteTableResult deleteRouteTable(DeleteRouteTableRequest request)
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
deleteRouteTable in interface AmazonEC2deleteRouteTableRequest - public DeleteSecurityGroupResult deleteSecurityGroup(DeleteSecurityGroupRequest request)
Deletes a security group.
If you attempt to delete a security group that is associated with an instance or network interface or is
referenced by another security group, the operation fails with DependencyViolation.
deleteSecurityGroup in interface AmazonEC2deleteSecurityGroupRequest - public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.
deleteSnapshot in interface AmazonEC2deleteSnapshotRequest - public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest request)
Deletes the data feed for Spot Instances.
deleteSpotDatafeedSubscription in interface AmazonEC2deleteSpotDatafeedSubscriptionRequest - Contains the parameters for DeleteSpotDatafeedSubscription.public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription()
AmazonEC2deleteSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest)public DeleteSubnetResult deleteSubnet(DeleteSubnetRequest request)
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
deleteSubnet in interface AmazonEC2deleteSubnetRequest - public DeleteSubnetCidrReservationResult deleteSubnetCidrReservation(DeleteSubnetCidrReservationRequest request)
Deletes a subnet CIDR reservation.
deleteSubnetCidrReservation in interface AmazonEC2deleteSubnetCidrReservationRequest - public DeleteTagsResult deleteTags(DeleteTagsRequest request)
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
deleteTags in interface AmazonEC2deleteTagsRequest - public DeleteTrafficMirrorFilterResult deleteTrafficMirrorFilter(DeleteTrafficMirrorFilterRequest request)
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
deleteTrafficMirrorFilter in interface AmazonEC2deleteTrafficMirrorFilterRequest - public DeleteTrafficMirrorFilterRuleResult deleteTrafficMirrorFilterRule(DeleteTrafficMirrorFilterRuleRequest request)
Deletes the specified Traffic Mirror rule.
deleteTrafficMirrorFilterRule in interface AmazonEC2deleteTrafficMirrorFilterRuleRequest - public DeleteTrafficMirrorSessionResult deleteTrafficMirrorSession(DeleteTrafficMirrorSessionRequest request)
Deletes the specified Traffic Mirror session.
deleteTrafficMirrorSession in interface AmazonEC2deleteTrafficMirrorSessionRequest - public DeleteTrafficMirrorTargetResult deleteTrafficMirrorTarget(DeleteTrafficMirrorTargetRequest request)
Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
deleteTrafficMirrorTarget in interface AmazonEC2deleteTrafficMirrorTargetRequest - public DeleteTransitGatewayResult deleteTransitGateway(DeleteTransitGatewayRequest request)
Deletes the specified transit gateway.
deleteTransitGateway in interface AmazonEC2deleteTransitGatewayRequest - public DeleteTransitGatewayConnectResult deleteTransitGatewayConnect(DeleteTransitGatewayConnectRequest request)
Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
deleteTransitGatewayConnect in interface AmazonEC2deleteTransitGatewayConnectRequest - public DeleteTransitGatewayConnectPeerResult deleteTransitGatewayConnectPeer(DeleteTransitGatewayConnectPeerRequest request)
Deletes the specified Connect peer.
deleteTransitGatewayConnectPeer in interface AmazonEC2deleteTransitGatewayConnectPeerRequest - public DeleteTransitGatewayMulticastDomainResult deleteTransitGatewayMulticastDomain(DeleteTransitGatewayMulticastDomainRequest request)
Deletes the specified transit gateway multicast domain.
deleteTransitGatewayMulticastDomain in interface AmazonEC2deleteTransitGatewayMulticastDomainRequest - public DeleteTransitGatewayPeeringAttachmentResult deleteTransitGatewayPeeringAttachment(DeleteTransitGatewayPeeringAttachmentRequest request)
Deletes a transit gateway peering attachment.
deleteTransitGatewayPeeringAttachment in interface AmazonEC2deleteTransitGatewayPeeringAttachmentRequest - public DeleteTransitGatewayPolicyTableResult deleteTransitGatewayPolicyTable(DeleteTransitGatewayPolicyTableRequest request)
Deletes the specified transit gateway policy table.
deleteTransitGatewayPolicyTable in interface AmazonEC2deleteTransitGatewayPolicyTableRequest - public DeleteTransitGatewayPrefixListReferenceResult deleteTransitGatewayPrefixListReference(DeleteTransitGatewayPrefixListReferenceRequest request)
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
deleteTransitGatewayPrefixListReference in interface AmazonEC2deleteTransitGatewayPrefixListReferenceRequest - public DeleteTransitGatewayRouteResult deleteTransitGatewayRoute(DeleteTransitGatewayRouteRequest request)
Deletes the specified route from the specified transit gateway route table.
deleteTransitGatewayRoute in interface AmazonEC2deleteTransitGatewayRouteRequest - public DeleteTransitGatewayRouteTableResult deleteTransitGatewayRouteTable(DeleteTransitGatewayRouteTableRequest request)
Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
deleteTransitGatewayRouteTable in interface AmazonEC2deleteTransitGatewayRouteTableRequest - public DeleteTransitGatewayRouteTableAnnouncementResult deleteTransitGatewayRouteTableAnnouncement(DeleteTransitGatewayRouteTableAnnouncementRequest request)
Advertises to the transit gateway that a transit gateway route table is deleted.
deleteTransitGatewayRouteTableAnnouncement in interface AmazonEC2deleteTransitGatewayRouteTableAnnouncementRequest - public DeleteTransitGatewayVpcAttachmentResult deleteTransitGatewayVpcAttachment(DeleteTransitGatewayVpcAttachmentRequest request)
Deletes the specified VPC attachment.
deleteTransitGatewayVpcAttachment in interface AmazonEC2deleteTransitGatewayVpcAttachmentRequest - public DeleteVerifiedAccessEndpointResult deleteVerifiedAccessEndpoint(DeleteVerifiedAccessEndpointRequest request)
Delete an Amazon Web Services Verified Access endpoint.
deleteVerifiedAccessEndpoint in interface AmazonEC2deleteVerifiedAccessEndpointRequest - public DeleteVerifiedAccessGroupResult deleteVerifiedAccessGroup(DeleteVerifiedAccessGroupRequest request)
Delete an Amazon Web Services Verified Access group.
deleteVerifiedAccessGroup in interface AmazonEC2deleteVerifiedAccessGroupRequest - public DeleteVerifiedAccessInstanceResult deleteVerifiedAccessInstance(DeleteVerifiedAccessInstanceRequest request)
Delete an Amazon Web Services Verified Access instance.
deleteVerifiedAccessInstance in interface AmazonEC2deleteVerifiedAccessInstanceRequest - public DeleteVerifiedAccessTrustProviderResult deleteVerifiedAccessTrustProvider(DeleteVerifiedAccessTrustProviderRequest request)
Delete an Amazon Web Services Verified Access trust provider.
deleteVerifiedAccessTrustProvider in interface AmazonEC2deleteVerifiedAccessTrustProviderRequest - public DeleteVolumeResult deleteVolume(DeleteVolumeRequest request)
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 Delete an Amazon EBS volume in the Amazon EBS User Guide.
deleteVolume in interface AmazonEC2deleteVolumeRequest - public DeleteVpcResult deleteVpc(DeleteVpcRequest request)
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.
deleteVpc in interface AmazonEC2deleteVpcRequest - public DeleteVpcEndpointConnectionNotificationsResult deleteVpcEndpointConnectionNotifications(DeleteVpcEndpointConnectionNotificationsRequest request)
Deletes the specified VPC endpoint connection notifications.
deleteVpcEndpointConnectionNotifications in interface AmazonEC2deleteVpcEndpointConnectionNotificationsRequest - public DeleteVpcEndpointServiceConfigurationsResult deleteVpcEndpointServiceConfigurations(DeleteVpcEndpointServiceConfigurationsRequest request)
Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service
configuration, you must reject any Available or PendingAcceptance interface endpoint
connections that are attached to the service.
deleteVpcEndpointServiceConfigurations in interface AmazonEC2deleteVpcEndpointServiceConfigurationsRequest - public DeleteVpcEndpointsResult deleteVpcEndpoints(DeleteVpcEndpointsRequest request)
Deletes the specified VPC endpoints.
When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete its 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 its endpoint network interfaces.
deleteVpcEndpoints in interface AmazonEC2deleteVpcEndpointsRequest - public DeleteVpcPeeringConnectionResult deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest request)
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 or rejected state.
deleteVpcPeeringConnection in interface AmazonEC2deleteVpcPeeringConnectionRequest - public DeleteVpnConnectionResult deleteVpnConnection(DeleteVpnConnectionRequest request)
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
deleteVpnConnection in interface AmazonEC2deleteVpnConnectionRequest - Contains the parameters for DeleteVpnConnection.public DeleteVpnConnectionRouteResult deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest request)
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
deleteVpnConnectionRoute in interface AmazonEC2deleteVpnConnectionRouteRequest - Contains the parameters for DeleteVpnConnectionRoute.public DeleteVpnGatewayResult deleteVpnGateway(DeleteVpnGatewayRequest request)
Deletes 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 AmazonEC2deleteVpnGatewayRequest - Contains the parameters for DeleteVpnGateway.public DeprovisionByoipCidrResult deprovisionByoipCidr(DeprovisionByoipCidrRequest request)
Releases the specified address range that you provisioned for use with your Amazon Web Services 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 AmazonEC2deprovisionByoipCidrRequest - public DeprovisionIpamByoasnResult deprovisionIpamByoasn(DeprovisionIpamByoasnRequest request)
Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
deprovisionIpamByoasn in interface AmazonEC2deprovisionIpamByoasnRequest - public DeprovisionIpamPoolCidrResult deprovisionIpamPoolCidr(DeprovisionIpamPoolCidrRequest request)
Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
deprovisionIpamPoolCidr in interface AmazonEC2deprovisionIpamPoolCidrRequest - public DeprovisionPublicIpv4PoolCidrResult deprovisionPublicIpv4PoolCidr(DeprovisionPublicIpv4PoolCidrRequest request)
Deprovision a CIDR from a public IPv4 pool.
deprovisionPublicIpv4PoolCidr in interface AmazonEC2deprovisionPublicIpv4PoolCidrRequest - public DeregisterImageResult deregisterImage(DeregisterImageRequest request)
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.
When you deregister an AMI, 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 AmazonEC2deregisterImageRequest - Contains the parameters for DeregisterImage.public DeregisterInstanceEventNotificationAttributesResult deregisterInstanceEventNotificationAttributes(DeregisterInstanceEventNotificationAttributesRequest request)
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
deregisterInstanceEventNotificationAttributes in interface AmazonEC2deregisterInstanceEventNotificationAttributesRequest - public DeregisterTransitGatewayMulticastGroupMembersResult deregisterTransitGatewayMulticastGroupMembers(DeregisterTransitGatewayMulticastGroupMembersRequest request)
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupMembers in interface AmazonEC2deregisterTransitGatewayMulticastGroupMembersRequest - public DeregisterTransitGatewayMulticastGroupSourcesResult deregisterTransitGatewayMulticastGroupSources(DeregisterTransitGatewayMulticastGroupSourcesRequest request)
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupSources in interface AmazonEC2deregisterTransitGatewayMulticastGroupSourcesRequest - public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
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.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
supported-platforms: This attribute is deprecated.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to
a network interface.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeAccountAttributes in interface AmazonEC2describeAccountAttributesRequest - public DescribeAccountAttributesResult describeAccountAttributes()
AmazonEC2describeAccountAttributes in interface AmazonEC2AmazonEC2.describeAccountAttributes(DescribeAccountAttributesRequest)public DescribeAddressTransfersResult describeAddressTransfers(DescribeAddressTransfersRequest request)
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for three days after the transfers have been accepted.
describeAddressTransfers in interface AmazonEC2describeAddressTransfersRequest - public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
describeAddresses in interface AmazonEC2describeAddressesRequest - public DescribeAddressesResult describeAddresses()
AmazonEC2describeAddresses in interface AmazonEC2AmazonEC2.describeAddresses(DescribeAddressesRequest)public DescribeAddressesAttributeResult describeAddressesAttribute(DescribeAddressesAttributeRequest request)
Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.
describeAddressesAttribute in interface AmazonEC2describeAddressesAttributeRequest - public DescribeAggregateIdFormatResult describeAggregateIdFormat(DescribeAggregateIdFormatRequest request)
Describes 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 AmazonEC2describeAggregateIdFormatRequest - public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest request)
Describes 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 and zones in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeAvailabilityZones in interface AmazonEC2describeAvailabilityZonesRequest - public DescribeAvailabilityZonesResult describeAvailabilityZones()
AmazonEC2describeAvailabilityZones in interface AmazonEC2AmazonEC2.describeAvailabilityZones(DescribeAvailabilityZonesRequest)public DescribeAwsNetworkPerformanceMetricSubscriptionsResult describeAwsNetworkPerformanceMetricSubscriptions(DescribeAwsNetworkPerformanceMetricSubscriptionsRequest request)
Describes the current Infrastructure Performance metric subscriptions.
describeAwsNetworkPerformanceMetricSubscriptions in interface AmazonEC2describeAwsNetworkPerformanceMetricSubscriptionsRequest - public DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest request)
Describes 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.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeBundleTasks in interface AmazonEC2describeBundleTasksRequest - public DescribeBundleTasksResult describeBundleTasks()
AmazonEC2describeBundleTasks in interface AmazonEC2AmazonEC2.describeBundleTasks(DescribeBundleTasksRequest)public DescribeByoipCidrsResult describeByoipCidrs(DescribeByoipCidrsRequest request)
Describes 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 AmazonEC2describeByoipCidrsRequest - public DescribeCapacityBlockOfferingsResult describeCapacityBlockOfferings(DescribeCapacityBlockOfferingsRequest request)
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
describeCapacityBlockOfferings in interface AmazonEC2describeCapacityBlockOfferingsRequest - public DescribeCapacityReservationFleetsResult describeCapacityReservationFleets(DescribeCapacityReservationFleetsRequest request)
Describes one or more Capacity Reservation Fleets.
describeCapacityReservationFleets in interface AmazonEC2describeCapacityReservationFleetsRequest - public DescribeCapacityReservationsResult describeCapacityReservations(DescribeCapacityReservationsRequest request)
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
describeCapacityReservations in interface AmazonEC2describeCapacityReservationsRequest - public DescribeCarrierGatewaysResult describeCarrierGateways(DescribeCarrierGatewaysRequest request)
Describes one or more of your carrier gateways.
describeCarrierGateways in interface AmazonEC2describeCarrierGatewaysRequest - public DescribeClassicLinkInstancesResult describeClassicLinkInstances(DescribeClassicLinkInstancesRequest request)
This action is deprecated.
Describes 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 AmazonEC2describeClassicLinkInstancesRequest - public DescribeClassicLinkInstancesResult describeClassicLinkInstances()
AmazonEC2describeClassicLinkInstances in interface AmazonEC2AmazonEC2.describeClassicLinkInstances(DescribeClassicLinkInstancesRequest)public DescribeClientVpnAuthorizationRulesResult describeClientVpnAuthorizationRules(DescribeClientVpnAuthorizationRulesRequest request)
Describes the authorization rules for a specified Client VPN endpoint.
describeClientVpnAuthorizationRules in interface AmazonEC2describeClientVpnAuthorizationRulesRequest - public DescribeClientVpnConnectionsResult describeClientVpnConnections(DescribeClientVpnConnectionsRequest request)
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
describeClientVpnConnections in interface AmazonEC2describeClientVpnConnectionsRequest - public DescribeClientVpnEndpointsResult describeClientVpnEndpoints(DescribeClientVpnEndpointsRequest request)
Describes one or more Client VPN endpoints in the account.
describeClientVpnEndpoints in interface AmazonEC2describeClientVpnEndpointsRequest - public DescribeClientVpnRoutesResult describeClientVpnRoutes(DescribeClientVpnRoutesRequest request)
Describes the routes for the specified Client VPN endpoint.
describeClientVpnRoutes in interface AmazonEC2describeClientVpnRoutesRequest - public DescribeClientVpnTargetNetworksResult describeClientVpnTargetNetworks(DescribeClientVpnTargetNetworksRequest request)
Describes the target networks associated with the specified Client VPN endpoint.
describeClientVpnTargetNetworks in interface AmazonEC2describeClientVpnTargetNetworksRequest - public DescribeCoipPoolsResult describeCoipPools(DescribeCoipPoolsRequest request)
Describes the specified customer-owned address pools or all of your customer-owned address pools.
describeCoipPools in interface AmazonEC2describeCoipPoolsRequest - public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest request)
Describes 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 AmazonEC2describeConversionTasksRequest - public DescribeConversionTasksResult describeConversionTasks()
AmazonEC2describeConversionTasks in interface AmazonEC2AmazonEC2.describeConversionTasks(DescribeConversionTasksRequest)public DescribeCustomerGatewaysResult describeCustomerGateways(DescribeCustomerGatewaysRequest request)
Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
describeCustomerGateways in interface AmazonEC2describeCustomerGatewaysRequest - Contains the parameters for DescribeCustomerGateways.public DescribeCustomerGatewaysResult describeCustomerGateways()
AmazonEC2describeCustomerGateways in interface AmazonEC2AmazonEC2.describeCustomerGateways(DescribeCustomerGatewaysRequest)public DescribeDhcpOptionsResult describeDhcpOptions(DescribeDhcpOptionsRequest request)
Describes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria.
For more information, see DHCP option sets in the Amazon VPC User Guide.
describeDhcpOptions in interface AmazonEC2describeDhcpOptionsRequest - public DescribeDhcpOptionsResult describeDhcpOptions()
AmazonEC2describeDhcpOptions in interface AmazonEC2AmazonEC2.describeDhcpOptions(DescribeDhcpOptionsRequest)public DescribeEgressOnlyInternetGatewaysResult describeEgressOnlyInternetGateways(DescribeEgressOnlyInternetGatewaysRequest request)
Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.
describeEgressOnlyInternetGateways in interface AmazonEC2describeEgressOnlyInternetGatewaysRequest - public DescribeElasticGpusResult describeElasticGpus(DescribeElasticGpusRequest request)
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the Elastic Graphics accelerator associated with your instances.
describeElasticGpus in interface AmazonEC2describeElasticGpusRequest - public DescribeExportImageTasksResult describeExportImageTasks(DescribeExportImageTasksRequest request)
Describes the specified export image tasks or all of your export image tasks.
describeExportImageTasks in interface AmazonEC2describeExportImageTasksRequest - public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
Describes the specified export instance tasks or all of your export instance tasks.
describeExportTasks in interface AmazonEC2describeExportTasksRequest - public DescribeExportTasksResult describeExportTasks()
AmazonEC2describeExportTasks in interface AmazonEC2AmazonEC2.describeExportTasks(DescribeExportTasksRequest)public DescribeFastLaunchImagesResult describeFastLaunchImages(DescribeFastLaunchImagesRequest request)
Describe details for Windows AMIs that are configured for Windows fast launch.
describeFastLaunchImages in interface AmazonEC2describeFastLaunchImagesRequest - public DescribeFastSnapshotRestoresResult describeFastSnapshotRestores(DescribeFastSnapshotRestoresRequest request)
Describes the state of fast snapshot restores for your snapshots.
describeFastSnapshotRestores in interface AmazonEC2describeFastSnapshotRestoresRequest - public DescribeFleetHistoryResult describeFleetHistory(DescribeFleetHistoryRequest request)
Describes 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 Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
describeFleetHistory in interface AmazonEC2describeFleetHistoryRequest - public DescribeFleetInstancesResult describeFleetInstances(DescribeFleetInstancesRequest request)
Describes the running instances for the specified EC2 Fleet.
Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use
DescribeFleets, specifying the instant fleet ID in the request.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
describeFleetInstances in interface AmazonEC2describeFleetInstancesRequest - public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
Describes the specified EC2 Fleet or all of your EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID in the request, otherwise the fleet
does not appear in the response.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
describeFleets in interface AmazonEC2describeFleetsRequest - public DescribeFlowLogsResult describeFlowLogs(DescribeFlowLogsRequest request)
Describes one or more flow logs.
To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
describeFlowLogs in interface AmazonEC2describeFlowLogsRequest - public DescribeFlowLogsResult describeFlowLogs()
AmazonEC2describeFlowLogs in interface AmazonEC2AmazonEC2.describeFlowLogs(DescribeFlowLogsRequest)public DescribeFpgaImageAttributeResult describeFpgaImageAttribute(DescribeFpgaImageAttributeRequest request)
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
describeFpgaImageAttribute in interface AmazonEC2describeFpgaImageAttributeRequest - public DescribeFpgaImagesResult describeFpgaImages(DescribeFpgaImagesRequest request)
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
describeFpgaImages in interface AmazonEC2describeFpgaImagesRequest - public DescribeHostReservationOfferingsResult describeHostReservationOfferings(DescribeHostReservationOfferingsRequest request)
Describes 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 AmazonEC2describeHostReservationOfferingsRequest - public DescribeHostReservationsResult describeHostReservations(DescribeHostReservationsRequest request)
Describes reservations that are associated with Dedicated Hosts in your account.
describeHostReservations in interface AmazonEC2describeHostReservationsRequest - public DescribeHostsResult describeHosts(DescribeHostsRequest request)
Describes 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 AmazonEC2describeHostsRequest - public DescribeHostsResult describeHosts()
AmazonEC2describeHosts in interface AmazonEC2AmazonEC2.describeHosts(DescribeHostsRequest)public DescribeIamInstanceProfileAssociationsResult describeIamInstanceProfileAssociations(DescribeIamInstanceProfileAssociationsRequest request)
Describes your IAM instance profile associations.
describeIamInstanceProfileAssociations in interface AmazonEC2describeIamInstanceProfileAssociationsRequest - public DescribeIdFormatResult describeIdFormat(DescribeIdFormatRequest request)
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. 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 Amazon Web Services
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 AmazonEC2describeIdFormatRequest - public DescribeIdFormatResult describeIdFormat()
AmazonEC2describeIdFormat in interface AmazonEC2AmazonEC2.describeIdFormat(DescribeIdFormatRequest)public DescribeIdentityIdFormatResult describeIdentityIdFormat(DescribeIdentityIdFormatRequest request)
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: 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 AmazonEC2describeIdentityIdFormatRequest - public DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest request)
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeImageAttribute in interface AmazonEC2describeImageAttributeRequest - Contains the parameters for DescribeImageAttribute.public DescribeImagesResult describeImages(DescribeImagesRequest request)
Describes 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 Amazon Web Services 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 will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeImages in interface AmazonEC2describeImagesRequest - public DescribeImagesResult describeImages()
AmazonEC2describeImages in interface AmazonEC2AmazonEC2.describeImages(DescribeImagesRequest)public DescribeImportImageTasksResult describeImportImageTasks(DescribeImportImageTasksRequest request)
Displays details about an import virtual machine or import snapshot tasks that are already created.
describeImportImageTasks in interface AmazonEC2describeImportImageTasksRequest - public DescribeImportImageTasksResult describeImportImageTasks()
AmazonEC2describeImportImageTasks in interface AmazonEC2AmazonEC2.describeImportImageTasks(DescribeImportImageTasksRequest)public DescribeImportSnapshotTasksResult describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest request)
Describes your import snapshot tasks.
describeImportSnapshotTasks in interface AmazonEC2describeImportSnapshotTasksRequest - public DescribeImportSnapshotTasksResult describeImportSnapshotTasks()
AmazonEC2describeImportSnapshotTasks in interface AmazonEC2AmazonEC2.describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest)public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
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 AmazonEC2describeInstanceAttributeRequest - public DescribeInstanceConnectEndpointsResult describeInstanceConnectEndpoints(DescribeInstanceConnectEndpointsRequest request)
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
describeInstanceConnectEndpoints in interface AmazonEC2describeInstanceConnectEndpointsRequest - public DescribeInstanceCreditSpecificationsResult describeInstanceCreditSpecifications(DescribeInstanceCreditSpecificationsRequest request)
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 AmazonEC2describeInstanceCreditSpecificationsRequest - public DescribeInstanceEventNotificationAttributesResult describeInstanceEventNotificationAttributes(DescribeInstanceEventNotificationAttributesRequest request)
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
describeInstanceEventNotificationAttributes in interface AmazonEC2describeInstanceEventNotificationAttributesRequest - public DescribeInstanceEventWindowsResult describeInstanceEventWindows(DescribeInstanceEventWindowsRequest request)
Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
describeInstanceEventWindows in interface AmazonEC2describeInstanceEventWindowsRequest - Describe instance event windows by InstanceEventWindow.public DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest request)
Describes 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 Troubleshoot 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.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeInstanceStatus in interface AmazonEC2describeInstanceStatusRequest - public DescribeInstanceStatusResult describeInstanceStatus()
AmazonEC2describeInstanceStatus in interface AmazonEC2AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest)public DescribeInstanceTopologyResult describeInstanceTopology(DescribeInstanceTopologyRequest request)
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge |
hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge |
hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
describeInstanceTopology in interface AmazonEC2describeInstanceTopologyRequest - public DescribeInstanceTypeOfferingsResult describeInstanceTypeOfferings(DescribeInstanceTypeOfferingsRequest request)
Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
describeInstanceTypeOfferings in interface AmazonEC2describeInstanceTypeOfferingsRequest - public DescribeInstanceTypesResult describeInstanceTypes(DescribeInstanceTypesRequest request)
Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
describeInstanceTypes in interface AmazonEC2describeInstanceTypesRequest - public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
Describes 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.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeInstances in interface AmazonEC2describeInstancesRequest - public DescribeInstancesResult describeInstances()
AmazonEC2describeInstances in interface AmazonEC2AmazonEC2.describeInstances(DescribeInstancesRequest)public DescribeInternetGatewaysResult describeInternetGateways(DescribeInternetGatewaysRequest request)
Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.
describeInternetGateways in interface AmazonEC2describeInternetGatewaysRequest - public DescribeInternetGatewaysResult describeInternetGateways()
AmazonEC2describeInternetGateways in interface AmazonEC2AmazonEC2.describeInternetGateways(DescribeInternetGatewaysRequest)public DescribeIpamByoasnResult describeIpamByoasn(DescribeIpamByoasnRequest request)
Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
describeIpamByoasn in interface AmazonEC2describeIpamByoasnRequest - public DescribeIpamExternalResourceVerificationTokensResult describeIpamExternalResourceVerificationTokens(DescribeIpamExternalResourceVerificationTokensRequest request)
Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
describeIpamExternalResourceVerificationTokens in interface AmazonEC2describeIpamExternalResourceVerificationTokensRequest - public DescribeIpamPoolsResult describeIpamPools(DescribeIpamPoolsRequest request)
Get information about your IPAM pools.
describeIpamPools in interface AmazonEC2describeIpamPoolsRequest - public DescribeIpamResourceDiscoveriesResult describeIpamResourceDiscoveries(DescribeIpamResourceDiscoveriesRequest request)
Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
describeIpamResourceDiscoveries in interface AmazonEC2describeIpamResourceDiscoveriesRequest - public DescribeIpamResourceDiscoveryAssociationsResult describeIpamResourceDiscoveryAssociations(DescribeIpamResourceDiscoveryAssociationsRequest request)
Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
describeIpamResourceDiscoveryAssociations in interface AmazonEC2describeIpamResourceDiscoveryAssociationsRequest - public DescribeIpamScopesResult describeIpamScopes(DescribeIpamScopesRequest request)
Get information about your IPAM scopes.
describeIpamScopes in interface AmazonEC2describeIpamScopesRequest - public DescribeIpamsResult describeIpams(DescribeIpamsRequest request)
Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
describeIpams in interface AmazonEC2describeIpamsRequest - public DescribeIpv6PoolsResult describeIpv6Pools(DescribeIpv6PoolsRequest request)
Describes your IPv6 address pools.
describeIpv6Pools in interface AmazonEC2describeIpv6PoolsRequest - public DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest request)
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
describeKeyPairs in interface AmazonEC2describeKeyPairsRequest - public DescribeKeyPairsResult describeKeyPairs()
AmazonEC2describeKeyPairs in interface AmazonEC2AmazonEC2.describeKeyPairs(DescribeKeyPairsRequest)public DescribeLaunchTemplateVersionsResult describeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest request)
Describes 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 AmazonEC2describeLaunchTemplateVersionsRequest - public DescribeLaunchTemplatesResult describeLaunchTemplates(DescribeLaunchTemplatesRequest request)
Describes one or more launch templates.
describeLaunchTemplates in interface AmazonEC2describeLaunchTemplatesRequest - public DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest request)
Describes the associations between virtual interface groups and local gateway route tables.
describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations in interface AmazonEC2describeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest - public DescribeLocalGatewayRouteTableVpcAssociationsResult describeLocalGatewayRouteTableVpcAssociations(DescribeLocalGatewayRouteTableVpcAssociationsRequest request)
Describes the specified associations between VPCs and local gateway route tables.
describeLocalGatewayRouteTableVpcAssociations in interface AmazonEC2describeLocalGatewayRouteTableVpcAssociationsRequest - public DescribeLocalGatewayRouteTablesResult describeLocalGatewayRouteTables(DescribeLocalGatewayRouteTablesRequest request)
Describes 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 AmazonEC2describeLocalGatewayRouteTablesRequest - public DescribeLocalGatewayVirtualInterfaceGroupsResult describeLocalGatewayVirtualInterfaceGroups(DescribeLocalGatewayVirtualInterfaceGroupsRequest request)
Describes the specified local gateway virtual interface groups.
describeLocalGatewayVirtualInterfaceGroups in interface AmazonEC2describeLocalGatewayVirtualInterfaceGroupsRequest - public DescribeLocalGatewayVirtualInterfacesResult describeLocalGatewayVirtualInterfaces(DescribeLocalGatewayVirtualInterfacesRequest request)
Describes the specified local gateway virtual interfaces.
describeLocalGatewayVirtualInterfaces in interface AmazonEC2describeLocalGatewayVirtualInterfacesRequest - public DescribeLocalGatewaysResult describeLocalGateways(DescribeLocalGatewaysRequest request)
Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
describeLocalGateways in interface AmazonEC2describeLocalGatewaysRequest - public DescribeLockedSnapshotsResult describeLockedSnapshots(DescribeLockedSnapshotsRequest request)
Describes the lock status for a snapshot.
describeLockedSnapshots in interface AmazonEC2describeLockedSnapshotsRequest - public DescribeMacHostsResult describeMacHosts(DescribeMacHostsRequest request)
Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
describeMacHosts in interface AmazonEC2describeMacHostsRequest - public DescribeManagedPrefixListsResult describeManagedPrefixLists(DescribeManagedPrefixListsRequest request)
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
describeManagedPrefixLists in interface AmazonEC2describeManagedPrefixListsRequest - public DescribeMovingAddressesResult describeMovingAddresses(DescribeMovingAddressesRequest request)
This action is deprecated.
Describes your Elastic IP addresses that are being moved from or 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 AmazonEC2describeMovingAddressesRequest - public DescribeMovingAddressesResult describeMovingAddresses()
AmazonEC2describeMovingAddresses in interface AmazonEC2AmazonEC2.describeMovingAddresses(DescribeMovingAddressesRequest)public DescribeNatGatewaysResult describeNatGateways(DescribeNatGatewaysRequest request)
Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.
describeNatGateways in interface AmazonEC2describeNatGatewaysRequest - public DescribeNetworkAclsResult describeNetworkAcls(DescribeNetworkAclsRequest request)
Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria.
For more information, see Network ACLs in the Amazon VPC User Guide.
describeNetworkAcls in interface AmazonEC2describeNetworkAclsRequest - public DescribeNetworkAclsResult describeNetworkAcls()
AmazonEC2describeNetworkAcls in interface AmazonEC2AmazonEC2.describeNetworkAcls(DescribeNetworkAclsRequest)public DescribeNetworkInsightsAccessScopeAnalysesResult describeNetworkInsightsAccessScopeAnalyses(DescribeNetworkInsightsAccessScopeAnalysesRequest request)
Describes the specified Network Access Scope analyses.
describeNetworkInsightsAccessScopeAnalyses in interface AmazonEC2describeNetworkInsightsAccessScopeAnalysesRequest - public DescribeNetworkInsightsAccessScopesResult describeNetworkInsightsAccessScopes(DescribeNetworkInsightsAccessScopesRequest request)
Describes the specified Network Access Scopes.
describeNetworkInsightsAccessScopes in interface AmazonEC2describeNetworkInsightsAccessScopesRequest - public DescribeNetworkInsightsAnalysesResult describeNetworkInsightsAnalyses(DescribeNetworkInsightsAnalysesRequest request)
Describes one or more of your network insights analyses.
describeNetworkInsightsAnalyses in interface AmazonEC2describeNetworkInsightsAnalysesRequest - public DescribeNetworkInsightsPathsResult describeNetworkInsightsPaths(DescribeNetworkInsightsPathsRequest request)
Describes one or more of your paths.
describeNetworkInsightsPaths in interface AmazonEC2describeNetworkInsightsPathsRequest - public DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest request)
Describes a network interface attribute. You can specify only one attribute at a time.
describeNetworkInterfaceAttribute in interface AmazonEC2describeNetworkInterfaceAttributeRequest - Contains the parameters for DescribeNetworkInterfaceAttribute.public DescribeNetworkInterfacePermissionsResult describeNetworkInterfacePermissions(DescribeNetworkInterfacePermissionsRequest request)
Describes the permissions for your network interfaces.
describeNetworkInterfacePermissions in interface AmazonEC2describeNetworkInterfacePermissionsRequest - Contains the parameters for DescribeNetworkInterfacePermissions.public DescribeNetworkInterfacesResult describeNetworkInterfaces(DescribeNetworkInterfacesRequest request)
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the
following filters: group-id, mac-address, private-dns-name,
private-ip-address, private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
describeNetworkInterfaces in interface AmazonEC2describeNetworkInterfacesRequest - Contains the parameters for DescribeNetworkInterfaces.public DescribeNetworkInterfacesResult describeNetworkInterfaces()
AmazonEC2describeNetworkInterfaces in interface AmazonEC2AmazonEC2.describeNetworkInterfaces(DescribeNetworkInterfacesRequest)public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest request)
Describes the specified placement groups or all of your placement groups.
To describe a specific placement group that is shared with your account, you must specify the ID of the
placement group using the GroupId parameter. Specifying the name of a shared placement group
using the GroupNames parameter will result in an error.
For more information, see Placement groups in the Amazon EC2 User Guide.
describePlacementGroups in interface AmazonEC2describePlacementGroupsRequest - public DescribePlacementGroupsResult describePlacementGroups()
AmazonEC2describePlacementGroups in interface AmazonEC2AmazonEC2.describePlacementGroups(DescribePlacementGroupsRequest)public DescribePrefixListsResult describePrefixLists(DescribePrefixListsRequest request)
Describes available Amazon Web Services 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 AmazonEC2describePrefixListsRequest - public DescribePrefixListsResult describePrefixLists()
AmazonEC2describePrefixLists in interface AmazonEC2AmazonEC2.describePrefixLists(DescribePrefixListsRequest)public DescribePrincipalIdFormatResult describePrincipalIdFormat(DescribePrincipalIdFormatRequest request)
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
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 AmazonEC2describePrincipalIdFormatRequest - public DescribePublicIpv4PoolsResult describePublicIpv4Pools(DescribePublicIpv4PoolsRequest request)
Describes the specified IPv4 address pools.
describePublicIpv4Pools in interface AmazonEC2describePublicIpv4PoolsRequest - public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.
For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeRegions in interface AmazonEC2describeRegionsRequest - public DescribeRegionsResult describeRegions()
AmazonEC2describeRegions in interface AmazonEC2AmazonEC2.describeRegions(DescribeRegionsRequest)public DescribeReplaceRootVolumeTasksResult describeReplaceRootVolumeTasks(DescribeReplaceRootVolumeTasksRequest request)
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.
describeReplaceRootVolumeTasks in interface AmazonEC2describeReplaceRootVolumeTasksRequest - public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)
Describes 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.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeReservedInstances in interface AmazonEC2describeReservedInstancesRequest - Contains the parameters for DescribeReservedInstances.public DescribeReservedInstancesResult describeReservedInstances()
AmazonEC2describeReservedInstances in interface AmazonEC2AmazonEC2.describeReservedInstances(DescribeReservedInstancesRequest)public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest request)
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeReservedInstancesListings in interface AmazonEC2describeReservedInstancesListingsRequest - Contains the parameters for DescribeReservedInstancesListings.public DescribeReservedInstancesListingsResult describeReservedInstancesListings()
AmazonEC2describeReservedInstancesListings in interface AmazonEC2AmazonEC2.describeReservedInstancesListings(DescribeReservedInstancesListingsRequest)public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest request)
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeReservedInstancesModifications in interface AmazonEC2describeReservedInstancesModificationsRequest - Contains the parameters for DescribeReservedInstancesModifications.public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications()
AmazonEC2describeReservedInstancesModifications in interface AmazonEC2AmazonEC2.describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest)public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest request)
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeReservedInstancesOfferings in interface AmazonEC2describeReservedInstancesOfferingsRequest - Contains the parameters for DescribeReservedInstancesOfferings.public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings()
AmazonEC2describeReservedInstancesOfferings in interface AmazonEC2AmazonEC2.describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest)public DescribeRouteTablesResult describeRouteTables(DescribeRouteTablesRequest request)
Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.
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 VPC User Guide.
describeRouteTables in interface AmazonEC2describeRouteTablesRequest - public DescribeRouteTablesResult describeRouteTables()
AmazonEC2describeRouteTables in interface AmazonEC2AmazonEC2.describeRouteTables(DescribeRouteTablesRequest)public DescribeScheduledInstanceAvailabilityResult describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest request)
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
describeScheduledInstanceAvailability in interface AmazonEC2describeScheduledInstanceAvailabilityRequest - Contains the parameters for DescribeScheduledInstanceAvailability.public DescribeScheduledInstancesResult describeScheduledInstances(DescribeScheduledInstancesRequest request)
Describes the specified Scheduled Instances or all your Scheduled Instances.
describeScheduledInstances in interface AmazonEC2describeScheduledInstancesRequest - Contains the parameters for DescribeScheduledInstances.public DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest request)
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 AmazonEC2describeSecurityGroupReferencesRequest - public DescribeSecurityGroupRulesResult describeSecurityGroupRules(DescribeSecurityGroupRulesRequest request)
Describes one or more of your security group rules.
describeSecurityGroupRules in interface AmazonEC2describeSecurityGroupRulesRequest - public DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest request)
Describes the specified security groups or all of your security groups.
describeSecurityGroups in interface AmazonEC2describeSecurityGroupsRequest - public DescribeSecurityGroupsResult describeSecurityGroups()
AmazonEC2describeSecurityGroups in interface AmazonEC2AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest)public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest request)
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
describeSnapshotAttribute in interface AmazonEC2describeSnapshotAttributeRequest - public DescribeSnapshotTierStatusResult describeSnapshotTierStatus(DescribeSnapshotTierStatusRequest request)
Describes the storage tier status of one or more Amazon EBS snapshots.
describeSnapshotTierStatus in interface AmazonEC2describeSnapshotTierStatusRequest - public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
Describes 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 Amazon Web Services 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 Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services
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 Amazon Web Services 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. For more information, see Pagination.
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 EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
describeSnapshots in interface AmazonEC2describeSnapshotsRequest - public DescribeSnapshotsResult describeSnapshots()
AmazonEC2describeSnapshots in interface AmazonEC2AmazonEC2.describeSnapshots(DescribeSnapshotsRequest)public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest request)
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.
describeSpotDatafeedSubscription in interface AmazonEC2describeSpotDatafeedSubscriptionRequest - Contains the parameters for DescribeSpotDatafeedSubscription.public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription()
AmazonEC2describeSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest)public DescribeSpotFleetInstancesResult describeSpotFleetInstances(DescribeSpotFleetInstancesRequest request)
Describes the running instances for the specified Spot Fleet.
describeSpotFleetInstances in interface AmazonEC2describeSpotFleetInstancesRequest - Contains the parameters for DescribeSpotFleetInstances.public DescribeSpotFleetRequestHistoryResult describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest request)
Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
describeSpotFleetRequestHistory in interface AmazonEC2describeSpotFleetRequestHistoryRequest - Contains the parameters for DescribeSpotFleetRequestHistory.public DescribeSpotFleetRequestsResult describeSpotFleetRequests(DescribeSpotFleetRequestsRequest request)
Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
describeSpotFleetRequests in interface AmazonEC2describeSpotFleetRequestsRequest - Contains the parameters for DescribeSpotFleetRequests.public DescribeSpotFleetRequestsResult describeSpotFleetRequests()
AmazonEC2describeSpotFleetRequests in interface AmazonEC2AmazonEC2.describeSpotFleetRequests(DescribeSpotFleetRequestsRequest)public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest request)
Describes 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 items
returned. This paginates the output, which makes the list more manageable and returns the items faster. If the
list of items exceeds your MaxResults value, then that number of items is returned along with a
NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request
to retrieve the remaining items.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
describeSpotInstanceRequests in interface AmazonEC2describeSpotInstanceRequestsRequest - Contains the parameters for DescribeSpotInstanceRequests.public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests()
AmazonEC2describeSpotInstanceRequests in interface AmazonEC2AmazonEC2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest)public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest request)
Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
describeSpotPriceHistory in interface AmazonEC2describeSpotPriceHistoryRequest - Contains the parameters for DescribeSpotPriceHistory.public DescribeSpotPriceHistoryResult describeSpotPriceHistory()
AmazonEC2describeSpotPriceHistory in interface AmazonEC2AmazonEC2.describeSpotPriceHistory(DescribeSpotPriceHistoryRequest)public DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest request)
Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or peered VPC. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.
describeStaleSecurityGroups in interface AmazonEC2describeStaleSecurityGroupsRequest - public DescribeStoreImageTasksResult describeStoreImageTasks(DescribeStoreImageTasksRequest request)
Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or
Failed. For tasks InProgress, the response shows the estimated progress as a
percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
describeStoreImageTasks in interface AmazonEC2describeStoreImageTasksRequest - public DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest request)
Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.
For more information, see Subnets in the Amazon VPC User Guide.
describeSubnets in interface AmazonEC2describeSubnetsRequest - public DescribeSubnetsResult describeSubnets()
AmazonEC2describeSubnets in interface AmazonEC2AmazonEC2.describeSubnets(DescribeSubnetsRequest)public DescribeTagsResult describeTags(DescribeTagsRequest request)
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeTags in interface AmazonEC2describeTagsRequest - public DescribeTagsResult describeTags()
AmazonEC2describeTags in interface AmazonEC2AmazonEC2.describeTags(DescribeTagsRequest)public DescribeTrafficMirrorFilterRulesResult describeTrafficMirrorFilterRules(DescribeTrafficMirrorFilterRulesRequest request)
Describe traffic mirror filters that determine the traffic that is mirrored.
describeTrafficMirrorFilterRules in interface AmazonEC2describeTrafficMirrorFilterRulesRequest - public DescribeTrafficMirrorFiltersResult describeTrafficMirrorFilters(DescribeTrafficMirrorFiltersRequest request)
Describes one or more Traffic Mirror filters.
describeTrafficMirrorFilters in interface AmazonEC2describeTrafficMirrorFiltersRequest - public DescribeTrafficMirrorSessionsResult describeTrafficMirrorSessions(DescribeTrafficMirrorSessionsRequest request)
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
describeTrafficMirrorSessions in interface AmazonEC2describeTrafficMirrorSessionsRequest - public DescribeTrafficMirrorTargetsResult describeTrafficMirrorTargets(DescribeTrafficMirrorTargetsRequest request)
Information about one or more Traffic Mirror targets.
describeTrafficMirrorTargets in interface AmazonEC2describeTrafficMirrorTargetsRequest - public DescribeTransitGatewayAttachmentsResult describeTransitGatewayAttachments(DescribeTransitGatewayAttachmentsRequest request)
Describes 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 AmazonEC2describeTransitGatewayAttachmentsRequest - public DescribeTransitGatewayConnectPeersResult describeTransitGatewayConnectPeers(DescribeTransitGatewayConnectPeersRequest request)
Describes one or more Connect peers.
describeTransitGatewayConnectPeers in interface AmazonEC2describeTransitGatewayConnectPeersRequest - public DescribeTransitGatewayConnectsResult describeTransitGatewayConnects(DescribeTransitGatewayConnectsRequest request)
Describes one or more Connect attachments.
describeTransitGatewayConnects in interface AmazonEC2describeTransitGatewayConnectsRequest - public DescribeTransitGatewayMulticastDomainsResult describeTransitGatewayMulticastDomains(DescribeTransitGatewayMulticastDomainsRequest request)
Describes one or more transit gateway multicast domains.
describeTransitGatewayMulticastDomains in interface AmazonEC2describeTransitGatewayMulticastDomainsRequest - public DescribeTransitGatewayPeeringAttachmentsResult describeTransitGatewayPeeringAttachments(DescribeTransitGatewayPeeringAttachmentsRequest request)
Describes your transit gateway peering attachments.
describeTransitGatewayPeeringAttachments in interface AmazonEC2describeTransitGatewayPeeringAttachmentsRequest - public DescribeTransitGatewayPolicyTablesResult describeTransitGatewayPolicyTables(DescribeTransitGatewayPolicyTablesRequest request)
Describes one or more transit gateway route policy tables.
describeTransitGatewayPolicyTables in interface AmazonEC2describeTransitGatewayPolicyTablesRequest - public DescribeTransitGatewayRouteTableAnnouncementsResult describeTransitGatewayRouteTableAnnouncements(DescribeTransitGatewayRouteTableAnnouncementsRequest request)
Describes one or more transit gateway route table advertisements.
describeTransitGatewayRouteTableAnnouncements in interface AmazonEC2describeTransitGatewayRouteTableAnnouncementsRequest - public DescribeTransitGatewayRouteTablesResult describeTransitGatewayRouteTables(DescribeTransitGatewayRouteTablesRequest request)
Describes 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 AmazonEC2describeTransitGatewayRouteTablesRequest - public DescribeTransitGatewayVpcAttachmentsResult describeTransitGatewayVpcAttachments(DescribeTransitGatewayVpcAttachmentsRequest request)
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
describeTransitGatewayVpcAttachments in interface AmazonEC2describeTransitGatewayVpcAttachmentsRequest - public DescribeTransitGatewaysResult describeTransitGateways(DescribeTransitGatewaysRequest request)
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
describeTransitGateways in interface AmazonEC2describeTransitGatewaysRequest - public DescribeTrunkInterfaceAssociationsResult describeTrunkInterfaceAssociations(DescribeTrunkInterfaceAssociationsRequest request)
Describes one or more network interface trunk associations.
describeTrunkInterfaceAssociations in interface AmazonEC2describeTrunkInterfaceAssociationsRequest - public DescribeVerifiedAccessEndpointsResult describeVerifiedAccessEndpoints(DescribeVerifiedAccessEndpointsRequest request)
Describes the specified Amazon Web Services Verified Access endpoints.
describeVerifiedAccessEndpoints in interface AmazonEC2describeVerifiedAccessEndpointsRequest - public DescribeVerifiedAccessGroupsResult describeVerifiedAccessGroups(DescribeVerifiedAccessGroupsRequest request)
Describes the specified Verified Access groups.
describeVerifiedAccessGroups in interface AmazonEC2describeVerifiedAccessGroupsRequest - public DescribeVerifiedAccessInstanceLoggingConfigurationsResult describeVerifiedAccessInstanceLoggingConfigurations(DescribeVerifiedAccessInstanceLoggingConfigurationsRequest request)
Describes the specified Amazon Web Services Verified Access instances.
describeVerifiedAccessInstanceLoggingConfigurations in interface AmazonEC2describeVerifiedAccessInstanceLoggingConfigurationsRequest - public DescribeVerifiedAccessInstancesResult describeVerifiedAccessInstances(DescribeVerifiedAccessInstancesRequest request)
Describes the specified Amazon Web Services Verified Access instances.
describeVerifiedAccessInstances in interface AmazonEC2describeVerifiedAccessInstancesRequest - public DescribeVerifiedAccessTrustProvidersResult describeVerifiedAccessTrustProviders(DescribeVerifiedAccessTrustProvidersRequest request)
Describes the specified Amazon Web Services Verified Access trust providers.
describeVerifiedAccessTrustProviders in interface AmazonEC2describeVerifiedAccessTrustProvidersRequest - public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest request)
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
describeVolumeAttribute in interface AmazonEC2describeVolumeAttributeRequest - public DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest request)
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok,
impaired , warning, or insufficient-data. If all checks pass, the overall
status of the volume is ok. If the check fails, the overall status is impaired. If the
status is insufficient-data, then the checks 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 Monitor the status of your
volumes in the Amazon EBS 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.)
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeVolumeStatus in interface AmazonEC2describeVolumeStatusRequest - public DescribeVolumeStatusResult describeVolumeStatus()
AmazonEC2describeVolumeStatus in interface AmazonEC2AmazonEC2.describeVolumeStatus(DescribeVolumeStatusRequest)public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
Describes 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. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
describeVolumes in interface AmazonEC2describeVolumesRequest - public DescribeVolumesResult describeVolumes()
AmazonEC2describeVolumes in interface AmazonEC2AmazonEC2.describeVolumes(DescribeVolumesRequest)public DescribeVolumesModificationsResult describeVolumesModifications(DescribeVolumesModificationsRequest request)
Describes the most recent volume modification request for the specified EBS volumes.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
describeVolumesModifications in interface AmazonEC2describeVolumesModificationsRequest - public DescribeVpcAttributeResult describeVpcAttribute(DescribeVpcAttributeRequest request)
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
describeVpcAttribute in interface AmazonEC2describeVpcAttributeRequest - public DescribeVpcClassicLinkResult describeVpcClassicLink(DescribeVpcClassicLinkRequest request)
This action is deprecated.
Describes the ClassicLink status of the specified VPCs.
describeVpcClassicLink in interface AmazonEC2describeVpcClassicLinkRequest - public DescribeVpcClassicLinkResult describeVpcClassicLink()
AmazonEC2describeVpcClassicLink in interface AmazonEC2AmazonEC2.describeVpcClassicLink(DescribeVpcClassicLinkRequest)public DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest request)
This action is deprecated.
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
describeVpcClassicLinkDnsSupport in interface AmazonEC2describeVpcClassicLinkDnsSupportRequest - public DescribeVpcEndpointConnectionNotificationsResult describeVpcEndpointConnectionNotifications(DescribeVpcEndpointConnectionNotificationsRequest request)
Describes the connection notifications for VPC endpoints and VPC endpoint services.
describeVpcEndpointConnectionNotifications in interface AmazonEC2describeVpcEndpointConnectionNotificationsRequest - public DescribeVpcEndpointConnectionsResult describeVpcEndpointConnections(DescribeVpcEndpointConnectionsRequest request)
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
describeVpcEndpointConnections in interface AmazonEC2describeVpcEndpointConnectionsRequest - public DescribeVpcEndpointServiceConfigurationsResult describeVpcEndpointServiceConfigurations(DescribeVpcEndpointServiceConfigurationsRequest request)
Describes the VPC endpoint service configurations in your account (your services).
describeVpcEndpointServiceConfigurations in interface AmazonEC2describeVpcEndpointServiceConfigurationsRequest - public DescribeVpcEndpointServicePermissionsResult describeVpcEndpointServicePermissions(DescribeVpcEndpointServicePermissionsRequest request)
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
describeVpcEndpointServicePermissions in interface AmazonEC2describeVpcEndpointServicePermissionsRequest - public DescribeVpcEndpointServicesResult describeVpcEndpointServices(DescribeVpcEndpointServicesRequest request)
Describes 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 AmazonEC2describeVpcEndpointServicesRequest - public DescribeVpcEndpointServicesResult describeVpcEndpointServices()
AmazonEC2describeVpcEndpointServices in interface AmazonEC2AmazonEC2.describeVpcEndpointServices(DescribeVpcEndpointServicesRequest)public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.
describeVpcEndpoints in interface AmazonEC2describeVpcEndpointsRequest - public DescribeVpcEndpointsResult describeVpcEndpoints()
AmazonEC2describeVpcEndpoints in interface AmazonEC2AmazonEC2.describeVpcEndpoints(DescribeVpcEndpointsRequest)public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest request)
Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
describeVpcPeeringConnections in interface AmazonEC2describeVpcPeeringConnectionsRequest - public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections()
AmazonEC2describeVpcPeeringConnections in interface AmazonEC2AmazonEC2.describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest)public DescribeVpcsResult describeVpcs(DescribeVpcsRequest request)
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.
describeVpcs in interface AmazonEC2describeVpcsRequest - public DescribeVpcsResult describeVpcs()
AmazonEC2describeVpcs in interface AmazonEC2AmazonEC2.describeVpcs(DescribeVpcsRequest)public DescribeVpnConnectionsResult describeVpnConnections(DescribeVpnConnectionsRequest request)
Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
describeVpnConnections in interface AmazonEC2describeVpnConnectionsRequest - Contains the parameters for DescribeVpnConnections.public DescribeVpnConnectionsResult describeVpnConnections()
AmazonEC2describeVpnConnections in interface AmazonEC2AmazonEC2.describeVpnConnections(DescribeVpnConnectionsRequest)public DescribeVpnGatewaysResult describeVpnGateways(DescribeVpnGatewaysRequest request)
Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
describeVpnGateways in interface AmazonEC2describeVpnGatewaysRequest - Contains the parameters for DescribeVpnGateways.public DescribeVpnGatewaysResult describeVpnGateways()
AmazonEC2describeVpnGateways in interface AmazonEC2AmazonEC2.describeVpnGateways(DescribeVpnGatewaysRequest)public DetachClassicLinkVpcResult detachClassicLinkVpc(DetachClassicLinkVpcRequest request)
This action is deprecated.
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
detachClassicLinkVpc in interface AmazonEC2detachClassicLinkVpcRequest - public DetachInternetGatewayResult detachInternetGateway(DetachInternetGatewayRequest request)
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
detachInternetGateway in interface AmazonEC2detachInternetGatewayRequest - public DetachNetworkInterfaceResult detachNetworkInterface(DetachNetworkInterfaceRequest request)
Detaches a network interface from an instance.
detachNetworkInterface in interface AmazonEC2detachNetworkInterfaceRequest - Contains the parameters for DetachNetworkInterface.public DetachVerifiedAccessTrustProviderResult detachVerifiedAccessTrustProvider(DetachVerifiedAccessTrustProviderRequest request)
Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.
detachVerifiedAccessTrustProvider in interface AmazonEC2detachVerifiedAccessTrustProviderRequest - public DetachVolumeResult detachVolume(DetachVolumeRequest request)
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 Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
You can't detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. Attempting to do this
results in the UnsupportedOperationException exception with the
Unable to detach volume attached to ECS tasks error message.
For more information, see Detach an Amazon EBS volume in the Amazon EBS User Guide.
detachVolume in interface AmazonEC2detachVolumeRequest - public DetachVpnGatewayResult detachVpnGateway(DetachVpnGatewayRequest request)
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or
attach a different VPC to the virtual private gateway.
detachVpnGateway in interface AmazonEC2detachVpnGatewayRequest - Contains the parameters for DetachVpnGateway.public DisableAddressTransferResult disableAddressTransfer(DisableAddressTransferRequest request)
Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
disableAddressTransfer in interface AmazonEC2disableAddressTransferRequest - public DisableAwsNetworkPerformanceMetricSubscriptionResult disableAwsNetworkPerformanceMetricSubscription(DisableAwsNetworkPerformanceMetricSubscriptionRequest request)
Disables Infrastructure Performance metric subscriptions.
disableAwsNetworkPerformanceMetricSubscription in interface AmazonEC2disableAwsNetworkPerformanceMetricSubscriptionRequest - public DisableEbsEncryptionByDefaultResult disableEbsEncryptionByDefault(DisableEbsEncryptionByDefaultRequest request)
Disables 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 EBS User Guide.
disableEbsEncryptionByDefault in interface AmazonEC2disableEbsEncryptionByDefaultRequest - public DisableFastLaunchResult disableFastLaunch(DisableFastLaunchRequest request)
Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.
You can only change these settings for Windows AMIs that you own or that have been shared with you.
disableFastLaunch in interface AmazonEC2disableFastLaunchRequest - public DisableFastSnapshotRestoresResult disableFastSnapshotRestores(DisableFastSnapshotRestoresRequest request)
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
disableFastSnapshotRestores in interface AmazonEC2disableFastSnapshotRestoresRequest - public DisableImageResult disableImage(DisableImageRequest request)
Sets the AMI state to disabled and removes all launch permissions from the AMI. A disabled AMI can't
be used for instance launches.
A disabled AMI can't be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.
A disabled AMI does not appear in DescribeImages API calls by default.
Only the AMI owner can disable an AMI.
You can re-enable a disabled AMI using EnableImage.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
disableImage in interface AmazonEC2disableImageRequest - public DisableImageBlockPublicAccessResult disableImageBlockPublicAccess(DisableImageBlockPublicAccessRequest request)
Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.
The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing. When the API has
completed the configuration, the response will be unblocked.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
disableImageBlockPublicAccess in interface AmazonEC2disableImageBlockPublicAccessRequest - public DisableImageDeprecationResult disableImageDeprecation(DisableImageDeprecationRequest request)
Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
disableImageDeprecation in interface AmazonEC2disableImageDeprecationRequest - public DisableImageDeregistrationProtectionResult disableImageDeregistrationProtection(DisableImageDeregistrationProtectionRequest request)
Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
disableImageDeregistrationProtection in interface AmazonEC2disableImageDeregistrationProtectionRequest - public DisableIpamOrganizationAdminAccountResult disableIpamOrganizationAdminAccount(DisableIpamOrganizationAdminAccountRequest request)
Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
disableIpamOrganizationAdminAccount in interface AmazonEC2disableIpamOrganizationAdminAccountRequest - public DisableSerialConsoleAccessResult disableSerialConsoleAccess(DisableSerialConsoleAccessRequest request)
Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
disableSerialConsoleAccess in interface AmazonEC2disableSerialConsoleAccessRequest - public DisableSnapshotBlockPublicAccessResult disableSnapshotBlockPublicAccess(DisableSnapshotBlockPublicAccessRequest request)
Disables the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region.
If block public access is enabled in block-all-sharing mode, and you disable block public access,
all snapshots that were previously publicly shared are no longer treated as private and they become publicly
accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide .
disableSnapshotBlockPublicAccess in interface AmazonEC2disableSnapshotBlockPublicAccessRequest - public DisableTransitGatewayRouteTablePropagationResult disableTransitGatewayRouteTablePropagation(DisableTransitGatewayRouteTablePropagationRequest request)
Disables the specified resource attachment from propagating routes to the specified propagation route table.
disableTransitGatewayRouteTablePropagation in interface AmazonEC2disableTransitGatewayRouteTablePropagationRequest - public DisableVgwRoutePropagationResult disableVgwRoutePropagation(DisableVgwRoutePropagationRequest request)
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
disableVgwRoutePropagation in interface AmazonEC2disableVgwRoutePropagationRequest - Contains the parameters for DisableVgwRoutePropagation.public DisableVpcClassicLinkResult disableVpcClassicLink(DisableVpcClassicLinkRequest request)
This action is deprecated.
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
disableVpcClassicLink in interface AmazonEC2disableVpcClassicLinkRequest - public DisableVpcClassicLinkDnsSupportResult disableVpcClassicLinkDnsSupport(DisableVpcClassicLinkDnsSupportRequest request)
This action is deprecated.
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked.
You must specify a VPC ID in the request.
disableVpcClassicLinkDnsSupport in interface AmazonEC2disableVpcClassicLinkDnsSupportRequest - public DisassociateAddressResult disassociateAddress(DisassociateAddressRequest request)
Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
disassociateAddress in interface AmazonEC2disassociateAddressRequest - public DisassociateClientVpnTargetNetworkResult disassociateClientVpnTargetNetwork(DisassociateClientVpnTargetNetworkRequest request)
Disassociates 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 AmazonEC2disassociateClientVpnTargetNetworkRequest - public DisassociateEnclaveCertificateIamRoleResult disassociateEnclaveCertificateIamRole(DisassociateEnclaveCertificateIamRoleRequest request)
Disassociates an IAM role from an 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 KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
disassociateEnclaveCertificateIamRole in interface AmazonEC2disassociateEnclaveCertificateIamRoleRequest - public DisassociateIamInstanceProfileResult disassociateIamInstanceProfile(DisassociateIamInstanceProfileRequest request)
Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
disassociateIamInstanceProfile in interface AmazonEC2disassociateIamInstanceProfileRequest - public DisassociateInstanceEventWindowResult disassociateInstanceEventWindow(DisassociateInstanceEventWindowRequest request)
Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
disassociateInstanceEventWindow in interface AmazonEC2disassociateInstanceEventWindowRequest - public DisassociateIpamByoasnResult disassociateIpamByoasn(DisassociateIpamByoasnRequest request)
Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
disassociateIpamByoasn in interface AmazonEC2disassociateIpamByoasnRequest - public DisassociateIpamResourceDiscoveryResult disassociateIpamResourceDiscovery(DisassociateIpamResourceDiscoveryRequest request)
Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
disassociateIpamResourceDiscovery in interface AmazonEC2disassociateIpamResourceDiscoveryRequest - public DisassociateNatGatewayAddressResult disassociateNatGatewayAddress(DisassociateNatGatewayAddressRequest request)
Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.
An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released.
disassociateNatGatewayAddress in interface AmazonEC2disassociateNatGatewayAddressRequest - public DisassociateRouteTableResult disassociateRouteTable(DisassociateRouteTableRequest request)
Disassociates 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 VPC User Guide.
disassociateRouteTable in interface AmazonEC2disassociateRouteTableRequest - public DisassociateSubnetCidrBlockResult disassociateSubnetCidrBlock(DisassociateSubnetCidrBlockRequest request)
Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
disassociateSubnetCidrBlock in interface AmazonEC2disassociateSubnetCidrBlockRequest - public DisassociateTransitGatewayMulticastDomainResult disassociateTransitGatewayMulticastDomain(DisassociateTransitGatewayMulticastDomainRequest request)
Disassociates the specified subnets from the transit gateway multicast domain.
disassociateTransitGatewayMulticastDomain in interface AmazonEC2disassociateTransitGatewayMulticastDomainRequest - public DisassociateTransitGatewayPolicyTableResult disassociateTransitGatewayPolicyTable(DisassociateTransitGatewayPolicyTableRequest request)
Removes the association between an an attachment and a policy table.
disassociateTransitGatewayPolicyTable in interface AmazonEC2disassociateTransitGatewayPolicyTableRequest - public DisassociateTransitGatewayRouteTableResult disassociateTransitGatewayRouteTable(DisassociateTransitGatewayRouteTableRequest request)
Disassociates a resource attachment from a transit gateway route table.
disassociateTransitGatewayRouteTable in interface AmazonEC2disassociateTransitGatewayRouteTableRequest - public DisassociateTrunkInterfaceResult disassociateTrunkInterface(DisassociateTrunkInterfaceRequest request)
Removes an association between a branch network interface with a trunk network interface.
disassociateTrunkInterface in interface AmazonEC2disassociateTrunkInterfaceRequest - public DisassociateVpcCidrBlockResult disassociateVpcCidrBlock(DisassociateVpcCidrBlockRequest request)
Disassociates 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 AmazonEC2disassociateVpcCidrBlockRequest - public EnableAddressTransferResult enableAddressTransfer(EnableAddressTransferRequest request)
Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
enableAddressTransfer in interface AmazonEC2enableAddressTransferRequest - public EnableAwsNetworkPerformanceMetricSubscriptionResult enableAwsNetworkPerformanceMetricSubscription(EnableAwsNetworkPerformanceMetricSubscriptionRequest request)
Enables Infrastructure Performance subscriptions.
enableAwsNetworkPerformanceMetricSubscription in interface AmazonEC2enableAwsNetworkPerformanceMetricSubscriptionRequest - public EnableEbsEncryptionByDefaultResult enableEbsEncryptionByDefault(EnableEbsEncryptionByDefaultRequest request)
Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
You can specify the default KMS key 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 AmazonEC2enableEbsEncryptionByDefaultRequest - public EnableFastLaunchResult enableFastLaunch(EnableFastLaunchRequest request)
When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
You can only change these settings for Windows AMIs that you own or that have been shared with you.
enableFastLaunch in interface AmazonEC2enableFastLaunchRequest - public EnableFastSnapshotRestoresResult enableFastSnapshotRestores(EnableFastSnapshotRestoresRequest request)
Enables 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 EBS User Guide.
enableFastSnapshotRestores in interface AmazonEC2enableFastSnapshotRestoresRequest - public EnableImageResult enableImage(EnableImageRequest request)
Re-enables a disabled AMI. The re-enabled AMI is marked as available and can be used for instance
launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and
Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once
the AMI is available, it can be shared with them again.
Only the AMI owner can re-enable a disabled AMI.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
enableImage in interface AmazonEC2enableImageRequest - public EnableImageBlockPublicAccessResult enableImageBlockPublicAccess(EnableImageBlockPublicAccessRequest request)
Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.
The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the
configuration, the response will be block-new-sharing.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
enableImageBlockPublicAccess in interface AmazonEC2enableImageBlockPublicAccessRequest - public EnableImageDeprecationResult enableImageDeprecation(EnableImageDeprecationRequest request)
Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
enableImageDeprecation in interface AmazonEC2enableImageDeprecationRequest - public EnableImageDeregistrationProtectionResult enableImageDeregistrationProtection(EnableImageDeregistrationProtectionRequest request)
Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
enableImageDeregistrationProtection in interface AmazonEC2enableImageDeregistrationProtectionRequest - public EnableIpamOrganizationAdminAccountResult enableIpamOrganizationAdminAccount(EnableIpamOrganizationAdminAccountRequest request)
Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
enableIpamOrganizationAdminAccount in interface AmazonEC2enableIpamOrganizationAdminAccountRequest - public EnableReachabilityAnalyzerOrganizationSharingResult enableReachabilityAnalyzerOrganizationSharing(EnableReachabilityAnalyzerOrganizationSharingRequest request)
Establishes a trust relationship between Reachability Analyzer and Organizations. This operation must be performed by the management account for the organization.
After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts.
enableReachabilityAnalyzerOrganizationSharing in interface AmazonEC2enableReachabilityAnalyzerOrganizationSharingRequest - public EnableSerialConsoleAccessResult enableSerialConsoleAccess(EnableSerialConsoleAccessRequest request)
Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
enableSerialConsoleAccess in interface AmazonEC2enableSerialConsoleAccessRequest - public EnableSnapshotBlockPublicAccessResult enableSnapshotBlockPublicAccess(EnableSnapshotBlockPublicAccessRequest request)
Enables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify.
If block public access is enabled in block-all-sharing mode, and you change the mode to
block-new-sharing, all snapshots that were previously publicly shared are no longer treated as
private and they become publicly accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
enableSnapshotBlockPublicAccess in interface AmazonEC2enableSnapshotBlockPublicAccessRequest - public EnableTransitGatewayRouteTablePropagationResult enableTransitGatewayRouteTablePropagation(EnableTransitGatewayRouteTablePropagationRequest request)
Enables the specified attachment to propagate routes to the specified propagation route table.
enableTransitGatewayRouteTablePropagation in interface AmazonEC2enableTransitGatewayRouteTablePropagationRequest - public EnableVgwRoutePropagationResult enableVgwRoutePropagation(EnableVgwRoutePropagationRequest request)
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
enableVgwRoutePropagation in interface AmazonEC2enableVgwRoutePropagationRequest - Contains the parameters for EnableVgwRoutePropagation.public EnableVolumeIOResult enableVolumeIO(EnableVolumeIORequest request)
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
enableVolumeIO in interface AmazonEC2enableVolumeIORequest - public EnableVpcClassicLinkResult enableVpcClassicLink(EnableVpcClassicLinkRequest request)
This action is deprecated.
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.
enableVpcClassicLink in interface AmazonEC2enableVpcClassicLinkRequest - public EnableVpcClassicLinkDnsSupportResult enableVpcClassicLinkDnsSupport(EnableVpcClassicLinkDnsSupportRequest request)
This action is deprecated.
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
You must specify a VPC ID in the request.
enableVpcClassicLinkDnsSupport in interface AmazonEC2enableVpcClassicLinkDnsSupportRequest - public ExportClientVpnClientCertificateRevocationListResult exportClientVpnClientCertificateRevocationList(ExportClientVpnClientCertificateRevocationListRequest request)
Downloads the client certificate revocation list for the specified Client VPN endpoint.
exportClientVpnClientCertificateRevocationList in interface AmazonEC2exportClientVpnClientCertificateRevocationListRequest - public ExportClientVpnClientConfigurationResult exportClientVpnClientConfiguration(ExportClientVpnClientConfigurationRequest request)
Downloads 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 AmazonEC2exportClientVpnClientConfigurationRequest - public ExportImageResult exportImage(ExportImageRequest request)
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
exportImage in interface AmazonEC2exportImageRequest - public ExportTransitGatewayRoutesResult exportTransitGatewayRoutes(ExportTransitGatewayRoutesRequest request)
Exports 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 the Amazon Web Services Transit Gateways Guide.
exportTransitGatewayRoutes in interface AmazonEC2exportTransitGatewayRoutesRequest - public GetAssociatedEnclaveCertificateIamRolesResult getAssociatedEnclaveCertificateIamRoles(GetAssociatedEnclaveCertificateIamRolesRequest request)
Returns the IAM roles that are associated with the specified ACM (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 KMS key that's used to encrypt the private key.
getAssociatedEnclaveCertificateIamRoles in interface AmazonEC2getAssociatedEnclaveCertificateIamRolesRequest - public GetAssociatedIpv6PoolCidrsResult getAssociatedIpv6PoolCidrs(GetAssociatedIpv6PoolCidrsRequest request)
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
getAssociatedIpv6PoolCidrs in interface AmazonEC2getAssociatedIpv6PoolCidrsRequest - public GetAwsNetworkPerformanceDataResult getAwsNetworkPerformanceData(GetAwsNetworkPerformanceDataRequest request)
Gets network performance data.
getAwsNetworkPerformanceData in interface AmazonEC2getAwsNetworkPerformanceDataRequest - public GetCapacityReservationUsageResult getCapacityReservationUsage(GetCapacityReservationUsageRequest request)
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services 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 AmazonEC2getCapacityReservationUsageRequest - public GetCoipPoolUsageResult getCoipPoolUsage(GetCoipPoolUsageRequest request)
Describes the allocations from the specified customer-owned address pool.
getCoipPoolUsage in interface AmazonEC2getCoipPoolUsageRequest - public GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest request)
Gets 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.
For more information, see Instance console output in the Amazon EC2 User Guide.
getConsoleOutput in interface AmazonEC2getConsoleOutputRequest - public GetConsoleScreenshotResult getConsoleScreenshot(GetConsoleScreenshotRequest request)
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
getConsoleScreenshot in interface AmazonEC2getConsoleScreenshotRequest - public GetDefaultCreditSpecificationResult getDefaultCreditSpecification(GetDefaultCreditSpecificationRequest request)
Describes 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 AmazonEC2getDefaultCreditSpecificationRequest - public GetEbsDefaultKmsKeyIdResult getEbsDefaultKmsKeyId(GetEbsDefaultKmsKeyIdRequest request)
Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
getEbsDefaultKmsKeyId in interface AmazonEC2getEbsDefaultKmsKeyIdRequest - public GetEbsEncryptionByDefaultResult getEbsEncryptionByDefault(GetEbsEncryptionByDefaultRequest request)
Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
getEbsEncryptionByDefault in interface AmazonEC2getEbsEncryptionByDefaultRequest - public GetFlowLogsIntegrationTemplateResult getFlowLogsIntegrationTemplate(GetFlowLogsIntegrationTemplateRequest request)
Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
GetFlowLogsIntegrationTemplate does not support integration between Amazon Web Services Transit
Gateway Flow Logs and Amazon Athena.
getFlowLogsIntegrationTemplate in interface AmazonEC2getFlowLogsIntegrationTemplateRequest - public GetGroupsForCapacityReservationResult getGroupsForCapacityReservation(GetGroupsForCapacityReservationRequest request)
Lists the resource groups to which a Capacity Reservation has been added.
getGroupsForCapacityReservation in interface AmazonEC2getGroupsForCapacityReservationRequest - public GetHostReservationPurchasePreviewResult getHostReservationPurchasePreview(GetHostReservationPurchasePreviewRequest request)
Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
getHostReservationPurchasePreview in interface AmazonEC2getHostReservationPurchasePreviewRequest - public GetImageBlockPublicAccessStateResult getImageBlockPublicAccessState(GetImageBlockPublicAccessStateRequest request)
Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
getImageBlockPublicAccessState in interface AmazonEC2getImageBlockPublicAccessStateRequest - public GetInstanceMetadataDefaultsResult getInstanceMetadataDefaults(GetInstanceMetadataDefaultsRequest request)
Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.
For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
getInstanceMetadataDefaults in interface AmazonEC2getInstanceMetadataDefaultsRequest - public GetInstanceTpmEkPubResult getInstanceTpmEkPub(GetInstanceTpmEkPubRequest request)
Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
getInstanceTpmEkPub in interface AmazonEC2getInstanceTpmEkPubRequest - public GetInstanceTypesFromInstanceRequirementsResult getInstanceTypesFromInstanceRequirements(GetInstanceTypesFromInstanceRequirementsRequest request)
Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
getInstanceTypesFromInstanceRequirements in interface AmazonEC2getInstanceTypesFromInstanceRequirementsRequest - public GetInstanceUefiDataResult getInstanceUefiData(GetInstanceUefiDataRequest request)
A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an
AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData
parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to
convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert
back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
getInstanceUefiData in interface AmazonEC2getInstanceUefiDataRequest - public GetIpamAddressHistoryResult getIpamAddressHistory(GetIpamAddressHistoryRequest request)
Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
getIpamAddressHistory in interface AmazonEC2getIpamAddressHistoryRequest - public GetIpamDiscoveredAccountsResult getIpamDiscoveredAccounts(GetIpamDiscoveredAccountsRequest request)
Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.
getIpamDiscoveredAccounts in interface AmazonEC2getIpamDiscoveredAccountsRequest - public GetIpamDiscoveredPublicAddressesResult getIpamDiscoveredPublicAddresses(GetIpamDiscoveredPublicAddressesRequest request)
Gets the public IP addresses that have been discovered by IPAM.
getIpamDiscoveredPublicAddresses in interface AmazonEC2getIpamDiscoveredPublicAddressesRequest - public GetIpamDiscoveredResourceCidrsResult getIpamDiscoveredResourceCidrs(GetIpamDiscoveredResourceCidrsRequest request)
Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.
getIpamDiscoveredResourceCidrs in interface AmazonEC2getIpamDiscoveredResourceCidrsRequest - public GetIpamPoolAllocationsResult getIpamPoolAllocations(GetIpamPoolAllocationsRequest request)
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
getIpamPoolAllocations in interface AmazonEC2getIpamPoolAllocationsRequest - public GetIpamPoolCidrsResult getIpamPoolCidrs(GetIpamPoolCidrsRequest request)
Get the CIDRs provisioned to an IPAM pool.
getIpamPoolCidrs in interface AmazonEC2getIpamPoolCidrsRequest - public GetIpamResourceCidrsResult getIpamResourceCidrs(GetIpamResourceCidrsRequest request)
Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
getIpamResourceCidrs in interface AmazonEC2getIpamResourceCidrsRequest - public GetLaunchTemplateDataResult getLaunchTemplateData(GetLaunchTemplateDataRequest request)
Retrieves 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, and DescribeInstanceAttribute. Or, you can allow
describe* depending on your instance requirements.
getLaunchTemplateData in interface AmazonEC2getLaunchTemplateDataRequest - public GetManagedPrefixListAssociationsResult getManagedPrefixListAssociations(GetManagedPrefixListAssociationsRequest request)
Gets information about the resources that are associated with the specified managed prefix list.
getManagedPrefixListAssociations in interface AmazonEC2getManagedPrefixListAssociationsRequest - public GetManagedPrefixListEntriesResult getManagedPrefixListEntries(GetManagedPrefixListEntriesRequest request)
Gets information about the entries for a specified managed prefix list.
getManagedPrefixListEntries in interface AmazonEC2getManagedPrefixListEntriesRequest - public GetNetworkInsightsAccessScopeAnalysisFindingsResult getNetworkInsightsAccessScopeAnalysisFindings(GetNetworkInsightsAccessScopeAnalysisFindingsRequest request)
Gets the findings for the specified Network Access Scope analysis.
getNetworkInsightsAccessScopeAnalysisFindings in interface AmazonEC2getNetworkInsightsAccessScopeAnalysisFindingsRequest - public GetNetworkInsightsAccessScopeContentResult getNetworkInsightsAccessScopeContent(GetNetworkInsightsAccessScopeContentRequest request)
Gets the content for the specified Network Access Scope.
getNetworkInsightsAccessScopeContent in interface AmazonEC2getNetworkInsightsAccessScopeContentRequest - public GetPasswordDataResult getPasswordData(GetPasswordDataRequest request)
Retrieves 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 AmazonEC2getPasswordDataRequest - public GetReservedInstancesExchangeQuoteResult getReservedInstancesExchangeQuote(GetReservedInstancesExchangeQuoteRequest request)
Returns 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 AmazonEC2getReservedInstancesExchangeQuoteRequest - Contains the parameters for GetReservedInstanceExchangeQuote.public GetSecurityGroupsForVpcResult getSecurityGroupsForVpc(GetSecurityGroupsForVpcRequest request)
Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.
getSecurityGroupsForVpc in interface AmazonEC2getSecurityGroupsForVpcRequest - public GetSerialConsoleAccessStatusResult getSerialConsoleAccessStatus(GetSerialConsoleAccessStatusRequest request)
Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
getSerialConsoleAccessStatus in interface AmazonEC2getSerialConsoleAccessStatusRequest - public GetSnapshotBlockPublicAccessStateResult getSnapshotBlockPublicAccessState(GetSnapshotBlockPublicAccessStateRequest request)
Gets the current state of block public access for snapshots setting for the account and Region.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
getSnapshotBlockPublicAccessState in interface AmazonEC2getSnapshotBlockPublicAccessStateRequest - public GetSpotPlacementScoresResult getSpotPlacementScores(GetSpotPlacementScoresRequest request)
Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and
letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the
instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
getSpotPlacementScores in interface AmazonEC2getSpotPlacementScoresRequest - public GetSubnetCidrReservationsResult getSubnetCidrReservations(GetSubnetCidrReservationsRequest request)
Gets information about the subnet CIDR reservations.
getSubnetCidrReservations in interface AmazonEC2getSubnetCidrReservationsRequest - public GetTransitGatewayAttachmentPropagationsResult getTransitGatewayAttachmentPropagations(GetTransitGatewayAttachmentPropagationsRequest request)
Lists the route tables to which the specified resource attachment propagates routes.
getTransitGatewayAttachmentPropagations in interface AmazonEC2getTransitGatewayAttachmentPropagationsRequest - public GetTransitGatewayMulticastDomainAssociationsResult getTransitGatewayMulticastDomainAssociations(GetTransitGatewayMulticastDomainAssociationsRequest request)
Gets information about the associations for the transit gateway multicast domain.
getTransitGatewayMulticastDomainAssociations in interface AmazonEC2getTransitGatewayMulticastDomainAssociationsRequest - public GetTransitGatewayPolicyTableAssociationsResult getTransitGatewayPolicyTableAssociations(GetTransitGatewayPolicyTableAssociationsRequest request)
Gets a list of the transit gateway policy table associations.
getTransitGatewayPolicyTableAssociations in interface AmazonEC2getTransitGatewayPolicyTableAssociationsRequest - public GetTransitGatewayPolicyTableEntriesResult getTransitGatewayPolicyTableEntries(GetTransitGatewayPolicyTableEntriesRequest request)
Returns a list of transit gateway policy table entries.
getTransitGatewayPolicyTableEntries in interface AmazonEC2getTransitGatewayPolicyTableEntriesRequest - public GetTransitGatewayPrefixListReferencesResult getTransitGatewayPrefixListReferences(GetTransitGatewayPrefixListReferencesRequest request)
Gets information about the prefix list references in a specified transit gateway route table.
getTransitGatewayPrefixListReferences in interface AmazonEC2getTransitGatewayPrefixListReferencesRequest - public GetTransitGatewayRouteTableAssociationsResult getTransitGatewayRouteTableAssociations(GetTransitGatewayRouteTableAssociationsRequest request)
Gets information about the associations for the specified transit gateway route table.
getTransitGatewayRouteTableAssociations in interface AmazonEC2getTransitGatewayRouteTableAssociationsRequest - public GetTransitGatewayRouteTablePropagationsResult getTransitGatewayRouteTablePropagations(GetTransitGatewayRouteTablePropagationsRequest request)
Gets information about the route table propagations for the specified transit gateway route table.
getTransitGatewayRouteTablePropagations in interface AmazonEC2getTransitGatewayRouteTablePropagationsRequest - public GetVerifiedAccessEndpointPolicyResult getVerifiedAccessEndpointPolicy(GetVerifiedAccessEndpointPolicyRequest request)
Get the Verified Access policy associated with the endpoint.
getVerifiedAccessEndpointPolicy in interface AmazonEC2getVerifiedAccessEndpointPolicyRequest - public GetVerifiedAccessGroupPolicyResult getVerifiedAccessGroupPolicy(GetVerifiedAccessGroupPolicyRequest request)
Shows the contents of the Verified Access policy associated with the group.
getVerifiedAccessGroupPolicy in interface AmazonEC2getVerifiedAccessGroupPolicyRequest - public GetVpnConnectionDeviceSampleConfigurationResult getVpnConnectionDeviceSampleConfiguration(GetVpnConnectionDeviceSampleConfigurationRequest request)
Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
getVpnConnectionDeviceSampleConfiguration in interface AmazonEC2getVpnConnectionDeviceSampleConfigurationRequest - public GetVpnConnectionDeviceTypesResult getVpnConnectionDeviceTypes(GetVpnConnectionDeviceTypesRequest request)
Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
getVpnConnectionDeviceTypes in interface AmazonEC2getVpnConnectionDeviceTypesRequest - public GetVpnTunnelReplacementStatusResult getVpnTunnelReplacementStatus(GetVpnTunnelReplacementStatusRequest request)
Get details of available tunnel endpoint maintenance.
getVpnTunnelReplacementStatus in interface AmazonEC2getVpnTunnelReplacementStatusRequest - public ImportClientVpnClientCertificateRevocationListResult importClientVpnClientCertificateRevocationList(ImportClientVpnClientCertificateRevocationListRequest request)
Uploads 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 AmazonEC2importClientVpnClientCertificateRevocationListRequest - public ImportImageResult importImage(ImportImageRequest request)
To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide .
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the
--license-type or --usage-operation parameter when you create a new VM Import task.
This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
importImage in interface AmazonEC2importImageRequest - public ImportImageResult importImage()
AmazonEC2importImage in interface AmazonEC2AmazonEC2.importImage(ImportImageRequest)public ImportInstanceResult importInstance(ImportInstanceRequest request)
We recommend that you use the ImportImage
API. For more information, see Importing a VM as an
image using VM Import/Export in the VM Import/Export User Guide.
Creates an import instance task using metadata from the specified disk image.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
For information about the import manifest referenced by this API action, see VM Import Manifest.
importInstance in interface AmazonEC2importInstanceRequest - public ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
importKeyPair in interface AmazonEC2importKeyPairRequest - public ImportSnapshotResult importSnapshot(ImportSnapshotRequest request)
Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
importSnapshot in interface AmazonEC2importSnapshotRequest - public ImportSnapshotResult importSnapshot()
AmazonEC2importSnapshot in interface AmazonEC2AmazonEC2.importSnapshot(ImportSnapshotRequest)public ImportVolumeResult importVolume(ImportVolumeRequest request)
Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
importVolume in interface AmazonEC2importVolumeRequest - public ListImagesInRecycleBinResult listImagesInRecycleBin(ListImagesInRecycleBinRequest request)
Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
listImagesInRecycleBin in interface AmazonEC2listImagesInRecycleBinRequest - public ListSnapshotsInRecycleBinResult listSnapshotsInRecycleBin(ListSnapshotsInRecycleBinRequest request)
Lists one or more snapshots that are currently in the Recycle Bin.
listSnapshotsInRecycleBin in interface AmazonEC2listSnapshotsInRecycleBinRequest - public LockSnapshotResult lockSnapshot(LockSnapshotRequest request)
Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted.
You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:
If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.
lockSnapshot in interface AmazonEC2lockSnapshotRequest - public ModifyAddressAttributeResult modifyAddressAttribute(ModifyAddressAttributeRequest request)
Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.
modifyAddressAttribute in interface AmazonEC2modifyAddressAttributeRequest - public ModifyAvailabilityZoneGroupResult modifyAvailabilityZoneGroup(ModifyAvailabilityZoneGroupRequest request)
Changes the opt-in status of the specified zone group for your account.
modifyAvailabilityZoneGroup in interface AmazonEC2modifyAvailabilityZoneGroupRequest - public ModifyCapacityReservationResult modifyCapacityReservation(ModifyCapacityReservationRequest request)
Modifies 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 AmazonEC2modifyCapacityReservationRequest - public ModifyCapacityReservationFleetResult modifyCapacityReservationFleet(ModifyCapacityReservationFleetRequest request)
Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
modifyCapacityReservationFleet in interface AmazonEC2modifyCapacityReservationFleetRequest - public ModifyClientVpnEndpointResult modifyClientVpnEndpoint(ModifyClientVpnEndpointRequest request)
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
modifyClientVpnEndpoint in interface AmazonEC2modifyClientVpnEndpointRequest - public ModifyDefaultCreditSpecificationResult modifyDefaultCreditSpecification(ModifyDefaultCreditSpecificationRequest request)
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services 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 Amazon Web Services
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 AmazonEC2modifyDefaultCreditSpecificationRequest - public ModifyEbsDefaultKmsKeyIdResult modifyEbsDefaultKmsKeyId(ModifyEbsDefaultKmsKeyIdRequest request)
Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key 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 EBS User Guide.
modifyEbsDefaultKmsKeyId in interface AmazonEC2modifyEbsDefaultKmsKeyIdRequest - public ModifyFleetResult modifyFleet(ModifyFleetRequest request)
Modifies 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 AmazonEC2modifyFleetRequest - public ModifyFpgaImageAttributeResult modifyFpgaImageAttribute(ModifyFpgaImageAttributeRequest request)
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
modifyFpgaImageAttribute in interface AmazonEC2modifyFpgaImageAttributeRequest - public ModifyHostsResult modifyHosts(ModifyHostsRequest request)
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 AmazonEC2modifyHostsRequest - public ModifyIdFormatResult modifyIdFormat(ModifyIdFormatRequest request)
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
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 Amazon Web Services 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 AmazonEC2modifyIdFormatRequest - public ModifyIdentityIdFormatResult modifyIdentityIdFormat(ModifyIdentityIdFormatRequest request)
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. 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 AmazonEC2modifyIdentityIdFormatRequest - public ModifyImageAttributeResult modifyImageAttribute(ModifyImageAttributeRequest request)
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use the Attribute parameter, or one of the following parameters:
Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services 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 AmazonEC2modifyImageAttributeRequest - Contains the parameters for ModifyImageAttribute.public ModifyInstanceAttributeResult modifyInstanceAttribute(ModifyInstanceAttributeRequest request)
Modifies 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 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 Modify a stopped instance in the Amazon EC2 User Guide.
modifyInstanceAttribute in interface AmazonEC2modifyInstanceAttributeRequest - public ModifyInstanceCapacityReservationAttributesResult modifyInstanceCapacityReservationAttributes(ModifyInstanceCapacityReservationAttributesRequest request)
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 AmazonEC2modifyInstanceCapacityReservationAttributesRequest - public ModifyInstanceCreditSpecificationResult modifyInstanceCreditSpecification(ModifyInstanceCreditSpecificationRequest request)
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 AmazonEC2modifyInstanceCreditSpecificationRequest - public ModifyInstanceEventStartTimeResult modifyInstanceEventStartTime(ModifyInstanceEventStartTimeRequest request)
Modifies the start time for a scheduled Amazon EC2 instance event.
modifyInstanceEventStartTime in interface AmazonEC2modifyInstanceEventStartTimeRequest - public ModifyInstanceEventWindowResult modifyInstanceEventWindow(ModifyInstanceEventWindowRequest request)
Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
modifyInstanceEventWindow in interface AmazonEC2modifyInstanceEventWindowRequest - public ModifyInstanceMaintenanceOptionsResult modifyInstanceMaintenanceOptions(ModifyInstanceMaintenanceOptionsRequest request)
Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
modifyInstanceMaintenanceOptions in interface AmazonEC2modifyInstanceMaintenanceOptionsRequest - public ModifyInstanceMetadataDefaultsResult modifyInstanceMetadataDefaults(ModifyInstanceMetadataDefaultsRequest request)
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level
setting is cleared with no-preference, then the instance launch considers the other instance
metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
modifyInstanceMetadataDefaults in interface AmazonEC2modifyInstanceMetadataDefaultsRequest - public ModifyInstanceMetadataOptionsResult modifyInstanceMetadataOptions(ModifyInstanceMetadataOptionsRequest request)
Modify 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 AmazonEC2modifyInstanceMetadataOptionsRequest - public ModifyInstancePlacementResult modifyInstancePlacement(ModifyInstancePlacementRequest request)
Modifies 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 started, 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.
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 AmazonEC2modifyInstancePlacementRequest - public ModifyIpamResult modifyIpam(ModifyIpamRequest request)
Modify the configurations of an IPAM.
modifyIpam in interface AmazonEC2modifyIpamRequest - public ModifyIpamPoolResult modifyIpamPool(ModifyIpamPoolRequest request)
Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
modifyIpamPool in interface AmazonEC2modifyIpamPoolRequest - public ModifyIpamResourceCidrResult modifyIpamResourceCidr(ModifyIpamResourceCidrRequest request)
Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
modifyIpamResourceCidr in interface AmazonEC2modifyIpamResourceCidrRequest - public ModifyIpamResourceDiscoveryResult modifyIpamResourceDiscovery(ModifyIpamResourceDiscoveryRequest request)
Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
modifyIpamResourceDiscovery in interface AmazonEC2modifyIpamResourceDiscoveryRequest - public ModifyIpamScopeResult modifyIpamScope(ModifyIpamScopeRequest request)
Modify an IPAM scope.
modifyIpamScope in interface AmazonEC2modifyIpamScopeRequest - public ModifyLaunchTemplateResult modifyLaunchTemplate(ModifyLaunchTemplateRequest request)
Modifies 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 AmazonEC2modifyLaunchTemplateRequest - public ModifyLocalGatewayRouteResult modifyLocalGatewayRoute(ModifyLocalGatewayRouteRequest request)
Modifies the specified local gateway route.
modifyLocalGatewayRoute in interface AmazonEC2modifyLocalGatewayRouteRequest - public ModifyManagedPrefixListResult modifyManagedPrefixList(ModifyManagedPrefixListRequest request)
Modifies 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 AmazonEC2modifyManagedPrefixListRequest - public ModifyNetworkInterfaceAttributeResult modifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest request)
Modifies 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 AmazonEC2modifyNetworkInterfaceAttributeRequest - Contains the parameters for ModifyNetworkInterfaceAttribute.public ModifyPrivateDnsNameOptionsResult modifyPrivateDnsNameOptions(ModifyPrivateDnsNameOptionsRequest request)
Modifies the options for instance hostnames for the specified instance.
modifyPrivateDnsNameOptions in interface AmazonEC2modifyPrivateDnsNameOptionsRequest - public ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest request)
Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.
modifyReservedInstances in interface AmazonEC2modifyReservedInstancesRequest - Contains the parameters for ModifyReservedInstances.public ModifySecurityGroupRulesResult modifySecurityGroupRules(ModifySecurityGroupRulesRequest request)
Modifies the rules of a security group.
modifySecurityGroupRules in interface AmazonEC2modifySecurityGroupRulesRequest - public ModifySnapshotAttributeResult modifySnapshotAttribute(ModifySnapshotAttributeRequest request)
Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services 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 Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
modifySnapshotAttribute in interface AmazonEC2modifySnapshotAttributeRequest - public ModifySnapshotTierResult modifySnapshotTier(ModifySnapshotTierRequest request)
Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.
modifySnapshotTier in interface AmazonEC2modifySnapshotTierRequest - public ModifySpotFleetRequestResult modifySpotFleetRequest(ModifySpotFleetRequestRequest request)
Modifies 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 AmazonEC2modifySpotFleetRequestRequest - Contains the parameters for ModifySpotFleetRequest.public ModifySubnetAttributeResult modifySubnetAttribute(ModifySubnetAttributeRequest request)
Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and
CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or
DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
modifySubnetAttribute in interface AmazonEC2modifySubnetAttributeRequest - public ModifyTrafficMirrorFilterNetworkServicesResult modifyTrafficMirrorFilterNetworkServices(ModifyTrafficMirrorFilterNetworkServicesRequest request)
Allows 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.
modifyTrafficMirrorFilterNetworkServices in interface AmazonEC2modifyTrafficMirrorFilterNetworkServicesRequest - public ModifyTrafficMirrorFilterRuleResult modifyTrafficMirrorFilterRule(ModifyTrafficMirrorFilterRuleRequest request)
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
modifyTrafficMirrorFilterRule in interface AmazonEC2modifyTrafficMirrorFilterRuleRequest - public ModifyTrafficMirrorSessionResult modifyTrafficMirrorSession(ModifyTrafficMirrorSessionRequest request)
Modifies a Traffic Mirror session.
modifyTrafficMirrorSession in interface AmazonEC2modifyTrafficMirrorSessionRequest - public ModifyTransitGatewayResult modifyTransitGateway(ModifyTransitGatewayRequest request)
Modifies 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 AmazonEC2modifyTransitGatewayRequest - public ModifyTransitGatewayPrefixListReferenceResult modifyTransitGatewayPrefixListReference(ModifyTransitGatewayPrefixListReferenceRequest request)
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
modifyTransitGatewayPrefixListReference in interface AmazonEC2modifyTransitGatewayPrefixListReferenceRequest - public ModifyTransitGatewayVpcAttachmentResult modifyTransitGatewayVpcAttachment(ModifyTransitGatewayVpcAttachmentRequest request)
Modifies the specified VPC attachment.
modifyTransitGatewayVpcAttachment in interface AmazonEC2modifyTransitGatewayVpcAttachmentRequest - public ModifyVerifiedAccessEndpointResult modifyVerifiedAccessEndpoint(ModifyVerifiedAccessEndpointRequest request)
Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
modifyVerifiedAccessEndpoint in interface AmazonEC2modifyVerifiedAccessEndpointRequest - public ModifyVerifiedAccessEndpointPolicyResult modifyVerifiedAccessEndpointPolicy(ModifyVerifiedAccessEndpointPolicyRequest request)
Modifies the specified Amazon Web Services Verified Access endpoint policy.
modifyVerifiedAccessEndpointPolicy in interface AmazonEC2modifyVerifiedAccessEndpointPolicyRequest - public ModifyVerifiedAccessGroupResult modifyVerifiedAccessGroup(ModifyVerifiedAccessGroupRequest request)
Modifies the specified Amazon Web Services Verified Access group configuration.
modifyVerifiedAccessGroup in interface AmazonEC2modifyVerifiedAccessGroupRequest - public ModifyVerifiedAccessGroupPolicyResult modifyVerifiedAccessGroupPolicy(ModifyVerifiedAccessGroupPolicyRequest request)
Modifies the specified Amazon Web Services Verified Access group policy.
modifyVerifiedAccessGroupPolicy in interface AmazonEC2modifyVerifiedAccessGroupPolicyRequest - public ModifyVerifiedAccessInstanceResult modifyVerifiedAccessInstance(ModifyVerifiedAccessInstanceRequest request)
Modifies the configuration of the specified Amazon Web Services Verified Access instance.
modifyVerifiedAccessInstance in interface AmazonEC2modifyVerifiedAccessInstanceRequest - public ModifyVerifiedAccessInstanceLoggingConfigurationResult modifyVerifiedAccessInstanceLoggingConfiguration(ModifyVerifiedAccessInstanceLoggingConfigurationRequest request)
Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
modifyVerifiedAccessInstanceLoggingConfiguration in interface AmazonEC2modifyVerifiedAccessInstanceLoggingConfigurationRequest - public ModifyVerifiedAccessTrustProviderResult modifyVerifiedAccessTrustProvider(ModifyVerifiedAccessTrustProviderRequest request)
Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
modifyVerifiedAccessTrustProvider in interface AmazonEC2modifyVerifiedAccessTrustProviderRequest - public ModifyVolumeResult modifyVolume(ModifyVolumeRequest request)
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes in the Amazon EBS User Guide.
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 more information, see Extend the file system.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the
in-use or available state before you can modify the same volume. This is sometimes
referred to as a cooldown period.
modifyVolume in interface AmazonEC2modifyVolumeRequest - public ModifyVolumeAttributeResult modifyVolumeAttribute(ModifyVolumeAttributeRequest request)
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
modifyVolumeAttribute in interface AmazonEC2modifyVolumeAttributeRequest - public ModifyVpcAttributeResult modifyVpcAttribute(ModifyVpcAttributeRequest request)
Modifies the specified attribute of the specified VPC.
modifyVpcAttribute in interface AmazonEC2modifyVpcAttributeRequest - public ModifyVpcEndpointResult modifyVpcEndpoint(ModifyVpcEndpointRequest request)
Modifies 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 the Amazon Web Services PrivateLink Guide.
modifyVpcEndpoint in interface AmazonEC2modifyVpcEndpointRequest - public ModifyVpcEndpointConnectionNotificationResult modifyVpcEndpointConnectionNotification(ModifyVpcEndpointConnectionNotificationRequest request)
Modifies 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 AmazonEC2modifyVpcEndpointConnectionNotificationRequest - public ModifyVpcEndpointServiceConfigurationResult modifyVpcEndpointServiceConfiguration(ModifyVpcEndpointServiceConfigurationRequest request)
Modifies 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.
modifyVpcEndpointServiceConfiguration in interface AmazonEC2modifyVpcEndpointServiceConfigurationRequest - public ModifyVpcEndpointServicePayerResponsibilityResult modifyVpcEndpointServicePayerResponsibility(ModifyVpcEndpointServicePayerResponsibilityRequest request)
Modifies the payer responsibility for your VPC endpoint service.
modifyVpcEndpointServicePayerResponsibility in interface AmazonEC2modifyVpcEndpointServicePayerResponsibilityRequest - public ModifyVpcEndpointServicePermissionsResult modifyVpcEndpointServicePermissions(ModifyVpcEndpointServicePermissionsRequest request)
Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) 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 AmazonEC2modifyVpcEndpointServicePermissionsRequest - public ModifyVpcPeeringConnectionOptionsResult modifyVpcPeeringConnectionOptions(ModifyVpcPeeringConnectionOptionsRequest request)
Modifies the VPC peering connection options on one side of a VPC peering connection.
If the peered VPCs are in the same Amazon Web Services 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 Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services 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 AmazonEC2modifyVpcPeeringConnectionOptionsRequest - public ModifyVpcTenancyResult modifyVpcTenancy(ModifyVpcTenancyRequest request)
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 EC2 User Guide.
modifyVpcTenancy in interface AmazonEC2modifyVpcTenancyRequest - public ModifyVpnConnectionResult modifyVpnConnection(ModifyVpnConnectionRequest request)
Modifies the customer gateway or the target gateway of an Amazon Web Services 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 Update VPC route tables in the Amazon Web Services 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 Amazon Web Services 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 VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
modifyVpnConnection in interface AmazonEC2modifyVpnConnectionRequest - public ModifyVpnConnectionOptionsResult modifyVpnConnectionOptions(ModifyVpnConnectionOptionsRequest request)
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services 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 AmazonEC2modifyVpnConnectionOptionsRequest - public ModifyVpnTunnelCertificateResult modifyVpnTunnelCertificate(ModifyVpnTunnelCertificateRequest request)
Modifies the VPN tunnel endpoint certificate.
modifyVpnTunnelCertificate in interface AmazonEC2modifyVpnTunnelCertificateRequest - public ModifyVpnTunnelOptionsResult modifyVpnTunnelOptions(ModifyVpnTunnelOptionsRequest request)
Modifies the options for a VPN tunnel in an Amazon Web Services 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 Amazon Web Services Site-to-Site VPN User Guide.
modifyVpnTunnelOptions in interface AmazonEC2modifyVpnTunnelOptionsRequest - public MonitorInstancesResult monitorInstances(MonitorInstancesRequest request)
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
monitorInstances in interface AmazonEC2monitorInstancesRequest - public MoveAddressToVpcResult moveAddressToVpc(MoveAddressToVpcRequest request)
This action is deprecated.
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
moveAddressToVpc in interface AmazonEC2moveAddressToVpcRequest - public MoveByoipCidrToIpamResult moveByoipCidrToIpam(MoveByoipCidrToIpamRequest request)
Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.
If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
moveByoipCidrToIpam in interface AmazonEC2moveByoipCidrToIpamRequest - public ProvisionByoipCidrResult provisionByoipCidr(ProvisionByoipCidrRequest request)
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services 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.
Amazon Web Services 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 EC2 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 AmazonEC2provisionByoipCidrRequest - public ProvisionIpamByoasnResult provisionIpamByoasn(ProvisionIpamByoasnRequest request)
Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
provisionIpamByoasn in interface AmazonEC2provisionIpamByoasnRequest - public ProvisionIpamPoolCidrResult provisionIpamPoolCidr(ProvisionIpamPoolCidrRequest request)
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
provisionIpamPoolCidr in interface AmazonEC2provisionIpamPoolCidrRequest - public ProvisionPublicIpv4PoolCidrResult provisionPublicIpv4PoolCidr(ProvisionPublicIpv4PoolCidrRequest request)
Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
provisionPublicIpv4PoolCidr in interface AmazonEC2provisionPublicIpv4PoolCidrRequest - public PurchaseCapacityBlockResult purchaseCapacityBlock(PurchaseCapacityBlockRequest request)
Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.
purchaseCapacityBlock in interface AmazonEC2purchaseCapacityBlockRequest - public PurchaseHostReservationResult purchaseHostReservation(PurchaseHostReservationRequest request)
Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
purchaseHostReservation in interface AmazonEC2purchaseHostReservationRequest - public PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest request)
Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
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 Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
purchaseReservedInstancesOffering in interface AmazonEC2purchaseReservedInstancesOfferingRequest - Contains the parameters for PurchaseReservedInstancesOffering.public PurchaseScheduledInstancesResult purchaseScheduledInstances(PurchaseScheduledInstancesRequest request)
You can no longer purchase Scheduled Instances.
Purchases 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 AmazonEC2purchaseScheduledInstancesRequest - Contains the parameters for PurchaseScheduledInstances.public RebootInstancesResult rebootInstances(RebootInstancesRequest request)
Requests 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 Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
rebootInstances in interface AmazonEC2rebootInstancesRequest - public RegisterImageResult registerImage(RegisterImageRequest request)
Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see Create your own AMI 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. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
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 Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services 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 Amazon 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 Understand AMI billing information in the Amazon EC2 User Guide.
registerImage in interface AmazonEC2registerImageRequest - Contains the parameters for RegisterImage.public RegisterInstanceEventNotificationAttributesResult registerInstanceEventNotificationAttributes(RegisterInstanceEventNotificationAttributesRequest request)
Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
registerInstanceEventNotificationAttributes in interface AmazonEC2registerInstanceEventNotificationAttributesRequest - public RegisterTransitGatewayMulticastGroupMembersResult registerTransitGatewayMulticastGroupMembers(RegisterTransitGatewayMulticastGroupMembersRequest request)
Registers 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 more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
registerTransitGatewayMulticastGroupMembers in interface AmazonEC2registerTransitGatewayMulticastGroupMembersRequest - public RegisterTransitGatewayMulticastGroupSourcesResult registerTransitGatewayMulticastGroupSources(RegisterTransitGatewayMulticastGroupSourcesRequest request)
Registers 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 more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
registerTransitGatewayMulticastGroupSources in interface AmazonEC2registerTransitGatewayMulticastGroupSourcesRequest - public RejectTransitGatewayMulticastDomainAssociationsResult rejectTransitGatewayMulticastDomainAssociations(RejectTransitGatewayMulticastDomainAssociationsRequest request)
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
rejectTransitGatewayMulticastDomainAssociations in interface AmazonEC2rejectTransitGatewayMulticastDomainAssociationsRequest - public RejectTransitGatewayPeeringAttachmentResult rejectTransitGatewayPeeringAttachment(RejectTransitGatewayPeeringAttachmentRequest request)
Rejects a transit gateway peering attachment request.
rejectTransitGatewayPeeringAttachment in interface AmazonEC2rejectTransitGatewayPeeringAttachmentRequest - public RejectTransitGatewayVpcAttachmentResult rejectTransitGatewayVpcAttachment(RejectTransitGatewayVpcAttachmentRequest request)
Rejects 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 AmazonEC2rejectTransitGatewayVpcAttachmentRequest - public RejectVpcEndpointConnectionsResult rejectVpcEndpointConnections(RejectVpcEndpointConnectionsRequest request)
Rejects VPC endpoint connection requests to your VPC endpoint service.
rejectVpcEndpointConnections in interface AmazonEC2rejectVpcEndpointConnectionsRequest - public RejectVpcPeeringConnectionResult rejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest request)
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 AmazonEC2rejectVpcPeeringConnectionRequest - public ReleaseAddressResult releaseAddress(ReleaseAddressRequest request)
Releases the specified Elastic IP address.
[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 Amazon Web Services account.
After you release an Elastic IP address, you might be able to recover it. For more information, see AllocateAddress.
releaseAddress in interface AmazonEC2releaseAddressRequest - public ReleaseHostsResult releaseHosts(ReleaseHostsRequest request)
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 AmazonEC2releaseHostsRequest - public ReleaseIpamPoolAllocationResult releaseIpamPoolAllocation(ReleaseIpamPoolAllocationRequest request)
Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.
All EC2 API actions follow an eventual consistency model.
releaseIpamPoolAllocation in interface AmazonEC2releaseIpamPoolAllocationRequest - public ReplaceIamInstanceProfileAssociationResult replaceIamInstanceProfileAssociation(ReplaceIamInstanceProfileAssociationRequest request)
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
replaceIamInstanceProfileAssociation in interface AmazonEC2replaceIamInstanceProfileAssociationRequest - public ReplaceNetworkAclAssociationResult replaceNetworkAclAssociation(ReplaceNetworkAclAssociationRequest request)
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
This is an idempotent operation.
replaceNetworkAclAssociation in interface AmazonEC2replaceNetworkAclAssociationRequest - public ReplaceNetworkAclEntryResult replaceNetworkAclEntry(ReplaceNetworkAclEntryRequest request)
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
replaceNetworkAclEntry in interface AmazonEC2replaceNetworkAclEntryRequest - public ReplaceRouteResult replaceRoute(ReplaceRouteRequest request)
Replaces an existing route within a route table in a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.
For more information, see Route tables in the Amazon VPC User Guide.
replaceRoute in interface AmazonEC2replaceRouteRequest - public ReplaceRouteTableAssociationResult replaceRouteTableAssociation(ReplaceRouteTableAssociationRequest request)
Changes 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 VPC 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 AmazonEC2replaceRouteTableAssociationRequest - public ReplaceTransitGatewayRouteResult replaceTransitGatewayRoute(ReplaceTransitGatewayRouteRequest request)
Replaces the specified route in the specified transit gateway route table.
replaceTransitGatewayRoute in interface AmazonEC2replaceTransitGatewayRouteRequest - public ReplaceVpnTunnelResult replaceVpnTunnel(ReplaceVpnTunnelRequest request)
Trigger replacement of specified VPN tunnel.
replaceVpnTunnel in interface AmazonEC2replaceVpnTunnelRequest - public ReportInstanceStatusResult reportInstanceStatus(ReportInstanceStatusRequest request)
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 AmazonEC2reportInstanceStatusRequest - public RequestSpotFleetResult requestSpotFleet(RequestSpotFleetRequest request)
Creates 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.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
requestSpotFleet in interface AmazonEC2requestSpotFleetRequest - Contains the parameters for RequestSpotFleet.public RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest request)
Creates a Spot Instance request.
For more information, see Work with Spot Instance in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
requestSpotInstances in interface AmazonEC2requestSpotInstancesRequest - Contains the parameters for RequestSpotInstances.public ResetAddressAttributeResult resetAddressAttribute(ResetAddressAttributeRequest request)
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.
resetAddressAttribute in interface AmazonEC2resetAddressAttributeRequest - public ResetEbsDefaultKmsKeyIdResult resetEbsDefaultKmsKeyId(ResetEbsDefaultKmsKeyIdRequest request)
Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
resetEbsDefaultKmsKeyId in interface AmazonEC2resetEbsDefaultKmsKeyIdRequest - public ResetFpgaImageAttributeResult resetFpgaImageAttribute(ResetFpgaImageAttributeRequest request)
Resets 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 AmazonEC2resetFpgaImageAttributeRequest - public ResetImageAttributeResult resetImageAttribute(ResetImageAttributeRequest request)
Resets an attribute of an AMI to its default value.
resetImageAttribute in interface AmazonEC2resetImageAttributeRequest - Contains the parameters for ResetImageAttribute.public ResetInstanceAttributeResult resetInstanceAttribute(ResetInstanceAttributeRequest request)
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 AmazonEC2resetInstanceAttributeRequest - public ResetNetworkInterfaceAttributeResult resetNetworkInterfaceAttribute(ResetNetworkInterfaceAttributeRequest request)
Resets a network interface attribute. You can specify only one attribute at a time.
resetNetworkInterfaceAttribute in interface AmazonEC2resetNetworkInterfaceAttributeRequest - Contains the parameters for ResetNetworkInterfaceAttribute.public ResetSnapshotAttributeResult resetSnapshotAttribute(ResetSnapshotAttributeRequest request)
Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
resetSnapshotAttribute in interface AmazonEC2resetSnapshotAttributeRequest - public RestoreAddressToClassicResult restoreAddressToClassic(RestoreAddressToClassicRequest request)
This action is deprecated.
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
restoreAddressToClassic in interface AmazonEC2restoreAddressToClassicRequest - public RestoreImageFromRecycleBinResult restoreImageFromRecycleBin(RestoreImageFromRecycleBinRequest request)
Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
restoreImageFromRecycleBin in interface AmazonEC2restoreImageFromRecycleBinRequest - public RestoreManagedPrefixListVersionResult restoreManagedPrefixListVersion(RestoreManagedPrefixListVersionRequest request)
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
restoreManagedPrefixListVersion in interface AmazonEC2restoreManagedPrefixListVersionRequest - public RestoreSnapshotFromRecycleBinResult restoreSnapshotFromRecycleBin(RestoreSnapshotFromRecycleBinRequest request)
Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon EBS User Guide.
restoreSnapshotFromRecycleBin in interface AmazonEC2restoreSnapshotFromRecycleBinRequest - public RestoreSnapshotTierResult restoreSnapshotTier(RestoreSnapshotTierRequest request)
Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.
restoreSnapshotTier in interface AmazonEC2restoreSnapshotTierRequest - public RevokeClientVpnIngressResult revokeClientVpnIngress(RevokeClientVpnIngressRequest request)
Removes an ingress authorization rule from a Client VPN endpoint.
revokeClientVpnIngress in interface AmazonEC2revokeClientVpnIngressRequest - public RevokeSecurityGroupEgressResult revokeSecurityGroupEgress(RevokeSecurityGroupEgressRequest request)
Removes the specified outbound (egress) rules from the specified security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). 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 need to specify the description to revoke the rule.
For a 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.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
revokeSecurityGroupEgress in interface AmazonEC2revokeSecurityGroupEgressRequest - public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest request)
Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). 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 need to specify the description to revoke the rule.
For a 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.
For a non-default VPC, if the values you specify do not match the existing rule's values, an
InvalidPermission.NotFound client error is returned, and no rules are revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
revokeSecurityGroupIngress in interface AmazonEC2revokeSecurityGroupIngressRequest - @Deprecated public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress()
AmazonEC2revokeSecurityGroupIngress in interface AmazonEC2AmazonEC2.revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest)public RunInstancesResult runInstances(RunInstancesRequest request)
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
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.
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 the VPC. 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.
RunInstances is subject to both request rate limiting and resource rate limiting. For more
information, see Request
throttling.
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 AmazonEC2runInstancesRequest - public RunScheduledInstancesResult runScheduledInstances(RunScheduledInstancesRequest request)
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes.
runScheduledInstances in interface AmazonEC2runScheduledInstancesRequest - Contains the parameters for RunScheduledInstances.public SearchLocalGatewayRoutesResult searchLocalGatewayRoutes(SearchLocalGatewayRoutesRequest request)
Searches for routes in the specified local gateway route table.
searchLocalGatewayRoutes in interface AmazonEC2searchLocalGatewayRoutesRequest - public SearchTransitGatewayMulticastGroupsResult searchTransitGatewayMulticastGroups(SearchTransitGatewayMulticastGroupsRequest request)
Searches one or more transit gateway multicast groups and returns the group membership information.
searchTransitGatewayMulticastGroups in interface AmazonEC2searchTransitGatewayMulticastGroupsRequest - public SearchTransitGatewayRoutesResult searchTransitGatewayRoutes(SearchTransitGatewayRoutesRequest request)
Searches for routes in the specified transit gateway route table.
searchTransitGatewayRoutes in interface AmazonEC2searchTransitGatewayRoutesRequest - public SendDiagnosticInterruptResult sendDiagnosticInterrupt(SendDiagnosticInterruptRequest request)
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). 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 (for advanced users) in the Amazon EC2 User Guide.
sendDiagnosticInterrupt in interface AmazonEC2sendDiagnosticInterruptRequest - public StartInstancesResult startInstances(StartInstancesRequest request)
Starts 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 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.
If you attempt to start a T3 instance with host tenancy and the unlimited CPU credit
option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts.
Before you start the instance, either change its CPU credit option to standard, or change its
tenancy to default or dedicated.
For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
startInstances in interface AmazonEC2startInstancesRequest - public StartNetworkInsightsAccessScopeAnalysisResult startNetworkInsightsAccessScopeAnalysis(StartNetworkInsightsAccessScopeAnalysisRequest request)
Starts analyzing the specified Network Access Scope.
startNetworkInsightsAccessScopeAnalysis in interface AmazonEC2startNetworkInsightsAccessScopeAnalysisRequest - public StartNetworkInsightsAnalysisResult startNetworkInsightsAnalysis(StartNetworkInsightsAnalysisRequest request)
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
startNetworkInsightsAnalysis in interface AmazonEC2startNetworkInsightsAnalysisRequest - public StartVpcEndpointServicePrivateDnsVerificationResult startVpcEndpointServicePrivateDnsVerification(StartVpcEndpointServicePrivateDnsVerificationRequest request)
Initiates 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.
startVpcEndpointServicePrivateDnsVerification in interface AmazonEC2startVpcEndpointServicePrivateDnsVerificationRequest - public StopInstancesResult stopInstances(StopInstancesRequest request)
Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
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 Amazon EC2 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 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 Troubleshoot stopping your instance in the Amazon EC2 User Guide.
stopInstances in interface AmazonEC2stopInstancesRequest - public TerminateClientVpnConnectionsResult terminateClientVpnConnections(TerminateClientVpnConnectionsRequest request)
Terminates 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 AmazonEC2terminateClientVpnConnectionsRequest - public TerminateInstancesResult terminateInstances(TerminateInstancesRequest request)
Shuts 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.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in
us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in
us-east-1b (Instance C) is enabled for termination protection.
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 AmazonEC2terminateInstancesRequest - public UnassignIpv6AddressesResult unassignIpv6Addresses(UnassignIpv6AddressesRequest request)
Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
unassignIpv6Addresses in interface AmazonEC2unassignIpv6AddressesRequest - public UnassignPrivateIpAddressesResult unassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest request)
Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.
unassignPrivateIpAddresses in interface AmazonEC2unassignPrivateIpAddressesRequest - Contains the parameters for UnassignPrivateIpAddresses.public UnassignPrivateNatGatewayAddressResult unassignPrivateNatGatewayAddress(UnassignPrivateNatGatewayAddressRequest request)
Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
unassignPrivateNatGatewayAddress in interface AmazonEC2unassignPrivateNatGatewayAddressRequest - public UnlockSnapshotResult unlockSnapshot(UnlockSnapshotRequest request)
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.
unlockSnapshot in interface AmazonEC2unlockSnapshotRequest - public UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest request)
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
unmonitorInstances in interface AmazonEC2unmonitorInstancesRequest - public UpdateSecurityGroupRuleDescriptionsEgressResult updateSecurityGroupRuleDescriptionsEgress(UpdateSecurityGroupRuleDescriptionsEgressRequest request)
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 can remove a description for a security group rule by omitting the description parameter in the request.
updateSecurityGroupRuleDescriptionsEgress in interface AmazonEC2updateSecurityGroupRuleDescriptionsEgressRequest - public UpdateSecurityGroupRuleDescriptionsIngressResult updateSecurityGroupRuleDescriptionsIngress(UpdateSecurityGroupRuleDescriptionsIngressRequest request)
Updates 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 can remove a description for a security group rule by omitting the description parameter in the request.
updateSecurityGroupRuleDescriptionsIngress in interface AmazonEC2updateSecurityGroupRuleDescriptionsIngressRequest - public WithdrawByoipCidrResult withdrawByoipCidr(WithdrawByoipCidrRequest request)
Stops 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 Amazon Web Services because of BGP propagation delays.
withdrawByoipCidr in interface AmazonEC2withdrawByoipCidrRequest - public <X extends AmazonWebServiceRequest> DryRunResult<X> dryRun(DryRunSupportedRequest<X> request) throws AmazonServiceException, AmazonClientException
dryRun in interface AmazonEC2request - The request object for any Amazon EC2 operation supported with dry-run.AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle
the response. Or if the service response does not clearly indicate whether you have the permission.AmazonServiceException - If an error response is returned by Amazon EC2 indicating either a problem with the data in the request,
or a server side issue.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonEC2request - The originally executed requestpublic AmazonEC2Waiters waiters()
public void shutdown()
AmazonEC2shutdown in interface AmazonEC2shutdown in class AmazonWebServiceClientCopyright © 2024. All rights reserved.