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

Contains the output of AcceptVpcPeeringConnection.

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 Address

Describes an Elastic IP address.

Class AllocateAddressRequest

Container for the parameters to the AllocateAddress operation. Allocates an Elastic IP address.

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.

If you release an Elastic IP address for use in a VPC, you might be able to recover it. To recover an Elastic IP address that you released, specify it in the Address parameter. Note that you cannot recover an Elastic IP address that you released after it is allocated to another AWS account.

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

Class AllocateAddressResponse

Contains the output of AllocateAddress.

Class AllocateHostsRequest

Container for the parameters to the AllocateHosts operation. Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

Class AllocateHostsResponse

Contains the output of AllocateHosts.

Class AllowedPrincipal

Describes a principal.

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.

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.

AssignPrivateIpAddresses is available only in EC2-VPC.

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 with an instance or a network interface.

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

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

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

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

Class AssociateAddressResponse

Contains the output of AssociateAddress.

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 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 AssociateRouteTableRequest

Container for the parameters to the AssociateRouteTable operation. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

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

Class AssociateRouteTableResponse

Contains the output of AssociateRouteTable.

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 AssociateVpcCidrBlockRequest

Container for the parameters to the AssociateVpcCidrBlock operation. Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56.

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

Contains the output of AttachClassicLinkVpc.

Class AttachInternetGatewayRequest

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

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 may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

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

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 Managed VPN Connections in the Amazon Virtual Private Cloud User Guide.

Class AttachVpnGatewayResponse

Contains the output of AttachVpnGateway.

Class AuthorizeSecurityGroupEgressRequest

Container for the parameters to the AuthorizeSecurityGroupEgress operation. [EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination IPv4 or IPv6 CIDR address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. For more information about security group limits, see Amazon VPC Limits.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. You can optionally specify a description for the rule.

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

Class AuthorizeSecurityGroupEgressResponse

This is the response object from the AuthorizeSecurityGroupEgress operation.

Class AuthorizeSecurityGroupIngressRequest

Container for the parameters to the AuthorizeSecurityGroupIngress operation. Adds one or more ingress rules to a security group.

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

[EC2-Classic] This action gives one or more IPv4 CIDR address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another. You can have up to 100 rules per group.

[EC2-VPC] This action gives one or more IPv4 or IPv6 CIDR address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC or a peer VPC in a VPC peering connection. For more information about VPC security group limits, see Amazon VPC Limits.

You can optionally specify a description for the security group rule.

Class AuthorizeSecurityGroupIngressResponse

This is the response object from the AuthorizeSecurityGroupIngress operation.

Class AvailabilityZone

Describes an Availability Zone.

Class AvailabilityZoneMessage

Describes a message about an Availability Zone.

Class AvailableCapacity

The capacity information for instances launched onto the Dedicated Host.

Class BlockDeviceMapping

Describes a block device mapping.

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.

For more information, see Creating an Instance Store-Backed Windows AMI.

Class BundleInstanceResponse

Contains the output of BundleInstance.

Class BundleTask

Describes a bundle task.

Class BundleTaskError

Describes an error for BundleInstance.

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

Contains the output for CancelImportTask.

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 Elastic Compute Cloud 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. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

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

Class CancelSpotInstanceRequestsResponse

Contains the output of CancelSpotInstanceRequests.

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 ClientData

Describes the client-specific data.

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

Contains the output of ConfirmProductInstance.

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 from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

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

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 the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

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

Class CopySnapshotResponse

Contains the output of CopySnapshot.

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 may be behind a device performing network address translation (NAT).

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

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

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.

You can create a default VPC if you deleted your previous 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

Contains the output of CreateDefaultVpc.

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. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

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

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

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

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

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

Class CreateDhcpOptionsResponse

Contains the output of CreateDhcpOptions.

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 CreateFlowLogsRequest

Container for the parameters to the CreateFlowLogs operation. Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

Class CreateFlowLogsResponse

Contains the output of CreateFlowLogs.

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 one or more 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 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

Contains the output of CreateImage.

Class CreateInstanceExportTaskRequest

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

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

Class CreateInstanceExportTaskResponse

Contains the output for CreateInstanceExportTask.

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

Contains the output of CreateInternetGateway.

Class CreateKeyPairRequest

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

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any region using ImportKeyPair.

For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

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.

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.

Class CreateLaunchTemplateVersionResponse

This is the response object from the CreateLaunchTemplateVersion operation.

Class CreateNatGatewayRequest

Container for the parameters to the CreateNatGateway operation. Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

Class CreateNatGatewayResponse

Contains the output of CreateNatGateway.

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 about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Class CreateNetworkAclResponse

Contains the output of CreateNetworkAcl.

Class CreateNetworkInterfacePermissionRequest

Container for the parameters to the CreateNetworkInterfacePermission operation. Grants an AWS authorized partner account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single AWS account only, and only one account at a time.

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.

For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Class CreatePlacementGroupResponse

This is the response object from the CreatePlacementGroup 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 with a capacity reservation can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances and Standard Reserved Instances with a regional benefit cannot be sold.

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

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

Class CreateReservedInstancesListingResponse

Contains the output of CreateReservedInstancesListing.

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, or egress-only Internet gateway.

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

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

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

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

Class CreateRouteResponse

Contains the output of CreateRoute.

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 about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

Class CreateRouteTableResponse

Contains the output of CreateRouteTable.

Class CreateSecurityGroupRequest

Container for the parameters to the CreateSecurityGroup operation. Creates a security group.

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

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

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

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

Class CreateSecurityGroupResponse

Contains the output of CreateSecurityGroup.

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.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

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

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

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

Class CreateSnapshotResponse

Contains the response data from the CreateSnapshot 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 AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

Class CreateSpotDatafeedSubscriptionResponse

Contains the output of CreateSpotDatafeedSubscription.

Class CreateSubnetRequest

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

When you create each subnet, you provide the VPC ID and the IPv4 CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).

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

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

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

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

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

Class CreateSubnetResponse

Contains the output of CreateSubnet.

Class CreateTagsRequest

Container for the parameters to the CreateTags operation. Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

Class CreateTagsResponse

This is the response object from the CreateTags operation.

Class CreateVolumePermission

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

Class CreateVolumePermissionModifications

Describes modifications to the 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. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources.

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

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

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. Service consumers can create an interface VPC endpoint to connect to your service.

To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services 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 AWS account and can be in a different region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

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

Contains the output of CreateVpcPeeringConnection.

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). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.

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

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

Class CreateVpcResponse

Contains the output of CreateVpc.

Class CreateVpnConnectionRequest

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

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

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

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

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

For more information, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud 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 about VPN connections, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud 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 about virtual private gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide.

Class CreateVpnGatewayResponse

Contains the output of CreateVpnGateway.

Class CreditSpecification

Describes the credit option for CPU usage of a T2 instance.

Class CreditSpecificationRequest

The credit option for CPU usage of a T2 instance.

Class CustomerGateway

Describes a customer gateway.

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 DeleteFlowLogsRequest

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

Class DeleteFlowLogsResponse

Contains the output of DeleteFlowLogs.

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 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 DeleteNatGatewayRequest

Container for the parameters to the DeleteNatGateway operation. Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

Class DeleteNatGatewayResponse

Contains the output of DeleteNatGateway.

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 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 Elastic Compute Cloud User Guide.

Class DeletePlacementGroupResponse

This is the response object from the DeletePlacementGroup 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 Deleting 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 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 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 may remain in the deleting state for several minutes.

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

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. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes 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.

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 using the new configuration information returned with the new VPN connection ID.

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. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

Class DeleteVpnGatewayResponse

This is the response object from the DeleteVpnGateway 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 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: The maximum number of On-Demand instances that you can run.

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

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

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

Class DescribeAccountAttributesResponse

Contains the output of DescribeAccountAttributes.

Class DescribeAddressesRequest

Container for the parameters to the DescribeAddresses operation. Describes one or more of your Elastic IP addresses.

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

Class DescribeAddressesResponse

Contains the output of DescribeAddresses.

Class DescribeAvailabilityZonesRequest

Container for the parameters to the DescribeAvailabilityZones operation. Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

Class DescribeAvailabilityZonesResponse

Contains the output of DescribeAvailabiltyZones.

Class DescribeBundleTasksRequest

Container for the parameters to the DescribeBundleTasks operation. Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

Class DescribeBundleTasksResponse

Contains the output of DescribeBundleTasks.

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

Contains the output of DescribeClassicLinkInstances.

Class DescribeConversionTasksRequest

Container for the parameters to the DescribeConversionTasks operation. Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

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

Class DescribeConversionTasksResponse

Contains the output for DescribeConversionTasks.

Class DescribeCustomerGatewaysRequest

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

For more information about VPN customer gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud 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 about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

Class DescribeDhcpOptionsResponse

Contains the output of DescribeDhcpOptions.

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 GPUs associated with your instances. For more information about Elastic GPUs, see Amazon EC2 Elastic GPUs.

Class DescribeElasticGpusResponse

This is the response object from the DescribeElasticGpus operation.

Class DescribeExportTasksRequest

Container for the parameters to the DescribeExportTasks operation. Describes one or more of your export tasks.

Class DescribeExportTasksResponse

Contains the output for DescribeExportTasks.

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

Contains the output of DescribeFlowLogs.

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 one or more available Amazon FPGA Images (AFIs). These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.

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 the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

Class DescribeHostReservationOfferingsResponse

This is the response object from the DescribeHostReservationOfferings operation.

Class DescribeHostReservationsRequest

Container for the parameters to the DescribeHostReservations operation. Describes Dedicated Host Reservations which 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 one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

Class DescribeHostsResponse

Contains the output of DescribeHosts.

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: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

Class DescribeIdentityIdFormatResponse

Contains the output of DescribeIdentityIdFormat.

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: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

Class DescribeIdFormatResponse

Contains the output of DescribeIdFormat.

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 one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

Class DescribeImagesResponse

Contains the output of DescribeImages.

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

Contains the output for DescribeImportImageTasks.

Class DescribeImportSnapshotTasksRequest

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

Class DescribeImportSnapshotTasksResponse

Contains the output for DescribeImportSnapshotTasks.

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 one or more of your T2 instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns only the T2 instances with the unlimited credit option. 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 T2 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 T2 Instances in the Amazon Elastic Compute Cloud User Guide.

Class DescribeInstanceCreditSpecificationsResponse

This is the response object from the DescribeInstanceCreditSpecifications operation.

Class DescribeInstancesRequest

Container for the parameters to the DescribeInstances operation. Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

Class DescribeInstancesResponse

Contains the output of DescribeInstances.

Class DescribeInstanceStatusRequest

Container for the parameters to the DescribeInstanceStatus operation. Describes the status of one or more 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 Elastic Compute Cloud User Guide.

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

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

Class DescribeInstanceStatusResponse

Contains the output of DescribeInstanceStatus.

Class DescribeInternetGatewaysRequest

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

Class DescribeInternetGatewaysResponse

Contains the output of DescribeInternetGateways.

Class DescribeKeyPairsRequest

Container for the parameters to the DescribeKeyPairs operation. Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

Class DescribeKeyPairsResponse

Contains the output of DescribeKeyPairs.

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.

Class DescribeLaunchTemplateVersionsResponse

This is the response object from the DescribeLaunchTemplateVersions 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

Contains the output of DescribeMovingAddresses.

Class DescribeNatGatewaysRequest

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

Class DescribeNatGatewaysResponse

Contains the output of DescribeNatGateways.

Class DescribeNetworkAclsRequest

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

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

Class DescribeNetworkAclsResponse

Contains the output of DescribeNetworkAcls.

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 one or more of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Class DescribePlacementGroupsResponse

Contains the output of DescribePlacementGroups.

Class DescribePrefixListsRequest

Container for the parameters to the DescribePrefixLists operation. Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint.

Class DescribePrefixListsResponse

Contains the output of DescribePrefixLists.

Class DescribeRegionsRequest

Container for the parameters to the DescribeRegions operation. Describes one or more regions that are currently available to you.

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

Class DescribeRegionsResponse

Contains the output of DescribeRegions.

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 Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud 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 about route tables, 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 one or more of your Scheduled Instances.

Class DescribeScheduledInstancesResponse

Contains the output of DescribeScheduledInstances.

Class DescribeSecurityGroupReferencesRequest

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

Class DescribeSecurityGroupReferencesResponse

This is the response object from the DescribeSecurityGroupReferences operation.

Class DescribeSecurityGroupsRequest

Container for the parameters to the DescribeSecurityGroups operation. Describes one or more of your security groups.

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

Class DescribeSecurityGroupsResponse

Contains the output of DescribeSecurityGroups.

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

Contains the output of DescribeSnapshotAttribute.

Class DescribeSnapshotsRequest

Container for the parameters to the DescribeSnapshots operation. Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

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

Class DescribeSnapshotsResponse

Contains the output of DescribeSnapshots.

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 Elastic Compute Cloud User Guide.

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.

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 Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the Spot price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

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

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 Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

Class DescribeSpotPriceHistoryResponse

Contains the output of DescribeSpotPriceHistory.

Class DescribeStaleSecurityGroupsRequest

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

Class DescribeStaleSecurityGroupsResponse

This is the response object from the DescribeStaleSecurityGroups operation.

Class DescribeSubnetsRequest

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

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

Class DescribeSubnetsResponse

Contains the output of DescribeSubnets.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation. Describes one or more of the tags for your EC2 resources.

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

Class DescribeTagsResponse

Contains the output of DescribeTags.

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

Contains the output of DescribeVolumeAttribute.

Class DescribeVolumesModificationsRequest

Container for the parameters to the DescribeVolumesModifications operation. Reports the current modification status of EBS volumes.

Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications".

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.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

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

Class DescribeVolumesResponse

Contains the output of DescribeVolumes.

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 may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

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

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

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

Class DescribeVolumeStatusResponse

Contains the output of DescribeVolumeStatus.

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

Contains the output of DescribeVpcAttribute.

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

Contains the output of DescribeVpcClassicLinkDnsSupport.

Class DescribeVpcClassicLinkRequest

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

Class DescribeVpcClassicLinkResponse

Contains the output of DescribeVpcClassicLink.

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.

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

Contains the output of DescribeVpcPeeringConnections.

Class DescribeVpcsRequest

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

Class DescribeVpcsResponse

Contains the output of DescribeVpcs.

Class DescribeVpnConnectionsRequest

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

For more information about VPN connections, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud 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 about virtual private gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud 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

Contains the output of DetachClassicLinkVpc.

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 AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

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

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 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 about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Class DisableVpcClassicLinkDnsSupportResponse

Contains the output of DisableVpcClassicLinkDnsSupport.

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

Contains the output of DisableVpcClassicLink.

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 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 DisassociateRouteTableRequest

Container for the parameters to the DisassociateRouteTable operation. Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

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 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 DnsEntry

Describes a DNS entry.

Class DryRunResponse

Returns information about the DryRun response and response metadata.

Class EbsBlockDevice

Describes a block device for an EBS volume.

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 EgressOnlyInternetGateway

Describes an egress-only Internet gateway.

Class ElasticGpuAssociation

Describes the association between an instance and an Elastic GPU.

Class ElasticGpuHealth

Describes the status of an Elastic GPU.

Class ElasticGpus

Describes an Elastic GPU.

Class ElasticGpuSpecification

A specification for an Elastic GPU.

Class ElasticGpuSpecificationResponse

Describes an elastic GPU.

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 about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Class EnableVpcClassicLinkDnsSupportResponse

Contains the output of EnableVpcClassicLinkDnsSupport.

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's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Class EnableVpcClassicLinkResponse

Contains the output of EnableVpcClassicLink.

Class EventInformation

Describes a Spot Fleet event.

Class ExportTask

Describes an instance export task.

Class ExportToS3Task

Describes the format and location for an instance export task.

Class ExportToS3TaskSpecification

Describes an instance export task.

Class Filter

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

Class FleetLaunchTemplateSpecification

Describes a launch template.

Class FlowLog

Describes a flow log.

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 GetConsoleOutputRequest

Container for the parameters to the GetConsoleOutput operation. Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output, which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

Class GetConsoleOutputResponse

Contains the output of GetConsoleOutput.

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

Contains the output of the request.

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.

Class GetLaunchTemplateDataResponse

This is the response object from the GetLaunchTemplateData 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 Elastic Compute Cloud 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

Contains the output of GetPasswordData.

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 GroupIdentifier

Describes a security group.

Class HistoryRecord

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

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 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 Image

Describes an image.

Class ImageAttribute

Describes an image attribute.

Class ImageDiskContainer

Describes the disk container object for an import image task.

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

Contains the output for ImportImage.

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. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

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

Class ImportInstanceResponse

Contains the output for ImportInstance.

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 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

Class ImportKeyPairResponse

Contains the output of ImportKeyPair.

Class ImportSnapshotRequest

Container for the parameters to the ImportSnapshot operation. Imports a disk into an EBS snapshot.

Class ImportSnapshotResponse

Contains the output for ImportSnapshot.

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.For more information, see Importing Disks to Amazon EBS.

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

Class ImportVolumeResponse

Contains the output for ImportVolume.

Class ImportVolumeTaskDetails

Describes an import volume task.

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 instance type that the Dedicated Host supports.

Class InstanceCount

Describes a Reserved Instance listing state.

Class InstanceCreditSpecification

Describes the credit option for CPU usage of a T2 instance.

Class InstanceCreditSpecificationRequest

Describes the credit option for CPU usage of a T2 instance.

Class InstanceExportDetails

Describes an instance to export.

Class InstanceIpv6Address

Describes an IPv6 address.

Class InstanceIpv6AddressRequest

Describes an IPv6 address.

Class InstanceLicenseSpecification

Instance License Specification

Class InstanceMarketOptionsRequest

Describes the market (purchasing) option for the instances.

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 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 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 Ipv6CidrBlock

Describes an IPv6 CIDR block.

Class Ipv6Range

[EC2-VPC only] Describes an IPv6 range.

Class KeyPair

Describes a key pair.

Class KeyPairInfo

Describes a key pair.

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 LaunchTemplateBlockDeviceMapping

Describes a block device mapping.

Class LaunchTemplateBlockDeviceMappingRequest

Describes a block device mapping.

Class LaunchTemplateConfig

Describes a launch template and overrides.

Class LaunchTemplateEbsBlockDevice

Describes a block device for an EBS volume.

Class LaunchTemplateEbsBlockDeviceRequest

The parameters for a block device for an EBS volume.

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 LaunchTemplateInstanceNetworkInterfaceSpecification

Describes a network interface.

Class LaunchTemplateInstanceNetworkInterfaceSpecificationRequest

The parameters for a network interface.

Class LaunchTemplateOverrides

Describes overrides for a launch template.

Class LaunchTemplatePlacement

Describes the placement of an instance.

Class LaunchTemplatePlacementRequest

The placement for the 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.

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 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 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, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

Class ModifyHostsResponse

Contains the output of ModifyHosts.

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.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

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

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. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

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

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, LaunchPermission, or ProductCode.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

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.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

Class ModifyInstanceAttributeResponse

This is the response object from the ModifyInstanceAttribute operation.

Class ModifyInstanceCreditSpecificationRequest

Container for the parameters to the ModifyInstanceCreditSpecification operation. Modifies the credit option for CPU usage on a running or stopped T2 instance. The credit options are standard and unlimited.

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

Class ModifyInstanceCreditSpecificationResponse

This is the response object from the ModifyInstanceCreditSpecification operation.

Class ModifyInstancePlacementRequest

Container for the parameters to the ModifyInstancePlacement operation. Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

Class ModifyInstancePlacementResponse

Contains the output of ModifyInstancePlacement.

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 ModifyNetworkInterfaceAttributeRequest

Container for the parameters to the ModifyNetworkInterfaceAttribute operation. Modifies the specified network interface attribute. You can specify only one attribute at a time.

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 Elastic Compute Cloud User Guide.

Class ModifyReservedInstancesResponse

Contains the output of ModifyReservedInstances.

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 AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

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.

While the Spot Fleet request is being modified, it is in the modifying state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open 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 diversified, the Spot Fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

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 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 may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System.

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

With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

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

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 or gateway). 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 for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

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 discover your endpoint service.

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 a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

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 about Dedicated Instances, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

Class ModifyVpcTenancyResponse

Contains the output of ModifyVpcTenancy.

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 Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

Class MonitorInstancesResponse

Contains the output of MonitorInstances.

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

Contains the output of MoveAddressToVpc.

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 NetworkInterface

Describes a network interface.

Class NetworkInterfaceAssociation

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

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 PciId

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

Class PeeringConnectionOptions

Describes the VPC peering connection options.

Class PeeringConnectionOptionsRequest

The VPC peering connection options.

Class Placement

Describes the placement of an instance.

Class PlacementGroup

Describes a placement group.

Class PortRange

Describes a range of ports.

Class PrefixList

Describes prefixes for AWS services.

Class PrefixListId

The ID of the prefix.

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 PrivateIpAddressSpecification

Describes a secondary private IPv4 address for a network interface.

Class ProductCode

Describes a product code.

Class PropagatingVgw

Describes a virtual private gateway propagating route.

Class ProvisionedBandwidth

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

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.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

Class PurchaseReservedInstancesOfferingResponse

Contains the output of PurchaseReservedInstancesOffering.

Class PurchaseScheduledInstancesRequest

Container for the parameters to the PurchaseScheduledInstances operation. Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

Class PurchaseScheduledInstancesResponse

Contains the output of PurchaseScheduledInstances.

Class RebootInstancesRequest

Container for the parameters to the RebootInstances operation. Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

Class RebootInstancesResponse

This is the response object from the RebootInstances operation.

Class RecurringCharge

Describes a recurring charge.

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.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. To create an AMI that must retain billing codes, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

Class RegisterImageResponse

Contains the output of RegisterImage.

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 AWS account.

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

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, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

Class ReleaseHostsResponse

Contains the output of ReleaseHosts.

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 about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Class ReplaceNetworkAclAssociationResponse

Contains the output of ReplaceNetworkAclAssociation.

Class ReplaceNetworkAclEntryRequest

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

Class ReplaceNetworkAclEntryResponse

This is the response object from the ReplaceNetworkAclEntry operation.

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 or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only Internet gateway.

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

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 in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

Class ReplaceRouteTableAssociationResponse

Contains the output of ReplaceRouteTableAssociation.

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.

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

By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request; only the instance resource type is supported.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

Class RequestSpotFleetResponse

Contains the output of RequestSpotFleet.

Class RequestSpotInstancesRequest

Container for the parameters to the RequestSpotInstances operation. Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the maximum price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Class RequestSpotInstancesResponse

Contains the output of RequestSpotInstances.

Class Reservation

Describes a reservation.

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

The productCodes attribute can't be reset.

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 Virtual Private Cloud 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 on modifying snapshot permissions, see Sharing Snapshots 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

Contains the output of RestoreAddressToClassic.

Class RevokeSecurityGroupEgressRequest

Container for the parameters to the RevokeSecurityGroupEgress operation. [EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

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

Class RevokeSecurityGroupEgressResponse

This is the response object from the RevokeSecurityGroupEgress operation.

Class RevokeSecurityGroupIngressRequest

Container for the parameters to the RevokeSecurityGroupIngress operation. Removes one or more ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

[EC2-Classic security groups only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

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

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.

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

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

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 Elastic Compute Cloud User Guide.

Class RunScheduledInstancesResponse

Contains the output of RunScheduledInstances.

Class S3Storage

Describes the storage parameters for S3 and 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 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 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 SnapshotTaskDetail

Details about the import snapshot task.

Class SpotDatafeedSubscription

Describes the data feed for a Spot Instance.

Class SpotFleetLaunchSpecification

Describes the launch specification for one or more Spot Instances.

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 SpotMarketOptions

The options for Spot Instances.

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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

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

Class StartInstancesResponse

Contains the output of StartInstances.

Class StateReason

Describes a state change.

Class StopInstancesRequest

Container for the parameters to the StopInstances operation. Stops an Amazon EBS-backed instance.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't start or stop Spot Instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

Class StopInstancesResponse

Contains the output of StopInstances.

Class Storage

Describes the storage location for an instance store-backed AMI.

Class StorageLocation

Describes a storage location in Amazon S3.

Class Subnet

Describes a subnet.

Class SubnetCidrBlockState

Describes the state of a CIDR block.

Class SubnetIpv6CidrBlockAssociation

Describes an IPv6 CIDR block associated with a subnet.

Class SuccessfulInstanceCreditSpecificationItem

Describes the T2 instance whose credit option for CPU usage was successfully modified.

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 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 TargetReservationValue

The total value of the new Convertible Reserved Instances.

Class TerminateInstancesRequest

Container for the parameters to the TerminateInstances operation. Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

Class TerminateInstancesResponse

Contains the output of TerminateInstances.

Class UnassignIpv6AddressesRequest

Container for the parameters to the UnassignIpv6Addresses operation. Unassigns one or more IPv6 addresses 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 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 Elastic Compute Cloud User Guide.

Class UnmonitorInstancesResponse

Contains the output of UnmonitorInstances.

Class UnsuccessfulInstanceCreditSpecificationItem

Describes the T2 instance whose credit option for CPU usage was not modified.

Class UnsuccessfulInstanceCreditSpecificationItemError

Information about the error for the T2 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. [EC2-VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

Class UpdateSecurityGroupRuleDescriptionsEgressResponse

Contains the output of UpdateSecurityGroupRuleDescriptionsEgress.

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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

Class UpdateSecurityGroupRuleDescriptionsIngressResponse

Contains the output of UpdateSecurityGroupRuleDescriptionsIngress.

Class UserBucket

Describes the S3 bucket for the disk image.

Class UserBucketDetails

Describes the S3 bucket for the disk image.

Class UserData

Describes the user data for an instance.

Class UserIdGroupPair

Describes a security group and AWS account ID pair.

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 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 VPN connection.