         | Did this page help you? Yes No Tell us about it... |
DescribeReservedInstancesOfferings
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 Instances offerings by including the optional
offeringType parameter when calling DescribeReservedInstancesOfferings.
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, DescribeReservedInstancesOfferings
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 where the Reserved Instance can be used. Type: String |
|
|
Duration of the Reserved Instance (e.g., one year or three years), in seconds. Type: xs:long Valid Values: |
|
|
Purchase price of the Reserved Instance (e.g., Type: xs:double |
|
|
Instance type on which the Reserved Instance can be used. Type: String |
|
|
Reserved Instance description. Type: String Valid Values: |
|
|
Reserved Instances offering ID. Type: String |
|
|
Usage price of the Reserved Instance, per hour (e.g., Type: xs:double |
Request Parameters
| Name | Description | Required |
|---|---|---|
|
|
One or more Reserved Instances offering IDs. Type: String Default: None |
No |
|
|
The instance type on which the Reserved Instance can be used. Type: String Default: None |
No |
|
|
The Availability Zone in which the Reserved Instance can be used. Type: String Default: None |
No |
|
|
The Reserved Instance description. Instances that include
Type: String Valid Values: Default: None |
No |
|
|
Name of a filter. See the preceding table for a list of allowed filter names. Type: String Default: None |
No |
|
|
A value for the filter. See the preceding table for a list of allowed values for each filter. Type: String Default: None |
No |
|
|
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 Valid Values: Default: default |
No |
|
|
The Reserved Instance offering type. Type: String Valid Values: Default: none |
No |
Response Elements
The elements in the following table are wrapped in a
DescribeReservedInstancesOfferingsResponse structure.
| Name | Description |
|---|---|
|
|
The ID of the request. Type: xsd:string |
|
|
A list of Reserved Instances offerings. Each offering's
information is wrapped in an |
Examples
Example Request
This example describes available Reserved Instance offerings.
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &AUTHPARAMS
Example Response
<DescribeReservedInstancesOfferingsResponse xmlns="http://ec2.amazonaws.com/doc/2011-12-15/">
<requestId>48692a1d-3036-48fd-8c0e-d34681b97efdEXAMPLE</requestId>
<reservedInstancesOfferingsSet>
<item>
<reservedInstancesOfferingId>248e7b75-c83a-48c1-bcf7-b7f03e9c43feEXAMPLE</reservedInstancesOfferingId>
<instanceType>c1.medium</instanceType>
<availabilityZone>us-east-1b</availabilityZone>
<duration>94608000</duration>
<fixedPrice>700.0</fixedPrice>
<usagePrice>0.06</usagePrice>
<productDescription>Linux/UNIX (Amazon VPC)</productDescription>
<instanceTenancy>default</instanceTenancy>
<currencyCode>USD</currencyCode>
<offeringType>Medium Utilization</offeringType>
<recurringCharges/>
</item>
...
</reservedInstancesOfferingsSet>
</DescribeReservedInstancesOfferingsResponse>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).
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &Filter.1.Name=duration &Filter.1.Value.1=31536000 &Filter.2.Name=instance-type &Filter.2.Value.1=m1.small &Filter.2.Value.2=m1.large &Filter.3.Name=product-description &Filter.3.Value.1=Linux/UNIX &AUTHPARAMS
