AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AcceptReservedInstancesExchangeQuoteRequest

Container for the parameters to the AcceptReservedInstancesExchangeQuote operation. Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

Class AcceptReservedInstancesExchangeQuoteResponse

The result of the exchange and whether it was successful.

Class AcceptTransitGatewayMulticastDomainAssociationsRequest

Container for the parameters to the AcceptTransitGatewayMulticastDomainAssociations operation. Accepts a request to associate subnets with a transit gateway multicast domain.

Class AcceptTransitGatewayMulticastDomainAssociationsResponse

This is the response object from the AcceptTransitGatewayMulticastDomainAssociations operation.

Class AcceptTransitGatewayPeeringAttachmentRequest

Container for the parameters to the AcceptTransitGatewayPeeringAttachment operation. Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.

Class AcceptTransitGatewayPeeringAttachmentResponse

This is the response object from the AcceptTransitGatewayPeeringAttachment operation.

Class AcceptTransitGatewayVpcAttachmentRequest

Container for the parameters to the AcceptTransitGatewayVpcAttachment operation. 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.

Class AcceptTransitGatewayVpcAttachmentResponse

This is the response object from the AcceptTransitGatewayVpcAttachment operation.

Class AcceptVpcEndpointConnectionsRequest

Container for the parameters to the AcceptVpcEndpointConnections operation. Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

Class AcceptVpcEndpointConnectionsResponse

This is the response object from the AcceptVpcEndpointConnections operation.

Class AcceptVpcPeeringConnectionRequest

Container for the parameters to the AcceptVpcPeeringConnection operation. 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.

Class AcceptVpcPeeringConnectionResponse

This is the response object from the AcceptVpcPeeringConnection operation.

Class AccountAttribute

Describes an account attribute.

Class AccountAttributeValue

Describes a value of an account attribute.

Class ActiveInstance

Describes a running instance in a Spot Fleet.

Class AddPrefixListEntry

An entry for a prefix list.

Class Address

Describes an Elastic IP address, or a carrier IP address.

Class AddressAttribute

The attributes associated with an Elastic IP address.

Class AdvertiseByoipCidrRequest

Container for the parameters to the AdvertiseByoipCidr operation. 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.

Class AdvertiseByoipCidrResponse

This is the response object from the AdvertiseByoipCidr operation.

Class AllocateAddressRequest

Container for the parameters to the AllocateAddress operation. 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 Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

Class AllocateAddressResponse

This is the response object from the AllocateAddress operation.

Class AllocateHostsRequest

Container for the parameters to the AllocateHosts operation. 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.

Class AllocateHostsResponse

Contains the output of AllocateHosts.

Class AllowedPrincipal

Describes a principal.

Class AlternatePathHint

Describes an potential intermediate component of a feasible path.

Class AnalysisAclRule

Describes a network access control (ACL) rule.

Class AnalysisComponent

Describes a path component.

Class AnalysisLoadBalancerListener

Describes a load balancer listener.

Class AnalysisLoadBalancerTarget

Describes a load balancer target.

Class AnalysisPacketHeader

Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.

Class AnalysisRouteTableRoute

Describes a route table route.

Class AnalysisSecurityGroupRule

Describes a security group rule.

Class ApplySecurityGroupsToClientVpnTargetNetworkRequest

Container for the parameters to the ApplySecurityGroupsToClientVpnTargetNetwork operation. 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.

Class ApplySecurityGroupsToClientVpnTargetNetworkResponse

This is the response object from the ApplySecurityGroupsToClientVpnTargetNetwork operation.

Class AssignedPrivateIpAddress

Describes the private IP addresses assigned to a network interface.

Class AssignIpv6AddressesRequest

Container for the parameters to the AssignIpv6Addresses operation. Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

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 Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

Class AssignIpv6AddressesResponse

This is the response object from the AssignIpv6Addresses operation.

Class AssignPrivateIpAddressesRequest

Container for the parameters to the AssignPrivateIpAddresses operation. Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

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 Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

Class AssignPrivateIpAddressesResponse

This is the response object from the AssignPrivateIpAddresses operation.

Class AssociateAddressRequest

Container for the parameters to the AssociateAddress operation. 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.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

Class AssociateAddressResponse

This is the response object from the AssociateAddress operation.

Class AssociateClientVpnTargetNetworkRequest

Container for the parameters to the AssociateClientVpnTargetNetwork operation. 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.

Class AssociateClientVpnTargetNetworkResponse

This is the response object from the AssociateClientVpnTargetNetwork operation.

Class AssociateDhcpOptionsRequest

Container for the parameters to the AssociateDhcpOptions operation. Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

Class AssociateDhcpOptionsResponse

This is the response object from the AssociateDhcpOptions operation.

Class AssociatedRole

Information about the associated IAM roles.

Class AssociatedTargetNetwork

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

Class AssociateEnclaveCertificateIamRoleRequest

Container for the parameters to the AssociateEnclaveCertificateIamRole operation. 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 bucket 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.

Class AssociateEnclaveCertificateIamRoleResponse

This is the response object from the AssociateEnclaveCertificateIamRole operation.

Class AssociateIamInstanceProfileRequest

Container for the parameters to the AssociateIamInstanceProfile operation. Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

Class AssociateIamInstanceProfileResponse

This is the response object from the AssociateIamInstanceProfile operation.

Class AssociateInstanceEventWindowRequest

Container for the parameters to the AssociateInstanceEventWindow operation. 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.

Class AssociateInstanceEventWindowResponse

This is the response object from the AssociateInstanceEventWindow operation.

Class AssociateRouteTableRequest

Container for the parameters to the AssociateRouteTable operation. 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 Virtual Private Cloud User Guide.

Class AssociateRouteTableResponse

This is the response object from the AssociateRouteTable operation.

Class AssociateSubnetCidrBlockRequest

Container for the parameters to the AssociateSubnetCidrBlock operation. Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

Class AssociateSubnetCidrBlockResponse

This is the response object from the AssociateSubnetCidrBlock operation.

Class AssociateTransitGatewayMulticastDomainRequest

Container for the parameters to the AssociateTransitGatewayMulticastDomain operation. 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.

Class AssociateTransitGatewayMulticastDomainResponse

This is the response object from the AssociateTransitGatewayMulticastDomain operation.

Class AssociateTransitGatewayRouteTableRequest

Container for the parameters to the AssociateTransitGatewayRouteTable operation. Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

Class AssociateTransitGatewayRouteTableResponse

This is the response object from the AssociateTransitGatewayRouteTable operation.

Class AssociateTrunkInterfaceRequest

Container for the parameters to the AssociateTrunkInterface operation.

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Associates a branch network interface with a trunk network interface.

Before you create the association, run the create-network-interface command and set --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.

Class AssociateTrunkInterfaceResponse

This is the response object from the AssociateTrunkInterface operation.

Class AssociateVpcCidrBlockRequest

Container for the parameters to the AssociateVpcCidrBlock operation. 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). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.

Class AssociateVpcCidrBlockResponse

This is the response object from the AssociateVpcCidrBlock operation.

Class AssociationStatus

Describes the state of a target network association.

Class AthenaIntegration

Describes integration options for Amazon Athena.

Class AttachClassicLinkVpcRequest

Container for the parameters to the AttachClassicLinkVpc operation. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

Class AttachClassicLinkVpcResponse

This is the response object from the AttachClassicLinkVpc operation.

Class AttachInternetGatewayRequest

Container for the parameters to the AttachInternetGateway operation. Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

Class AttachInternetGatewayResponse

This is the response object from the AttachInternetGateway operation.

Class AttachNetworkInterfaceRequest

Container for the parameters to the AttachNetworkInterface operation. Attaches a network interface to an instance.

Class AttachNetworkInterfaceResponse

Contains the output of AttachNetworkInterface.

Class AttachVolumeRequest

Container for the parameters to the AttachVolume operation. 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.

Class AttachVolumeResponse

Contains the response data from the AttachVolume operation.

Class AttachVpnGatewayRequest

Container for the parameters to the AttachVpnGateway operation. 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class AttachVpnGatewayResponse

Contains the output of AttachVpnGateway.

Class AuthorizationRule

Information about an authorization rule.

Class AuthorizeClientVpnIngressRequest

Container for the parameters to the AuthorizeClientVpnIngress operation. 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 AWS or on-premises networks.

Class AuthorizeClientVpnIngressResponse

This is the response object from the AuthorizeClientVpnIngress operation.

Class AuthorizeSecurityGroupEgressRequest

Container for the parameters to the AuthorizeSecurityGroupEgress operation. [VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For information about VPC security group quotas, see Amazon VPC quotas.

Class AuthorizeSecurityGroupEgressResponse

This is the response object from the AuthorizeSecurityGroupEgress operation.

Class AuthorizeSecurityGroupIngressRequest

Container for the parameters to the AuthorizeSecurityGroupIngress operation. Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group quotas, see Amazon VPC quotas.

Class AuthorizeSecurityGroupIngressResponse

This is the response object from the AuthorizeSecurityGroupIngress operation.

Class AvailabilityZone

Describes Availability Zones, Local Zones, and Wavelength Zones.

Class AvailabilityZoneMessage

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

Class AvailableCapacity

The capacity information for instances that can be launched onto the Dedicated Host.

Class BlockDeviceMapping

Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

Class BundleInstanceRequest

Container for the parameters to the BundleInstance operation. 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.

Class BundleInstanceResponse

Contains the output of BundleInstance.

Class BundleTask

Describes a bundle task.

Class BundleTaskError

Describes an error for BundleInstance.

Class ByoipCidr

Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

Class CancelBundleTaskRequest

Container for the parameters to the CancelBundleTask operation. Cancels a bundling operation for an instance store-backed Windows instance.

Class CancelBundleTaskResponse

Contains the output of CancelBundleTask.

Class CancelCapacityReservationRequest

Container for the parameters to the CancelCapacityReservation operation. 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.

Class CancelCapacityReservationResponse

This is the response object from the CancelCapacityReservation operation.

Class CancelConversionTaskRequest

Container for the parameters to the CancelConversionTask operation. 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.

Class CancelConversionTaskResponse

This is the response object from the CancelConversionTask operation.

Class CancelExportTaskRequest

Container for the parameters to the CancelExportTask operation. 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.

Class CancelExportTaskResponse

This is the response object from the CancelExportTask operation.

Class CancelImportTaskRequest

Container for the parameters to the CancelImportTask operation. Cancels an in-process import virtual machine or import snapshot task.

Class CancelImportTaskResponse

This is the response object from the CancelImportTask operation.

Class CancelledSpotInstanceRequest

Describes a request to cancel a Spot Instance.

Class CancelReservedInstancesListingRequest

Container for the parameters to the CancelReservedInstancesListing operation. Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

Class CancelReservedInstancesListingResponse

Contains the output of CancelReservedInstancesListing.

Class CancelSpotFleetRequestsError

Describes a Spot Fleet error.

Class CancelSpotFleetRequestsErrorItem

Describes a Spot Fleet request that was not successfully canceled.

Class CancelSpotFleetRequestsRequest

Container for the parameters to the CancelSpotFleetRequests operation. Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

Class CancelSpotFleetRequestsResponse

Contains the output of CancelSpotFleetRequests.

Class CancelSpotFleetRequestsSuccessItem

Describes a Spot Fleet request that was successfully canceled.

Class CancelSpotInstanceRequestsRequest

Container for the parameters to the CancelSpotInstanceRequests operation. Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Class CancelSpotInstanceRequestsResponse

Contains the output of CancelSpotInstanceRequests.

Class CapacityReservation

Describes a Capacity Reservation.

Class CapacityReservationGroup

Describes a resource group to which a Capacity Reservation has been added.

Class CapacityReservationOptions

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

This strategy can only be used if the EC2 Fleet is of type instant.

For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.

Class CapacityReservationOptionsRequest

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

This strategy can only be used if the EC2 Fleet is of type instant.

For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.

Class CapacityReservationSpecification

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

Class CapacityReservationSpecificationResponse

Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.

Class CapacityReservationTarget

Describes a target Capacity Reservation or Capacity Reservation group.

Class CapacityReservationTargetResponse

Describes a target Capacity Reservation or Capacity Reservation group.

Class CarrierGateway

Describes a carrier gateway.

Class CertificateAuthentication

Information about the client certificate used for authentication.

Class CertificateAuthenticationRequest

Information about the client certificate to be used for authentication.

Class CidrAuthorizationContext

Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.

Class CidrBlock

Describes an IPv4 CIDR block.

Class ClassicLinkDnsSupport

Describes the ClassicLink DNS support status of a VPC.

Class ClassicLinkInstance

Describes a linked EC2-Classic instance.

Class ClassicLoadBalancer

Describes a Classic Load Balancer.

Class ClassicLoadBalancersConfig

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.

Class ClientCertificateRevocationListStatus

Describes the state of a client certificate revocation list.

Class ClientConnectOptions

The options for managing connection authorization for new client connections.

Class ClientConnectResponseOptions

The options for managing connection authorization for new client connections.

Class ClientData

Describes the client-specific data.

Class ClientVpnAuthentication

Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide.

Class ClientVpnAuthenticationRequest

Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide.

Class ClientVpnAuthorizationRuleStatus

Describes the state of an authorization rule.

Class ClientVpnConnection

Describes a client connection.

Class ClientVpnConnectionStatus

Describes the status of a client connection.

Class ClientVpnEndpoint

Describes a Client VPN endpoint.

Class ClientVpnEndpointAttributeStatus

Describes the status of the Client VPN endpoint attribute.

Class ClientVpnEndpointStatus

Describes the state of a Client VPN endpoint.

Class ClientVpnRoute

Information about a Client VPN endpoint route.

Class ClientVpnRouteStatus

Describes the state of a Client VPN endpoint route.

Class CoipAddressUsage

Describes address usage for a customer-owned address pool.

Class CoipPool

Describes a customer-owned address pool.

Class ConfirmProductInstanceRequest

Container for the parameters to the ConfirmProductInstance operation. 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.

Class ConfirmProductInstanceResponse

This is the response object from the ConfirmProductInstance operation.

Class ConnectionLogOptions

Describes the client connection logging options for the Client VPN endpoint.

Class ConnectionLogResponseOptions

Information about the client connection logging options for a Client VPN endpoint.

Class ConnectionNotification

Describes a connection notification for a VPC endpoint or VPC endpoint service.

Class ConversionTask

Describes a conversion task.

Class CopyFpgaImageRequest

Container for the parameters to the CopyFpgaImage operation. Copies the specified Amazon FPGA Image (AFI) to the current Region.

Class CopyFpgaImageResponse

This is the response object from the CopyFpgaImage operation.

Class CopyImageRequest

Container for the parameters to the CopyImage operation. 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 Elastic Compute Cloud User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

Class CopyImageResponse

Contains the output of CopyImage.

Class CopySnapshotRequest

Container for the parameters to the CopySnapshot operation. 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 Key Management Service (KMS) 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 Elastic Compute Cloud User Guide.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

Class CopySnapshotResponse

This is the response object from the CopySnapshot operation.

Class CpuOptions

The CPU options for the instance.

Class CpuOptionsRequest

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

Class CreateCapacityReservationRequest

Container for the parameters to the CreateCapacityReservation operation. 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.

Class CreateCapacityReservationResponse

This is the response object from the CreateCapacityReservation operation.

Class CreateCarrierGatewayRequest

Container for the parameters to the CreateCarrierGateway operation. Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

Class CreateCarrierGatewayResponse

This is the response object from the CreateCarrierGateway operation.

Class CreateClientVpnEndpointRequest

Container for the parameters to the CreateClientVpnEndpoint operation. 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.

Class CreateClientVpnEndpointResponse

This is the response object from the CreateClientVpnEndpoint operation.

Class CreateClientVpnRouteRequest

Container for the parameters to the CreateClientVpnRoute operation. 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.

Class CreateClientVpnRouteResponse

This is the response object from the CreateClientVpnRoute operation.

Class CreateCustomerGatewayRequest

Container for the parameters to the CreateCustomerGateway operation. Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:

  • 7224 - reserved in the us-east-1 Region

  • 9059 - reserved in the eu-west-1 Region

  • 17943 - reserved in the ap-southeast-1 Region

  • 10124 - reserved in the ap-northeast-1 Region

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.

Class CreateCustomerGatewayResponse

Contains the output of CreateCustomerGateway.

Class CreateDefaultSubnetRequest

Container for the parameters to the CreateDefaultSubnet operation. Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.

Class CreateDefaultSubnetResponse

This is the response object from the CreateDefaultSubnet operation.

Class CreateDefaultVpcRequest

Container for the parameters to the CreateDefaultVpc operation. Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.

Class CreateDefaultVpcResponse

This is the response object from the CreateDefaultVpc operation.

Class CreateDhcpOptionsRequest

Container for the parameters to the CreateDhcpOptions operation. Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

Class CreateDhcpOptionsResponse

This is the response object from the CreateDhcpOptions operation.

Class CreateEgressOnlyInternetGatewayRequest

Container for the parameters to the CreateEgressOnlyInternetGateway operation. [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.

Class CreateEgressOnlyInternetGatewayResponse

This is the response object from the CreateEgressOnlyInternetGateway operation.

Class CreateFleetError

Describes the instances that could not be launched by the fleet.

Class CreateFleetInstance

Describes the instances that were launched by the fleet.

Class CreateFleetRequest

Container for the parameters to the CreateFleet operation. Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.

Class CreateFleetResponse

This is the response object from the CreateFleet operation.

Class CreateFlowLogsRequest

Container for the parameters to the CreateFlowLogs operation. 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 Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

Class CreateFlowLogsResponse

This is the response object from the CreateFlowLogs operation.

Class CreateFpgaImageRequest

Container for the parameters to the CreateFpgaImage operation. 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 AWS FPGA Hardware Development Kit.

Class CreateFpgaImageResponse

This is the response object from the CreateFpgaImage operation.

Class CreateImageRequest

Container for the parameters to the CreateImage operation. 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 Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

Class CreateImageResponse

This is the response object from the CreateImage operation.

Class CreateInstanceEventWindowRequest

Container for the parameters to the CreateInstanceEventWindow operation. 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.

Class CreateInstanceEventWindowResponse

This is the response object from the CreateInstanceEventWindow operation.

Class CreateInstanceExportTaskRequest

Container for the parameters to the CreateInstanceExportTask operation. Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

Class CreateInstanceExportTaskResponse

This is the response object from the CreateInstanceExportTask operation.

Class CreateInternetGatewayRequest

Container for the parameters to the CreateInternetGateway operation. Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

Class CreateInternetGatewayResponse

This is the response object from the CreateInternetGateway operation.

Class CreateKeyPairRequest

Container for the parameters to the CreateKeyPair operation. Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

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.

Class CreateKeyPairResponse

Contains the response data from the CreateKeyPair operation.

Class CreateLaunchTemplateRequest

Container for the parameters to the CreateLaunchTemplate operation. 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 Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.

Class CreateLaunchTemplateResponse

This is the response object from the CreateLaunchTemplate operation.

Class CreateLaunchTemplateVersionRequest

Container for the parameters to the CreateLaunchTemplateVersion operation. Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

Class CreateLaunchTemplateVersionResponse

This is the response object from the CreateLaunchTemplateVersion operation.

Class CreateLocalGatewayRouteRequest

Container for the parameters to the CreateLocalGatewayRoute operation. Creates a static route for the specified local gateway route table.

Class CreateLocalGatewayRouteResponse

This is the response object from the CreateLocalGatewayRoute operation.

Class CreateLocalGatewayRouteTableVpcAssociationRequest

Container for the parameters to the CreateLocalGatewayRouteTableVpcAssociation operation. Associates the specified VPC with the specified local gateway route table.

Class CreateLocalGatewayRouteTableVpcAssociationResponse

This is the response object from the CreateLocalGatewayRouteTableVpcAssociation operation.

Class CreateManagedPrefixListRequest

Container for the parameters to the CreateManagedPrefixList operation. 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.

Class CreateManagedPrefixListResponse

This is the response object from the CreateManagedPrefixList operation.

Class CreateNatGatewayRequest

Container for the parameters to the CreateNatGateway operation. 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 Virtual Private Cloud User Guide.

Class CreateNatGatewayResponse

This is the response object from the CreateNatGateway operation.

Class CreateNetworkAclEntryRequest

Container for the parameters to the CreateNetworkAclEntry operation. Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Class CreateNetworkAclEntryResponse

This is the response object from the CreateNetworkAclEntry operation.

Class CreateNetworkAclRequest

Container for the parameters to the CreateNetworkAcl operation. 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 Virtual Private Cloud User Guide.

Class CreateNetworkAclResponse

This is the response object from the CreateNetworkAcl operation.

Class CreateNetworkInsightsPathRequest

Container for the parameters to the CreateNetworkInsightsPath operation. 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 What is Reachability Analyzer.

Class CreateNetworkInsightsPathResponse

This is the response object from the CreateNetworkInsightsPath operation.

Class CreateNetworkInterfacePermissionRequest

Container for the parameters to the CreateNetworkInterfacePermission operation. 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.

Class CreateNetworkInterfacePermissionResponse

Contains the output of CreateNetworkInterfacePermission.

Class CreateNetworkInterfaceRequest

Container for the parameters to the CreateNetworkInterface operation. Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

Class CreateNetworkInterfaceResponse

Contains the output of CreateNetworkInterface.

Class CreatePlacementGroupRequest

Container for the parameters to the CreatePlacementGroup operation. 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.

Class CreatePlacementGroupResponse

This is the response object from the CreatePlacementGroup operation.

Class CreateReplaceRootVolumeTaskRequest

Container for the parameters to the CreateReplaceRootVolumeTask operation. Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

Class CreateReplaceRootVolumeTaskResponse

This is the response object from the CreateReplaceRootVolumeTask operation.

Class CreateReservedInstancesListingRequest

Container for the parameters to the CreateReservedInstancesListing operation. 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 Reserved Instance Marketplace in the Amazon EC2 User Guide.

Class CreateReservedInstancesListingResponse

Contains the output of CreateReservedInstancesListing.

Class CreateRestoreImageTaskRequest

Container for the parameters to the CreateRestoreImageTask operation. 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 Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

Class CreateRestoreImageTaskResponse

This is the response object from the CreateRestoreImageTask operation.

Class CreateRouteRequest

Container for the parameters to the CreateRoute operation. Creates a route in a route table within a VPC.

You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

Class CreateRouteResponse

This is the response object from the CreateRoute operation.

Class CreateRouteTableRequest

Container for the parameters to the CreateRouteTable operation. 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 Virtual Private Cloud User Guide.

Class CreateRouteTableResponse

This is the response object from the CreateRouteTable operation.

Class CreateSecurityGroupRequest

Container for the parameters to the CreateSecurityGroup operation. 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 have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

Class CreateSecurityGroupResponse

This is the response object from the CreateSecurityGroup operation.

Class CreateSnapshotRequest

Container for the parameters to the CreateSnapshot operation. 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.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

Class CreateSnapshotResponse

Contains the response data from the CreateSnapshot operation.

Class CreateSnapshotsRequest

Container for the parameters to the CreateSnapshots operation. 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. Boot volumes can be excluded by changing the parameters.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

Class CreateSnapshotsResponse

This is the response object from the CreateSnapshots operation.

Class CreateSpotDatafeedSubscriptionRequest

Container for the parameters to the CreateSpotDatafeedSubscription operation. 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 for Linux Instances.

Class CreateSpotDatafeedSubscriptionResponse

Contains the output of CreateSpotDatafeedSubscription.

Class CreateStoreImageTaskRequest

Container for the parameters to the CreateStoreImageTask operation. 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 Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

Class CreateStoreImageTaskResponse

This is the response object from the CreateStoreImageTask operation.

Class CreateSubnetCidrReservationRequest

Container for the parameters to the CreateSubnetCidrReservation operation. Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

Class CreateSubnetCidrReservationResponse

This is the response object from the CreateSubnetCidrReservation operation.

Class CreateSubnetRequest

Container for the parameters to the CreateSubnet operation. Creates a subnet in a specified VPC.

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

Class CreateSubnetResponse

This is the response object from the CreateSubnet operation.

Class CreateTagsRequest

Container for the parameters to the CreateTags operation. 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 Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

Class CreateTagsResponse

This is the response object from the CreateTags operation.

Class CreateTrafficMirrorFilterRequest

Container for the parameters to the CreateTrafficMirrorFilter operation. 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.

Class CreateTrafficMirrorFilterResponse

This is the response object from the CreateTrafficMirrorFilter operation.

Class CreateTrafficMirrorFilterRuleRequest

Container for the parameters to the CreateTrafficMirrorFilterRule operation. 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.

Class CreateTrafficMirrorFilterRuleResponse

This is the response object from the CreateTrafficMirrorFilterRule operation.

Class CreateTrafficMirrorSessionRequest

Container for the parameters to the CreateTrafficMirrorSession operation. 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.

Class CreateTrafficMirrorSessionResponse

This is the response object from the CreateTrafficMirrorSession operation.

Class CreateTrafficMirrorTargetRequest

Container for the parameters to the CreateTrafficMirrorTarget operation. 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, or a Network Load Balancer.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

Class CreateTrafficMirrorTargetResponse

This is the response object from the CreateTrafficMirrorTarget operation.

Class CreateTransitGatewayConnectPeerRequest

Container for the parameters to the CreateTransitGatewayConnectPeer operation. 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 Transit Gateways Guide.

Class CreateTransitGatewayConnectPeerResponse

This is the response object from the CreateTransitGatewayConnectPeer operation.

Class CreateTransitGatewayConnectRequest

Container for the parameters to the CreateTransitGatewayConnect operation. 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.

Class CreateTransitGatewayConnectRequestOptions

The options for a Connect attachment.

Class CreateTransitGatewayConnectResponse

This is the response object from the CreateTransitGatewayConnect operation.

Class CreateTransitGatewayMulticastDomainRequest

Container for the parameters to the CreateTransitGatewayMulticastDomain operation. 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.

Class CreateTransitGatewayMulticastDomainRequestOptions

The options for the transit gateway multicast domain.

Class CreateTransitGatewayMulticastDomainResponse

This is the response object from the CreateTransitGatewayMulticastDomain operation.

Class CreateTransitGatewayPeeringAttachmentRequest

Container for the parameters to the CreateTransitGatewayPeeringAttachment operation. Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

Class CreateTransitGatewayPeeringAttachmentResponse

This is the response object from the CreateTransitGatewayPeeringAttachment operation.

Class CreateTransitGatewayPrefixListReferenceRequest

Container for the parameters to the CreateTransitGatewayPrefixListReference operation. Creates a reference (route) to a prefix list in a specified transit gateway route table.

Class CreateTransitGatewayPrefixListReferenceResponse

This is the response object from the CreateTransitGatewayPrefixListReference operation.

Class CreateTransitGatewayRequest

Container for the parameters to the CreateTransitGateway operation. 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.

Class CreateTransitGatewayResponse

This is the response object from the CreateTransitGateway operation.

Class CreateTransitGatewayRouteRequest

Container for the parameters to the CreateTransitGatewayRoute operation. Creates a static route for the specified transit gateway route table.

Class CreateTransitGatewayRouteResponse

This is the response object from the CreateTransitGatewayRoute operation.

Class CreateTransitGatewayRouteTableRequest

Container for the parameters to the CreateTransitGatewayRouteTable operation. Creates a route table for the specified transit gateway.

Class CreateTransitGatewayRouteTableResponse

This is the response object from the CreateTransitGatewayRouteTable operation.

Class CreateTransitGatewayVpcAttachmentRequest

Container for the parameters to the CreateTransitGatewayVpcAttachment operation. 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.

Class CreateTransitGatewayVpcAttachmentRequestOptions

Describes the options for a VPC attachment.

Class CreateTransitGatewayVpcAttachmentResponse

This is the response object from the CreateTransitGatewayVpcAttachment operation.

Class CreateVolumePermission

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

Class CreateVolumePermissionModifications

Describes modifications to the list of create volume permissions for a volume.

Class CreateVolumeRequest

Container for the parameters to the CreateVolume operation. 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 Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

Class CreateVolumeResponse

Contains the response data from the CreateVolume operation.

Class CreateVpcEndpointConnectionNotificationRequest

Container for the parameters to the CreateVpcEndpointConnectionNotification operation. 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 Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

Class CreateVpcEndpointConnectionNotificationResponse

This is the response object from the CreateVpcEndpointConnectionNotification operation.

Class CreateVpcEndpointRequest

Container for the parameters to the CreateVpcEndpoint operation. Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint, which will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.

A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.

Use DescribeVpcEndpointServices to get a list of supported services.

Class CreateVpcEndpointResponse

Contains the output of CreateVpcEndpoint.

Class CreateVpcEndpointServiceConfigurationRequest

Container for the parameters to the CreateVpcEndpointServiceConfiguration operation. Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.

If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.

Class CreateVpcEndpointServiceConfigurationResponse

This is the response object from the CreateVpcEndpointServiceConfiguration operation.

Class CreateVpcPeeringConnectionRequest

Container for the parameters to the CreateVpcPeeringConnection operation. 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 limitations section in the VPC Peering Guide.

The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.

Class CreateVpcPeeringConnectionResponse

This is the response object from the CreateVpcPeeringConnection operation.

Class CreateVpcRequest

Container for the parameters to the CreateVpc operation. Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).

By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

Class CreateVpcResponse

This is the response object from the CreateVpc operation.

Class CreateVpnConnectionRequest

Container for the parameters to the CreateVpnConnection operation. Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class CreateVpnConnectionResponse

Contains the output of CreateVpnConnection.

Class CreateVpnConnectionRouteRequest

Container for the parameters to the CreateVpnConnectionRoute operation. 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class CreateVpnConnectionRouteResponse

This is the response object from the CreateVpnConnectionRoute operation.

Class CreateVpnGatewayRequest

Container for the parameters to the CreateVpnGateway operation. 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class CreateVpnGatewayResponse

Contains the output of CreateVpnGateway.

Class CreditSpecification

Describes the credit option for CPU usage of a T2, T3, or T3a instance.

Class CreditSpecificationRequest

The credit option for CPU usage of a T2, T3, or T3a instance.

Class CustomerGateway

Describes a customer gateway.

Class DeleteCarrierGatewayRequest

Container for the parameters to the DeleteCarrierGateway operation. 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.

Class DeleteCarrierGatewayResponse

This is the response object from the DeleteCarrierGateway operation.

Class DeleteClientVpnEndpointRequest

Container for the parameters to the DeleteClientVpnEndpoint operation. Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

Class DeleteClientVpnEndpointResponse

This is the response object from the DeleteClientVpnEndpoint operation.

Class DeleteClientVpnRouteRequest

Container for the parameters to the DeleteClientVpnRoute operation. 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.

Class DeleteClientVpnRouteResponse

This is the response object from the DeleteClientVpnRoute operation.

Class DeleteCustomerGatewayRequest

Container for the parameters to the DeleteCustomerGateway operation. Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

Class DeleteCustomerGatewayResponse

This is the response object from the DeleteCustomerGateway operation.

Class DeleteDhcpOptionsRequest

Container for the parameters to the DeleteDhcpOptions operation. 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.

Class DeleteDhcpOptionsResponse

This is the response object from the DeleteDhcpOptions operation.

Class DeleteEgressOnlyInternetGatewayRequest

Container for the parameters to the DeleteEgressOnlyInternetGateway operation. Deletes an egress-only internet gateway.

Class DeleteEgressOnlyInternetGatewayResponse

This is the response object from the DeleteEgressOnlyInternetGateway operation.

Class DeleteFleetError

Describes an EC2 Fleet error.

Class DeleteFleetErrorItem

Describes an EC2 Fleet that was not successfully deleted.

Class DeleteFleetsRequest
Class DeleteFleetsResponse

This is the response object from the DeleteFleets operation.

Class DeleteFleetSuccessItem

Describes an EC2 Fleet that was successfully deleted.

Class DeleteFlowLogsRequest

Container for the parameters to the DeleteFlowLogs operation. Deletes one or more flow logs.

Class DeleteFlowLogsResponse

This is the response object from the DeleteFlowLogs operation.

Class DeleteFpgaImageRequest

Container for the parameters to the DeleteFpgaImage operation. Deletes the specified Amazon FPGA Image (AFI).

Class DeleteFpgaImageResponse

This is the response object from the DeleteFpgaImage operation.

Class DeleteInstanceEventWindowRequest

Container for the parameters to the DeleteInstanceEventWindow operation. Deletes the specified event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Class DeleteInstanceEventWindowResponse

This is the response object from the DeleteInstanceEventWindow operation.

Class DeleteInternetGatewayRequest

Container for the parameters to the DeleteInternetGateway operation. Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

Class DeleteInternetGatewayResponse

This is the response object from the DeleteInternetGateway operation.

Class DeleteKeyPairRequest

Container for the parameters to the DeleteKeyPair operation. Deletes the specified key pair, by removing the public key from Amazon EC2.

Class DeleteKeyPairResponse

This is the response object from the DeleteKeyPair operation.

Class DeleteLaunchTemplateRequest

Container for the parameters to the DeleteLaunchTemplate operation. Deletes a launch template. Deleting a launch template deletes all of its versions.

Class DeleteLaunchTemplateResponse

This is the response object from the DeleteLaunchTemplate operation.

Class DeleteLaunchTemplateVersionsRequest

Container for the parameters to the DeleteLaunchTemplateVersions operation. Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.

Class DeleteLaunchTemplateVersionsResponse

This is the response object from the DeleteLaunchTemplateVersions operation.

Class DeleteLaunchTemplateVersionsResponseErrorItem

Describes a launch template version that could not be deleted.

Class DeleteLaunchTemplateVersionsResponseSuccessItem

Describes a launch template version that was successfully deleted.

Class DeleteLocalGatewayRouteRequest

Container for the parameters to the DeleteLocalGatewayRoute operation. Deletes the specified route from the specified local gateway route table.

Class DeleteLocalGatewayRouteResponse

This is the response object from the DeleteLocalGatewayRoute operation.

Class DeleteLocalGatewayRouteTableVpcAssociationRequest

Container for the parameters to the DeleteLocalGatewayRouteTableVpcAssociation operation. Deletes the specified association between a VPC and local gateway route table.

Class DeleteLocalGatewayRouteTableVpcAssociationResponse

This is the response object from the DeleteLocalGatewayRouteTableVpcAssociation operation.

Class DeleteManagedPrefixListRequest

Container for the parameters to the DeleteManagedPrefixList operation. Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

Class DeleteManagedPrefixListResponse

This is the response object from the DeleteManagedPrefixList operation.

Class DeleteNatGatewayRequest

Container for the parameters to the DeleteNatGateway operation. 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.

Class DeleteNatGatewayResponse

This is the response object from the DeleteNatGateway operation.

Class DeleteNetworkAclEntryRequest

Container for the parameters to the DeleteNetworkAclEntry operation. Deletes the specified ingress or egress entry (rule) from the specified network ACL.

Class DeleteNetworkAclEntryResponse

This is the response object from the DeleteNetworkAclEntry operation.

Class DeleteNetworkAclRequest

Container for the parameters to the DeleteNetworkAcl operation. 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.

Class DeleteNetworkAclResponse

This is the response object from the DeleteNetworkAcl operation.

Class DeleteNetworkInsightsAnalysisRequest

Container for the parameters to the DeleteNetworkInsightsAnalysis operation. Deletes the specified network insights analysis.

Class DeleteNetworkInsightsAnalysisResponse

This is the response object from the DeleteNetworkInsightsAnalysis operation.

Class DeleteNetworkInsightsPathRequest

Container for the parameters to the DeleteNetworkInsightsPath operation. Deletes the specified path.

Class DeleteNetworkInsightsPathResponse

This is the response object from the DeleteNetworkInsightsPath operation.

Class DeleteNetworkInterfacePermissionRequest

Container for the parameters to the DeleteNetworkInterfacePermission operation. 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.

Class DeleteNetworkInterfacePermissionResponse

Contains the output for DeleteNetworkInterfacePermission.

Class DeleteNetworkInterfaceRequest

Container for the parameters to the DeleteNetworkInterface operation. Deletes the specified network interface. You must detach the network interface before you can delete it.

Class DeleteNetworkInterfaceResponse

This is the response object from the DeleteNetworkInterface operation.

Class DeletePlacementGroupRequest

Container for the parameters to the DeletePlacementGroup operation. 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.

Class DeletePlacementGroupResponse

This is the response object from the DeletePlacementGroup operation.

Class DeleteQueuedReservedInstancesError

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

Class DeleteQueuedReservedInstancesRequest

Container for the parameters to the DeleteQueuedReservedInstances operation. Deletes the queued purchases for the specified Reserved Instances.

Class DeleteQueuedReservedInstancesResponse

This is the response object from the DeleteQueuedReservedInstances operation.

Class DeleteRouteRequest

Container for the parameters to the DeleteRoute operation. Deletes the specified route from the specified route table.

Class DeleteRouteResponse

This is the response object from the DeleteRoute operation.

Class DeleteRouteTableRequest

Container for the parameters to the DeleteRouteTable operation. 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.

Class DeleteRouteTableResponse

This is the response object from the DeleteRouteTable operation.

Class DeleteSecurityGroupRequest

Container for the parameters to the DeleteSecurityGroup operation. Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

Class DeleteSecurityGroupResponse

This is the response object from the DeleteSecurityGroup operation.

Class DeleteSnapshotRequest

Container for the parameters to the DeleteSnapshot operation. 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 Elastic Compute Cloud User Guide.

Class DeleteSnapshotResponse

This is the response object from the DeleteSnapshot operation.

Class DeleteSpotDatafeedSubscriptionRequest

Container for the parameters to the DeleteSpotDatafeedSubscription operation. Deletes the data feed for Spot Instances.

Class DeleteSpotDatafeedSubscriptionResponse

This is the response object from the DeleteSpotDatafeedSubscription operation.

Class DeleteSubnetCidrReservationRequest

Container for the parameters to the DeleteSubnetCidrReservation operation. Deletes a subnet CIDR reservation.

Class DeleteSubnetCidrReservationResponse

This is the response object from the DeleteSubnetCidrReservation operation.

Class DeleteSubnetRequest

Container for the parameters to the DeleteSubnet operation. Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

Class DeleteSubnetResponse

This is the response object from the DeleteSubnet operation.

Class DeleteTagsRequest

Container for the parameters to the DeleteTags operation. 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 Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Class DeleteTagsResponse

This is the response object from the DeleteTags operation.

Class DeleteTrafficMirrorFilterRequest

Container for the parameters to the DeleteTrafficMirrorFilter operation. Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

Class DeleteTrafficMirrorFilterResponse

This is the response object from the DeleteTrafficMirrorFilter operation.

Class DeleteTrafficMirrorFilterRuleRequest

Container for the parameters to the DeleteTrafficMirrorFilterRule operation. Deletes the specified Traffic Mirror rule.

Class DeleteTrafficMirrorFilterRuleResponse

This is the response object from the DeleteTrafficMirrorFilterRule operation.

Class DeleteTrafficMirrorSessionRequest

Container for the parameters to the DeleteTrafficMirrorSession operation. Deletes the specified Traffic Mirror session.

Class DeleteTrafficMirrorSessionResponse

This is the response object from the DeleteTrafficMirrorSession operation.

Class DeleteTrafficMirrorTargetRequest

Container for the parameters to the DeleteTrafficMirrorTarget operation. Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

Class DeleteTrafficMirrorTargetResponse

This is the response object from the DeleteTrafficMirrorTarget operation.

Class DeleteTransitGatewayConnectPeerRequest

Container for the parameters to the DeleteTransitGatewayConnectPeer operation. Deletes the specified Connect peer.

Class DeleteTransitGatewayConnectPeerResponse

This is the response object from the DeleteTransitGatewayConnectPeer operation.

Class DeleteTransitGatewayConnectRequest

Container for the parameters to the DeleteTransitGatewayConnect operation. Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

Class DeleteTransitGatewayConnectResponse

This is the response object from the DeleteTransitGatewayConnect operation.

Class DeleteTransitGatewayMulticastDomainRequest

Container for the parameters to the DeleteTransitGatewayMulticastDomain operation. Deletes the specified transit gateway multicast domain.

Class DeleteTransitGatewayMulticastDomainResponse

This is the response object from the DeleteTransitGatewayMulticastDomain operation.

Class DeleteTransitGatewayPeeringAttachmentRequest

Container for the parameters to the DeleteTransitGatewayPeeringAttachment operation. Deletes a transit gateway peering attachment.

Class DeleteTransitGatewayPeeringAttachmentResponse

This is the response object from the DeleteTransitGatewayPeeringAttachment operation.

Class DeleteTransitGatewayPrefixListReferenceRequest

Container for the parameters to the DeleteTransitGatewayPrefixListReference operation. Deletes a reference (route) to a prefix list in a specified transit gateway route table.

Class DeleteTransitGatewayPrefixListReferenceResponse

This is the response object from the DeleteTransitGatewayPrefixListReference operation.

Class DeleteTransitGatewayRequest

Container for the parameters to the DeleteTransitGateway operation. Deletes the specified transit gateway.

Class DeleteTransitGatewayResponse

This is the response object from the DeleteTransitGateway operation.

Class DeleteTransitGatewayRouteRequest

Container for the parameters to the DeleteTransitGatewayRoute operation. Deletes the specified route from the specified transit gateway route table.

Class DeleteTransitGatewayRouteResponse

This is the response object from the DeleteTransitGatewayRoute operation.

Class DeleteTransitGatewayRouteTableRequest

Container for the parameters to the DeleteTransitGatewayRouteTable operation. Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.

Class DeleteTransitGatewayRouteTableResponse

This is the response object from the DeleteTransitGatewayRouteTable operation.

Class DeleteTransitGatewayVpcAttachmentRequest

Container for the parameters to the DeleteTransitGatewayVpcAttachment operation. Deletes the specified VPC attachment.

Class DeleteTransitGatewayVpcAttachmentResponse

This is the response object from the DeleteTransitGatewayVpcAttachment operation.

Class DeleteVolumeRequest

Container for the parameters to the DeleteVolume operation. 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 Elastic Compute Cloud User Guide.

Class DeleteVolumeResponse

This is the response object from the DeleteVolume operation.

Class DeleteVpcEndpointConnectionNotificationsRequest

Container for the parameters to the DeleteVpcEndpointConnectionNotifications operation. Deletes one or more VPC endpoint connection notifications.

Class DeleteVpcEndpointConnectionNotificationsResponse

This is the response object from the DeleteVpcEndpointConnectionNotifications operation.

Class DeleteVpcEndpointServiceConfigurationsRequest

Container for the parameters to the DeleteVpcEndpointServiceConfigurations operation. Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

Class DeleteVpcEndpointServiceConfigurationsResponse

This is the response object from the DeleteVpcEndpointServiceConfigurations operation.

Class DeleteVpcEndpointsRequest

Container for the parameters to the DeleteVpcEndpoints operation. Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.

  • Gateway endpoint,

  • Gateway Load Balancer endpoint,

  • Interface endpoint

The following rules apply when you delete a VPC endpoint:

  • When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.

  • When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.

    You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

  • When you delete an interface endpoint, we delete the endpoint network interfaces.

Class DeleteVpcEndpointsResponse

Contains the output of DeleteVpcEndpoints.

Class DeleteVpcPeeringConnectionRequest

Container for the parameters to the DeleteVpcPeeringConnection operation. Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.

Class DeleteVpcPeeringConnectionResponse

Returns information about the DeleteVpcPeeringConnection response metadata. The DeleteVpcPeeringConnection operation has a void result type.

Class DeleteVpcRequest

Container for the parameters to the DeleteVpc operation. 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.

Class DeleteVpcResponse

This is the response object from the DeleteVpc operation.

Class DeleteVpnConnectionRequest

Container for the parameters to the DeleteVpnConnection operation. 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 AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.

Class DeleteVpnConnectionResponse

This is the response object from the DeleteVpnConnection operation.

Class DeleteVpnConnectionRouteRequest

Container for the parameters to the DeleteVpnConnectionRoute operation. 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.

Class DeleteVpnConnectionRouteResponse

This is the response object from the DeleteVpnConnectionRoute operation.

Class DeleteVpnGatewayRequest

Container for the parameters to the DeleteVpnGateway operation. 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.

Class DeleteVpnGatewayResponse

This is the response object from the DeleteVpnGateway operation.

Class DeprovisionByoipCidrRequest

Container for the parameters to the DeprovisionByoipCidr operation. 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.

Class DeprovisionByoipCidrResponse

This is the response object from the DeprovisionByoipCidr operation.

Class DeregisterImageRequest

Container for the parameters to the DeregisterImage operation. Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

Class DeregisterImageResponse

This is the response object from the DeregisterImage operation.

Class DeregisterInstanceEventNotificationAttributesRequest

Container for the parameters to the DeregisterInstanceEventNotificationAttributes operation. c

Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.

Class DeregisterInstanceEventNotificationAttributesResponse

This is the response object from the DeregisterInstanceEventNotificationAttributes operation.

Class DeregisterInstanceTagAttributeRequest

Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request

Class DeregisterTransitGatewayMulticastGroupMembersRequest

Container for the parameters to the DeregisterTransitGatewayMulticastGroupMembers operation. Deregisters the specified members (network interfaces) from the transit gateway multicast group.

Class DeregisterTransitGatewayMulticastGroupMembersResponse

This is the response object from the DeregisterTransitGatewayMulticastGroupMembers operation.

Class DeregisterTransitGatewayMulticastGroupSourcesRequest

Container for the parameters to the DeregisterTransitGatewayMulticastGroupSources operation. Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

Class DeregisterTransitGatewayMulticastGroupSourcesResponse

This is the response object from the DeregisterTransitGatewayMulticastGroupSources operation.

Class DescribeAccountAttributesRequest

Container for the parameters to the DescribeAccountAttributes operation. Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

Class DescribeAccountAttributesResponse

This is the response object from the DescribeAccountAttributes operation.

Class DescribeAddressesAttributeRequest

Container for the parameters to the DescribeAddressesAttribute operation. Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

Class DescribeAddressesAttributeResponse

This is the response object from the DescribeAddressesAttribute operation.

Class DescribeAddressesRequest

Container for the parameters to the DescribeAddresses operation. Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

Class DescribeAddressesResponse

This is the response object from the DescribeAddresses operation.

Class DescribeAggregateIdFormatRequest

Container for the parameters to the DescribeAggregateIdFormat operation. 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.

Class DescribeAggregateIdFormatResponse

This is the response object from the DescribeAggregateIdFormat operation.

Class DescribeAvailabilityZonesRequest

Container for the parameters to the DescribeAvailabilityZones operation. 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, Zones and Outposts in the Amazon Elastic Compute Cloud User Guide.

Class DescribeAvailabilityZonesResponse

This is the response object from the DescribeAvailabilityZones operation.

Class DescribeBundleTasksRequest

Container for the parameters to the DescribeBundleTasks operation. 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.

Class DescribeBundleTasksResponse

This is the response object from the DescribeBundleTasks operation.

Class DescribeByoipCidrsRequest

Container for the parameters to the DescribeByoipCidrs operation. 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.

Class DescribeByoipCidrsResponse

This is the response object from the DescribeByoipCidrs operation.

Class DescribeCapacityReservationsRequest

Container for the parameters to the DescribeCapacityReservations operation. 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.

Class DescribeCapacityReservationsResponse

This is the response object from the DescribeCapacityReservations operation.

Class DescribeCarrierGatewaysRequest

Container for the parameters to the DescribeCarrierGateways operation. Describes one or more of your carrier gateways.

Class DescribeCarrierGatewaysResponse

This is the response object from the DescribeCarrierGateways operation.

Class DescribeClassicLinkInstancesRequest

Container for the parameters to the DescribeClassicLinkInstances operation. Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.

Class DescribeClassicLinkInstancesResponse

This is the response object from the DescribeClassicLinkInstances operation.

Class DescribeClientVpnAuthorizationRulesRequest

Container for the parameters to the DescribeClientVpnAuthorizationRules operation. Describes the authorization rules for a specified Client VPN endpoint.

Class DescribeClientVpnAuthorizationRulesResponse

This is the response object from the DescribeClientVpnAuthorizationRules operation.

Class DescribeClientVpnConnectionsRequest

Container for the parameters to the DescribeClientVpnConnections operation. Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Class DescribeClientVpnConnectionsResponse

This is the response object from the DescribeClientVpnConnections operation.

Class DescribeClientVpnEndpointsRequest

Container for the parameters to the DescribeClientVpnEndpoints operation. Describes one or more Client VPN endpoints in the account.

Class DescribeClientVpnEndpointsResponse

This is the response object from the DescribeClientVpnEndpoints operation.

Class DescribeClientVpnRoutesRequest

Container for the parameters to the DescribeClientVpnRoutes operation. Describes the routes for the specified Client VPN endpoint.

Class DescribeClientVpnRoutesResponse

This is the response object from the DescribeClientVpnRoutes operation.

Class DescribeClientVpnTargetNetworksRequest

Container for the parameters to the DescribeClientVpnTargetNetworks operation. Describes the target networks associated with the specified Client VPN endpoint.

Class DescribeClientVpnTargetNetworksResponse

This is the response object from the DescribeClientVpnTargetNetworks operation.

Class DescribeCoipPoolsRequest

Container for the parameters to the DescribeCoipPools operation. Describes the specified customer-owned address pools or all of your customer-owned address pools.

Class DescribeCoipPoolsResponse

This is the response object from the DescribeCoipPools operation.

Class DescribeConversionTasksRequest

Container for the parameters to the DescribeConversionTasks operation. 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.

Class DescribeConversionTasksResponse

This is the response object from the DescribeConversionTasks operation.

Class DescribeCustomerGatewaysRequest

Container for the parameters to the DescribeCustomerGateways operation. Describes one or more of your VPN customer gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class DescribeCustomerGatewaysResponse

Contains the output of DescribeCustomerGateways.

Class DescribeDhcpOptionsRequest

Container for the parameters to the DescribeDhcpOptions operation. Describes one or more of your DHCP options sets.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

Class DescribeDhcpOptionsResponse

This is the response object from the DescribeDhcpOptions operation.

Class DescribeEgressOnlyInternetGatewaysRequest

Container for the parameters to the DescribeEgressOnlyInternetGateways operation. Describes one or more of your egress-only internet gateways.

Class DescribeEgressOnlyInternetGatewaysResponse

This is the response object from the DescribeEgressOnlyInternetGateways operation.

Class DescribeElasticGpusRequest

Container for the parameters to the DescribeElasticGpus operation. Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.

Class DescribeElasticGpusResponse

This is the response object from the DescribeElasticGpus operation.

Class DescribeExportImageTasksRequest

Container for the parameters to the DescribeExportImageTasks operation. Describes the specified export image tasks or all of your export image tasks.

Class DescribeExportImageTasksResponse

This is the response object from the DescribeExportImageTasks operation.

Class DescribeExportTasksRequest

Container for the parameters to the DescribeExportTasks operation. Describes the specified export instance tasks or all of your export instance tasks.

Class DescribeExportTasksResponse

This is the response object from the DescribeExportTasks operation.

Class DescribeFastSnapshotRestoresRequest

Container for the parameters to the DescribeFastSnapshotRestores operation. Describes the state of fast snapshot restores for your snapshots.

Class DescribeFastSnapshotRestoresResponse

This is the response object from the DescribeFastSnapshotRestores operation.

Class DescribeFastSnapshotRestoreSuccessItem

Describes fast snapshot restores for a snapshot.

Class DescribeFleetError

Describes the instances that could not be launched by the fleet.

Class DescribeFleetHistoryRequest

Container for the parameters to the DescribeFleetHistory operation. 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 Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

Class DescribeFleetHistoryResponse

This is the response object from the DescribeFleetHistory operation.

Class DescribeFleetInstancesRequest

Container for the parameters to the DescribeFleetInstances operation. Describes the running instances for the specified EC2 Fleet.

For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

Class DescribeFleetInstancesResponse

This is the response object from the DescribeFleetInstances operation.

Class DescribeFleetsInstances

Describes the instances that were launched by the fleet.

Class DescribeFleetsRequest

Container for the parameters to the DescribeFleets operation. Describes the specified EC2 Fleets or all of your EC2 Fleets.

For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

Class DescribeFleetsResponse

This is the response object from the DescribeFleets operation.

Class DescribeFlowLogsRequest

Container for the parameters to the DescribeFlowLogs operation. Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

Class DescribeFlowLogsResponse

This is the response object from the DescribeFlowLogs operation.

Class DescribeFpgaImageAttributeRequest

Container for the parameters to the DescribeFpgaImageAttribute operation. Describes the specified attribute of the specified Amazon FPGA Image (AFI).

Class DescribeFpgaImageAttributeResponse

This is the response object from the DescribeFpgaImageAttribute operation.

Class DescribeFpgaImagesRequest

Container for the parameters to the DescribeFpgaImages operation. Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.

Class DescribeFpgaImagesResponse

This is the response object from the DescribeFpgaImages operation.

Class DescribeHostReservationOfferingsRequest

Container for the parameters to the DescribeHostReservationOfferings operation. 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.

Class DescribeHostReservationOfferingsResponse

This is the response object from the DescribeHostReservationOfferings operation.

Class DescribeHostReservationsRequest

Container for the parameters to the DescribeHostReservations operation. Describes reservations that are associated with Dedicated Hosts in your account.

Class DescribeHostReservationsResponse

This is the response object from the DescribeHostReservations operation.

Class DescribeHostsRequest

Container for the parameters to the DescribeHosts operation. 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.

Class DescribeHostsResponse

This is the response object from the DescribeHosts operation.

Class DescribeIamInstanceProfileAssociationsRequest

Container for the parameters to the DescribeIamInstanceProfileAssociations operation. Describes your IAM instance profile associations.

Class DescribeIamInstanceProfileAssociationsResponse

This is the response object from the DescribeIamInstanceProfileAssociations operation.

Class DescribeIdentityIdFormatRequest

Container for the parameters to the DescribeIdentityIdFormat operation. 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.

Class DescribeIdentityIdFormatResponse

This is the response object from the DescribeIdentityIdFormat operation.

Class DescribeIdFormatRequest

Container for the parameters to the DescribeIdFormat operation. 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 AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

Class DescribeIdFormatResponse

This is the response object from the DescribeIdFormat operation.

Class DescribeImageAttributeRequest

Container for the parameters to the DescribeImageAttribute operation. Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

Class DescribeImageAttributeResponse

Contains the response data from the DescribeImageAttribute operation.

Class DescribeImagesRequest

Container for the parameters to the DescribeImages operation. 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.

Class DescribeImagesResponse

This is the response object from the DescribeImages operation.

Class DescribeImportImageTasksRequest

Container for the parameters to the DescribeImportImageTasks operation. Displays details about an import virtual machine or import snapshot tasks that are already created.

Class DescribeImportImageTasksResponse

This is the response object from the DescribeImportImageTasks operation.

Class DescribeImportSnapshotTasksRequest

Container for the parameters to the DescribeImportSnapshotTasks operation. Describes your import snapshot tasks.

Class DescribeImportSnapshotTasksResponse

This is the response object from the DescribeImportSnapshotTasks operation.

Class DescribeInstanceAttributeRequest

Container for the parameters to the DescribeInstanceAttribute operation. 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

Class DescribeInstanceAttributeResponse

Contains the response data from the DescribeInstanceAttribute operation.

Class DescribeInstanceCreditSpecificationsRequest

Container for the parameters to the DescribeInstanceCreditSpecifications operation. 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.

Class DescribeInstanceCreditSpecificationsResponse

This is the response object from the DescribeInstanceCreditSpecifications operation.

Class DescribeInstanceEventNotificationAttributesRequest

Container for the parameters to the DescribeInstanceEventNotificationAttributes operation. Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.

Class DescribeInstanceEventNotificationAttributesResponse

This is the response object from the DescribeInstanceEventNotificationAttributes operation.

Class DescribeInstanceEventWindowsRequest

Container for the parameters to the DescribeInstanceEventWindows operation. 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.

Class DescribeInstanceEventWindowsResponse

This is the response object from the DescribeInstanceEventWindows operation.

Class DescribeInstancesRequest

Container for the parameters to the DescribeInstances operation. 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.

Class DescribeInstancesResponse

This is the response object from the DescribeInstances operation.

Class DescribeInstanceStatusRequest

Container for the parameters to the DescribeInstanceStatus operation. 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 Troubleshooting instances with failed status checks in the Amazon EC2 User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.

Class DescribeInstanceStatusResponse

This is the response object from the DescribeInstanceStatus operation.

Class DescribeInstanceTypeOfferingsRequest

Container for the parameters to the DescribeInstanceTypeOfferings operation. Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.

Class DescribeInstanceTypeOfferingsResponse

This is the response object from the DescribeInstanceTypeOfferings operation.

Class DescribeInstanceTypesRequest

Container for the parameters to the DescribeInstanceTypes operation. Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.

Class DescribeInstanceTypesResponse

This is the response object from the DescribeInstanceTypes operation.

Class DescribeInternetGatewaysRequest

Container for the parameters to the DescribeInternetGateways operation. Describes one or more of your internet gateways.

Class DescribeInternetGatewaysResponse

This is the response object from the DescribeInternetGateways operation.

Class DescribeIpv6PoolsRequest

Container for the parameters to the DescribeIpv6Pools operation. Describes your IPv6 address pools.

Class DescribeIpv6PoolsResponse

This is the response object from the DescribeIpv6Pools operation.

Class DescribeKeyPairsRequest

Container for the parameters to the DescribeKeyPairs operation. 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.

Class DescribeKeyPairsResponse

This is the response object from the DescribeKeyPairs operation.

Class DescribeLaunchTemplatesRequest

Container for the parameters to the DescribeLaunchTemplates operation. Describes one or more launch templates.

Class DescribeLaunchTemplatesResponse

This is the response object from the DescribeLaunchTemplates operation.

Class DescribeLaunchTemplateVersionsRequest

Container for the parameters to the DescribeLaunchTemplateVersions operation. 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.

Class DescribeLaunchTemplateVersionsResponse

This is the response object from the DescribeLaunchTemplateVersions operation.

Class DescribeLocalGatewayRouteTablesRequest

Container for the parameters to the DescribeLocalGatewayRouteTables operation. Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.

Class DescribeLocalGatewayRouteTablesResponse

This is the response object from the DescribeLocalGatewayRouteTables operation.

Class DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest

Container for the parameters to the DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations operation. Describes the associations between virtual interface groups and local gateway route tables.

Class DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResponse

This is the response object from the DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations operation.

Class DescribeLocalGatewayRouteTableVpcAssociationsRequest

Container for the parameters to the DescribeLocalGatewayRouteTableVpcAssociations operation. Describes the specified associations between VPCs and local gateway route tables.

Class DescribeLocalGatewayRouteTableVpcAssociationsResponse

This is the response object from the DescribeLocalGatewayRouteTableVpcAssociations operation.

Class DescribeLocalGatewaysRequest

Container for the parameters to the DescribeLocalGateways operation. Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

Class DescribeLocalGatewaysResponse

This is the response object from the DescribeLocalGateways operation.

Class DescribeLocalGatewayVirtualInterfaceGroupsRequest

Container for the parameters to the DescribeLocalGatewayVirtualInterfaceGroups operation. Describes the specified local gateway virtual interface groups.

Class DescribeLocalGatewayVirtualInterfaceGroupsResponse

This is the response object from the DescribeLocalGatewayVirtualInterfaceGroups operation.

Class DescribeLocalGatewayVirtualInterfacesRequest

Container for the parameters to the DescribeLocalGatewayVirtualInterfaces operation. Describes the specified local gateway virtual interfaces.

Class DescribeLocalGatewayVirtualInterfacesResponse

This is the response object from the DescribeLocalGatewayVirtualInterfaces operation.

Class DescribeManagedPrefixListsRequest

Container for the parameters to the DescribeManagedPrefixLists operation. Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

Class DescribeManagedPrefixListsResponse

This is the response object from the DescribeManagedPrefixLists operation.

Class DescribeMovingAddressesRequest

Container for the parameters to the DescribeMovingAddresses operation. Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

Class DescribeMovingAddressesResponse

This is the response object from the DescribeMovingAddresses operation.

Class DescribeNatGatewaysRequest

Container for the parameters to the DescribeNatGateways operation. Describes one or more of your NAT gateways.

Class DescribeNatGatewaysResponse

This is the response object from the DescribeNatGateways operation.

Class DescribeNetworkAclsRequest

Container for the parameters to the DescribeNetworkAcls operation. Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Class DescribeNetworkAclsResponse

This is the response object from the DescribeNetworkAcls operation.

Class DescribeNetworkInsightsAnalysesRequest

Container for the parameters to the DescribeNetworkInsightsAnalyses operation. Describes one or more of your network insights analyses.

Class DescribeNetworkInsightsAnalysesResponse

This is the response object from the DescribeNetworkInsightsAnalyses operation.

Class DescribeNetworkInsightsPathsRequest

Container for the parameters to the DescribeNetworkInsightsPaths operation. Describes one or more of your paths.

Class DescribeNetworkInsightsPathsResponse

This is the response object from the DescribeNetworkInsightsPaths operation.

Class DescribeNetworkInterfaceAttributeRequest

Container for the parameters to the DescribeNetworkInterfaceAttribute operation. Describes a network interface attribute. You can specify only one attribute at a time.

Class DescribeNetworkInterfaceAttributeResponse

Contains the output of DescribeNetworkInterfaceAttribute.

Class DescribeNetworkInterfacePermissionsRequest

Container for the parameters to the DescribeNetworkInterfacePermissions operation. Describes the permissions for your network interfaces.

Class DescribeNetworkInterfacePermissionsResponse

Contains the output for DescribeNetworkInterfacePermissions.

Class DescribeNetworkInterfacesRequest

Container for the parameters to the DescribeNetworkInterfaces operation. Describes one or more of your network interfaces.

Class DescribeNetworkInterfacesResponse

Contains the output of DescribeNetworkInterfaces.

Class DescribePlacementGroupsRequest

Container for the parameters to the DescribePlacementGroups operation. Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.

Class DescribePlacementGroupsResponse

This is the response object from the DescribePlacementGroups operation.

Class DescribePrefixListsRequest

Container for the parameters to the DescribePrefixLists operation. 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.

Class DescribePrefixListsResponse

This is the response object from the DescribePrefixLists operation.

Class DescribePrincipalIdFormatRequest

Container for the parameters to the DescribePrincipalIdFormat operation. 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.

Class DescribePrincipalIdFormatResponse

This is the response object from the DescribePrincipalIdFormat operation.

Class DescribePublicIpv4PoolsRequest

Container for the parameters to the DescribePublicIpv4Pools operation. Describes the specified IPv4 address pools.

Class DescribePublicIpv4PoolsResponse

This is the response object from the DescribePublicIpv4Pools operation.

Class DescribeRegionsRequest

Container for the parameters to the DescribeRegions operation. Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.

For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.

Class DescribeRegionsResponse

This is the response object from the DescribeRegions operation.

Class DescribeReplaceRootVolumeTasksRequest

Container for the parameters to the DescribeReplaceRootVolumeTasks operation. Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

Class DescribeReplaceRootVolumeTasksResponse

This is the response object from the DescribeReplaceRootVolumeTasks operation.

Class DescribeReservedInstancesListingsRequest

Container for the parameters to the DescribeReservedInstancesListings operation. Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

Class DescribeReservedInstancesListingsResponse

Contains the output of DescribeReservedInstancesListings.

Class DescribeReservedInstancesModificationsRequest

Container for the parameters to the DescribeReservedInstancesModifications operation. Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

Class DescribeReservedInstancesModificationsResponse

Contains the output of DescribeReservedInstancesModifications.

Class DescribeReservedInstancesOfferingsRequest

Container for the parameters to the DescribeReservedInstancesOfferings operation. Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

Class DescribeReservedInstancesOfferingsResponse

Contains the output of DescribeReservedInstancesOfferings.

Class DescribeReservedInstancesRequest

Container for the parameters to the DescribeReservedInstances operation. 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.

Class DescribeReservedInstancesResponse

Contains the output for DescribeReservedInstances.

Class DescribeRouteTablesRequest

Container for the parameters to the DescribeRouteTables operation. Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

Class DescribeRouteTablesResponse

Contains the output of DescribeRouteTables.

Class DescribeScheduledInstanceAvailabilityRequest

Container for the parameters to the DescribeScheduledInstanceAvailability operation. 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.

Class DescribeScheduledInstanceAvailabilityResponse

Contains the output of DescribeScheduledInstanceAvailability.

Class DescribeScheduledInstancesRequest

Container for the parameters to the DescribeScheduledInstances operation. Describes the specified Scheduled Instances or all your Scheduled Instances.

Class DescribeScheduledInstancesResponse

Contains the output of DescribeScheduledInstances.

Class DescribeSecurityGroupReferencesRequest

Container for the parameters to the DescribeSecurityGroupReferences operation. [VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

Class DescribeSecurityGroupReferencesResponse

This is the response object from the DescribeSecurityGroupReferences operation.

Class DescribeSecurityGroupRulesRequest

Container for the parameters to the DescribeSecurityGroupRules operation. Describes one or more of your security group rules.

Class DescribeSecurityGroupRulesResponse

This is the response object from the DescribeSecurityGroupRules operation.

Class DescribeSecurityGroupsRequest

Container for the parameters to the DescribeSecurityGroups operation. Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

Class DescribeSecurityGroupsResponse

This is the response object from the DescribeSecurityGroups operation.

Class DescribeSnapshotAttributeRequest

Container for the parameters to the DescribeSnapshotAttribute operation. Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

Class DescribeSnapshotAttributeResponse

This is the response object from the DescribeSnapshotAttribute operation.

Class DescribeSnapshotsRequest

Container for the parameters to the DescribeSnapshots operation. 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. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

Class DescribeSnapshotsResponse

This is the response object from the DescribeSnapshots operation.

Class DescribeSpotDatafeedSubscriptionRequest

Container for the parameters to the DescribeSpotDatafeedSubscription operation. Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.

Class DescribeSpotDatafeedSubscriptionResponse

Contains the output of DescribeSpotDatafeedSubscription.

Class DescribeSpotFleetInstancesRequest

Container for the parameters to the DescribeSpotFleetInstances operation. Describes the running instances for the specified Spot Fleet.

Class DescribeSpotFleetInstancesResponse

Contains the output of DescribeSpotFleetInstances.

Class DescribeSpotFleetRequestHistoryRequest

Container for the parameters to the DescribeSpotFleetRequestHistory operation. 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.

Class DescribeSpotFleetRequestHistoryResponse

Contains the output of DescribeSpotFleetRequestHistory.

Class DescribeSpotFleetRequestsRequest

Container for the parameters to the DescribeSpotFleetRequests operation. Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

Class DescribeSpotFleetRequestsResponse

Contains the output of DescribeSpotFleetRequests.

Class DescribeSpotInstanceRequestsRequest

Container for the parameters to the DescribeSpotInstanceRequests operation. 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 results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

Class DescribeSpotInstanceRequestsResponse

Contains the output of DescribeSpotInstanceRequests.

Class DescribeSpotPriceHistoryRequest

Container for the parameters to the DescribeSpotPriceHistory operation. Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, 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.

Class DescribeSpotPriceHistoryResponse

Contains the output of DescribeSpotPriceHistory.

Class DescribeStaleSecurityGroupsRequest

Container for the parameters to the DescribeStaleSecurityGroups operation. [VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

Class DescribeStaleSecurityGroupsResponse

This is the response object from the DescribeStaleSecurityGroups operation.

Class DescribeStoreImageTasksRequest

Container for the parameters to the DescribeStoreImageTasks operation. 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 Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

Class DescribeStoreImageTasksResponse

This is the response object from the DescribeStoreImageTasks operation.

Class DescribeSubnetsRequest

Container for the parameters to the DescribeSubnets operation. Describes one or more of your subnets.

For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

Class DescribeSubnetsResponse

This is the response object from the DescribeSubnets operation.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation. Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Class DescribeTagsResponse

This is the response object from the DescribeTags operation.

Class DescribeTrafficMirrorFiltersRequest

Container for the parameters to the DescribeTrafficMirrorFilters operation. Describes one or more Traffic Mirror filters.

Class DescribeTrafficMirrorFiltersResponse

This is the response object from the DescribeTrafficMirrorFilters operation.

Class DescribeTrafficMirrorSessionsRequest

Container for the parameters to the DescribeTrafficMirrorSessions operation. Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

Class DescribeTrafficMirrorSessionsResponse

This is the response object from the DescribeTrafficMirrorSessions operation.

Class DescribeTrafficMirrorTargetsRequest

Container for the parameters to the DescribeTrafficMirrorTargets operation. Information about one or more Traffic Mirror targets.

Class DescribeTrafficMirrorTargetsResponse

This is the response object from the DescribeTrafficMirrorTargets operation.

Class DescribeTransitGatewayAttachmentsRequest

Container for the parameters to the DescribeTransitGatewayAttachments operation. 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.

Class DescribeTransitGatewayAttachmentsResponse

This is the response object from the DescribeTransitGatewayAttachments operation.

Class DescribeTransitGatewayConnectPeersRequest

Container for the parameters to the DescribeTransitGatewayConnectPeers operation. Describes one or more Connect peers.

Class DescribeTransitGatewayConnectPeersResponse

This is the response object from the DescribeTransitGatewayConnectPeers operation.

Class DescribeTransitGatewayConnectsRequest

Container for the parameters to the DescribeTransitGatewayConnects operation. Describes one or more Connect attachments.

Class DescribeTransitGatewayConnectsResponse

This is the response object from the DescribeTransitGatewayConnects operation.

Class DescribeTransitGatewayMulticastDomainsRequest

Container for the parameters to the DescribeTransitGatewayMulticastDomains operation. Describes one or more transit gateway multicast domains.

Class DescribeTransitGatewayMulticastDomainsResponse

This is the response object from the DescribeTransitGatewayMulticastDomains operation.

Class DescribeTransitGatewayPeeringAttachmentsRequest

Container for the parameters to the DescribeTransitGatewayPeeringAttachments operation. Describes your transit gateway peering attachments.

Class DescribeTransitGatewayPeeringAttachmentsResponse

This is the response object from the DescribeTransitGatewayPeeringAttachments operation.

Class DescribeTransitGatewayRouteTablesRequest

Container for the parameters to the DescribeTransitGatewayRouteTables operation. Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

Class DescribeTransitGatewayRouteTablesResponse

This is the response object from the DescribeTransitGatewayRouteTables operation.

Class DescribeTransitGatewaysRequest

Container for the parameters to the DescribeTransitGateways operation. Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

Class DescribeTransitGatewaysResponse

This is the response object from the DescribeTransitGateways operation.

Class DescribeTransitGatewayVpcAttachmentsRequest

Container for the parameters to the DescribeTransitGatewayVpcAttachments operation. Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

Class DescribeTransitGatewayVpcAttachmentsResponse

This is the response object from the DescribeTransitGatewayVpcAttachments operation.

Class DescribeTrunkInterfaceAssociationsRequest

Container for the parameters to the DescribeTrunkInterfaceAssociations operation.

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Describes one or more network interface trunk associations.

Class DescribeTrunkInterfaceAssociationsResponse

This is the response object from the DescribeTrunkInterfaceAssociations operation.

Class DescribeVolumeAttributeRequest

Container for the parameters to the DescribeVolumeAttribute operation. Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

Class DescribeVolumeAttributeResponse

This is the response object from the DescribeVolumeAttribute operation.

Class DescribeVolumesModificationsRequest

Container for the parameters to the DescribeVolumesModifications operation. Describes the most recent volume modification request for the specified EBS volumes.

If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

Class DescribeVolumesModificationsResponse

This is the response object from the DescribeVolumesModifications operation.

Class DescribeVolumesRequest

Container for the parameters to the DescribeVolumes operation. 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. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

Class DescribeVolumesResponse

This is the response object from the DescribeVolumes operation.

Class DescribeVolumeStatusRequest

Container for the parameters to the DescribeVolumeStatus operation. 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 Elastic Compute Cloud User Guide.

Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.

Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

Class DescribeVolumeStatusResponse

This is the response object from the DescribeVolumeStatus operation.

Class DescribeVpcAttributeRequest

Container for the parameters to the DescribeVpcAttribute operation. Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

Class DescribeVpcAttributeResponse

This is the response object from the DescribeVpcAttribute operation.

Class DescribeVpcClassicLinkDnsSupportRequest

Container for the parameters to the DescribeVpcClassicLinkDnsSupport operation. Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Class DescribeVpcClassicLinkDnsSupportResponse

This is the response object from the DescribeVpcClassicLinkDnsSupport operation.

Class DescribeVpcClassicLinkRequest

Container for the parameters to the DescribeVpcClassicLink operation. Describes the ClassicLink status of one or more VPCs.

Class DescribeVpcClassicLinkResponse

This is the response object from the DescribeVpcClassicLink operation.

Class DescribeVpcEndpointConnectionNotificationsRequest

Container for the parameters to the DescribeVpcEndpointConnectionNotifications operation. Describes the connection notifications for VPC endpoints and VPC endpoint services.

Class DescribeVpcEndpointConnectionNotificationsResponse

This is the response object from the DescribeVpcEndpointConnectionNotifications operation.

Class DescribeVpcEndpointConnectionsRequest

Container for the parameters to the DescribeVpcEndpointConnections operation. Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

Class DescribeVpcEndpointConnectionsResponse

This is the response object from the DescribeVpcEndpointConnections operation.

Class DescribeVpcEndpointServiceConfigurationsRequest

Container for the parameters to the DescribeVpcEndpointServiceConfigurations operation. Describes the VPC endpoint service configurations in your account (your services).

Class DescribeVpcEndpointServiceConfigurationsResponse

This is the response object from the DescribeVpcEndpointServiceConfigurations operation.

Class DescribeVpcEndpointServicePermissionsRequest

Container for the parameters to the DescribeVpcEndpointServicePermissions operation. Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

Class DescribeVpcEndpointServicePermissionsResponse

This is the response object from the DescribeVpcEndpointServicePermissions operation.

Class DescribeVpcEndpointServicesRequest

Container for the parameters to the DescribeVpcEndpointServices operation. 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.

Class DescribeVpcEndpointServicesResponse

Contains the output of DescribeVpcEndpointServices.

Class DescribeVpcEndpointsRequest

Container for the parameters to the DescribeVpcEndpoints operation. Describes one or more of your VPC endpoints.

Class DescribeVpcEndpointsResponse

Contains the output of DescribeVpcEndpoints.

Class DescribeVpcPeeringConnectionsRequest

Container for the parameters to the DescribeVpcPeeringConnections operation. Describes one or more of your VPC peering connections.

Class DescribeVpcPeeringConnectionsResponse

This is the response object from the DescribeVpcPeeringConnections operation.

Class DescribeVpcsRequest

Container for the parameters to the DescribeVpcs operation. Describes one or more of your VPCs.

Class DescribeVpcsResponse

This is the response object from the DescribeVpcs operation.

Class DescribeVpnConnectionsRequest

Container for the parameters to the DescribeVpnConnections operation. Describes one or more of your VPN connections.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class DescribeVpnConnectionsResponse

Contains the output of DescribeVpnConnections.

Class DescribeVpnGatewaysRequest

Container for the parameters to the DescribeVpnGateways operation. Describes one or more of your virtual private gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Class DescribeVpnGatewaysResponse

Contains the output of DescribeVpnGateways.

Class DetachClassicLinkVpcRequest

Container for the parameters to the DetachClassicLinkVpc operation. 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.

Class DetachClassicLinkVpcResponse

This is the response object from the DetachClassicLinkVpc operation.

Class DetachInternetGatewayRequest

Container for the parameters to the DetachInternetGateway operation. 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.

Class DetachInternetGatewayResponse

This is the response object from the DetachInternetGateway operation.

Class DetachNetworkInterfaceRequest

Container for the parameters to the DetachNetworkInterface operation. Detaches a network interface from an instance.

Class DetachNetworkInterfaceResponse

This is the response object from the DetachNetworkInterface operation.

Class DetachVolumeRequest

Container for the parameters to the DetachVolume operation. 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.

For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

Class DetachVolumeResponse

Contains the response data from the DetachVolume operation.

Class DetachVpnGatewayRequest

Container for the parameters to the DetachVpnGateway operation. 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.

Class DetachVpnGatewayResponse

This is the response object from the DetachVpnGateway operation.

Class DhcpConfiguration

Describes a DHCP configuration option.

Class DhcpOptions

Describes a set of DHCP options.

Class DirectoryServiceAuthentication

Describes an Active Directory.

Class DirectoryServiceAuthenticationRequest

Describes the Active Directory to be used for client authentication.

Class DisableEbsEncryptionByDefaultRequest

Container for the parameters to the DisableEbsEncryptionByDefault operation. 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 Elastic Compute Cloud User Guide.

Class DisableEbsEncryptionByDefaultResponse

This is the response object from the DisableEbsEncryptionByDefault operation.

Class DisableFastSnapshotRestoreErrorItem

Contains information about the errors that occurred when disabling fast snapshot restores.

Class DisableFastSnapshotRestoresRequest

Container for the parameters to the DisableFastSnapshotRestores operation. Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

Class DisableFastSnapshotRestoresResponse

This is the response object from the DisableFastSnapshotRestores operation.

Class DisableFastSnapshotRestoreStateError

Describes an error that occurred when disabling fast snapshot restores.

Class DisableFastSnapshotRestoreStateErrorItem

Contains information about an error that occurred when disabling fast snapshot restores.

Class DisableFastSnapshotRestoreSuccessItem

Describes fast snapshot restores that were successfully disabled.

Class DisableImageDeprecationRequest

Container for the parameters to the DisableImageDeprecation operation. Cancels the deprecation of the specified AMI.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

Class DisableImageDeprecationResponse

This is the response object from the DisableImageDeprecation operation.

Class DisableSerialConsoleAccessRequest

Container for the parameters to the DisableSerialConsoleAccess operation. 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.

Class DisableSerialConsoleAccessResponse

This is the response object from the DisableSerialConsoleAccess operation.

Class DisableTransitGatewayRouteTablePropagationRequest

Container for the parameters to the DisableTransitGatewayRouteTablePropagation operation. Disables the specified resource attachment from propagating routes to the specified propagation route table.

Class DisableTransitGatewayRouteTablePropagationResponse

This is the response object from the DisableTransitGatewayRouteTablePropagation operation.

Class DisableVgwRoutePropagationRequest

Container for the parameters to the DisableVgwRoutePropagation operation. Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

Class DisableVgwRoutePropagationResponse

This is the response object from the DisableVgwRoutePropagation operation.

Class DisableVpcClassicLinkDnsSupportRequest

Container for the parameters to the DisableVpcClassicLinkDnsSupport operation. Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

Class DisableVpcClassicLinkDnsSupportResponse

This is the response object from the DisableVpcClassicLinkDnsSupport operation.

Class DisableVpcClassicLinkRequest

Container for the parameters to the DisableVpcClassicLink operation. Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

Class DisableVpcClassicLinkResponse

This is the response object from the DisableVpcClassicLink operation.

Class DisassociateAddressRequest

Container for the parameters to the DisassociateAddress operation. Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

Class DisassociateAddressResponse

This is the response object from the DisassociateAddress operation.

Class DisassociateClientVpnTargetNetworkRequest

Container for the parameters to the DisassociateClientVpnTargetNetwork operation. 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

Class DisassociateClientVpnTargetNetworkResponse

This is the response object from the DisassociateClientVpnTargetNetwork operation.

Class DisassociateEnclaveCertificateIamRoleRequest

Container for the parameters to the DisassociateEnclaveCertificateIamRole operation. 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.

Class DisassociateEnclaveCertificateIamRoleResponse

This is the response object from the DisassociateEnclaveCertificateIamRole operation.

Class DisassociateIamInstanceProfileRequest

Container for the parameters to the DisassociateIamInstanceProfile operation. Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

Class DisassociateIamInstanceProfileResponse

This is the response object from the DisassociateIamInstanceProfile operation.

Class DisassociateInstanceEventWindowRequest

Container for the parameters to the DisassociateInstanceEventWindow operation. 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.

Class DisassociateInstanceEventWindowResponse

This is the response object from the DisassociateInstanceEventWindow operation.

Class DisassociateRouteTableRequest

Container for the parameters to the DisassociateRouteTable operation. 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 Virtual Private Cloud User Guide.

Class DisassociateRouteTableResponse

This is the response object from the DisassociateRouteTable operation.

Class DisassociateSubnetCidrBlockRequest

Container for the parameters to the DisassociateSubnetCidrBlock operation. 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.

Class DisassociateSubnetCidrBlockResponse

This is the response object from the DisassociateSubnetCidrBlock operation.

Class DisassociateTransitGatewayMulticastDomainRequest

Container for the parameters to the DisassociateTransitGatewayMulticastDomain operation. Disassociates the specified subnets from the transit gateway multicast domain.

Class DisassociateTransitGatewayMulticastDomainResponse

This is the response object from the DisassociateTransitGatewayMulticastDomain operation.

Class DisassociateTransitGatewayRouteTableRequest

Container for the parameters to the DisassociateTransitGatewayRouteTable operation. Disassociates a resource attachment from a transit gateway route table.

Class DisassociateTransitGatewayRouteTableResponse

This is the response object from the DisassociateTransitGatewayRouteTable operation.

Class DisassociateTrunkInterfaceRequest

Container for the parameters to the DisassociateTrunkInterface operation.

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Removes an association between a branch network interface with a trunk network interface.

Class DisassociateTrunkInterfaceResponse

This is the response object from the DisassociateTrunkInterface operation.

Class DisassociateVpcCidrBlockRequest

Container for the parameters to the DisassociateVpcCidrBlock operation. 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).

Class DisassociateVpcCidrBlockResponse

This is the response object from the DisassociateVpcCidrBlock operation.

Class DiskImage

Describes a disk image.

Class DiskImageDescription

Describes a disk image.

Class DiskImageDetail

Describes a disk image.

Class DiskImageVolumeDescription

Describes a disk image volume.

Class DiskInfo

Describes the disk.

Class DnsEntry

Describes a DNS entry.

Class DnsServersOptionsModifyStructure

Information about the DNS server to be used.

Class DryRunResponse

Returns information about the DryRun response and response metadata.

Class EbsBlockDevice

Describes a block device for an EBS volume.

Class EbsInfo

Describes the Amazon EBS features supported by the instance type.

Class EbsInstanceBlockDevice

Describes a parameter used to set up an EBS volume in a block device mapping.

Class EbsInstanceBlockDeviceSpecification

Describes information used to set up an EBS volume specified in a block device mapping.

Class EbsOptimizedInfo

Describes the optimized EBS performance for supported instance types.

Class EC2PaginatorFactory

Paginators for the EC2 service

Class EfaInfo

Describes the Elastic Fabric Adapters for the instance type.

Class EgressOnlyInternetGateway

Describes an egress-only internet gateway.

Class ElasticGpuAssociation

Describes the association between an instance and an Elastic Graphics accelerator.

Class ElasticGpuHealth

Describes the status of an Elastic Graphics accelerator.

Class ElasticGpus

Describes an Elastic Graphics accelerator.

Class ElasticGpuSpecification

A specification for an Elastic Graphics accelerator.

Class ElasticGpuSpecificationResponse

Describes an elastic GPU.

Class ElasticInferenceAccelerator

Describes an elastic inference accelerator.

Class ElasticInferenceAcceleratorAssociation

Describes the association between an instance and an elastic inference accelerator.

Class EnableEbsEncryptionByDefaultRequest

Container for the parameters to the EnableEbsEncryptionByDefault operation. 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 Elastic Compute Cloud 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.

Class EnableEbsEncryptionByDefaultResponse

This is the response object from the EnableEbsEncryptionByDefault operation.

Class EnableFastSnapshotRestoreErrorItem

Contains information about the errors that occurred when enabling fast snapshot restores.

Class EnableFastSnapshotRestoresRequest

Container for the parameters to the EnableFastSnapshotRestores operation. 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 Elastic Compute Cloud User Guide.

Class EnableFastSnapshotRestoresResponse

This is the response object from the EnableFastSnapshotRestores operation.

Class EnableFastSnapshotRestoreStateError

Describes an error that occurred when enabling fast snapshot restores.

Class EnableFastSnapshotRestoreStateErrorItem

Contains information about an error that occurred when enabling fast snapshot restores.

Class EnableFastSnapshotRestoreSuccessItem

Describes fast snapshot restores that were successfully enabled.

Class EnableImageDeprecationRequest

Container for the parameters to the EnableImageDeprecation operation. Enables deprecation of the specified AMI at the specified date and time.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

Class EnableImageDeprecationResponse

This is the response object from the EnableImageDeprecation operation.

Class EnableSerialConsoleAccessRequest

Container for the parameters to the EnableSerialConsoleAccess operation. 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.

Class EnableSerialConsoleAccessResponse

This is the response object from the EnableSerialConsoleAccess operation.

Class EnableTransitGatewayRouteTablePropagationRequest

Container for the parameters to the EnableTransitGatewayRouteTablePropagation operation. Enables the specified attachment to propagate routes to the specified propagation route table.

Class EnableTransitGatewayRouteTablePropagationResponse

This is the response object from the EnableTransitGatewayRouteTablePropagation operation.

Class EnableVgwRoutePropagationRequest

Container for the parameters to the EnableVgwRoutePropagation operation. Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

Class EnableVgwRoutePropagationResponse

This is the response object from the EnableVgwRoutePropagation operation.

Class EnableVolumeIORequest

Container for the parameters to the EnableVolumeIO operation. Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

Class EnableVolumeIOResponse

This is the response object from the EnableVolumeIO operation.

Class EnableVpcClassicLinkDnsSupportRequest

Container for the parameters to the EnableVpcClassicLinkDnsSupport operation. Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

Class EnableVpcClassicLinkDnsSupportResponse

This is the response object from the EnableVpcClassicLinkDnsSupport operation.

Class EnableVpcClassicLinkRequest

Container for the parameters to the EnableVpcClassicLink operation. Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Class EnableVpcClassicLinkResponse

This is the response object from the EnableVpcClassicLink operation.

Class EnclaveOptions

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

Class EnclaveOptionsRequest

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

Class EventInformation

Describes an EC2 Fleet or Spot Fleet event.

Class Explanation

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

Class ExportClientVpnClientCertificateRevocationListRequest

Container for the parameters to the ExportClientVpnClientCertificateRevocationList operation. Downloads the client certificate revocation list for the specified Client VPN endpoint.

Class ExportClientVpnClientCertificateRevocationListResponse

This is the response object from the ExportClientVpnClientCertificateRevocationList operation.

Class ExportClientVpnClientConfigurationRequest

Container for the parameters to the ExportClientVpnClientConfiguration operation. 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.

Class ExportClientVpnClientConfigurationResponse

This is the response object from the ExportClientVpnClientConfiguration operation.

Class ExportImageRequest

Container for the parameters to the ExportImage operation. 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.

Class ExportImageResponse

This is the response object from the ExportImage operation.

Class ExportImageTask

Describes an export image task.

Class ExportTask

Describes an export instance task.

Class ExportTaskS3Location

Describes the destination for an export image task.

Class ExportTaskS3LocationRequest

Describes the destination for an export image task.

Class ExportToS3Task

Describes the format and location for the export task.

Class ExportToS3TaskSpecification

Describes an export instance task.

Class ExportTransitGatewayRoutesRequest

Container for the parameters to the ExportTransitGatewayRoutes operation. 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 Transit Gateways.

Class ExportTransitGatewayRoutesResponse

This is the response object from the ExportTransitGatewayRoutes operation.

Class FailedQueuedPurchaseDeletion

Describes a Reserved Instance whose queued purchase was not deleted.

Class FederatedAuthentication

Describes the IAM SAML identity providers used for federated authentication.

Class FederatedAuthenticationRequest

The IAM SAML identity provider used for federated authentication.

Class Filter

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Class FleetData

Describes an EC2 Fleet.

Class FleetLaunchTemplateConfig

Describes a launch template and overrides.

Class FleetLaunchTemplateConfigRequest

Describes a launch template and overrides.

Class FleetLaunchTemplateOverrides

Describes overrides for a launch template.

Class FleetLaunchTemplateOverridesRequest

Describes overrides for a launch template.

Class FleetLaunchTemplateSpecification

Describes the Amazon EC2 launch template and the launch template version that can be used by a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon EC2 User Guide for Linux Instances.

Class FleetLaunchTemplateSpecificationRequest

Describes the Amazon EC2 launch template and the launch template version that can be used by an EC2 Fleet to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon EC2 User Guide.

Class FleetSpotCapacityRebalance

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

Class FleetSpotCapacityRebalanceRequest

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide.

Class FleetSpotMaintenanceStrategies

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Class FleetSpotMaintenanceStrategiesRequest

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Class FlowLog

Describes a flow log.

Class FpgaDeviceInfo

Describes the FPGA accelerator for the instance type.

Class FpgaDeviceMemoryInfo

Describes the memory for the FPGA accelerator for the instance type.

Class FpgaImage

Describes an Amazon FPGA image (AFI).

Class FpgaImageAttribute

Describes an Amazon FPGA image (AFI) attribute.

Class FpgaImageState

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

Class FpgaInfo

Describes the FPGAs for the instance type.

Class GetAssociatedEnclaveCertificateIamRolesRequest

Container for the parameters to the GetAssociatedEnclaveCertificateIamRoles operation. 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.

Class GetAssociatedEnclaveCertificateIamRolesResponse

This is the response object from the GetAssociatedEnclaveCertificateIamRoles operation.

Class GetAssociatedIpv6PoolCidrsRequest

Container for the parameters to the GetAssociatedIpv6PoolCidrs operation. Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

Class GetAssociatedIpv6PoolCidrsResponse

This is the response object from the GetAssociatedIpv6PoolCidrs operation.

Class GetCapacityReservationUsageRequest

Container for the parameters to the GetCapacityReservationUsage operation. 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.

Class GetCapacityReservationUsageResponse

This is the response object from the GetCapacityReservationUsage operation.

Class GetCoipPoolUsageRequest

Container for the parameters to the GetCoipPoolUsage operation. Describes the allocations from the specified customer-owned address pool.

Class GetCoipPoolUsageResponse

This is the response object from the GetCoipPoolUsage operation.

Class GetConsoleOutputRequest

Container for the parameters to the GetConsoleOutput operation. 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.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance console output in the Amazon EC2 User Guide.

Class GetConsoleOutputResponse

This is the response object from the GetConsoleOutput operation.

Class GetConsoleScreenshotRequest

Container for the parameters to the GetConsoleScreenshot operation. Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

Class GetConsoleScreenshotResponse

This is the response object from the GetConsoleScreenshot operation.

Class GetDefaultCreditSpecificationRequest

Container for the parameters to the GetDefaultCreditSpecification operation. 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.

Class GetDefaultCreditSpecificationResponse

This is the response object from the GetDefaultCreditSpecification operation.

Class GetEbsDefaultKmsKeyIdRequest

Container for the parameters to the GetEbsDefaultKmsKeyId operation. 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 Elastic Compute Cloud User Guide.

Class GetEbsDefaultKmsKeyIdResponse

This is the response object from the GetEbsDefaultKmsKeyId operation.

Class GetEbsEncryptionByDefaultRequest

Container for the parameters to the GetEbsEncryptionByDefault operation. 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 Elastic Compute Cloud User Guide.

Class GetEbsEncryptionByDefaultResponse

This is the response object from the GetEbsEncryptionByDefault operation.

Class GetFlowLogsIntegrationTemplateRequest

Container for the parameters to the GetFlowLogsIntegrationTemplate operation. 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

Class GetFlowLogsIntegrationTemplateResponse

This is the response object from the GetFlowLogsIntegrationTemplate operation.

Class GetGroupsForCapacityReservationRequest

Container for the parameters to the GetGroupsForCapacityReservation operation. Lists the resource groups to which a Capacity Reservation has been added.

Class GetGroupsForCapacityReservationResponse

This is the response object from the GetGroupsForCapacityReservation operation.

Class GetHostReservationPurchasePreviewRequest

Container for the parameters to the GetHostReservationPurchasePreview operation. 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.

Class GetHostReservationPurchasePreviewResponse

This is the response object from the GetHostReservationPurchasePreview operation.

Class GetLaunchTemplateDataRequest

Container for the parameters to the GetLaunchTemplateData operation. 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, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.

Class GetLaunchTemplateDataResponse

This is the response object from the GetLaunchTemplateData operation.

Class GetManagedPrefixListAssociationsRequest

Container for the parameters to the GetManagedPrefixListAssociations operation. Gets information about the resources that are associated with the specified managed prefix list.

Class GetManagedPrefixListAssociationsResponse

This is the response object from the GetManagedPrefixListAssociations operation.

Class GetManagedPrefixListEntriesRequest

Container for the parameters to the GetManagedPrefixListEntries operation. Gets information about the entries for a specified managed prefix list.

Class GetManagedPrefixListEntriesResponse

This is the response object from the GetManagedPrefixListEntries operation.

Class GetPasswordDataRequest

Container for the parameters to the GetPasswordData operation. 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.

Class GetPasswordDataResponse

This is the response object from the GetPasswordData operation.

Class GetReservedInstancesExchangeQuoteRequest

Container for the parameters to the GetReservedInstancesExchangeQuote operation. 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.

Class GetReservedInstancesExchangeQuoteResponse

Contains the output of GetReservedInstancesExchangeQuote.

Class GetSerialConsoleAccessStatusRequest

Container for the parameters to the GetSerialConsoleAccessStatus operation. 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.

Class GetSerialConsoleAccessStatusResponse

This is the response object from the GetSerialConsoleAccessStatus operation.

Class GetSubnetCidrReservationsRequest

Container for the parameters to the GetSubnetCidrReservations operation. Gets information about the subnet CIDR reservations.

Class GetSubnetCidrReservationsResponse

This is the response object from the GetSubnetCidrReservations operation.

Class GetTransitGatewayAttachmentPropagationsRequest

Container for the parameters to the GetTransitGatewayAttachmentPropagations operation. Lists the route tables to which the specified resource attachment propagates routes.

Class GetTransitGatewayAttachmentPropagationsResponse

This is the response object from the GetTransitGatewayAttachmentPropagations operation.

Class GetTransitGatewayMulticastDomainAssociationsRequest

Container for the parameters to the GetTransitGatewayMulticastDomainAssociations operation. Gets information about the associations for the transit gateway multicast domain.

Class GetTransitGatewayMulticastDomainAssociationsResponse

This is the response object from the GetTransitGatewayMulticastDomainAssociations operation.

Class GetTransitGatewayPrefixListReferencesRequest

Container for the parameters to the GetTransitGatewayPrefixListReferences operation. Gets information about the prefix list references in a specified transit gateway route table.

Class GetTransitGatewayPrefixListReferencesResponse

This is the response object from the GetTransitGatewayPrefixListReferences operation.

Class GetTransitGatewayRouteTableAssociationsRequest

Container for the parameters to the GetTransitGatewayRouteTableAssociations operation. Gets information about the associations for the specified transit gateway route table.

Class GetTransitGatewayRouteTableAssociationsResponse

This is the response object from the GetTransitGatewayRouteTableAssociations operation.

Class GetTransitGatewayRouteTablePropagationsRequest

Container for the parameters to the GetTransitGatewayRouteTablePropagations operation. Gets information about the route table propagations for the specified transit gateway route table.

Class GetTransitGatewayRouteTablePropagationsResponse

This is the response object from the GetTransitGatewayRouteTablePropagations operation.

Class GpuDeviceInfo

Describes the GPU accelerators for the instance type.

Class GpuDeviceMemoryInfo

Describes the memory available to the GPU accelerator.

Class GpuInfo

Describes the GPU accelerators for the instance type.

Class GroupIdentifier

Describes a security group.

Class HibernationOptions

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Class HibernationOptionsRequest

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Class HistoryRecord

Describes an event in the history of the Spot Fleet request.

Class HistoryRecordEntry

Describes an event in the history of an EC2 Fleet.

Class Host

Describes the properties of the Dedicated Host.

Class HostInstance

Describes an instance running on a Dedicated Host.

Class HostOffering

Details about the Dedicated Host Reservation offering.

Class HostProperties

Describes the properties of a Dedicated Host.

Class HostReservation

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

Class IamInstanceProfile

Describes an IAM instance profile.

Class IamInstanceProfileAssociation

Describes an association between an IAM instance profile and an instance.

Class IamInstanceProfileSpecification

Describes an IAM instance profile.

Class IcmpTypeCode

Describes the ICMP type and code.

Class IdFormat

Describes the ID format for a resource.

Class IKEVersionsListValue

The internet key exchange (IKE) version permitted for the VPN tunnel.

Class IKEVersionsRequestListValue

The IKE version that is permitted for the VPN tunnel.

Class Image

Describes an image.

Class ImageAttribute

Describes an image attribute.

Class ImageDiskContainer

Describes the disk container object for an import image task.

Class ImportClientVpnClientCertificateRevocationListRequest

Container for the parameters to the ImportClientVpnClientCertificateRevocationList operation. 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.

Class ImportClientVpnClientCertificateRevocationListResponse

This is the response object from the ImportClientVpnClientCertificateRevocationList operation.

Class ImportImageLicenseConfigurationRequest

The request information of license configurations.

Class ImportImageLicenseConfigurationResponse

The response information for license configurations.

Class ImportImageRequest

Container for the parameters to the ImportImage operation. Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

Class ImportImageResponse

This is the response object from the ImportImage operation.

Class ImportImageTask

Describes an import image task.

Class ImportInstanceLaunchSpecification

Describes the launch specification for VM import.

Class ImportInstanceRequest

Container for the parameters to the ImportInstance operation. Creates an import instance task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage 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 a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest.

Class ImportInstanceResponse

This is the response object from the ImportInstance operation.

Class ImportInstanceTaskDetails

Describes an import instance task.

Class ImportInstanceVolumeDetailItem

Describes an import volume task.

Class ImportKeyPairRequest

Container for the parameters to the ImportKeyPair operation. 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.

Class ImportKeyPairResponse

This is the response object from the ImportKeyPair operation.

Class ImportSnapshotRequest

Container for the parameters to the ImportSnapshot operation. 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.

Class ImportSnapshotResponse

This is the response object from the ImportSnapshot operation.

Class ImportSnapshotTask

Describes an import snapshot task.

Class ImportVolumeRequest

Container for the parameters to the ImportVolume operation. 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.

Class ImportVolumeResponse

This is the response object from the ImportVolume operation.

Class ImportVolumeTaskDetails

Describes an import volume task.

Class InferenceAcceleratorInfo

Describes the Inference accelerators for the instance type.

Class InferenceDeviceInfo

Describes the Inference accelerators for the instance type.

Class Instance

Describes an instance.

Class InstanceAttribute

Describes an instance attribute.

Class InstanceBlockDeviceMapping

Describes a block device mapping.

Class InstanceBlockDeviceMappingSpecification

Describes a block device mapping entry.

Class InstanceCapacity

Information about the number of instances that can be launched onto the Dedicated Host.

Class InstanceCount

Describes a Reserved Instance listing state.

Class InstanceCreditSpecification

Describes the credit option for CPU usage of a burstable performance instance.

Class InstanceCreditSpecificationRequest

Describes the credit option for CPU usage of a burstable performance instance.

Class InstanceEventWindow

The event window.

Class InstanceEventWindowAssociationRequest

One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.

Class InstanceEventWindowAssociationTarget

One or more targets associated with the event window.

Class InstanceEventWindowDisassociationRequest

The targets to disassociate from the specified event window.

Class InstanceEventWindowStateChange

The state of the event window.

Class InstanceEventWindowTimeRange

The start day and time and the end day and time of the time range, in UTC.

Class InstanceEventWindowTimeRangeRequest

The start day and time and the end day and time of the time range, in UTC.

Class InstanceExportDetails

Describes an instance to export.

Class InstanceFamilyCreditSpecification

Describes the default credit option for CPU usage of a burstable performance instance family.

Class InstanceIpv4Prefix

Information about an IPv4 prefix.

Class InstanceIpv6Address

Describes an IPv6 address.

Class InstanceIpv6AddressRequest

Describes an IPv6 address.

Class InstanceIpv6Prefix

Information about an IPv6 prefix.

Class InstanceLicenseSpecification

Instance License Specification

Class InstanceMarketOptionsRequest

Describes the market (purchasing) option for the instances.

Class InstanceMetadataOptionsRequest

The metadata options for the instance.

Class InstanceMetadataOptionsResponse

The metadata options for the instance.

Class InstanceMonitoring

Describes the monitoring of an instance.

Class InstanceNetworkInterface

Describes a network interface.

Class InstanceNetworkInterfaceAssociation

Describes association information for an Elastic IP address (IPv4).

Class InstanceNetworkInterfaceAttachment

Describes a network interface attachment.

Class InstanceNetworkInterfaceSpecification

Describes a network interface.

Class InstancePrivateIpAddress

Describes a private IPv4 address.

Class InstanceSpecification

The instance details to specify which volumes should be snapshotted.

Class InstanceState

Describes the current state of an instance.

Class InstanceStateChange

Describes an instance state change.

Class InstanceStatus

Describes the status of an instance.

Class InstanceStatusDetails

Describes the instance status.

Class InstanceStatusEvent

Describes a scheduled event for an instance.

Class InstanceStatusSummary

Describes the status of an instance.

Class InstanceStorageInfo

Describes the disks that are available for the instance type.

Class InstanceTagNotificationAttribute

Describes the registered tag keys for the current Region.

Class InstanceTypeInfo

Describes the instance type.

Class InstanceTypeOffering

The instance types offered.

Class InstanceUsage

Information about the Capacity Reservation usage.

Class IntegrateServices

Describes service integrations with VPC Flow logs.

Class InternetGateway

Describes an internet gateway.

Class InternetGatewayAttachment

Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

Class IpPermission

Describes a security group rule.

Class IpRange

Describes an IPv4 range.

Class Ipv4PrefixSpecification

Describes an IPv4 prefix.

Class Ipv4PrefixSpecificationRequest

Describes the IPv4 prefix option for a network interface.

Class Ipv4PrefixSpecificationResponse

Information about the IPv4 delegated prefixes assigned to a network interface.

Class Ipv6CidrAssociation

Describes an IPv6 CIDR block association.

Class Ipv6CidrBlock

Describes an IPv6 CIDR block.

Class Ipv6Pool

Describes an IPv6 address pool.

Class Ipv6PrefixSpecification

Describes the IPv6 prefix.

Class Ipv6PrefixSpecificationRequest

Describes the IPv4 prefix option for a network interface.

Class Ipv6PrefixSpecificationResponse

Information about the IPv6 delegated prefixes assigned to a network interface.

Class Ipv6Range

[EC2-VPC only] Describes an IPv6 range.

Class KeyPair

Describes a key pair.

Class KeyPairInfo

Describes a key pair.

Class LastError

The last error that occurred for a VPC endpoint.

Class LaunchPermission

Describes a launch permission.

Class LaunchPermissionModifications

Describes a launch permission modification.

Class LaunchSpecification

Describes the launch specification for an instance.

Class LaunchTemplate

Describes a launch template.

Class LaunchTemplateAndOverridesResponse

Describes a launch template and overrides.

Class LaunchTemplateBlockDeviceMapping

Describes a block device mapping.

Class LaunchTemplateBlockDeviceMappingRequest

Describes a block device mapping.

Class LaunchTemplateCapacityReservationSpecificationRequest

Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

Class LaunchTemplateCapacityReservationSpecificationResponse

Information about the Capacity Reservation targeting option.

Class LaunchTemplateConfig

Describes a launch template and overrides.

Class LaunchTemplateCpuOptions

The CPU options for the instance.

Class LaunchTemplateCpuOptionsRequest

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

Class LaunchTemplateEbsBlockDevice

Describes a block device for an EBS volume.

Class LaunchTemplateEbsBlockDeviceRequest

The parameters for a block device for an EBS volume.

Class LaunchTemplateElasticInferenceAccelerator

Describes an elastic inference accelerator.

Class LaunchTemplateElasticInferenceAcceleratorResponse

Describes an elastic inference accelerator.

Class LaunchTemplateEnclaveOptions

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

Class LaunchTemplateEnclaveOptionsRequest

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

Class LaunchTemplateHibernationOptions

Indicates whether an instance is configured for hibernation.

Class LaunchTemplateHibernationOptionsRequest

Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites.

Class LaunchTemplateIamInstanceProfileSpecification

Describes an IAM instance profile.

Class LaunchTemplateIamInstanceProfileSpecificationRequest

An IAM instance profile.

Class LaunchTemplateInstanceMarketOptions

The market (purchasing) option for the instances.

Class LaunchTemplateInstanceMarketOptionsRequest

The market (purchasing) option for the instances.

Class LaunchTemplateInstanceMetadataOptions

The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

Class LaunchTemplateInstanceMetadataOptionsRequest

The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

Class LaunchTemplateInstanceNetworkInterfaceSpecification

Describes a network interface.

Class LaunchTemplateInstanceNetworkInterfaceSpecificationRequest

The parameters for a network interface.

Class LaunchTemplateLicenseConfiguration

Describes a license configuration.

Class LaunchTemplateLicenseConfigurationRequest

Describes a license configuration.

Class LaunchTemplateOverrides

Describes overrides for a launch template.

Class LaunchTemplatePlacement

Describes the placement of an instance.

Class LaunchTemplatePlacementRequest

Describes the placement of an instance.

Class LaunchTemplatesMonitoring

Describes the monitoring for the instance.

Class LaunchTemplatesMonitoringRequest

Describes the monitoring for the instance.

Class LaunchTemplateSpecification

The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.

Class LaunchTemplateSpotMarketOptions

The options for Spot Instances.

Class LaunchTemplateSpotMarketOptionsRequest

The options for Spot Instances.

Class LaunchTemplateTagSpecification

The tag specification for the launch template.

Class LaunchTemplateTagSpecificationRequest

The tags specification for the launch template.

Class LaunchTemplateVersion

Describes a launch template version.

Class LicenseConfiguration

Describes a license configuration.

Class LicenseConfigurationRequest

Describes a license configuration.

Class LoadBalancersConfig

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.

Class LoadPermission

Describes a load permission.

Class LoadPermissionModifications

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

Class LoadPermissionRequest

Describes a load permission.

Class LocalGateway

Describes a local gateway.

Class LocalGatewayRoute

Describes a route for a local gateway route table.

Class LocalGatewayRouteTable

Describes a local gateway route table.

Class LocalGatewayRouteTableVirtualInterfaceGroupAssociation

Describes an association between a local gateway route table and a virtual interface group.

Class LocalGatewayRouteTableVpcAssociation

Describes an association between a local gateway route table and a VPC.

Class LocalGatewayVirtualInterface

Describes a local gateway virtual interface.

Class LocalGatewayVirtualInterfaceGroup

Describes a local gateway virtual interface group.

Class ManagedPrefixList

Describes a managed prefix list.

Class MemoryInfo

Describes the memory for the instance type.

Class ModifyAddressAttributeRequest

Container for the parameters to the ModifyAddressAttribute operation. Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

Class ModifyAddressAttributeResponse

This is the response object from the ModifyAddressAttribute operation.

Class ModifyAvailabilityZoneGroupRequest

Container for the parameters to the ModifyAvailabilityZoneGroup operation. Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.

Use DescribeAvailabilityZones to view the value for GroupName.

Class ModifyAvailabilityZoneGroupResponse

This is the response object from the ModifyAvailabilityZoneGroup operation.

Class ModifyCapacityReservationRequest

Container for the parameters to the ModifyCapacityReservation operation. 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.

Class ModifyCapacityReservationResponse

This is the response object from the ModifyCapacityReservation operation.

Class ModifyClientVpnEndpointRequest

Container for the parameters to the ModifyClientVpnEndpoint operation. Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Class ModifyClientVpnEndpointResponse

This is the response object from the ModifyClientVpnEndpoint operation.

Class ModifyDefaultCreditSpecificationRequest

Container for the parameters to the ModifyDefaultCreditSpecification operation. 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.

Class ModifyDefaultCreditSpecificationResponse

This is the response object from the ModifyDefaultCreditSpecification operation.

Class ModifyEbsDefaultKmsKeyIdRequest

Container for the parameters to the ModifyEbsDefaultKmsKeyId operation. 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 Elastic Compute Cloud User Guide.

Class ModifyEbsDefaultKmsKeyIdResponse

This is the response object from the ModifyEbsDefaultKmsKeyId operation.

Class ModifyFleetRequest

Container for the parameters to the ModifyFleet operation. 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.

Class ModifyFleetResponse

This is the response object from the ModifyFleet operation.

Class ModifyFpgaImageAttributeRequest

Container for the parameters to the ModifyFpgaImageAttribute operation. Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

Class ModifyFpgaImageAttributeResponse

This is the response object from the ModifyFpgaImageAttribute operation.

Class ModifyHostsRequest

Container for the parameters to the ModifyHosts operation. 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.

Class ModifyHostsResponse

This is the response object from the ModifyHosts operation.

Class ModifyIdentityIdFormatRequest

Container for the parameters to the ModifyIdentityIdFormat operation. 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.

Class ModifyIdentityIdFormatResponse

This is the response object from the ModifyIdentityIdFormat operation.

Class ModifyIdFormatRequest

Container for the parameters to the ModifyIdFormat operation. 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 AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

Class ModifyIdFormatResponse

This is the response object from the ModifyIdFormat operation.

Class ModifyImageAttributeRequest

Container for the parameters to the ModifyImageAttribute operation. Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description 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.

Class ModifyImageAttributeResponse

This is the response object from the ModifyImageAttribute operation.

Class ModifyInstanceAttributeRequest

Container for the parameters to the ModifyInstanceAttribute operation. 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 in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon EC2 User Guide.

Class ModifyInstanceAttributeResponse

This is the response object from the ModifyInstanceAttribute operation.

Class ModifyInstanceCapacityReservationAttributesRequest

Container for the parameters to the ModifyInstanceCapacityReservationAttributes operation. 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.

Class ModifyInstanceCapacityReservationAttributesResponse

This is the response object from the ModifyInstanceCapacityReservationAttributes operation.

Class ModifyInstanceCreditSpecificationRequest

Container for the parameters to the ModifyInstanceCreditSpecification operation. 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.

Class ModifyInstanceCreditSpecificationResponse

This is the response object from the ModifyInstanceCreditSpecification operation.

Class ModifyInstanceEventStartTimeRequest

Container for the parameters to the ModifyInstanceEventStartTime operation. Modifies the start time for a scheduled Amazon EC2 instance event.

Class ModifyInstanceEventStartTimeResponse

This is the response object from the ModifyInstanceEventStartTime operation.

Class ModifyInstanceEventWindowRequest

Container for the parameters to the ModifyInstanceEventWindow operation. 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.

Class ModifyInstanceEventWindowResponse

This is the response object from the ModifyInstanceEventWindow operation.

Class ModifyInstanceMetadataOptionsRequest

Container for the parameters to the ModifyInstanceMetadataOptions operation. 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.

Class ModifyInstanceMetadataOptionsResponse

This is the response object from the ModifyInstanceMetadataOptions operation.

Class ModifyInstancePlacementRequest

Container for the parameters to the ModifyInstancePlacement operation. 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 launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.

  • Move an instance to or from a placement group.

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

Class ModifyInstancePlacementResponse

This is the response object from the ModifyInstancePlacement operation.

Class ModifyLaunchTemplateRequest

Container for the parameters to the ModifyLaunchTemplate operation. 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.

Class ModifyLaunchTemplateResponse

This is the response object from the ModifyLaunchTemplate operation.

Class ModifyManagedPrefixListRequest

Container for the parameters to the ModifyManagedPrefixList operation. 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.

Class ModifyManagedPrefixListResponse

This is the response object from the ModifyManagedPrefixList operation.

Class ModifyNetworkInterfaceAttributeRequest

Container for the parameters to the ModifyNetworkInterfaceAttribute operation. 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.

Class ModifyNetworkInterfaceAttributeResponse

This is the response object from the ModifyNetworkInterfaceAttribute operation.

Class ModifyReservedInstancesRequest

Container for the parameters to the ModifyReservedInstances operation. Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

Class ModifyReservedInstancesResponse

Contains the output of ModifyReservedInstances.

Class ModifySecurityGroupRulesRequest

Container for the parameters to the ModifySecurityGroupRules operation. Modifies the rules of a security group.

Class ModifySecurityGroupRulesResponse

This is the response object from the ModifySecurityGroupRules operation.

Class ModifySnapshotAttributeRequest

Container for the parameters to the ModifySnapshotAttribute operation. 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 Elastic Compute Cloud User Guide.

Class ModifySnapshotAttributeResponse

This is the response object from the ModifySnapshotAttribute operation.

Class ModifySpotFleetRequestRequest

Container for the parameters to the ModifySpotFleetRequest operation. 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.

Class ModifySpotFleetRequestResponse

Contains the output of ModifySpotFleetRequest.

Class ModifySubnetAttributeRequest

Container for the parameters to the ModifySubnetAttribute operation. Modifies a subnet attribute. You can only modify one attribute at a time.

Class ModifySubnetAttributeResponse

This is the response object from the ModifySubnetAttribute operation.

Class ModifyTrafficMirrorFilterNetworkServicesRequest

Container for the parameters to the ModifyTrafficMirrorFilterNetworkServices operation. 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.

For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .

Class ModifyTrafficMirrorFilterNetworkServicesResponse

This is the response object from the ModifyTrafficMirrorFilterNetworkServices operation.

Class ModifyTrafficMirrorFilterRuleRequest

Container for the parameters to the ModifyTrafficMirrorFilterRule operation. Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

Class ModifyTrafficMirrorFilterRuleResponse

This is the response object from the ModifyTrafficMirrorFilterRule operation.

Class ModifyTrafficMirrorSessionRequest

Container for the parameters to the ModifyTrafficMirrorSession operation. Modifies a Traffic Mirror session.

Class ModifyTrafficMirrorSessionResponse

This is the response object from the ModifyTrafficMirrorSession operation.

Class ModifyTransitGatewayOptions

The transit gateway options.

Class ModifyTransitGatewayPrefixListReferenceRequest

Container for the parameters to the ModifyTransitGatewayPrefixListReference operation. Modifies a reference (route) to a prefix list in a specified transit gateway route table.

Class ModifyTransitGatewayPrefixListReferenceResponse

This is the response object from the ModifyTransitGatewayPrefixListReference operation.

Class ModifyTransitGatewayRequest

Container for the parameters to the ModifyTransitGateway operation. 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.

Class ModifyTransitGatewayResponse

This is the response object from the ModifyTransitGateway operation.

Class ModifyTransitGatewayVpcAttachmentRequest

Container for the parameters to the ModifyTransitGatewayVpcAttachment operation. Modifies the specified VPC attachment.

Class ModifyTransitGatewayVpcAttachmentRequestOptions

Describes the options for a VPC attachment.

Class ModifyTransitGatewayVpcAttachmentResponse

This is the response object from the ModifyTransitGatewayVpcAttachment operation.

Class ModifyVolumeAttributeRequest

Container for the parameters to the ModifyVolumeAttribute operation. 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.

Class ModifyVolumeAttributeResponse

This is the response object from the ModifyVolumeAttribute operation.

Class ModifyVolumeRequest

Container for the parameters to the ModifyVolume operation. 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 (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).

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 a Linux file system or Extend a Windows file system.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

If you reach the maximum volume modification rate per volume limit, you must wait at least six hours before applying further modifications to the affected EBS volume.

Class ModifyVolumeResponse

This is the response object from the ModifyVolume operation.

Class ModifyVpcAttributeRequest

Container for the parameters to the ModifyVpcAttribute operation. Modifies the specified attribute of the specified VPC.

Class ModifyVpcAttributeResponse

This is the response object from the ModifyVpcAttribute operation.

Class ModifyVpcEndpointConnectionNotificationRequest

Container for the parameters to the ModifyVpcEndpointConnectionNotification operation. 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.

Class ModifyVpcEndpointConnectionNotificationResponse

This is the response object from the ModifyVpcEndpointConnectionNotification operation.

Class ModifyVpcEndpointRequest

Container for the parameters to the ModifyVpcEndpoint operation. 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 VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

Class ModifyVpcEndpointResponse

This is the response object from the ModifyVpcEndpoint operation.

Class ModifyVpcEndpointServiceConfigurationRequest

Container for the parameters to the ModifyVpcEndpointServiceConfiguration operation. 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. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.

Class ModifyVpcEndpointServiceConfigurationResponse

This is the response object from the ModifyVpcEndpointServiceConfiguration operation.

Class ModifyVpcEndpointServicePermissionsRequest

Container for the parameters to the ModifyVpcEndpointServicePermissions operation. Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

Class ModifyVpcEndpointServicePermissionsResponse

This is the response object from the ModifyVpcEndpointServicePermissions operation.

Class ModifyVpcPeeringConnectionOptionsRequest

Container for the parameters to the ModifyVpcPeeringConnectionOptions operation. Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in the same 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 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.

Class ModifyVpcPeeringConnectionOptionsResponse

This is the response object from the ModifyVpcPeeringConnectionOptions operation.

Class ModifyVpcTenancyRequest

Container for the parameters to the ModifyVpcTenancy operation. Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

Class ModifyVpcTenancyResponse

This is the response object from the ModifyVpcTenancy operation.

Class ModifyVpnConnectionOptionsRequest

Container for the parameters to the ModifyVpnConnectionOptions operation. 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 AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

Class ModifyVpnConnectionOptionsResponse

This is the response object from the ModifyVpnConnectionOptions operation.

Class ModifyVpnConnectionRequest

Container for the parameters to the ModifyVpnConnection operation. Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.

Class ModifyVpnConnectionResponse

This is the response object from the ModifyVpnConnection operation.

Class ModifyVpnTunnelCertificateRequest

Container for the parameters to the ModifyVpnTunnelCertificate operation. Modifies the VPN tunnel endpoint certificate.

Class ModifyVpnTunnelCertificateResponse

This is the response object from the ModifyVpnTunnelCertificate operation.

Class ModifyVpnTunnelOptionsRequest

Container for the parameters to the ModifyVpnTunnelOptions operation. Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection in the AWS Site-to-Site VPN User Guide.

Class ModifyVpnTunnelOptionsResponse

This is the response object from the ModifyVpnTunnelOptions operation.

Class ModifyVpnTunnelOptionsSpecification

The AWS Site-to-Site VPN tunnel options to modify.

Class Monitoring

Describes the monitoring of an instance.

Class MonitorInstancesRequest

Container for the parameters to the MonitorInstances operation. Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.

To disable detailed monitoring, see .

Class MonitorInstancesResponse

This is the response object from the MonitorInstances operation.

Class MoveAddressToVpcRequest

Container for the parameters to the MoveAddressToVpc operation. 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.

Class MoveAddressToVpcResponse

This is the response object from the MoveAddressToVpc operation.

Class MovingAddressStatus

Describes the status of a moving Elastic IP address.

Class NatGateway

Describes a NAT gateway.

Class NatGatewayAddress

Describes the IP addresses and network interface associated with a NAT gateway.

Class NetworkAcl

Describes a network ACL.

Class NetworkAclAssociation

Describes an association between a network ACL and a subnet.

Class NetworkAclEntry

Describes an entry in a network ACL.

Class NetworkCardInfo

Describes the network card support of the instance type.

Class NetworkInfo

Describes the networking features of the instance type.

Class NetworkInsightsAnalysis

Describes a network insights analysis.

Class NetworkInsightsPath

Describes a path.

Class NetworkInterface

Describes a network interface.

Class NetworkInterfaceAssociation

Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).

Class NetworkInterfaceAttachment

Describes a network interface attachment.

Class NetworkInterfaceAttachmentChanges

Describes an attachment change.

Class NetworkInterfaceIpv6Address

Describes an IPv6 address associated with a network interface.

Class NetworkInterfacePermission

Describes a permission for a network interface.

Class NetworkInterfacePermissionState

Describes the state of a network interface permission.

Class NetworkInterfacePrivateIpAddress

Describes the private IPv4 address of a network interface.

Class OnDemandOptions

Describes the configuration of On-Demand Instances in an EC2 Fleet.

Class OnDemandOptionsRequest

Describes the configuration of On-Demand Instances in an EC2 Fleet.

Class PathComponent

Describes a path component.

Class PciId

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

Class PeeringAttachmentStatus

The status of the transit gateway peering attachment.

Class PeeringConnectionOptions

Describes the VPC peering connection options.

Class PeeringConnectionOptionsRequest

The VPC peering connection options.

Class PeeringTgwInfo

Information about the transit gateway in the peering attachment.

Class Phase1DHGroupNumbersListValue

The Diffie-Hellmann group number for phase 1 IKE negotiations.

Class Phase1DHGroupNumbersRequestListValue

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.

Class Phase1EncryptionAlgorithmsListValue

The encryption algorithm for phase 1 IKE negotiations.

Class Phase1EncryptionAlgorithmsRequestListValue

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.

Class Phase1IntegrityAlgorithmsListValue

The integrity algorithm for phase 1 IKE negotiations.

Class Phase1IntegrityAlgorithmsRequestListValue

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.

Class Phase2DHGroupNumbersListValue

The Diffie-Hellmann group number for phase 2 IKE negotiations.

Class Phase2DHGroupNumbersRequestListValue

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.

Class Phase2EncryptionAlgorithmsListValue

The encryption algorithm for phase 2 IKE negotiations.

Class Phase2EncryptionAlgorithmsRequestListValue

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.

Class Phase2IntegrityAlgorithmsListValue

The integrity algorithm for phase 2 IKE negotiations.

Class Phase2IntegrityAlgorithmsRequestListValue

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.

Class Placement

Describes the placement of an instance.

Class PlacementGroup

Describes a placement group.

Class PlacementGroupInfo

Describes the placement group support of the instance type.

Class PlacementResponse

Describes the placement of an instance.

Class PoolCidrBlock

Describes a CIDR block for an address pool.

Class PortRange

Describes a range of ports.

Class PrefixList

Describes prefixes for Amazon Web Services services.

Class PrefixListAssociation

Describes the resource with which a prefix list is associated.

Class PrefixListEntry

Describes a prefix list entry.

Class PrefixListId

Describes a prefix list ID.

Class PriceSchedule

Describes the price for a Reserved Instance.

Class PriceScheduleSpecification

Describes the price for a Reserved Instance.

Class PricingDetail

Describes a Reserved Instance offering.

Class PrincipalIdFormat

PrincipalIdFormat description

Class PrivateDnsDetails

Information about the Private DNS name for interface endpoints.

Class PrivateDnsNameConfiguration

Information about the private DNS name for the service endpoint. For more information about these parameters, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.

Class PrivateIpAddressSpecification

Describes a secondary private IPv4 address for a network interface.

Class ProcessorInfo

Describes the processor used by the instance type.

Class ProductCode

Describes a product code.

Class PropagatingVgw

Describes a virtual private gateway propagating route.

Class ProvisionByoipCidrRequest

Container for the parameters to the ProvisionByoipCidr operation. 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 Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

Class ProvisionByoipCidrResponse

This is the response object from the ProvisionByoipCidr operation.

Class ProvisionedBandwidth

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

Class PtrUpdateStatus

The status of an updated pointer (PTR) record for an Elastic IP address.

Class PublicIpv4Pool

Describes an IPv4 address pool.

Class PublicIpv4PoolRange

Describes an address range of an IPv4 address pool.

Class Purchase

Describes the result of the purchase.

Class PurchaseHostReservationRequest

Container for the parameters to the PurchaseHostReservation operation. 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.

Class PurchaseHostReservationResponse

This is the response object from the PurchaseHostReservation operation.

Class PurchaseRequest

Describes a request to purchase Scheduled Instances.

Class PurchaseReservedInstancesOfferingRequest

Container for the parameters to the PurchaseReservedInstancesOffering operation. 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 Reserved Instance Marketplace in the Amazon EC2 User Guide.

Class PurchaseReservedInstancesOfferingResponse

Contains the output of PurchaseReservedInstancesOffering.

Class PurchaseScheduledInstancesRequest

Container for the parameters to the PurchaseScheduledInstances operation. 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.

Class PurchaseScheduledInstancesResponse

Contains the output of PurchaseScheduledInstances.

Class RebootInstancesRequest

Container for the parameters to the RebootInstances operation. 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 Getting console output and rebooting instances in the Amazon EC2 User Guide.

Class RebootInstancesResponse

This is the response object from the RebootInstances operation.

Class RecurringCharge

Describes a recurring charge.

Class ReferencedSecurityGroup

Describes the security group that is referenced in the security group rule.

Class Region

Describes a Region.

Class RegisterImageRequest

Container for the parameters to the RegisterImage operation. Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

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:

  1. Launch an instance from an existing AMI with that billing product code.

  2. Customize the instance.

  3. 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 Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.

Class RegisterImageResponse

Contains the output of RegisterImage.

Class RegisterInstanceEventNotificationAttributesRequest

Container for the parameters to the RegisterInstanceEventNotificationAttributes operation. Registers a set of tag keys to include in scheduled event notifications for your resources.

To remove tags, use .

Class RegisterInstanceEventNotificationAttributesResponse

This is the response object from the RegisterInstanceEventNotificationAttributes operation.

Class RegisterInstanceTagAttributeRequest

Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request

Class RegisterTransitGatewayMulticastGroupMembersRequest

Container for the parameters to the RegisterTransitGatewayMulticastGroupMembers operation. 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 information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.

Class RegisterTransitGatewayMulticastGroupMembersResponse

This is the response object from the RegisterTransitGatewayMulticastGroupMembers operation.

Class RegisterTransitGatewayMulticastGroupSourcesRequest

Container for the parameters to the RegisterTransitGatewayMulticastGroupSources operation. 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 information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

Class RegisterTransitGatewayMulticastGroupSourcesResponse

This is the response object from the RegisterTransitGatewayMulticastGroupSources operation.

Class RejectTransitGatewayMulticastDomainAssociationsRequest

Container for the parameters to the RejectTransitGatewayMulticastDomainAssociations operation. Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

Class RejectTransitGatewayMulticastDomainAssociationsResponse

This is the response object from the RejectTransitGatewayMulticastDomainAssociations operation.

Class RejectTransitGatewayPeeringAttachmentRequest

Container for the parameters to the RejectTransitGatewayPeeringAttachment operation. Rejects a transit gateway peering attachment request.

Class RejectTransitGatewayPeeringAttachmentResponse

This is the response object from the RejectTransitGatewayPeeringAttachment operation.

Class RejectTransitGatewayVpcAttachmentRequest

Container for the parameters to the RejectTransitGatewayVpcAttachment operation. 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.

Class RejectTransitGatewayVpcAttachmentResponse

This is the response object from the RejectTransitGatewayVpcAttachment operation.

Class RejectVpcEndpointConnectionsRequest

Container for the parameters to the RejectVpcEndpointConnections operation. Rejects one or more VPC endpoint connection requests to your VPC endpoint service.

Class RejectVpcEndpointConnectionsResponse

This is the response object from the RejectVpcEndpointConnections operation.

Class RejectVpcPeeringConnectionRequest

Container for the parameters to the RejectVpcPeeringConnection operation. 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.

Class RejectVpcPeeringConnectionResponse

Returns information about the RejectVpcPeeringConnection response metadata. The RejectVpcPeeringConnection operation has a void result type.

Class ReleaseAddressRequest

Container for the parameters to the ReleaseAddress operation. Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

Class ReleaseAddressResponse

This is the response object from the ReleaseAddress operation.

Class ReleaseHostsRequest

Container for the parameters to the ReleaseHosts operation. 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.

Class ReleaseHostsResponse

This is the response object from the ReleaseHosts operation.

Class RemovePrefixListEntry

An entry for a prefix list.

Class ReplaceIamInstanceProfileAssociationRequest

Container for the parameters to the ReplaceIamInstanceProfileAssociation operation. 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.

Class ReplaceIamInstanceProfileAssociationResponse

This is the response object from the ReplaceIamInstanceProfileAssociation operation.

Class ReplaceNetworkAclAssociationRequest

Container for the parameters to the ReplaceNetworkAclAssociation operation. 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 Virtual Private Cloud User Guide.

This is an idempotent operation.

Class ReplaceNetworkAclAssociationResponse

This is the response object from the ReplaceNetworkAclAssociation operation.

Class ReplaceNetworkAclEntryRequest

Container for the parameters to the ReplaceNetworkAclEntry operation. Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Class ReplaceNetworkAclEntryResponse

This is the response object from the ReplaceNetworkAclEntry operation.

Class ReplaceRootVolumeTask

Information about a root volume replacement task.

Class ReplaceRouteRequest

Container for the parameters to the ReplaceRoute operation. Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

Class ReplaceRouteResponse

This is the response object from the ReplaceRoute operation.

Class ReplaceRouteTableAssociationRequest

Container for the parameters to the ReplaceRouteTableAssociation operation. 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 Virtual Private Cloud User Guide.

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

Class ReplaceRouteTableAssociationResponse

This is the response object from the ReplaceRouteTableAssociation operation.

Class ReplaceTransitGatewayRouteRequest

Container for the parameters to the ReplaceTransitGatewayRoute operation. Replaces the specified route in the specified transit gateway route table.

Class ReplaceTransitGatewayRouteResponse

This is the response object from the ReplaceTransitGatewayRoute operation.

Class ReportInstanceStatusRequest

Container for the parameters to the ReportInstanceStatus operation. 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.

Class ReportInstanceStatusResponse

This is the response object from the ReportInstanceStatus operation.

Class RequestLaunchTemplateData

The information to include in the launch template.

Class RequestSpotFleetRequest

Container for the parameters to the RequestSpotFleet operation. 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 for Linux Instances.

Class RequestSpotFleetResponse

Contains the output of RequestSpotFleet.

Class RequestSpotInstancesRequest

Container for the parameters to the RequestSpotInstances operation. Creates a Spot Instance request.

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

Class RequestSpotInstancesResponse

Contains the output of RequestSpotInstances.

Class Reservation

Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.

Class ReservationValue

The cost associated with the Reserved Instance.

Class ReservedInstanceLimitPrice

Describes the limit price of a Reserved Instance offering.

Class ReservedInstanceReservationValue

The total value of the Convertible Reserved Instance.

Class ReservedInstances

Describes a Reserved Instance.

Class ReservedInstancesConfiguration

Describes the configuration settings for the modified Reserved Instances.

Class ReservedInstancesId

Describes the ID of a Reserved Instance.

Class ReservedInstancesListing

Describes a Reserved Instance listing.

Class ReservedInstancesModification

Describes a Reserved Instance modification.

Class ReservedInstancesModificationResult

Describes the modification request/s.

Class ReservedInstancesOffering

Describes a Reserved Instance offering.

Class ResetAddressAttributeRequest

Container for the parameters to the ResetAddressAttribute operation. Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

Class ResetAddressAttributeResponse

This is the response object from the ResetAddressAttribute operation.

Class ResetEbsDefaultKmsKeyIdRequest

Container for the parameters to the ResetEbsDefaultKmsKeyId operation. 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 Elastic Compute Cloud User Guide.

Class ResetEbsDefaultKmsKeyIdResponse

This is the response object from the ResetEbsDefaultKmsKeyId operation.

Class ResetFpgaImageAttributeRequest

Container for the parameters to the ResetFpgaImageAttribute operation. Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

Class ResetFpgaImageAttributeResponse

This is the response object from the ResetFpgaImageAttribute operation.

Class ResetImageAttributeRequest

Container for the parameters to the ResetImageAttribute operation. Resets an attribute of an AMI to its default value.

Class ResetImageAttributeResponse

This is the response object from the ResetImageAttribute operation.

Class ResetInstanceAttributeRequest

Container for the parameters to the ResetInstanceAttribute operation. 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.

Class ResetInstanceAttributeResponse

This is the response object from the ResetInstanceAttribute operation.

Class ResetNetworkInterfaceAttributeRequest

Container for the parameters to the ResetNetworkInterfaceAttribute operation. Resets a network interface attribute. You can specify only one attribute at a time.

Class ResetNetworkInterfaceAttributeResponse

This is the response object from the ResetNetworkInterfaceAttribute operation.

Class ResetSnapshotAttributeRequest

Container for the parameters to the ResetSnapshotAttribute operation. Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.

Class ResetSnapshotAttributeResponse

This is the response object from the ResetSnapshotAttribute operation.

Class ResponseError

Describes the error that's returned when you cannot delete a launch template version.

Class ResponseLaunchTemplateData

The information for a launch template.

Class RestoreAddressToClassicRequest

Container for the parameters to the RestoreAddressToClassic operation. 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.

Class RestoreAddressToClassicResponse

This is the response object from the RestoreAddressToClassic operation.

Class RestoreManagedPrefixListVersionRequest

Container for the parameters to the RestoreManagedPrefixListVersion operation. Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

Class RestoreManagedPrefixListVersionResponse

This is the response object from the RestoreManagedPrefixListVersion operation.

Class RevokeClientVpnIngressRequest

Container for the parameters to the RevokeClientVpnIngress operation. Removes an ingress authorization rule from a Client VPN endpoint.

Class RevokeClientVpnIngressResponse

This is the response object from the RevokeClientVpnIngress operation.

Class RevokeSecurityGroupEgressRequest

Container for the parameters to the RevokeSecurityGroupEgress operation. [VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.

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.

[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.

Class RevokeSecurityGroupEgressResponse

This is the response object from the RevokeSecurityGroupEgress operation.

Class RevokeSecurityGroupIngressRequest

Container for the parameters to the RevokeSecurityGroupIngress operation. 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.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

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.

Class RevokeSecurityGroupIngressResponse

This is the response object from the RevokeSecurityGroupIngress operation.

Class Route

Describes a route in a route table.

Class RouteTable

Describes a route table.

Class RouteTableAssociation

Describes an association between a route table and a subnet or gateway.

Class RouteTableAssociationState

Describes the state of an association between a route table and a subnet or gateway.

Class RunInstancesRequest

Container for the parameters to the RunInstances operation. Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.

Class RunInstancesResponse

Contains the response data from the RunInstances operation.

Class RunScheduledInstancesRequest

Container for the parameters to the RunScheduledInstances operation. Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.

Class RunScheduledInstancesResponse

Contains the output of RunScheduledInstances.

Class S3ObjectTag

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.

Class S3Storage

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

Class ScheduledInstance

Describes a Scheduled Instance.

Class ScheduledInstanceAvailability

Describes a schedule that is available for your Scheduled Instances.

Class ScheduledInstanceRecurrence

Describes the recurring schedule for a Scheduled Instance.

Class ScheduledInstanceRecurrenceRequest

Describes the recurring schedule for a Scheduled Instance.

Class ScheduledInstancesBlockDeviceMapping

Describes a block device mapping for a Scheduled Instance.

Class ScheduledInstancesEbs

Describes an EBS volume for a Scheduled Instance.

Class ScheduledInstancesIamInstanceProfile

Describes an IAM instance profile for a Scheduled Instance.

Class ScheduledInstancesIpv6Address

Describes an IPv6 address.

Class ScheduledInstancesLaunchSpecification

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

Class ScheduledInstancesMonitoring

Describes whether monitoring is enabled for a Scheduled Instance.

Class ScheduledInstancesNetworkInterface

Describes a network interface for a Scheduled Instance.

Class ScheduledInstancesPlacement

Describes the placement for a Scheduled Instance.

Class ScheduledInstancesPrivateIpAddressConfig

Describes a private IPv4 address for a Scheduled Instance.

Class SearchLocalGatewayRoutesRequest

Container for the parameters to the SearchLocalGatewayRoutes operation. Searches for routes in the specified local gateway route table.

Class SearchLocalGatewayRoutesResponse

This is the response object from the SearchLocalGatewayRoutes operation.

Class SearchTransitGatewayMulticastGroupsRequest

Container for the parameters to the SearchTransitGatewayMulticastGroups operation. Searches one or more transit gateway multicast groups and returns the group membership information.

Class SearchTransitGatewayMulticastGroupsResponse

This is the response object from the SearchTransitGatewayMulticastGroups operation.

Class SearchTransitGatewayRoutesRequest

Container for the parameters to the SearchTransitGatewayRoutes operation. Searches for routes in the specified transit gateway route table.

Class SearchTransitGatewayRoutesResponse

This is the response object from the SearchTransitGatewayRoutes operation.

Class SecurityGroup

Describes a security group.

Class SecurityGroupIdentifier

Describes a security group.

Class SecurityGroupReference

Describes a VPC with a security group that references your security group.

Class SecurityGroupRule

Describes a security group rule.

Class SecurityGroupRuleDescription

Describes the description of a security group rule.

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

Class SecurityGroupRuleRequest

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:

  • CidrIpv4

  • CidrIpv6

  • PrefixListId

  • ReferencedGroupId

When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.

Class SecurityGroupRuleUpdate

Describes an update to a security group rule.

Class SendDiagnosticInterruptRequest

Container for the parameters to the SendDiagnosticInterrupt operation. 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 (Linux instances) or Send a Diagnostic Interrupt (Windows instances).

Class SendDiagnosticInterruptResponse

This is the response object from the SendDiagnosticInterrupt operation.

Class ServiceConfiguration

Describes a service configuration for a VPC endpoint service.

Class ServiceDetail

Describes a VPC endpoint service.

Class ServiceTypeDetail

Describes the type of service for a VPC endpoint.

Class SlotDateTimeRangeRequest

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

Class SlotStartTimeRangeRequest

Describes the time period for a Scheduled Instance to start its first schedule.

Class Snapshot

Describes a snapshot.

Class SnapshotDetail

Describes the snapshot created from the imported disk.

Class SnapshotDiskContainer

The disk container object for the import snapshot request.

Class SnapshotInfo

Information about a snapshot.

Class SnapshotTaskDetail

Details about the import snapshot task.

Class SpotCapacityRebalance

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.

Class SpotDatafeedSubscription

Describes the data feed for a Spot Instance.

Class SpotFleetLaunchSpecification

Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

Class SpotFleetMonitoring

Describes whether monitoring is enabled.

Class SpotFleetRequestConfig

Describes a Spot Fleet request.

Class SpotFleetRequestConfigData

Describes the configuration of a Spot Fleet request.

Class SpotFleetTagSpecification

The tags for a Spot Fleet resource.

Class SpotInstanceRequest

Describes a Spot Instance request.

Class SpotInstanceStateFault

Describes a Spot Instance state change.

Class SpotInstanceStatus

Describes the status of a Spot Instance request.

Class SpotMaintenanceStrategies

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Class SpotMarketOptions

The options for Spot Instances.

Class SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

Class SpotOptionsRequest

Describes the configuration of Spot Instances in an EC2 Fleet request.

Class SpotPlacement

Describes Spot Instance placement.

Class SpotPrice

Describes the maximum price per hour that you are willing to pay for a Spot Instance.

Class StaleIpPermission

Describes a stale rule in a security group.

Class StaleSecurityGroup

Describes a stale security group (a security group that contains stale rules).

Class StartInstancesRequest

Container for the parameters to the StartInstances operation. 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 unlimted 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 Stopping instances in the Amazon EC2 User Guide.

Class StartInstancesResponse

This is the response object from the StartInstances operation.

Class StartNetworkInsightsAnalysisRequest

Container for the parameters to the StartNetworkInsightsAnalysis operation. Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

Class StartNetworkInsightsAnalysisResponse

This is the response object from the StartNetworkInsightsAnalysis operation.

Class StartVpcEndpointServicePrivateDnsVerificationRequest

Container for the parameters to the StartVpcEndpointServicePrivateDnsVerification operation. 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. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.

Class StartVpcEndpointServicePrivateDnsVerificationResponse

This is the response object from the StartVpcEndpointServicePrivateDnsVerification operation.

Class StateReason

Describes a state change.

Class StopInstancesRequest

Container for the parameters to the StopInstances operation. Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide.

Class StopInstancesResponse

This is the response object from the StopInstances operation.

Class Storage

Describes the storage location for an instance store-backed AMI.

Class StorageLocation

Describes a storage location in Amazon S3.

Class StoreImageTaskResult

The information about the AMI store task, including the progress of the task.

Class Subnet

Describes a subnet.

Class SubnetAssociation

Describes the subnet association with the transit gateway multicast domain.

Class SubnetCidrBlockState

Describes the state of a CIDR block.

Class SubnetCidrReservation

Describes a subnet CIDR reservation.

Class SubnetIpv6CidrBlockAssociation

Describes an IPv6 CIDR block associated with a subnet.

Class SuccessfulInstanceCreditSpecificationItem

Describes the burstable performance instance whose credit option for CPU usage was successfully modified.

Class SuccessfulQueuedPurchaseDeletion

Describes a Reserved Instance whose queued purchase was successfully deleted.

Class Tag

Describes a tag.

Class TagDescription

Describes a tag.

Class TagSpecification

The tags to apply to a resource when the resource is being created.

Class TargetCapacitySpecification

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.

Class TargetCapacitySpecificationRequest

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.

Class TargetConfiguration

Information about the Convertible Reserved Instance offering.

Class TargetConfigurationRequest

Details about the target configuration.

Class TargetGroup

Describes a load balancer target group.

Class TargetGroupsConfig

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.

Class TargetNetwork

Describes a target network associated with a Client VPN endpoint.

Class TargetReservationValue

The total value of the new Convertible Reserved Instances.

Class TerminateClientVpnConnectionsRequest

Container for the parameters to the TerminateClientVpnConnections operation. 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.

Class TerminateClientVpnConnectionsResponse

This is the response object from the TerminateClientVpnConnections operation.

Class TerminateConnectionStatus

Information about a terminated Client VPN endpoint client connection.

Class TerminateInstancesRequest

Container for the parameters to the TerminateInstances operation. 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.

Class TerminateInstancesResponse

This is the response object from the TerminateInstances operation.

Class TrafficMirrorFilter

Describes the Traffic Mirror filter.

Class TrafficMirrorFilterRule

Describes the Traffic Mirror rule.

Class TrafficMirrorPortRange

Describes the Traffic Mirror port range.

Class TrafficMirrorPortRangeRequest

Information about the Traffic Mirror filter rule port range.

Class TrafficMirrorSession

Describes a Traffic Mirror session.

Class TrafficMirrorTarget

Describes a Traffic Mirror target.

Class TransitGateway

Describes a transit gateway.

Class TransitGatewayAssociation

Describes an association between a resource attachment and a transit gateway route table.

Class TransitGatewayAttachment

Describes an attachment between a resource and a transit gateway.

Class TransitGatewayAttachmentAssociation

Describes an association.

Class TransitGatewayAttachmentBgpConfiguration

The BGP configuration information.

Class TransitGatewayAttachmentPropagation

Describes a propagation route table.

Class TransitGatewayConnect

Describes a transit gateway Connect attachment.

Class TransitGatewayConnectOptions

Describes the Connect attachment options.

Class TransitGatewayConnectPeer

Describes a transit gateway Connect peer.

Class TransitGatewayConnectPeerConfiguration

Describes the Connect peer details.

Class TransitGatewayConnectRequestBgpOptions

The BGP options for the Connect attachment.

Class TransitGatewayMulticastDeregisteredGroupMembers

Describes the deregistered transit gateway multicast group members.

Class TransitGatewayMulticastDeregisteredGroupSources

Describes the deregistered transit gateway multicast group sources.

Class TransitGatewayMulticastDomain

Describes the transit gateway multicast domain.

Class TransitGatewayMulticastDomainAssociation

Describes the resources associated with the transit gateway multicast domain.

Class TransitGatewayMulticastDomainAssociations

Describes the multicast domain associations.

Class TransitGatewayMulticastDomainOptions

Describes the options for a transit gateway multicast domain.

Class TransitGatewayMulticastGroup

Describes the transit gateway multicast group resources.

Class TransitGatewayMulticastRegisteredGroupMembers

Describes the registered transit gateway multicast group members.

Class TransitGatewayMulticastRegisteredGroupSources

Describes the members registered with the transit gateway multicast group.

Class TransitGatewayOptions

Describes the options for a transit gateway.

Class TransitGatewayPeeringAttachment

Describes the transit gateway peering attachment.

Class TransitGatewayPrefixListAttachment

Describes a transit gateway prefix list attachment.

Class TransitGatewayPrefixListReference

Describes a prefix list reference.

Class TransitGatewayPropagation

Describes route propagation.

Class TransitGatewayRequestOptions

Describes the options for a transit gateway.

Class TransitGatewayRoute

Describes a route for a transit gateway route table.

Class TransitGatewayRouteAttachment

Describes a route attachment.

Class TransitGatewayRouteTable

Describes a transit gateway route table.

Class TransitGatewayRouteTableAssociation

Describes an association between a route table and a resource attachment.

Class TransitGatewayRouteTablePropagation

Describes a route table propagation.

Class TransitGatewayVpcAttachment

Describes a VPC attachment.

Class TransitGatewayVpcAttachmentOptions

Describes the VPC attachment options.

Class TrunkInterfaceAssociation

Currently available in limited preview only. If you are interested in using this feature, contact your account manager.

Information about an association between a branch network interface with a trunk network interface.

Class TunnelOption

The VPN tunnel options.

Class UnassignIpv6AddressesRequest

Container for the parameters to the UnassignIpv6Addresses operation. Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

Class UnassignIpv6AddressesResponse

This is the response object from the UnassignIpv6Addresses operation.

Class UnassignPrivateIpAddressesRequest

Container for the parameters to the UnassignPrivateIpAddresses operation. Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.

Class UnassignPrivateIpAddressesResponse

This is the response object from the UnassignPrivateIpAddresses operation.

Class UnmonitorInstancesRequest

Container for the parameters to the UnmonitorInstances operation. Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.

Class UnmonitorInstancesResponse

This is the response object from the UnmonitorInstances operation.

Class UnsuccessfulInstanceCreditSpecificationItem

Describes the burstable performance instance whose credit option for CPU usage was not modified.

Class UnsuccessfulInstanceCreditSpecificationItemError

Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.

Class UnsuccessfulItem

Information about items that were not successfully processed in a batch call.

Class UnsuccessfulItemError

Information about the error that occurred. For more information about errors, see Error codes.

Class UpdateSecurityGroupRuleDescriptionsEgressRequest

Container for the parameters to the UpdateSecurityGroupRuleDescriptionsEgress operation. [VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

Class UpdateSecurityGroupRuleDescriptionsEgressResponse

This is the response object from the UpdateSecurityGroupRuleDescriptionsEgress operation.

Class UpdateSecurityGroupRuleDescriptionsIngressRequest

Container for the parameters to the UpdateSecurityGroupRuleDescriptionsIngress operation. 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.

Class UpdateSecurityGroupRuleDescriptionsIngressResponse

This is the response object from the UpdateSecurityGroupRuleDescriptionsIngress operation.

Class UserBucket

Describes the Amazon S3 bucket for the disk image.

Class UserBucketDetails

Describes the Amazon S3 bucket for the disk image.

Class UserData

Describes the user data for an instance.

Class UserIdGroupPair

Describes a security group and Amazon Web Services account ID pair.

Class ValidationError

The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.

Class ValidationWarning

The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created.

Class VCpuInfo

Describes the vCPU configurations for the instance type.

Class VgwTelemetry

Describes telemetry for a VPN tunnel.

Class Volume

Describes a volume.

Class VolumeAttachment

Describes volume attachment details.

Class VolumeDetail

Describes an EBS volume.

Class VolumeModification

Describes the modification status of an EBS volume.

If the volume has never been modified, some element values will be null.

Class VolumeStatusAction

Describes a volume status operation code.

Class VolumeStatusAttachmentStatus

Information about the instances to which the volume is attached.

Class VolumeStatusDetails

Describes a volume status.

Class VolumeStatusEvent

Describes a volume status event.

Class VolumeStatusInfo

Describes the status of a volume.

Class VolumeStatusItem

Describes the volume status.

Class Vpc

Describes a VPC.

Class VpcAttachment

Describes an attachment between a virtual private gateway and a VPC.

Class VpcCidrBlockAssociation

Describes an IPv4 CIDR block associated with a VPC.

Class VpcCidrBlockState

Describes the state of a CIDR block.

Class VpcClassicLink

Describes whether a VPC is enabled for ClassicLink.

Class VpcEndpoint

Describes a VPC endpoint.

Class VpcEndpointConnection

Describes a VPC endpoint connection to a service.

Class VpcIpv6CidrBlockAssociation

Describes an IPv6 CIDR block associated with a VPC.

Class VpcPeeringConnection

Describes a VPC peering connection.

Class VpcPeeringConnectionOptionsDescription

Describes the VPC peering connection options.

Class VpcPeeringConnectionStateReason

Describes the status of a VPC peering connection.

Class VpcPeeringConnectionVpcInfo

Describes a VPC in a VPC peering connection.

Class VpnConnection

Describes a VPN connection.

Class VpnConnectionOptions

Describes VPN connection options.

Class VpnConnectionOptionsSpecification

Describes VPN connection options.

Class VpnGateway

Describes a virtual private gateway.

Class VpnStaticRoute

Describes a static route for a VPN connection.

Class VpnTunnelOptionsSpecification

The tunnel options for a single VPN tunnel.

Class WithdrawByoipCidrRequest

Container for the parameters to the WithdrawByoipCidr operation. 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.

Class WithdrawByoipCidrResponse

This is the response object from the WithdrawByoipCidr operation.

Interfaces

NameDescription
Interface IDescribeAddressesAttributePaginator

Paginator for the DescribeAddressesAttribute operation

Interface IDescribeByoipCidrsPaginator

Paginator for the DescribeByoipCidrs operation

Interface IDescribeCapacityReservationsPaginator

Paginator for the DescribeCapacityReservations operation

Interface IDescribeCarrierGatewaysPaginator

Paginator for the DescribeCarrierGateways operation

Interface IDescribeClassicLinkInstancesPaginator

Paginator for the DescribeClassicLinkInstances operation

Interface IDescribeClientVpnAuthorizationRulesPaginator

Paginator for the DescribeClientVpnAuthorizationRules operation

Interface IDescribeClientVpnConnectionsPaginator

Paginator for the DescribeClientVpnConnections operation

Interface IDescribeClientVpnEndpointsPaginator

Paginator for the DescribeClientVpnEndpoints operation

Interface IDescribeClientVpnRoutesPaginator

Paginator for the DescribeClientVpnRoutes operation

Interface IDescribeClientVpnTargetNetworksPaginator

Paginator for the DescribeClientVpnTargetNetworks operation

Interface IDescribeCoipPoolsPaginator

Paginator for the DescribeCoipPools operation

Interface IDescribeDhcpOptionsPaginator

Paginator for the DescribeDhcpOptions operation

Interface IDescribeEgressOnlyInternetGatewaysPaginator

Paginator for the DescribeEgressOnlyInternetGateways operation

Interface IDescribeExportImageTasksPaginator

Paginator for the DescribeExportImageTasks operation

Interface IDescribeFastSnapshotRestoresPaginator

Paginator for the DescribeFastSnapshotRestores operation

Interface IDescribeFleetsPaginator

Paginator for the DescribeFleets operation

Interface IDescribeFlowLogsPaginator

Paginator for the DescribeFlowLogs operation

Interface IDescribeFpgaImagesPaginator

Paginator for the DescribeFpgaImages operation

Interface IDescribeHostReservationOfferingsPaginator

Paginator for the DescribeHostReservationOfferings operation

Interface IDescribeHostReservationsPaginator

Paginator for the DescribeHostReservations operation

Interface IDescribeHostsPaginator

Paginator for the DescribeHosts operation

Interface IDescribeIamInstanceProfileAssociationsPaginator

Paginator for the DescribeIamInstanceProfileAssociations operation

Interface IDescribeImportImageTasksPaginator

Paginator for the DescribeImportImageTasks operation

Interface IDescribeImportSnapshotTasksPaginator

Paginator for the DescribeImportSnapshotTasks operation

Interface IDescribeInstanceCreditSpecificationsPaginator

Paginator for the DescribeInstanceCreditSpecifications operation

Interface IDescribeInstanceEventWindowsPaginator

Paginator for the DescribeInstanceEventWindows operation

Interface IDescribeInstancesPaginator

Paginator for the DescribeInstances operation

Interface IDescribeInstanceStatusPaginator

Paginator for the DescribeInstanceStatus operation

Interface IDescribeInstanceTypeOfferingsPaginator

Paginator for the DescribeInstanceTypeOfferings operation

Interface IDescribeInstanceTypesPaginator

Paginator for the DescribeInstanceTypes operation

Interface IDescribeInternetGatewaysPaginator

Paginator for the DescribeInternetGateways operation

Interface IDescribeIpv6PoolsPaginator

Paginator for the DescribeIpv6Pools operation

Interface IDescribeLaunchTemplatesPaginator

Paginator for the DescribeLaunchTemplates operation

Interface IDescribeLaunchTemplateVersionsPaginator

Paginator for the DescribeLaunchTemplateVersions operation

Interface IDescribeLocalGatewayRouteTablesPaginator

Paginator for the DescribeLocalGatewayRouteTables operation

Interface IDescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator

Paginator for the DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations operation

Interface IDescribeLocalGatewayRouteTableVpcAssociationsPaginator

Paginator for the DescribeLocalGatewayRouteTableVpcAssociations operation

Interface IDescribeLocalGatewaysPaginator

Paginator for the DescribeLocalGateways operation

Interface IDescribeLocalGatewayVirtualInterfaceGroupsPaginator

Paginator for the DescribeLocalGatewayVirtualInterfaceGroups operation

Interface IDescribeLocalGatewayVirtualInterfacesPaginator

Paginator for the DescribeLocalGatewayVirtualInterfaces operation

Interface IDescribeManagedPrefixListsPaginator

Paginator for the DescribeManagedPrefixLists operation

Interface IDescribeMovingAddressesPaginator

Paginator for the DescribeMovingAddresses operation

Interface IDescribeNatGatewaysPaginator

Paginator for the DescribeNatGateways operation

Interface IDescribeNetworkAclsPaginator

Paginator for the DescribeNetworkAcls operation

Interface IDescribeNetworkInsightsAnalysesPaginator

Paginator for the DescribeNetworkInsightsAnalyses operation

Interface IDescribeNetworkInsightsPathsPaginator

Paginator for the DescribeNetworkInsightsPaths operation

Interface IDescribeNetworkInterfacePermissionsPaginator

Paginator for the DescribeNetworkInterfacePermissions operation

Interface IDescribeNetworkInterfacesPaginator

Paginator for the DescribeNetworkInterfaces operation

Interface IDescribePrefixListsPaginator

Paginator for the DescribePrefixLists operation

Interface IDescribePrincipalIdFormatPaginator

Paginator for the DescribePrincipalIdFormat operation

Interface IDescribePublicIpv4PoolsPaginator

Paginator for the DescribePublicIpv4Pools operation

Interface IDescribeReplaceRootVolumeTasksPaginator

Paginator for the DescribeReplaceRootVolumeTasks operation

Interface IDescribeReservedInstancesModificationsPaginator

Paginator for the DescribeReservedInstancesModifications operation

Interface IDescribeReservedInstancesOfferingsPaginator

Paginator for the DescribeReservedInstancesOfferings operation

Interface IDescribeRouteTablesPaginator

Paginator for the DescribeRouteTables operation

Interface IDescribeScheduledInstanceAvailabilityPaginator

Paginator for the DescribeScheduledInstanceAvailability operation

Interface IDescribeScheduledInstancesPaginator

Paginator for the DescribeScheduledInstances operation

Interface IDescribeSecurityGroupRulesPaginator

Paginator for the DescribeSecurityGroupRules operation

Interface IDescribeSecurityGroupsPaginator

Paginator for the DescribeSecurityGroups operation

Interface IDescribeSnapshotsPaginator

Paginator for the DescribeSnapshots operation

Interface IDescribeSpotFleetRequestsPaginator

Paginator for the DescribeSpotFleetRequests operation

Interface IDescribeSpotInstanceRequestsPaginator

Paginator for the DescribeSpotInstanceRequests operation

Interface IDescribeSpotPriceHistoryPaginator

Paginator for the DescribeSpotPriceHistory operation

Interface IDescribeStaleSecurityGroupsPaginator

Paginator for the DescribeStaleSecurityGroups operation

Interface IDescribeStoreImageTasksPaginator

Paginator for the DescribeStoreImageTasks operation

Interface IDescribeSubnetsPaginator

Paginator for the DescribeSubnets operation

Interface IDescribeTagsPaginator

Paginator for the DescribeTags operation

Interface IDescribeTrafficMirrorFiltersPaginator

Paginator for the DescribeTrafficMirrorFilters operation

Interface IDescribeTrafficMirrorSessionsPaginator

Paginator for the DescribeTrafficMirrorSessions operation

Interface IDescribeTrafficMirrorTargetsPaginator

Paginator for the DescribeTrafficMirrorTargets operation

Interface IDescribeTransitGatewayAttachmentsPaginator

Paginator for the DescribeTransitGatewayAttachments operation

Interface IDescribeTransitGatewayConnectPeersPaginator

Paginator for the DescribeTransitGatewayConnectPeers operation

Interface IDescribeTransitGatewayConnectsPaginator

Paginator for the DescribeTransitGatewayConnects operation

Interface IDescribeTransitGatewayMulticastDomainsPaginator

Paginator for the DescribeTransitGatewayMulticastDomains operation

Interface IDescribeTransitGatewayPeeringAttachmentsPaginator

Paginator for the DescribeTransitGatewayPeeringAttachments operation

Interface IDescribeTransitGatewayRouteTablesPaginator

Paginator for the DescribeTransitGatewayRouteTables operation

Interface IDescribeTransitGatewaysPaginator

Paginator for the DescribeTransitGateways operation

Interface IDescribeTransitGatewayVpcAttachmentsPaginator

Paginator for the DescribeTransitGatewayVpcAttachments operation

Interface IDescribeTrunkInterfaceAssociationsPaginator

Paginator for the DescribeTrunkInterfaceAssociations operation

Interface IDescribeVolumesModificationsPaginator

Paginator for the DescribeVolumesModifications operation

Interface IDescribeVolumesPaginator

Paginator for the DescribeVolumes operation

Interface IDescribeVolumeStatusPaginator

Paginator for the DescribeVolumeStatus operation

Interface IDescribeVpcClassicLinkDnsSupportPaginator

Paginator for the DescribeVpcClassicLinkDnsSupport operation

Interface IDescribeVpcEndpointConnectionNotificationsPaginator

Paginator for the DescribeVpcEndpointConnectionNotifications operation

Interface IDescribeVpcEndpointConnectionsPaginator

Paginator for the DescribeVpcEndpointConnections operation

Interface IDescribeVpcEndpointServiceConfigurationsPaginator

Paginator for the DescribeVpcEndpointServiceConfigurations operation

Interface IDescribeVpcEndpointServicePermissionsPaginator

Paginator for the DescribeVpcEndpointServicePermissions operation

Interface IDescribeVpcEndpointsPaginator

Paginator for the DescribeVpcEndpoints operation

Interface IDescribeVpcPeeringConnectionsPaginator

Paginator for the DescribeVpcPeeringConnections operation

Interface IDescribeVpcsPaginator

Paginator for the DescribeVpcs operation

Interface IEC2PaginatorFactory

Paginators for the EC2 service

Interface IGetAssociatedIpv6PoolCidrsPaginator

Paginator for the GetAssociatedIpv6PoolCidrs operation

Interface IGetGroupsForCapacityReservationPaginator

Paginator for the GetGroupsForCapacityReservation operation

Interface IGetManagedPrefixListAssociationsPaginator

Paginator for the GetManagedPrefixListAssociations operation

Interface IGetManagedPrefixListEntriesPaginator

Paginator for the GetManagedPrefixListEntries operation

Interface IGetTransitGatewayAttachmentPropagationsPaginator

Paginator for the GetTransitGatewayAttachmentPropagations operation

Interface IGetTransitGatewayMulticastDomainAssociationsPaginator

Paginator for the GetTransitGatewayMulticastDomainAssociations operation

Interface IGetTransitGatewayPrefixListReferencesPaginator

Paginator for the GetTransitGatewayPrefixListReferences operation

Interface IGetTransitGatewayRouteTableAssociationsPaginator

Paginator for the GetTransitGatewayRouteTableAssociations operation

Interface IGetTransitGatewayRouteTablePropagationsPaginator

Paginator for the GetTransitGatewayRouteTablePropagations operation

Interface ISearchLocalGatewayRoutesPaginator

Paginator for the SearchLocalGatewayRoutes operation

Interface ISearchTransitGatewayMulticastGroupsPaginator

Paginator for the SearchTransitGatewayMulticastGroups operation