Types

Activates a license.

Activates a license.

A static public IP address designed for dynamic cloud computing. Any elastic IP addresses that you associate with your account remains associated with your account until you explicitly release them. Unlike traditional static IP addresses, however, elastic IP addresses allow you to mask instance or Availability Zone failures by rapidly remapping your public IP addresses to any instance in your account. The Address type contains an Elastic IP associated with your account and the InstanceId of the instance it is associated with.

Acquires an elastic IP address for use with your account.

Allocate Address Response

Allocate Address Result

Associates an elastic IP address with an instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

Associate Address Response

AssociateAddress Result

Associates a set of DHCP options (that you've previously created) with the specified VPC. Or, associates the default DHCP options with the VPC. The default set consists of the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. For more information about the supported DHCP options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer Guide.

Associate Dhcp Options Response

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 if you want to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

The Response for the AssociateRouteTable operation.

AssociateRouteTable Result

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, go to the Amazon Virtual Private Cloud User Guide.

The Response for the AttachInternetGateway operation.

Volume Attachment

Request to attach a network interface to an instance.

Attach Network Interface result.

Attaches an Amazon EBS volume to a running instance and exposes it as the specified device. Windows instances currently support devices xvda through xvdp. Devices xvda and xvdb are reserved by the operating system, xvdc is assigned to drive C:\, and, depending on the instance type, devices xvdd through xvde might be reserved by the instance stores. Any device that is not reserved can be attached to an Amazon EBS volume. For a list of devices that are reserved by the instance stores, go to the Amazon Elastic Compute Cloud Developer Guide.

Attach Volume Response

Attach Volume Result

Attaches a VPN gateway to a VPC. This is the last step required to get your VPC fully connected to your data center before launching instances in it. For more information, go to Process for Using Amazon VPC in the Amazon Virtual Private Cloud Developer Guide.

Attach Vpn Gateway Response

Attach VpnGateway Result

This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups. For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide. The action adds one or more egress rules to a VPC security group. Specifically, this permits instances in a security group to send traffic to either one or more destination CIDR IP address ranges, or to one or more destination security groups in the same VPC. Each rule consists of the protocol (e.g., 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 as a wildcard for the ICMP type or code. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

The Response for the AuthorizeSecurityGroupEgress operation.

Adds permissions to a security group. Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields. Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur. When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission, GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified

Authorize Security GroupIngress Response

Availability Zone

Block device mapping.

Bundles the Windows instance. This procedure is not applicable for Linux and UNIX instances. For more information, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud Getting Started Guide.

Bundle Instance Response

Bundle Instance Result

Bundle Task

If the task fails, a description of the error.

Cancels an Amazon EC2 bundling operation.

CancelBundleTaskResponse

Cancel Bundle Task Result

Cancels an active conversion task. The task can be the import of an instance or volume. The command 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.

The Response for the CancelConversionTask operation.

A cancelled Spot Instance Request.

Request to cancel existing Spot Instance requests.

The Response from the CancelSpotInstanceRequests operation.

The Cancel Spot Instance Requests Result.

Verifies whether a Amazon DevPay product code is associated with an instance. This can only be executed by the owner of the AMI and is useful when an AMI owner wants to verify whether a user's instance is eligible for support.

Confirm Product Instance Response

Confirm Product Instance Result

Console Output

Provides information to AWS about your customer gateway device. The customer gateway is the appliance at your end of the VPN connection (compared to the VPN gateway, which is the device at the AWS side of the VPN connection). AWS might delete any customer gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer gateway). You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). You must also provide the device's Border Gateway Protocol (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)

Create Customer Gateway Response

Create Customer Gateway Result

Creates a set of DHCP options that you can then associate with one or more VPCs, causing all existing and new instances that you launch in those VPCs to use the set of DHCP options. The following table lists the individual DHCP options you can specify. For more information about the options, go to RFC 2132. Options: 1. domain-name A domain name of your choice (e.g., mydomain.com). 2. domain-name-servers The IP address of a domain name server (e.g., 10.2.5.1). You can specify up to four addresses. 3. ntp-servers The IP address of a Network Time Protocol (NTP) server (e.g., 10.4.6.1). You can specify up to four addresses. 4. netbios-name-servers The IP address of a NetBIOS name server (e.g., 10.8.9.5). You can specify up to four addresses. 5. netbios-node-type Value indicating the NetBIOS node type (1, 2, 4, or 8). For more information about the values, go to RFC 2132. We recommend you only use 2 at this time (broadcast and multicast are currently not supported)

Create Dhcp Options Response

Create Dhcp Options Result

Creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.

Information returned by a CreateImage request.

Information about the created image.

Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you then attach it to a VPC using AttachInternetGateway. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.

The Response for the CreateInternetGateway operation.

CreateInternetGateway Result

Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is displayed on the console. 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.

Create Key Pair Response

Create Key Pair Result

Creates an entry (i.e., rule) in a network ACL with a rule number you specify. 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, Amazon VPC processes the entries in the ACL according to the rule numbers, in ascending order. We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number them sequentially (101, 102, 103, etc.). This allows you to easily add a new 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 a new entry and delete the old one. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.

The Response for the CreateNetworkAclEntry operation.

Creates a new network ACL in a VPC. Network ACLs provide an optional layer of security (on top of security groups) for the instances in your VPC. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.

The Response for the CreateNetworkAcl operation.

CreateNetworkAcl Result

Create Network Interface request

Create Network Interface response

Create Network Interface result

Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account.

Information returned by the CreatePlacementGroup request.

Creates a new route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. 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 is more specific, so we use that route to determine where to target the traffic. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the CreateRoute operation.

Creates a new route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the CreateRouteTable operation.

CreateRouteTable Result

Creates a new security group. Group names must be unique per account. Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations

Create Security Group Response

CreateSecurityGroup Result

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make identical copies of instance devices, and to save data before shutting down an instance. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. When taking a snapshot of a file system, we recommend unmounting it first. This ensures the file system metadata is in a consistent state, that the 'mounted indicator' is cleared, and that all applications using that file system are stopped and in a consistent state. Some file systems, such as xfs, can freeze and unfreeze activity so a snapshot can be made without unmounting. For Linux/UNIX, enter the following command from the command line. umount -d /dev/sdh For Windows, open Disk Management, right-click the volume to unmount, and select Change Drive Letter and Path. Then, select the mount point to remove and click Remove.

Create Snapshot Response

Create Snapshot Result

Request to create the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account.

The Response for the CreateSpotDatafeedSubscription operation.

Create Spot Datafeed Result

Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC. 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 feel you need more than 20 subnets, you can request more by going to http://aws.amazon.com/contact-us/vpc-request/. When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. Once 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 /18 netmask (16,384 IP addresses). *Important* AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. AWS might delete any subnet you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet).

Create Subnet Response

Create Subnet Result

Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource.

The Response for the CreateTagsResponse operation.

Creat Volume Permission

Creates a new Amazon EBS volume to which any Amazon EC2 instance can attach within the same Availability Zone. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. You must specify an Availability Zone when creating a volume. The volume and the instance to which it attaches must be in the same Availability Zone.

Create Volume Response

Create Volume Result

Creates a VPC with the CIDR block you specify. The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask (16,384 IP addresses). To help you decide how big to make your VPC, go to the topic about creating VPCs in the Amazon Virtual Private Cloud Developer Guide. By default, each instance you launch in the VPC has the default DHCP options (the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type). AWS might delete any VPC that you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC).

Create Vpc Response

Create Vpc Result

The response includes information that you need to configure your customer gateway, in XML format.

Create Vpn Connection Response

Create Vpn Connection Result

Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint for your VPN connection. You can create a VPN gateway before creating the VPC itself. AWS might delete any VPN gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway)

Create Vpn Gateway Response

Create Vpn Gateway Result

Customer Gateway

Deactivates a license.

Deactivates a license.

Deletes a customer gateway. You must delete the VPN connection before deleting the customer gateway. AWS might delete any customer gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer gateway).

Delete Customer Gateway Response

Deletes a set of DHCP options that you specify. Amazon VPC returns an error if the set of options you specify is currently associated with a VPC. You can disassociate the set of options by associating either a new set of options or the default options with the VPC.

Delete Dhcp Options Response

Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.

The Response for the DeleteInternetGateway operation.

Deletes the specified key pair, by removing the public key from Amazon EC2. You must own the key pair.

Delete Key Pair Response

Deletes an ingress or egress entry (i.e., rule) from a network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.

The Response for the DeleteNetworkAclEntry operation.

Deletes a network ACL from a VPC. The ACL must not have any subnets associated with it.You can't delete the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.

The Response for the DeleteNetworkAcl operation.

Delete Network Interface request

Delete Network Interface response

Deletes a PlacementGroupfrom a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.

Information returned by the DeletePlacementGroup request.

Deletes a route from a route table in a VPC. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the DeleteRoute operation.

Deletes a route table from a VPC. The route table must not be associated with a subnet.You can't delete the main route table. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the DeleteRouteTableResponse operation.

Deletes a security group that you own. If you attempt to delete a security group that contains instances, a fault is returned. If you attempt to delete a security group that is referenced by another security group, a fault is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the allow rule is removed.

Delete Security Group Response

Deletes a snapshot of an Amazon EBS volume that you own. For more information, go to the Amazon Elastic Compute Cloud Developer Guide

Delete Snapshot Response

Request to delete the data feed for Spot Instances.

The Response for the DeleteSpotDatafeedSubscription operation.

Deletes a subnet from a VPC. You must terminate all running instances in the subnet before deleting it, otherwise Amazon VPC returns an error. AWS might delete any subnet if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet).

Delete Subnet Response

Deletes tags from the specified resources.

The Response for the DeleteTags operation.

Deletes an Amazon EBS volume that you own. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide.

Delete Volume Response

Deletes a VPC. You must terminate all running instances and delete all subnets before deleting the VPC, otherwise Amazon VPC returns an error. AWS might delete any VPC if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC).

Delete Vpc Response

Deletes a VPN connection. Use this if you want to delete a VPC and all its associated components. Another reason to use this operation is if you believe the tunnel credentials for your VPN connection have been compromised. In that situation, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or VPN 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. If you're deleting the VPC and all its associated parts, we recommend you detach the VPN gateway from the VPC and delete the VPC before deleting the VPN connection.

Delete Vpn Connection Response

Deletes a VPN gateway. Use this when you want to delete a VPC and all its associated components because you no longer need them. We recommend that before you delete a VPN gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the VPN gateway if you just want to delete and re-create the VPN connection between your VPC and data center. AWS might delete any VPN gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway).

Delete Vpn Gateway Response

Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. This command does not delete the AMI from Amazon S3.

Deregister Image Response

Lists elastic IP addresses assigned to your account or provides information about a specific address.

Describe Addresses Response

Describe Addresses Result

Displays Availability Zones that are currently available to the account and their states. Availability Zones are not the same across accounts. The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account.

Describe Availability Zones Response

Describe Availability Zones Result

Describes current bundling tasks. For more information on bundling instances, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud Getting Started Guide.

Describe Bundle Tasks Response

Describe Bundle Tasks Result

Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

The Response for the DescribeConversionTasks operation.

DescribeConversionTasks Result

Gives you information about your customer gateways. You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty

Describe Customer Gateways Response

Describe Customer Gateways Result

Gives you information about one or more sets of DHCP options. You can specify one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options). The returned information consists of: 1. The DHCP options set ID 2. The options

Describe Dhcp Options Response

Describe Dhcp Options Result

Returns information about an attribute of an AMI. Only one attribute can be specified per call.

Describe Image Attribute Response

Describe Image Attribute Result

Returns information about AMIs, AKIs, and ARIs. This includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions. Launch permissions fall into three categories: 1. public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs. explicit: The owner of the AMI granted launch permissions to a specific user. 3. implicit: A user has implicit launch permissions for all AMIs he or she owns. The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions. If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results. If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own. If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs.

Describe Images Response

Describe Images Result

Returns information about an attribute of an instance. Only one attribute can be specified per call.

Information returned by a DescribeInstanceAttribute request.

Information about the instance attribute.

Returns information about instances that you own. 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 invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour.

Describe Instances Response

Describe Instances Result

Describes the components of a Describe Instance Status request.

Describe Instance Status response.

Describe Instance Status result.

Gives you information about your Internet gateways.You can filter the results to return information only about Internet gateways that match criteria you specify. For example, you could get information only about gateways with particular tags. The Internet gateway must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a particular value). The result includes information for a particular Internet gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The Response for the DescribeInternetGateways operation.

DescribeInternetGateways Result

Returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.

DescribeKeyPairsResponse

Describe Key Pairs Result

Provides details of a user's registered licenses. Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned.

Gives you information about the network ACLs in your VPC.You can filter the results to return information only about ACLs that match criteria you specify. For example, you could get information only the ACL associated with a particular subnet. The ACL must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress entry that denies traffic to a particular port). The result includes information for a particular ACL only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The Response for the DescribeNetworkAcls operation.

DescribeNetworkAcls Result

Describe Network Interface Attribute request

Describe Network Interface Attribute response

Describe Network Interface Attribute result

Describe Network Interfaces request

Describe Network Interfaces response

Describe Network Interfaces result

Returns information about one or more PlacementGroup instances in a user's account.

Information returned by the DescribePlacementGroup request.

Describes regions that are currently available to the account.

Describe Regions Response

Describe Regions Result

Describes Reserved Instance offerings that are available for purchase. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide.

Describe Reserved Instances Offerings Response

Describe Reserved Instances Offerings Result

Describes Reserved Instances that you purchased. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide.

Describe Reserved Instances Response

Describe Reserved Instances Result

Gives you information about your route tables.You can filter the results to return information only about tables that match criteria you specify. For example, you could get information only about a table associated with a particular subnet.You can specify multiple values for the filter. The table must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular subnet). The result includes information for a particular table only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The Response for the DescribeRouteTables operation.

DescribeRouteTables Result

Returns information about security groups that you own.

Describe Security Groups Response

Describe Security Groups Result

Returns information about an attribute of a snapshot. Only one attribute can be specified per call.

Describe Snapshot Attribute Response

Describe Snapshot Attribute Result

Returns information about Amazon EBS snapshots available to the user. Information returned includes volume ID, status, start time, progress, owner ID, volume size, and description. Snapshots available to the user include public snapshots available for any user to launch, private snapshots owned by the user making the request, and private snapshots owned by other users for which the user granted explicit create volume permissions. The create volume permissions fall into 3 categories: public The owner of the snapshot granted create volume permissions for the snapshot to the all group. All users have create volume permissions for these snapshots. explicit The owner of the snapshot granted create volume permissions to a specific user. implicit A user has implicit create volume permissions for all snapshots he or she owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or users with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which the user has 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, a fault is returned. If you specify a snapshot ID for which you do not have access, it will not be 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 users that have create snapshot permissions for the snapshots are returned. You can specify AWS Account IDs (if you own the snapshot(s)), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

Describe Snapshots Response

Describe Snapshots Result

Request to describe the data feed for Spot Instances.

The Response for the DescribeSpotDatafeedSubscription operation.

Describe Spot Datafeed Result

Request to describe Spot Instance requests. Spot Instances are instances that automatically launch when your request price exceeds that Spot Price that Amazon EC2 periodically calculates.

The Response for the DescribeSpotInstanceRequests operation.

The Result of the Describe Spot Instances operation.

Request to describe historical pricing for Spot Instances.

The list of cancelled Spot Instance requests.

The Result containing the Spot Price history data.

Gives you information about your subnets. You can filter the results to return information only about subnets that match criteria you specify. For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available). The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty

Describe Subnets Response

Describe Subnets Result

Describes Tags for the specified resources.

The Response for the DescribeTags operation.

DescribeTags Result

Describes the components of a Describe Volume Attribute request.

Describe Volume Attribute response.

Describe Volume Attribute result.

Describes the specified Amazon EBS volumes that you own. If you do not specify one or more volume IDs, Amazon EBS describes all volumes that you own. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide.

Describe Volumes Response

Describe Volumes Result

Describes the components of a Describe Volume Status request.

Describe Volume Status response.

Describe Volume Status result.

Gives you information about your VPCs. You can filter the results to return information only about VPCs that match criteria you specify. For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters. If there's no match, no special message is returned; the response is simply empty. The information returned consists of: a) The VPC ID. b) The CIDR block you've assigned to the VPC. c) The ID of the DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC) The current state of the VPC (pending or available)

Describe VPCs Response

Describe Vpcs Result

Gives you information about your VPN connections. Important - we strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway's state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN connection ID. 2. The type of connection. 3. Customer gateway ID. 4. VPN gateway ID. 5. The current state of the VPN connection (pending, available, deleting, deleted). 6. The customer gateway configuration information in the native XML format.

Describe Vpn Connections Response

Describe Vpn Connections Result

Gives you information about your VPN gateways. You can filter the results to return information only about VPN gateways that match criteria you specify. For example, you could ask to get information about a particular VPN gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is in a particular Availability Zone and the gateway's state is pending or available). The result includes information for a particular VPN gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN gateway ID - The current state of the VPN gateway (pending, available, deleting, deleted) 2. The type of VPN connection the VPN gateway supports. 3. The Availability Zone where the VPN gateway was created. 4. The VPCs the VPN gateway is attached to and the state of each attachment (attaching, attached, detaching, detached)

Describe Vpn Gateways Response

Describe Vpn Gateways Result

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. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. For more information about Amazon Virtual Private Cloud and Internet gateways, go to the Amazon Virtual Private Cloud User Guide.

The Response for the DetachInternetGateway operation.

Detach Network Interface request

Detach Network Interface response

Detaches an Amazon EBS volume from an instance. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. Important - make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to unmount file systems, or otherwise properly release the device from use, can result in lost data and will corrupt the file system.

Detach Volume Response

Detach Volume Result

Detaches a VPN 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 VPN gateway has been completely detached from a VPC by describing the VPN gateway (any attachments to the VPN 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 VPN gateway.

Detach Vpn Gateway Response

DHCP Configuration

DHCP Options

Disassociates the specified elastic IP address from the instance to which it is assigned. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

Disassociate Address Response

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, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the DisassociateRouteTable operation.

Details about the format of the image.

Details about the image.

Details about the size of the image.

Information about the EBS block device.

Describes the components of an Enable Volume IO request.

Enable Volume IO response.

Error

Error Response

A filter used to limit results when describing tags. Multiple values can be specified per filter. A tag must match at least one of the specified values for it to be returned from an operation. Wildcards can be included in filter values; * specifies that zero or more characters must match, and ? specifies that exactly one character must match.Use a backslash to escape special characters. For example, a filter value of \*amazon\?\\ specifies the literal string *amazon?\.

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

Get Console Output Response

Get Console Output Result

Retrieves the encrypted administrator password for the instances running Windows. Note - the Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.

Get Password Data Response

Get Password Data Result

AMI

Image Attribute

Specifies additional launch instance information.

Creates a new import instance task using metadata from the specified disk image.

The Response for the ImportInstance operation.

Import Instance Result

Imports the public key from an RSA key pair created with a third-party tool. This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers. RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages. The following formats are supported: - OpenSSH public key format, - Base64 encoded DER format. - SSH public key file format as specified in RFC4716.

The Response for the ImportKeyPair operation.

ImportKeyPair Result

Creates a new import volume task using metadata from the specified disk image.

The Response for the ImportVolume operation.

Import Volume Result

A list of instance attributes.

Information about the instance block device mapping set.

Information about the instance block device mapping.

Information about the instance EBS block device.

Information about the instance EBS block device.

Represents an active license in use and attached to an Amazon EC2 instance.

Part of a request to launch Amazon EC2 instances, specifying which license pool to use if a license should be attached to the new Amazon EC2 instance.

Instance Monitoring

Instance Network Interface

Instance Network Interface Association

Instance Network Interface Attachment

Instance Network Interface Specification

Instance State

Instance state change

Information about the status of an instance.

Instance Status Detail

Instance Status Detail Type

Details of a status event for an instance

The instance types possible by EC2. http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-RunInstances.html

IP Permission

IP Permission

Key Pair

Launch Permission

Specifies additional launch instance information.

A software license that can be associated with an Amazon EC2 instance when launched (ex. a Microsoft Windows license).

Represents the capacity that a license is able to support.

Modifies an attribute of an AMI

Modify Image Attribute Response

Modifies an attribute of an instance.

Information returned by a ModifyInstanceAttribute request.

Modify Network Interface Attachment

Modify Network Interface Attribute request. Modifies a network interface attribute. Only one attribute can be specified per call.

Modify Network Interface Attribute response

Adds or remove permission settings for the specified snapshot

Modify Snapshot Attribute Response

Modifies a volume attribute.

Modify Volume Attribute response.

Monitoring

Specifies whether to enable monitoring for the Spot Instance.

Enables monitoring for a running instance. For more information, refer to the Amazon CloudWatch Developer Guide.

Monitor Instances Response

Monitor Instances Result

Describes a Network Interface

Network Interface Association

Network Interface Attachment

Network Interface Attribute

Password Data

Specifies the placement constraints.

Represents a placement group into which multiple Amazon EC2 instances can be launched. A placement group ensures that Amazon EC2 instances are physically located close enough to support HPC features, such as higher IO network connections between instances in the group.

Constants for the strategy of a placement group. http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference_query_CreatePlacementGroup.html

Product Code

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide.

Purchase Reserved Instances Offering Response

Purchase Reserved Instances Offering Result

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. Note - if a Linux/UNIX instance does not cleanly shut down within four minutes, Amazon EC2 will perform a hard reboot.

Reboot Instances Response

This class describes the frequency and the amount of recurring charges.

Region

Registers an AMI with Amazon EC2. Images must be registered before they can be launched. To launch instances, use the RunInstances operation. Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image. The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. To deregister an image, use the DeregisterImage operation.

Register Image Response

Register Image Result

Releases an elastic IP address associated with your account. If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error. Note - releasing an IP address automatically disassociates it from any instance with which it is associated. To disassociate an IP address without releasing it, use the DisassociateAddress operation. Important - after releasing an elastic IP address, it is released to the IP address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address.

Release Address Response

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

The Response for the ReplaceNetworkAclAssociation operation.

ReplaceNetworkAclAssociation Result

Replaces an entry (i.e., rule) in a network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.

The Response for the ReplaceNetworkAclEntry operation.

Replaces an existing route within a route table in a VPC. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the ReplaceRoute operation.

Changes the route table associated with a given subnet in a VPC. After you execute this action, the subnet uses the routes in the new route table it's associated with. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The Response for the ReplaceRouteTableAssociation operation.

ReplaceRouteTableAssociation Result

Feedback about an instance's status. This action works only for instances that are in the running state. If your experience with the instance differs from the instance status returned by the DescribeInstanceStatus action, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Report Instance Status response.

Request to create a Spot Instance request.

The Response for the RequestSpotInstances operation.

Result of the Request Spot Instances operation.

Reservation

Reserved Instances

Reserved Instances Offering

Resets an attribute of an AMI to its default value. Note - The productCodes attribute cannot be reset.

Reset Image Attribute Response

Resets an attribute of an instance to its default value.

Information returned by a ResetInstanceAttribute request.

Reset Network Interface Attribute request

Reset Network Interface Attribute response

Resets permission settings for the specified snapshot

Reset Snapshot Attribute Response

Response Metadata

This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups. For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide. The action removes one or more egress rules from a VPC security group. The values that you specify in the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be revoked. Each rule consists of the protocol, and the CIDR range or destination 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.

The Response for the RevokeSecurityGroupEgress operation.

Revokes permissions from a security group. The permissions used to revoke must be specified using the same values used to grant the permissions. Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay is might occur.

Revoke Security GroupIngress Response

Route description

Route Table

Launches a specified number of instances of an AMI for which you have permissions. If Amazon EC2 cannot launch the minimum number AMIs you request, no instances will be launched. If there is insufficient capacity to launch the maximum number of AMIs you request, Amazon EC2 launches the minimum number specified for each AMI and allocate the remaining available instances using round robin. In the following example, Libby generates a request to launch two images (database and web_server): Libby runs the RunInstances operation to launch database instances (min. 10, max. 15) and web_server instances (min. 30, max. 40). Because there are currently 30 instances available and Libby needs a minimum of 40, no instances are launched. Libby adjusts the number of instances she needs and runs the RunInstances operation to launch database instances (min. 5, max. 10) and web_server instances (min. 20, max. 40). Amazon EC2 launches the minimum number of instances for each AMI (5 database, 20 web_server). The remaining 5 instances are allocated using round robin. Libby adjusts the number of instances she needs and runs the RunInstances operation again to launch database instances (min. 5, max. 10) and web_server instances (min. 20, max. 40). Note - every instance is launched in a security group (created using the CreateSecurityGroup operation.) You can provide an optional key pair ID for each image in the launch request (created using the CreateKeyPair operation). All instances that are created from images that use this key pair will have access to the associated public key at boot. You can use this key to provide secure access to an instance of an image on a per-instance basis. Amazon EC2 public images use this feature to provide secure access without passwords. Important - launching public images without a key pair ID will leave them inaccessible. The public key material is made available to the instance at boot time by placing it in the openssh_id.pub file on a logical device that is exposed to the instance as /dev/sda2 (the instance store). The format of this file is suitable for use as an entry within ~/.ssh/authorized_keys (the OpenSSH format). This can be done at boot (e.g., as part of rc.local) allowing for secure access without passwords. Optional user data can be provided in the launch request. All instances that collectively comprise the launch request have access to this data. For more information, go the Amazon Elastic Compute Cloud Developer Guide. Note - if any of the AMIs have a product code attached for which the user has not subscribed, the RunInstances call will fail. Important - we strongly recommend using the 2.6.18 Xen stock kernel with High-CPU and High-Memory instances. Although the default Amazon EC2 kernels will work, the new kernels provide greater stability and performance for these instance types. For more information about kernels, go the Amazon Elastic Compute Cloud Developer Guide

Run Instances Response

Run Instances Result

Properties of a Launched EC2 Instance

S3 Storage

Security Group

A Snapshot of an EBS volume.

Snapshot Attribute

Describes the Spot Datafeed subscription.

Describes the components of a Spot Instance request.

Fault details for the Spot Instance request, if any.

A single Spot Price history data point.

Starts an instance that uses an Amazon EBS volume as its root device. 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.

Information returned by the StartInstances request.

Result of a StartInstances request.

Reason for the state change.

Stops an instance that uses an Amazon EBS volume as its root device. 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. 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.

Information returned by a StopInstances request.

Result of a StopInstances request.

Storage

Subnet

Represents metadata to associate with Amazon EC2 resources. Each tag consists of a user-defined key and value. Use tags to categorize EC2 resources, such as by purpose, owner, or environment.

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call will succeed. Terminated instances will remain visible after termination (approximately one hour).

Terminate Instances Response

Terminate Instances Result

Disables monitoring for a running instance. For more information, refer to the Amazon CloudWatch Developer Guide.

Unmonitor Instances Response

Unmonitor Instances Result

Security group and user ID pair.

Constants for the possible virtualization type. http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-RunInstances.html

Volume

VolumeStatus

VolumeStatusAction

VolumeStatusDetail

VolumeStatusEvent

VolumeStatusInfo

VPC

VPC Attachment

VPN Connection

VPN Gateway

VPN Tunnel Telemetry