Amazon.EC2.Model
Namespace with 595 public types
Classes
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 the DescribeVpcPeeringConnections request to view your
outstanding VPC peering connection requests.
AcceptVpcPeeringConnectionResponse
Contains the output of AcceptVpcPeeringConnection.
AccountAttribute
Describes an account attribute.
AccountAttributeValue
Describes a value of an account attribute.
ActiveInstance
Describes a running instance in a Spot fleet.
Address
Describes an Elastic IP address.
AllocateAddressRequest
Container for the parameters to the AllocateAddress operation.
Acquires an Elastic IP address.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For
more information, see Elastic
IP Addresses in the Amazon Elastic Compute Cloud User Guide.
AllocateAddressResponse
Contains the output of AllocateAddress.
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.
AllocateHostsResponse
Contains the output of AllocateHosts.
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.
AssignPrivateIpAddressesResponse
This is the response object from the AssignPrivateIpAddresses operation.
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.
[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.
This is an idempotent operation. If you perform the operation more than once, Amazon
EC2 doesn't return an error.
AssociateAddressResponse
Contains the output of AssociateAddress.
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.
AssociateDhcpOptionsResponse
This is the response object from the AssociateDhcpOptions operation.
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.
AssociateRouteTableResponse
Contains the output of AssociateRouteTable.
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.
AttachClassicLinkVpcResponse
Contains the output of AttachClassicLinkVpc.
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.
AttachInternetGatewayResponse
This is the response object from the AttachInternetGateway operation.
AttachNetworkInterfaceRequest
Container for the parameters to the AttachNetworkInterface operation.
Attaches a network interface to an instance.
AttachNetworkInterfaceResponse
Contains the output of AttachNetworkInterface.
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.
AttachVolumeResponse
Contains the response data from the AttachVolume operation.
AttachVpnGatewayRequest
Container for the parameters to the AttachVpnGateway operation.
Attaches a virtual private gateway to a VPC. For more information, see Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
AttachVpnGatewayResponse
Contains the output of AttachVpnGateway.
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
CIDR IP 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.
You can have up to 50 rules per security group (covering both ingress and egress rules).
Each rule consists of the protocol (for example, TCP), plus either a CIDR range or
a source group. For the TCP and UDP protocols, you must also specify the destination
port or port range. For the ICMP protocol, you must also specify the ICMP type and
code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However,
a small delay might occur.
AuthorizeSecurityGroupEgressResponse
This is the response object from the AuthorizeSecurityGroupEgress operation.
AuthorizeSecurityGroupIngressRequest
Container for the parameters to the AuthorizeSecurityGroupIngress operation.
Adds one or more ingress rules to a security group.
EC2-Classic: You can have up to 100 rules per group.
EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).
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 CIDR IP 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.
[EC2-VPC] This action gives one or more CIDR IP 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.
AuthorizeSecurityGroupIngressResponse
This is the response object from the AuthorizeSecurityGroupIngress operation.
AvailabilityZone
Describes an Availability Zone.
AvailabilityZoneMessage
Describes a message about an Availability Zone.
AvailableCapacity
The capacity information for instances launched onto the Dedicated host.
BlockDeviceMapping
Describes a block device mapping.
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.
BundleInstanceResponse
Contains the output of BundleInstance.
BundleTask
Describes a bundle task.
BundleTaskError
Describes an error for BundleInstance.
CancelBundleTaskRequest
Container for the parameters to the CancelBundleTask operation.
Cancels a bundling operation for an instance store-backed Windows instance.
CancelBundleTaskResponse
Contains the output of CancelBundleTask.
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 Using
the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon
Elastic Compute Cloud User Guide.
CancelConversionTaskResponse
This is the response object from the CancelConversionTask operation.
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.
CancelExportTaskResponse
This is the response object from the CancelExportTask operation.
CancelImportTaskRequest
Container for the parameters to the CancelImportTask operation.
Cancels an in-process import virtual machine or import snapshot task.
CancelImportTaskResponse
Contains the output for CancelImportTask.
CancelledSpotInstanceRequest
Describes a request to cancel a Spot instance.
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.
CancelReservedInstancesListingResponse
Contains the output of CancelReservedInstancesListing.
CancelSpotFleetRequestsError
Describes a Spot fleet error.
CancelSpotFleetRequestsErrorItem
Describes a Spot fleet request that was not successfully canceled.
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.
CancelSpotFleetRequestsResponse
Contains the output of CancelSpotFleetRequests.
CancelSpotFleetRequestsSuccessItem
Describes a Spot fleet request that was successfully canceled.
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 bid price that you specify exceeds the current
Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance
capacity and current Spot instance requests. For more information, see Spot
Instance Requests in the Amazon Elastic Compute Cloud User Guide.
Canceling a Spot instance request does not terminate running Spot instances associated
with the request.
CancelSpotInstanceRequestsResponse
Contains the output of CancelSpotInstanceRequests.
ClassicLinkDnsSupport
Describes the ClassicLink DNS support status of a VPC.
ClassicLinkInstance
Describes a linked EC2-Classic instance.
ClientData
Describes the client-specific data.
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
needs to verify whether another user's instance is eligible for support.
ConfirmProductInstanceResponse
Contains the output of ConfirmProductInstance.
ConversionTask
Describes a conversion task.
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, see Copying
AMIs in the Amazon Elastic Compute Cloud User Guide.
CopyImageResponse
Contains the output of CopyImage.
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.
For more information, see Copying
an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
CopySnapshotResponse
Contains the output of CopySnapshot.
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 Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address,
and BGP ASN parameter values. If you run an identical request more than one time,
the first request creates the customer gateway, and subsequent requests return information
about the existing customer gateway. The subsequent requests do not create new customer
gateway resources.
CreateCustomerGatewayResponse
Contains the output of CreateCustomerGateway.
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.
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"). 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.
CreateDhcpOptionsResponse
Contains the output of CreateDhcpOptions.
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.
CreateFlowLogsResponse
Contains the output of CreateFlowLogs.
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.
CreateImageResponse
Contains the output of CreateImage.
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
EC2 Instances in the Amazon Elastic Compute Cloud User Guide.
CreateInstanceExportTaskResponse
Contains the output for CreateInstanceExportTask.
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.
CreateInternetGatewayResponse
Contains the output of CreateInternetGateway.
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#8 private key. If a key with the specified name
already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per region.
The key pair returned to you is available only in the region in which you create it.
To create a key pair that is available in all regions, use ImportKeyPair.
For more information about key pairs, see Key
Pairs in the Amazon Elastic Compute Cloud User Guide.
CreateKeyPairResponse
Contains the response data from the CreateKeyPair operation.
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.
CreateNatGatewayResponse
Contains the output of CreateNatGateway.
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.
CreateNetworkAclEntryResponse
This is the response object from the CreateNetworkAclEntry operation.
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.
CreateNetworkAclResponse
Contains the output of CreateNetworkAcl.
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 Elastic Compute Cloud User Guide.
CreateNetworkInterfaceResponse
Contains the output of CreateNetworkInterface.
CreatePlacementGroupRequest
Container for the parameters to the CreatePlacementGroup operation.
Creates a placement group that you launch cluster instances into. You must give the
group a name that's unique within the scope of your account.
For more information about placement groups and cluster instances, see Cluster
Instances in the Amazon Elastic Compute Cloud User Guide.
CreatePlacementGroupResponse
This is the response object from the CreatePlacementGroup operation.
CreateReservedInstancesListingRequest
Container for the parameters to the CreateReservedInstancesListing operation.
Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance
Marketplace. You can submit one Reserved Instance listing at a time. To get a list
of your Reserved Instances, you can use the DescribeReservedInstances operation.
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.
To sell your 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 Reserved Instances, and
specify the upfront price to receive for them. Your Reserved Instance listings then
become available for purchase. To view the details of your Reserved Instance listing,
you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved
Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
CreateReservedInstancesListingResponse
Contains the output of CreateReservedInstancesListing.
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, or network interface.
When determining how to route traffic, we use the route with the most specific match.
For example, let's say the traffic is destined for 192.0.2.3, and the
route table includes the following two 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.
CreateRouteResponse
Contains the output of CreateRoute.
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.
CreateRouteTableResponse
Contains the output of CreateRouteTable.
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.
CreateSecurityGroupResponse
Contains the output of CreateSecurityGroup.
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.
CreateSnapshotResponse
Contains the response data from the CreateSnapshot operation.
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.
CreateSpotDatafeedSubscriptionResponse
Contains the output of CreateSpotDatafeedSubscription.
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 CIDR block you want for
the subnet. After you create a subnet, you can't change its CIDR block. The subnet's
CIDR block can be the same as the VPC's CIDR block (assuming you want only a single
subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one
subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and
VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16
netmask (65,536 IP addresses).
AWS reserves both the first four and the last IP 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.
CreateSubnetResponse
Contains the output of CreateSubnet.
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 10 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.
CreateTagsResponse
This is the response object from the CreateTags operation.
CreateVolumePermission
CreateVolumePermissionModifications
Describes modifications to the permissions for a volume.
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.
For more information, see Creating
or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User
Guide.
CreateVolumeResponse
Contains the response data from the CreateVolume operation.
CreateVpcEndpointRequest
Container for the parameters to the CreateVpcEndpoint operation.
Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create
a private connection between your VPC and another AWS service in your account. You
can specify an endpoint policy to attach to the endpoint that will control access
to the service from your VPC. You can also specify the VPC route tables that use the
endpoint.
Currently, only endpoints to Amazon S3 are supported.
CreateVpcEndpointResponse
Contains the output of CreateVpcEndpoint.
CreateVpcPeeringConnectionRequest
Container for the parameters to the CreateVpcPeeringConnection operation.
Requests a VPC peering connection between two VPCs: a requester VPC that you own and
a peer VPC with which to create the connection. The peer VPC can belong to another
AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.
The owner of the peer VPC must accept the peering request to activate the peering
connection. The VPC peering connection request expires after 7 days, after which it
cannot be accepted or rejected.
A CreateVpcPeeringConnection request between VPCs with overlapping CIDR
blocks results in the VPC peering connection having a status of failed.
CreateVpcPeeringConnectionResponse
Contains the output of CreateVpcPeeringConnection.
CreateVpcRequest
Container for the parameters to the CreateVpc operation.
Creates a VPC with the specified CIDR block.
The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest
uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your
VPC, see Your
VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
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 Virtual Private Cloud User Guide.
CreateVpcResponse
Contains the output of CreateVpc.
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 about VPN connections, see Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
CreateVpnConnectionResponse
Contains the output of CreateVpnConnection.
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 Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
CreateVpnConnectionRouteResponse
This is the response object from the CreateVpnConnectionRoute operation.
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 Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
CreateVpnGatewayResponse
Contains the output of CreateVpnGateway.
CustomerGateway
Describes a customer gateway.
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.
DeleteCustomerGatewayResponse
This is the response object from the DeleteCustomerGateway operation.
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.
DeleteDhcpOptionsResponse
This is the response object from the DeleteDhcpOptions operation.
DeleteFlowLogsRequest
Container for the parameters to the DeleteFlowLogs operation.
Deletes one or more flow logs.
DeleteFlowLogsResponse
Contains the output of DeleteFlowLogs.
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.
DeleteInternetGatewayResponse
This is the response object from the DeleteInternetGateway operation.
DeleteKeyPairRequest
Container for the parameters to the DeleteKeyPair operation.
Deletes the specified key pair, by removing the public key from Amazon EC2.
DeleteKeyPairResponse
This is the response object from the DeleteKeyPair operation.
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.
DeleteNatGatewayResponse
Contains the output of DeleteNatGateway.
DeleteNetworkAclEntryRequest
Container for the parameters to the DeleteNetworkAclEntry operation.
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
DeleteNetworkAclEntryResponse
This is the response object from the DeleteNetworkAclEntry operation.
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.
DeleteNetworkAclResponse
This is the response object from the DeleteNetworkAcl operation.
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.
DeleteNetworkInterfaceResponse
This is the response object from the DeleteNetworkInterface operation.
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 about placement
groups and cluster instances, see Cluster
Instances in the Amazon Elastic Compute Cloud User Guide.
DeletePlacementGroupResponse
This is the response object from the DeletePlacementGroup operation.
DeleteRouteRequest
Container for the parameters to the DeleteRoute operation.
Deletes the specified route from the specified route table.
DeleteRouteResponse
This is the response object from the DeleteRoute operation.
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.
DeleteRouteTableResponse
This is the response object from the DeleteRouteTable operation.
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.
DeleteSecurityGroupResponse
This is the response object from the DeleteSecurityGroup operation.
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.
DeleteSnapshotResponse
This is the response object from the DeleteSnapshot operation.
DeleteSpotDatafeedSubscriptionRequest
Container for the parameters to the DeleteSpotDatafeedSubscription operation.
Deletes the data feed for Spot instances.
DeleteSpotDatafeedSubscriptionResponse
This is the response object from the DeleteSpotDatafeedSubscription operation.
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.
DeleteSubnetResponse
This is the response object from the DeleteSubnet operation.
DeleteTagsRequest
Container for the parameters to the DeleteTags operation.
Deletes the specified set of tags from the specified set of resources. This call is
designed to follow a DescribeTags request.
For more information about tags, see Tagging
Your Resources in the Amazon Elastic Compute Cloud User Guide.
DeleteTagsResponse
This is the response object from the DeleteTags operation.
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.
DeleteVolumeResponse
This is the response object from the DeleteVolume operation.
DeleteVpcEndpointsRequest
Container for the parameters to the DeleteVpcEndpoints operation.
Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the
endpoint routes in the route tables that were associated with the endpoint.
DeleteVpcEndpointsResponse
Contains the output of DeleteVpcEndpoints.
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 peer VPC can delete the VPC peering connection if it's in the active
state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance
state.
DeleteVpcPeeringConnectionResponse
Returns information about the DeleteVpcPeeringConnection response metadata.
The DeleteVpcPeeringConnection operation has a void result type.
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.
DeleteVpcResponse
This is the response object from the DeleteVpc operation.
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.
DeleteVpnConnectionResponse
This is the response object from the DeleteVpnConnection operation.
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.
DeleteVpnConnectionRouteResponse
This is the response object from the DeleteVpnConnectionRoute operation.
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.
DeleteVpnGatewayResponse
This is the response object from the DeleteVpnGateway operation.
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.
This command does not delete the AMI.
DeregisterImageResponse
This is the response object from the DeregisterImage operation.
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.
DescribeAccountAttributesResponse
Contains the output of DescribeAccountAttributes.
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.
DescribeAddressesResponse
Contains the output of DescribeAddresses.
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.
DescribeAvailabilityZonesResponse
Contains the output of DescribeAvailabiltyZones.
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.
DescribeBundleTasksResponse
Contains the output of DescribeBundleTasks.
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.
DescribeClassicLinkInstancesResponse
Contains the output of DescribeClassicLinkInstances.
DescribeConversionTasksRequest
Container for the parameters to the DescribeConversionTasks operation.
Describes one or more of your conversion tasks. For more information, see Using
the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon
Elastic Compute Cloud User Guide.
For information about the import manifest referenced by this API action, see VM
Import Manifest.
DescribeConversionTasksResponse
Contains the output for DescribeConversionTasks.
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 Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
DescribeCustomerGatewaysResponse
Contains the output of DescribeCustomerGateways.
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.
DescribeDhcpOptionsResponse
Contains the output of DescribeDhcpOptions.
DescribeExportTasksRequest
Container for the parameters to the DescribeExportTasks operation.
Describes one or more of your export tasks.
DescribeExportTasksResponse
Contains the output for DescribeExportTasks.
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.
DescribeFlowLogsResponse
Contains the output of DescribeFlowLogs.
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.
DescribeHostsResponse
Contains the output of DescribeHosts.
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.
DescribeIdFormatResponse
Contains the output of DescribeIdFormat.
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.
DescribeImageAttributeResponse
Contains the response data from the DescribeImageAttribute operation.
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.
DescribeImagesResponse
Contains the output of DescribeImages.
DescribeImportImageTasksRequest
Container for the parameters to the DescribeImportImageTasks operation.
Displays details about an import virtual machine or import snapshot tasks that are
already created.
DescribeImportImageTasksResponse
Contains the output for DescribeImportImageTasks.
DescribeImportSnapshotTasksRequest
Container for the parameters to the DescribeImportSnapshotTasks operation.
Describes your import snapshot tasks.
DescribeImportSnapshotTasksResponse
Contains the output for DescribeImportSnapshotTasks.
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
DescribeInstanceAttributeResponse
Contains the response data from the DescribeInstanceAttribute operation.
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.
DescribeInstancesResponse
Contains the output of DescribeInstances.
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 specified otherwise.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances
to identify hardware and software issues. For more information, see Status
Checks for Your Instances and Troubleshooting
Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User
Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or
terminate) for your instances related to hardware issues, software updates, or system
maintenance. For more information, see Scheduled
Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.
Instance state - You can manage your instances from the moment you launch them
through their termination. For more information, see Instance
Lifecycle in the Amazon Elastic Compute Cloud User Guide.
DescribeInstanceStatusResponse
Contains the output of DescribeInstanceStatus.
DescribeInternetGatewaysRequest
Container for the parameters to the DescribeInternetGateways operation.
Describes one or more of your Internet gateways.
DescribeInternetGatewaysResponse
Contains the output of DescribeInternetGateways.
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.
DescribeKeyPairsResponse
Contains the output of DescribeKeyPairs.
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.
DescribeMovingAddressesResponse
Contains the output of DescribeMovingAddresses.
DescribeNatGatewaysRequest
Container for the parameters to the DescribeNatGateways operation.
Describes one or more of the your NAT gateways.
DescribeNatGatewaysResponse
Contains the output of DescribeNatGateways.
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.
DescribeNetworkAclsResponse
Contains the output of DescribeNetworkAcls.
DescribeNetworkInterfaceAttributeRequest
Container for the parameters to the DescribeNetworkInterfaceAttribute operation.
Describes a network interface attribute. You can specify only one attribute at a time.
DescribeNetworkInterfaceAttributeResponse
Contains the output of DescribeNetworkInterfaceAttribute.
DescribeNetworkInterfacesRequest
Container for the parameters to the DescribeNetworkInterfaces operation.
Describes one or more of your network interfaces.
DescribeNetworkInterfacesResponse
Contains the output of DescribeNetworkInterfaces.
DescribePlacementGroupsRequest
Container for the parameters to the DescribePlacementGroups operation.
Describes one or more of your placement groups. For more information about placement
groups and cluster instances, see Cluster
Instances in the Amazon Elastic Compute Cloud User Guide.
DescribePlacementGroupsResponse
Contains the output of DescribePlacementGroups.
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 VPC endpoint.
DescribePrefixListsResponse
Contains the output of DescribePrefixLists.
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.
DescribeRegionsResponse
Contains the output of DescribeRegions.
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.
DescribeReservedInstancesListingsResponse
Contains the output of DescribeReservedInstancesListings.
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.
DescribeReservedInstancesModificationsResponse
Contains the output of DescribeReservedInstancesModifications.
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.
DescribeReservedInstancesOfferingsResponse
Contains the output of DescribeReservedInstancesOfferings.
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.
DescribeReservedInstancesResponse
Contains the output for DescribeReservedInstances.
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.
DescribeRouteTablesResponse
Contains the output of DescribeRouteTables.
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.
DescribeScheduledInstanceAvailabilityResponse
Contains the output of DescribeScheduledInstanceAvailability.
DescribeScheduledInstancesRequest
Container for the parameters to the DescribeScheduledInstances operation.
Describes one or more of your Scheduled Instances.
DescribeScheduledInstancesResponse
Contains the output of DescribeScheduledInstances.
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.
DescribeSecurityGroupReferencesResponse
This is the response object from the DescribeSecurityGroupReferences operation.
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.
DescribeSecurityGroupsResponse
Contains the output of DescribeSecurityGroups.
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.
DescribeSnapshotAttributeResponse
Contains the output of DescribeSnapshotAttribute.
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, 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.
DescribeSnapshotsResponse
Contains the output of DescribeSnapshots.
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.
DescribeSpotDatafeedSubscriptionResponse
Contains the output of DescribeSpotDatafeedSubscription.
DescribeSpotFleetInstancesRequest
Container for the parameters to the DescribeSpotFleetInstances operation.
Describes the running instances for the specified Spot fleet.
DescribeSpotFleetInstancesResponse
Contains the output of DescribeSpotFleetInstances.
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.
DescribeSpotFleetRequestHistoryResponse
Contains the output of DescribeSpotFleetRequestHistory.
DescribeSpotFleetRequestsRequest
Container for the parameters to the DescribeSpotFleetRequests operation.
Describes your Spot fleet requests.
DescribeSpotFleetRequestsResponse
Contains the output of DescribeSpotFleetRequests.
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 bid price that you specify exceeds the
current Spot price. Amazon EC2 periodically sets the Spot price based on available
Spot instance capacity and current Spot instance requests. For more information, see
Spot
Instance Requests in the Amazon Elastic Compute Cloud User Guide.
You can use DescribeSpotInstanceRequests to find a running Spot instance
by examining the response. If the status of the Spot instance is fulfilled,
the instance ID appears in the response and contains the identifier of the instance.
Alternatively, you can use DescribeInstances with a filter to look for instances
where the instance lifecycle is spot.
DescribeSpotInstanceRequestsResponse
Contains the output of DescribeSpotInstanceRequests.
DescribeSpotPriceHistoryRequest
Container for the parameters to the DescribeSpotPriceHistory operation.
Describes the Spot price history. The prices returned are listed in chronological
order, from the oldest to the most recent, for up to the past 90 days. 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.
DescribeSpotPriceHistoryResponse
Contains the output of DescribeSpotPriceHistory.
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.
DescribeStaleSecurityGroupsResponse
This is the response object from the DescribeStaleSecurityGroups operation.
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.
DescribeSubnetsResponse
Contains the output of DescribeSubnets.
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.
DescribeTagsResponse
Contains the output of DescribeTags.
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.
DescribeVolumeAttributeResponse
Contains the output of DescribeVolumeAttribute.
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.
DescribeVolumesResponse
Contains the output of DescribeVolumes.
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.)
DescribeVolumeStatusResponse
Contains the output of DescribeVolumeStatus.
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.
DescribeVpcAttributeResponse
Contains the output of DescribeVpcAttribute.
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 about ClassicLink, see ClassicLink
in the Amazon Elastic Compute Cloud User Guide.
DescribeVpcClassicLinkDnsSupportResponse
Contains the output of DescribeVpcClassicLinkDnsSupport.
DescribeVpcClassicLinkRequest
Container for the parameters to the DescribeVpcClassicLink operation.
Describes the ClassicLink status of one or more VPCs.
DescribeVpcClassicLinkResponse
Contains the output of DescribeVpcClassicLink.
DescribeVpcEndpointServicesRequest
Container for the parameters to the DescribeVpcEndpointServices operation.
Describes all supported AWS services that can be specified when creating a VPC endpoint.
DescribeVpcEndpointServicesResponse
Contains the output of DescribeVpcEndpointServices.
DescribeVpcEndpointsRequest
Container for the parameters to the DescribeVpcEndpoints operation.
Describes one or more of your VPC endpoints.
DescribeVpcEndpointsResponse
Contains the output of DescribeVpcEndpoints.
DescribeVpcPeeringConnectionsRequest
Container for the parameters to the DescribeVpcPeeringConnections operation.
Describes one or more of your VPC peering connections.
DescribeVpcPeeringConnectionsResponse
Contains the output of DescribeVpcPeeringConnections.
DescribeVpcsRequest
Container for the parameters to the DescribeVpcs operation.
Describes one or more of your VPCs.
DescribeVpcsResponse
Contains the output of DescribeVpcs.
DescribeVpnConnectionsRequest
Container for the parameters to the DescribeVpnConnections operation.
Describes one or more of your VPN connections.
For more information about VPN connections, see Adding
a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private
Cloud User Guide.
DescribeVpnConnectionsResponse
Contains the output of DescribeVpnConnections.
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 Adding
an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User
Guide.
DescribeVpnGatewaysResponse
Contains the output of DescribeVpnGateways.
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.
DetachClassicLinkVpcResponse
Contains the output of DetachClassicLinkVpc.
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.
DetachInternetGatewayResponse
This is the response object from the DetachInternetGateway operation.
DetachNetworkInterfaceRequest
Container for the parameters to the DetachNetworkInterface operation.
Detaches a network interface from an instance.
DetachNetworkInterfaceResponse
This is the response object from the DetachNetworkInterface operation.
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 results in the volume being stuck in a busy state while detaching.
If an Amazon 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.
DetachVolumeResponse
Contains the response data from the DetachVolume operation.
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.
DetachVpnGatewayResponse
This is the response object from the DetachVpnGateway operation.
DhcpConfiguration
Describes a DHCP configuration option.
DhcpOptions
Describes a set of DHCP options.
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.
DisableVgwRoutePropagationResponse
This is the response object from the DisableVgwRoutePropagation operation.
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.
DisableVpcClassicLinkDnsSupportResponse
Contains the output of DisableVpcClassicLinkDnsSupport.
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.
DisableVpcClassicLinkResponse
Contains the output of DisableVpcClassicLink.
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.
DisassociateAddressResponse
This is the response object from the DisassociateAddress operation.
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.
DisassociateRouteTableResponse
This is the response object from the DisassociateRouteTable operation.
DiskImage
Describes a disk image.
DiskImageDescription
Describes a disk image.
DiskImageDetail
Describes a disk image.
DiskImageVolumeDescription
Describes a disk image volume.
DryRunResponse
Returns information about the DryRun response and response metadata.
EbsBlockDevice
Describes a block device for an EBS volume.
EbsInstanceBlockDevice
Describes a parameter used to set up an EBS volume in a block device mapping.
EbsInstanceBlockDeviceSpecification
Describes information used to set up an EBS volume specified in a block device mapping.
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.
EnableVgwRoutePropagationResponse
This is the response object from the EnableVgwRoutePropagation operation.
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.
EnableVolumeIOResponse
This is the response object from the EnableVolumeIO operation.
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.
EnableVpcClassicLinkDnsSupportResponse
Contains the output of EnableVpcClassicLinkDnsSupport.
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.
EnableVpcClassicLinkResponse
Contains the output of EnableVpcClassicLink.
EventInformation
Describes a Spot fleet event.
ExportTask
Describes an instance export task.
ExportToS3Task
Describes the format and location for an instance export task.
ExportToS3TaskSpecification
Describes an instance export task.
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.
FlowLog
Describes a flow log.
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.
GetConsoleOutputResponse
Contains the output of GetConsoleOutput.
GetPasswordDataRequest
Container for the parameters to the GetPasswordData operation.
Retrieves the encrypted administrator password for an instance running Windows.
The Windows password is generated at boot if the EC2Config service plugin,
Ec2SetPassword, is enabled. This usually only happens the first time
an AMI is launched, and then Ec2SetPassword is automatically disabled.
The password is not generated for rebundled AMIs unless Ec2SetPassword
is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched
the instance. You must provide the corresponding key pair file.
Password generation and encryption takes a few moments. We recommend that you wait
up to 15 minutes after launching an instance before trying to retrieve the generated
password.
GetPasswordDataResponse
Contains the output of GetPasswordData.
GroupIdentifier
Describes a security group.
HistoryRecord
Describes an event in the history of the Spot fleet request.
Host
Describes the properties of the Dedicated host.
HostInstance
Describes an instance running on a Dedicated host.
HostProperties
Describes properties of a Dedicated host.
IamInstanceProfile
Describes an IAM instance profile.
IamInstanceProfileSpecification
Describes an IAM instance profile.
IcmpTypeCode
Describes the ICMP type and code.
IdFormat
Describes the ID format for a resource.
Image
Describes an image.
ImageAttribute
Describes an image attribute.
ImageDiskContainer
Describes the disk container object for an import image task.
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).
ImportImageResponse
Contains the output for ImportImage.
ImportImageTask
Describes an import image task.
ImportInstanceLaunchSpecification
Describes the launch specification for VM import.
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.
After importing the image, you then upload it using the ec2-import-volume
command in the EC2 command line tools. For more information, see Using
the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon
Elastic Compute Cloud User Guide.
For information about the import manifest referenced by this API action, see VM
Import Manifest.
ImportInstanceResponse
Contains the output for ImportInstance.
ImportInstanceTaskDetails
Describes an import instance task.
ImportInstanceVolumeDetailItem
Describes an import volume task.
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.
ImportKeyPairResponse
Contains the output of ImportKeyPair.
ImportSnapshotRequest
Container for the parameters to the ImportSnapshot operation.
Imports a disk into an EBS snapshot.
ImportSnapshotResponse
Contains the output for ImportSnapshot.
ImportSnapshotTask
Describes an import snapshot task.
ImportVolumeRequest
Container for the parameters to the ImportVolume operation.
Creates an import volume task using metadata from the specified disk image. After
importing the image, you then upload it using the ec2-import-volume command
in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using
the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon
Elastic Compute Cloud User Guide.
For information about the import manifest referenced by this API action, see VM
Import Manifest.
ImportVolumeResponse
Contains the output for ImportVolume.
ImportVolumeTaskDetails
Describes an import volume task.
Instance
Describes an instance.
InstanceAttribute
Describes an instance attribute.
InstanceBlockDeviceMapping
Describes a block device mapping.
InstanceBlockDeviceMappingSpecification
Describes a block device mapping entry.
InstanceCapacity
Information about the instance type that the Dedicated host supports.
InstanceCount
Describes a Reserved Instance listing state.
InstanceExportDetails
Describes an instance to export.
InstanceLicenseSpecification
Instance License Specification
InstanceMonitoring
Describes the monitoring information of the instance.
InstanceNetworkInterface
Describes a network interface.
InstanceNetworkInterfaceAssociation
Describes association information for an Elastic IP address.
InstanceNetworkInterfaceAttachment
Describes a network interface attachment.
InstanceNetworkInterfaceSpecification
Describes a network interface.
InstancePrivateIpAddress
Describes a private IP address.
InstanceState
Describes the current state of the instance.
InstanceStateChange
Describes an instance state change.
InstanceStatus
Describes the status of an instance.
InstanceStatusDetails
Describes the instance status.
InstanceStatusEvent
Describes a scheduled event for an instance.
InstanceStatusSummary
Describes the status of an instance.
InternetGateway
Describes an Internet gateway.
InternetGatewayAttachment
Describes the attachment of a VPC to an Internet gateway.
IpPermission
Describes a security group rule.
KeyPair
Describes a key pair.
KeyPairInfo
Describes a key pair.
LaunchPermission
Describes a launch permission.
LaunchPermissionModifications
Describes a launch permission modification.
LaunchSpecification
Describes the launch specification for an instance.
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.
ModifyHostsResponse
Contains the output of ModifyHosts.
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 or as an IAM role that has permission
to use this action, then these settings apply to the entire account, unless an IAM
user explicitly overrides these settings for themselves. For more information, see
Controlling
Access to Longer ID Settings in the Amazon Elastic Compute Cloud User Guide.
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.
ModifyIdFormatResponse
This is the response object from the ModifyIdFormat operation.
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.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product
code cannot be made public.
ModifyImageAttributeResponse
This is the response object from the ModifyImageAttribute operation.
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.
ModifyInstanceAttributeResponse
This is the response object from the ModifyInstanceAttribute operation.
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.
ModifyInstancePlacementResponse
Contains the output of ModifyInstancePlacement.
ModifyNetworkInterfaceAttributeRequest
Container for the parameters to the ModifyNetworkInterfaceAttribute operation.
Modifies the specified network interface attribute. You can specify only one attribute
at a time.
ModifyNetworkInterfaceAttributeResponse
This is the response object from the ModifyNetworkInterfaceAttribute operation.
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.
ModifyReservedInstancesResponse
Contains the output of ModifyReservedInstances.
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.
For more information on modifying snapshot permissions, see Sharing
Snapshots in the Amazon Elastic Compute Cloud User Guide.
Snapshots with AWS Marketplace product codes cannot be made public.
ModifySnapshotAttributeResponse
This is the response object from the ModifySnapshotAttribute operation.
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 bids that exceed the new target capacity. You can request that the
Spot fleet terminate Spot instances until the size of the fleet no longer exceeds
the new target capacity. If the allocation strategy is lowestPrice, the
Spot fleet terminates the instances with the highest price per unit. If the allocation
strategy is diversified, the Spot fleet terminates instances across the
Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its
current size, but not replace any Spot instances that are interrupted or that you
terminate manually.
ModifySpotFleetRequestResponse
Contains the output of ModifySpotFleetRequest.
ModifySubnetAttributeRequest
Container for the parameters to the ModifySubnetAttribute operation.
Modifies a subnet attribute.
ModifySubnetAttributeResponse
This is the response object from the ModifySubnetAttribute operation.
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.
ModifyVolumeAttributeResponse
This is the response object from the ModifyVolumeAttribute operation.
ModifyVpcAttributeRequest
Container for the parameters to the ModifyVpcAttribute operation.
Modifies the specified attribute of the specified VPC.
ModifyVpcAttributeResponse
This is the response object from the ModifyVpcAttribute operation.
ModifyVpcEndpointRequest
Container for the parameters to the ModifyVpcEndpoint operation.
Modifies attributes of a specified VPC endpoint. You can modify the policy associated
with the endpoint, and you can add and remove route tables associated with the endpoint.
ModifyVpcEndpointResponse
Contains the output of ModifyVpcEndpoint.
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.
If the peered VPCs are in different accounts, each owner must initiate a separate
request to enable or disable communication in either direction, 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.
ModifyVpcPeeringConnectionOptionsResponse
This is the response object from the ModifyVpcPeeringConnectionOptions operation.
Monitoring
Describes the monitoring for the instance.
MonitorInstancesRequest
Container for the parameters to the MonitorInstances operation.
Enables monitoring for a running instance. For more information about monitoring instances,
see Monitoring
Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
MonitorInstancesResponse
Contains the output of MonitorInstances.
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. You cannot migrate an Elastic IP address that's associated with a reverse
DNS record. Contact AWS account and billing support to remove the reverse DNS record.
MoveAddressToVpcResponse
Contains the output of MoveAddressToVpc.
MovingAddressStatus
Describes the status of a moving Elastic IP address.
NatGateway
Describes a NAT gateway.
NatGatewayAddress
Describes the IP addresses and network interface associated with a NAT gateway.
NetworkAcl
Describes a network ACL.
NetworkAclAssociation
Describes an association between a network ACL and a subnet.
NetworkAclEntry
Describes an entry in a network ACL.
NetworkInterface
Describes a network interface.
NetworkInterfaceAssociation
Describes association information for an Elastic IP address.
NetworkInterfaceAttachment
Describes a network interface attachment.
NetworkInterfaceAttachmentChanges
Describes an attachment change.
NetworkInterfacePrivateIpAddress
Describes the private IP address of a network interface.
PeeringConnectionOptions
Describes the VPC peering connection options.
PeeringConnectionOptionsRequest
The VPC peering connection options.
Placement
Describes the placement for the instance.
PlacementGroup
Describes a placement group.
PortRange
Describes a range of ports.
PrefixList
Describes prefixes for AWS services.
PrefixListId
The ID of the prefix.
PriceSchedule
Describes the price for a Reserved Instance.
PriceScheduleSpecification
Describes the price for a Reserved Instance.
PricingDetail
Describes a Reserved Instance offering.
PrivateIpAddressSpecification
Describes a secondary private IP address for a network interface.
ProductCode
Describes a product code.
PropagatingVgw
Describes a virtual private gateway propagating route.
PurchaseRequest
Describes a request to purchase Scheduled Instances.
PurchaseReservedInstancesOfferingRequest
Container for the parameters to the PurchaseReservedInstancesOffering operation.
Purchases a Reserved Instance for use with your account. With Reserved Instances,
you obtain a capacity reservation for a certain instance configuration over a specified
period of time and 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.
PurchaseReservedInstancesOfferingResponse
Contains the output of PurchaseReservedInstancesOffering.
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.
PurchaseScheduledInstancesResponse
Contains the output of PurchaseScheduledInstances.
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.
RebootInstancesResponse
This is the response object from the RebootInstances operation.
RecurringCharge
Describes a recurring charge.
Region
Describes a region.
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. For more information, see Launching
an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.
Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise
Server (SLES), use the EC2 billingProduct code associated with an AMI
to verify 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.
Similarly, although you can create a Windows AMI from a snapshot, you can't successfully
launch an instance from the AMI.
To create Windows AMIs or to create AMIs for Linux operating systems that must retain
AMI billing codes to work properly, 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.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace
product codes.
RegisterImageResponse
Contains the output of RegisterImage.
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.
RejectVpcPeeringConnectionResponse
Returns information about the RejectVpcPeeringConnection response metadata.
The RejectVpcPeeringConnection operation has a void result type.
ReleaseAddressRequest
Container for the parameters to the ReleaseAddress operation.
Releases the specified Elastic IP address.
After releasing an Elastic IP address, it is released to the IP address pool and might
be unavailable to you. Be sure to update your DNS records and any servers or devices
that communicate with the address. If you attempt to release an Elastic IP address
that you already released, you'll get an AuthFailure error if the address
is already allocated to another AWS account.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates
it from any instance that it's associated with. To disassociate an Elastic IP address
without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic
IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
ReleaseAddressResponse
This is the response object from the ReleaseAddress operation.
ReleaseHostsRequest
Container for the parameters to the ReleaseHosts operation.
When you no longer want to use a 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.
ReleaseHostsResponse
Contains the output of ReleaseHosts.
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.
ReplaceNetworkAclAssociationResponse
Contains the output of ReplaceNetworkAclAssociation.
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.
ReplaceNetworkAclEntryResponse
This is the response object from the ReplaceNetworkAclEntry operation.
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, or network interface.
For more information about route tables, see Route
Tables in the Amazon Virtual Private Cloud User Guide.
ReplaceRouteResponse
This is the response object from the ReplaceRoute operation.
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.
ReplaceRouteTableAssociationResponse
Contains the output of ReplaceRouteTableAssociation.
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.
ReportInstanceStatusResponse
This is the response object from the ReportInstanceStatus operation.
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.
For more information, see Spot
Fleet Requests in the Amazon Elastic Compute Cloud User Guide.
RequestSpotFleetResponse
Contains the output of RequestSpotFleet.
RequestSpotInstancesRequest
Container for the parameters to the RequestSpotInstances operation.
Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches
when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically
sets the Spot price based on available Spot Instance capacity and current Spot instance
requests. For more information, see Spot
Instance Requests in the Amazon Elastic Compute Cloud User Guide.
RequestSpotInstancesResponse
Contains the output of RequestSpotInstances.
Reservation
Describes a reservation.
ReservedInstanceLimitPrice
Describes the limit price of a Reserved Instance offering.
ReservedInstances
Describes a Reserved Instance.
ReservedInstancesConfiguration
Describes the configuration settings for the modified Reserved Instances.
ReservedInstancesId
Describes the ID of a Reserved Instance.
ReservedInstancesListing
Describes a Reserved Instance listing.
ReservedInstancesModification
Describes a Reserved Instance modification.
ReservedInstancesModificationResult
Describes the modification request/s.
ReservedInstancesOffering
Describes a Reserved Instance offering.
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.
ResetImageAttributeResponse
This is the response object from the ResetImageAttribute operation.
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.
ResetInstanceAttributeResponse
This is the response object from the ResetInstanceAttribute operation.
ResetNetworkInterfaceAttributeRequest
Container for the parameters to the ResetNetworkInterfaceAttribute operation.
Resets a network interface attribute. You can specify only one attribute at a time.
ResetNetworkInterfaceAttributeResponse
This is the response object from the ResetNetworkInterfaceAttribute operation.
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.
ResetSnapshotAttributeResponse
This is the response object from the ResetSnapshotAttribute operation.
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. You cannot restore an Elastic IP address that's associated
with a reverse DNS record. Contact AWS account and billing support to remove the reverse
DNS record.
RestoreAddressToClassicResponse
Contains the output of RestoreAddressToClassic.
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. The values that
you specify in the revoke request (for example, ports) must match the existing rule's
values for the rule to be revoked.
Each rule consists of the protocol and the CIDR range or source security group. For
the TCP and UDP protocols, you must also specify the destination port or range of
ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible.
However, a small delay might occur.
RevokeSecurityGroupEgressResponse
This is the response object from the RevokeSecurityGroupEgress operation.
RevokeSecurityGroupIngressRequest
Container for the parameters to the RevokeSecurityGroupIngress operation.
Removes one or more ingress rules from a security group. The values that you specify
in the revoke request (for example, ports) must match the existing rule's values for
the rule to be removed.
Each rule consists of the protocol and the CIDR range or source security group. For
the TCP and UDP protocols, you must also specify the destination port or range of
ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible.
However, a small delay might occur.
RevokeSecurityGroupIngressResponse
This is the response object from the RevokeSecurityGroupIngress operation.
Route
Describes a route in a route table.
RouteTable
Describes a route table.
RouteTableAssociation
Describes an association between a route table and a subnet.
RunInstancesRequest
Container for the parameters to the RunInstances operation.
Launches the specified number of instances using an AMI for which you have permissions.
When you launch an instance, it enters the pending state. After the instance
is ready for you, it enters the running state. To check the state of
your instance, call DescribeInstances.
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.
If you don't specify a security group when launching an instance, Amazon EC2 uses
the default security group. For more information, see Security
Groups in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a
default subnet from your default VPC for you.
[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify
an Availability Zone, we choose one for you.
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.
You can provide optional user data when launching an instance. For more information,
see Instance
Metadata in the Amazon Elastic Compute Cloud User Guide.
If any of the AMIs have a product code attached for which the user has not subscribed,
RunInstances fails.
Some instance types can only be launched into a VPC. If you do not have a default
VPC, or if you do not specify a subnet ID in the request, RunInstances
fails. For more information, see Instance
Types Available Only in a VPC.
For more information about troubleshooting, see What
To Do If An Instance Immediately Terminates, and Troubleshooting
Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
RunInstancesResponse
Contains the response data from the RunInstances operation.
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.
RunScheduledInstancesResponse
Contains the output of RunScheduledInstances.
S3Storage
Describes the storage parameters for S3 and S3 buckets for an instance store-backed
AMI.
ScheduledInstance
Describes a Scheduled Instance.
ScheduledInstanceAvailability
Describes a schedule that is available for your Scheduled Instances.
ScheduledInstanceRecurrence
Describes the recurring schedule for a Scheduled Instance.
ScheduledInstanceRecurrenceRequest
Describes the recurring schedule for a Scheduled Instance.
ScheduledInstancesBlockDeviceMapping
Describes a block device mapping for a Scheduled Instance.
ScheduledInstancesEbs
Describes an EBS volume for a Scheduled Instance.
ScheduledInstancesIamInstanceProfile
Describes an IAM instance profile for a Scheduled Instance.
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.
ScheduledInstancesMonitoring
Describes whether monitoring is enabled for a Scheduled Instance.
ScheduledInstancesNetworkInterface
Describes a network interface for a Scheduled Instance.
ScheduledInstancesPlacement
Describes the placement for a Scheduled Instance.
ScheduledInstancesPrivateIpAddressConfig
Describes a private IP address for a Scheduled Instance.
SecurityGroup
Describes a security group
SecurityGroupReference
Describes a VPC with a security group that references your security group.
SlotDateTimeRangeRequest
Describes the time period for a Scheduled Instance to start its first schedule. The
time period must span less than one day.
SlotStartTimeRangeRequest
Describes the time period for a Scheduled Instance to start its first schedule.
Snapshot
Describes a snapshot.
SnapshotDetail
Describes the snapshot created from the imported disk.
SnapshotDiskContainer
The disk container object for the import snapshot request.
SnapshotTaskDetail
Details about the import snapshot task.
SpotDatafeedSubscription
Describes the data feed for a Spot instance.
SpotFleetLaunchSpecification
Describes the launch specification for one or more Spot instances.
SpotFleetMonitoring
Describes whether monitoring is enabled.
SpotFleetRequestConfig
Describes a Spot fleet request.
SpotFleetRequestConfigData
Describes the configuration of a Spot fleet request.
SpotInstanceRequest
Describes a Spot instance request.
SpotInstanceStateFault
Describes a Spot instance state change.
SpotInstanceStatus
Describes the status of a Spot instance request.
SpotPlacement
Describes Spot instance placement.
SpotPrice
Describes the maximum hourly price (bid) for any Spot instance launched to fulfill
the request.
StaleIpPermission
Describes a stale rule in a security group.
StaleSecurityGroup
Describes a stale security group (a security group that contains stale rules).
StartInstancesRequest
Container for the parameters to the StartInstances operation.
Starts an Amazon EBS-backed AMI that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped
and started. When an instance is stopped, the compute resources are released and you
are not billed for hourly instance usage. However, your root partition Amazon EBS
volume remains, continues to persist your data, and you are charged for Amazon EBS
volume usage. You can restart your instance at any time. Each time you transition
an instance from stopped to started, Amazon EC2 charges a full instance hour, even
if transitions happen multiple times within a single hour.
Before stopping an instance, make sure it is in a state from which it can be restarted.
Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device
returns an error.
For more information, see Stopping
Instances in the Amazon Elastic Compute Cloud User Guide.
StartInstancesResponse
Contains the output of StartInstances.
StateReason
Describes a state change.
StopInstancesRequest
Container for the parameters to the StopInstances operation.
Stops an Amazon EBS-backed instance.
We don't charge hourly usage for a stopped instance, or data transfer fees; however,
your root partition Amazon EBS volume remains, continues to persist your data, and
you are charged for Amazon EBS volume usage. Each time you transition an instance
from stopped to started, Amazon EC2 charges a full instance hour, even if transitions
happen multiple times within a single hour.
You can't start or stop Spot instances, and you can't stop instance store-backed instances.
When you stop an instance, we shut it down. You can restart your instance at any time.
Before stopping an instance, make sure it is in a state from which it can be restarted.
Stopping an instance does not preserve data stored in RAM.
Stopping an instance is different to rebooting or terminating it. For example, when
you stop an instance, the root device and any other devices attached to the instance
persist. When you terminate an instance, the root device and any other devices attached
during the instance launch are automatically deleted. For more information about the
differences between rebooting, stopping, and terminating instances, see Instance
Lifecycle in the Amazon Elastic Compute Cloud User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while.
If your instance appears stuck in the stopping state after a period of time, there
may be an issue with the underlying host computer. For more information, see Troubleshooting
Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
StopInstancesResponse
Contains the output of StopInstances.
Storage
Describes the storage location for an instance store-backed AMI.
Subnet
Describes a subnet.
Tag
Describes a tag.
TagDescription
Describes a tag.
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.
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.
TerminateInstancesResponse
Contains the output of TerminateInstances.
UnassignPrivateIpAddressesRequest
Container for the parameters to the UnassignPrivateIpAddresses operation.
Unassigns one or more secondary private IP addresses from a network interface.
UnassignPrivateIpAddressesResponse
This is the response object from the UnassignPrivateIpAddresses operation.
UnmonitorInstancesRequest
Container for the parameters to the UnmonitorInstances operation.
Disables monitoring for a running instance. For more information about monitoring
instances, see Monitoring
Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
UnmonitorInstancesResponse
Contains the output of UnmonitorInstances.
UnsuccessfulItem
Information about items that were not successfully processed in a batch call.
UnsuccessfulItemError
Information about the error that occurred. For more information about errors, see
Error
Codes.
UserBucket
Describes the S3 bucket for the disk image.
UserBucketDetails
Describes the S3 bucket for the disk image.
UserData
Describes the user data to be made available to an instance.
UserIdGroupPair
Describes a security group and AWS account ID pair.
VgwTelemetry
Describes telemetry for a VPN tunnel.
Volume
Describes a volume.
VolumeAttachment
Describes volume attachment details.
VolumeDetail
Describes an EBS volume.
VolumeStatusAction
Describes a volume status operation code.
VolumeStatusDetails
Describes a volume status.
VolumeStatusEvent
Describes a volume status event.
VolumeStatusInfo
Describes the status of a volume.
VolumeStatusItem
Describes the volume status.
Vpc
Describes a VPC.
VpcAttachment
Describes an attachment between a virtual private gateway and a VPC.
VpcClassicLink
Describes whether a VPC is enabled for ClassicLink.
VpcEndpoint
Describes a VPC endpoint.
VpcPeeringConnection
Describes a VPC peering connection.
VpcPeeringConnectionOptionsDescription
Describes the VPC peering connection options.
VpcPeeringConnectionStateReason
Describes the status of a VPC peering connection.
VpcPeeringConnectionVpcInfo
Describes a VPC in a VPC peering connection.
VpnConnection
Describes a VPN connection.
VpnConnectionOptions
Describes VPN connection options.
VpnConnectionOptionsSpecification
Describes VPN connection options.
VpnGateway
Describes a virtual private gateway.
VpnStaticRoute
Describes a static route for a VPN connection.