Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-describe-reserved-instances-offerings

Description

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.

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 Instance offering by including the optional offering-type parameter when calling ec2-describe-reserved-instances-offerings. 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.

Our policy is to provide filters for all describe calls so you can limit the results to your specified criteria. Therefore, you can use filters to limit the results when describing Reserved Instances offerings, even though you can use the regular request parameters to do something similar.

For example, you could use the regular request parameters or a filter to get the offerings for a particular instance type. You can specify multiple request parameters or multiple filters (e.g., limit the results to the m2.xlarge instance type, and only for Windows instances). The result includes information for a particular offering only if it matches all your request parameters or 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 following table shows the available filters.

Filter Name Description

availability-zone

Availability Zone where the Reserved Instance can be used.

Type: String

duration

Duration of the Reserved Instance (e.g., one year or three years), in seconds.

Type: xs:long

Valid Values: 31536000 | 94608000

fixed-price

Purchase price of the Reserved Instance (e.g., 9800.0)

Type: xs:double

instance-type

Instance type on which the Reserved Instance can be used.

Type: String

product-description

Reserved Instance description.

Type: String

Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)

reserved-instances-offering-id

Reserved Instances offering ID.

Type: String

usage-price

Usage price of the Reserved Instance, per hour (e.g., 0.84)

Type: xs:double

The short version of this command is ec2drio.

Syntax

ec2-describe-reserved-instances-offerings [offering_id ...] [--type instance_type ...] [--offering-type offering] [--availability-zone zone ...] [--description description ...] [[--filter name=value] ...] [--tenancy tenancy]

Options

NameDescriptionRequired

offering_id

ID of a Reserved Instance offering.

Type: String

Default: None

Example: 438012d3-4967-4ba9-aa40-cbb1d13235e0

No

-t, --type instance_type

The instance type on which the Reserved Instance can be used.

Type: String

Default: None

Example: -t m1.small

No

--offering-type offering-type

The Reserved Instance offering type.

Type: String

Default: None

Valid Values: "Heavy Utilization" | "Medium Utilization" | "Light Utilization"

Example: --offering-type "Medium Utilization"

No

-z, --availability-zone zone

The Availability Zone in which the Reserved Instance can be used.

Type: String

Default: None

Example: -z us-east-1a

No

-d, --description description

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

Type: String

Default: None

Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)

Example: -d Linux/UNIX

No

-F, --filter FILTER name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "name=value").

Type: String

Default: Describes all Reserved Instances offerings, or those otherwise specified.

Example: --filter "instance-type=m1.small"

No

--tenancy TENANCY

Specifies the tenancy of the Reserved Instance offering. A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC.

Type: String

Default: default

Valid Values: default | dedicated

No

Common Options

OptionDescription

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

  • OFFERING identifier

  • ID of the offer

  • The instance type

  • The Availability Zone in which the Reserved Instance can be used

  • The duration of the Reserved Instance

  • The purchase price of the Reserved Instance

  • The usage price of the Reserved Instance, per hour

  • The Reserved Instance description (Linux/UNIX, Windows, Linux/UNIX (Amazon VPC), or Windows (Amazon VPC))

  • The tenancy of the Reserved Instance.

  • The currency of the Reserved Instance. It's specified using ISO 4217 standard (e.g., USD, JPY).

  • The instance offering type

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example describes available Reserved Instance offerings in the us-east-1 Availability Zone.

PROMPT> ec2-describe-reserved-instances-offerings --region us-east-1 -H
Type	ReservedInstancesOfferingId	AvailabilityZone	InstanceType	Duration	FixedPrice	UsagePrice	ProductDescription	Currency	InstanceTenancy	OfferingType
OFFERING	248e7b75-c83a-48c1-bcf7-b7f03e9c43fe	us-east-1b	c1.medium	3y 	700.0	0.06	Linux/UNIX (Amazon VPC)	USD	default	Medium Utilization
OFFERING	3a98bf7d-05c0-40d0-a173-81a3986ba568	us-east-1b	c1.medium	3y 	700.0	0.125	Windows	USD	default	Medium Utilization
OFFERING	4b2293b4-ff40-4a1a-9fef-1f12ad37a711	us-east-1b	c1.medium	3y 	700.0	0.06	Linux/UNIX	USD	default	Medium Utilization
...
OFFERING	4b2293b4-b3c5-4ad1-b7f5-b7832ecd6d63	us-east-1d	m1.xlarge	3y 	3600.0	0.0	Linux/UNIX	USD	default	Heavy Utilization
...
OFFERING	649fd0c8-efd6-4800-a7f3-0a9f1c3ea2c1	us-east-1d	m2.xlarge	1y 	1000.0	0.5	Linux/UNIX	USD	default	Light Utilization
...

Example Request

This example filters the results to display only one-year, m1.small or m1.large Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with Amazon VPC, set the product descripton to Linux/UNIX (Amazon VPC).

PROMPT> ec2-describe-reserved-instances-offerings --filter "duration=31536000" --filter "instance-type=m1.small" --filter "instance-type=m1.large" --filter "product-description=Linux/UNIX" -H
Type	ReservedInstancesOfferingId	AvailabilityZone	InstanceType	Duration	FixedPrice	UsagePrice	ProductDescription	Currency	InstanceTenancy	OfferingType
OFFERING	649fd0c8-7d25-4e81-959e-0e1bc9410a87	us-east-1c	m1.large	1y 	910.0	0.12	Linux/UNIX	USD	default	Medium Utilization
OFFERING	438012d3-278f-4ad6-9cb9-e23188dafcf5	us-east-1b	m1.large	1y 	910.0	0.12	Linux/UNIX	USD	default	Medium Utilization
OFFERING	4b2293b4-20f5-4b3d-9969-46341f34b03c	us-east-1d	m1.large	1y 	910.0	0.12	Linux/UNIX	USD	default	Medium Utilization
OFFERING	3a98bf7d-abc6-47a0-870e-e245903ddf6a	us-east-1a	m1.large	1y 	910.0	0.12	Linux/UNIX	USD	default	Medium Utilization
OFFERING	ceb6a579-757c-474b-b09b-52c84b605767	us-east-1c	m1.small	1y 	227.5	0.03	Linux/UNIX	USD	default	Medium Utilization
OFFERING	60dcfab3-06bb-4b68-9503-53bf89823b5e	us-east-1b	m1.small	1y 	227.5	0.03	Linux/UNIX	USD	default	Medium Utilization
OFFERING	438012d3-80c7-42c6-9396-a209c58607f9	us-east-1d	m1.small	1y 	227.5	0.03	Linux/UNIX	USD	default	Medium Utilization
OFFERING	649fd0c8-5d76-4881-a522-fe5224c10fcc	us-east-1a	m1.small	1y 	227.5	0.03	Linux/UNIX	USD	default	Medium Utilization
...