ec2-purchase-reserved-instances-offering

Description

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.

Starting with the 2011-11-01 API version, AWS expanded its offering of Amazon EC2 Reserved Instances to address a range of projected instance use. There are three types of Reserved Instances based on customer utilization levels: Heavy Utilization, Medium Utilization, and Light Utilization. You determine the type of the Reserved Instances offerings by including the optional offering-type parameter when calling ec2-describe-reserved-instances-offerings. After you've identified the Reserved Instance with the offering type you want, specify its --offering when you call ec2-purchase-reserved-instances-offering.

The Medium Utilization offering type is equivalent to the Reserved Instance offering available before API version 2011-11-01. If you are using tools that predate the 2011-11-01 API version, ec2-describe-reserved-instances-offerings will only list information about the Medium Utilization Reserved Instance offering type.

For more information about Reserved Instances, go to Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

The short version of this command is ec2prio.

Syntax

ec2-purchase-reserved-instances-offering --offering offering --instance-count count

Options

Name Description Required

Name	Description	Required
`-o, --offering` `offering`	The offering ID of the Reserved Instance to purchase. Type: String Default: None Example: -o 4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8	Yes
`-c, --instance-count` `count`	The number of Reserved Instances to purchase. Type: Integer Default: 1 Example: -c 5	Yes

-o, --offering offering

The offering ID of the Reserved Instance to purchase.

Type: String

Default: None

Example: -o 4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8

Yes

-c, --instance-count count

The number of Reserved Instances to purchase.

Type: Integer

Default: 1

Example: -c 5

Yes

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

RESERVEDINSTANCES identifier
The ID(s) of the purchased Reserved Instances

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example illustrates a purchase of a Reserved Instances offering.

PROMPT> ec2-purchase-reserved-instances-offering --offering 649fd0c8-becc-49d9-b259-fc8e2aa08833 --instance-count 3
RESERVEDINSTANCES b847fa93-0c31-405b-b745-b6bf00032333
 b847fa93-0c31-405b-b745-b6bf00032334 b847fa93-0c31-405b-b745-b6bf00032335