Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeReservedInstancesOfferings

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AvailabilityZone

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

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Filter.N

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

Type: array of Filter objects

Required: No

IncludeMarketplace

Include Reserved Instance Marketplace offerings in the response.

Type: Boolean

Required: No

InstanceTenancy

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

Type: String

Valid Values: default | dedicated | host

Required: No

InstanceType

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Type: String

Valid Values: t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | x1.16xlarge | x1.32xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | hi1.4xlarge | hs1.8xlarge | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | cc1.4xlarge | cc2.8xlarge | g2.2xlarge | g2.8xlarge | cg1.4xlarge | p2.xlarge | p2.8xlarge | p2.16xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | f1.2xlarge | f1.16xlarge

Required: No

MaxDuration

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

Type: Long

Required: No

MaxInstanceCount

The maximum number of instances to filter when searching for offerings.

Default: 20

Type: Integer

Required: No

MaxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

Type: Integer

Required: No

MinDuration

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

Type: Long

Required: No

NextToken

The token to retrieve the next page of results.

Type: String

Required: No

OfferingClass

The offering class of the Reserved Instance. Can be standard or convertible.

Type: String

Valid Values: standard | convertible

Required: No

OfferingType

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

Type: String

Valid Values: Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront

Required: No

ProductDescription

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

Type: String

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

Required: No

ReservedInstancesOfferingId.N

One or more Reserved Instances offering IDs.

Type: array of Strings

Required: No

Response Elements

The following elements are returned by the service.

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

reservedInstancesOfferingsSet

A list of Reserved Instances offerings.

Type: array of ReservedInstancesOffering objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example Describing Reserved Instance Marketplace Offerings Only

This example requests a list of Linux/UNIX, No Upfront Reserved Instances that are available through the Reserved Instance Marketplace only. When using the Query API, all strings must be URL-encoded.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &Filter.1.Name=marketplace &Filter.1.Value.1=true &IncludeMarketplace=true &OfferingType=No+Upfront &ProductDescription=Linux%2FUNIX &Version=2016-11-15 &AUTHPARAMS

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &AUTHPARAMS

Sample Response

Copy
<DescribeReservedInstancesOfferingsResponse> <requestId>cec5c904-8f3a-4de5-8f5a-ff7f9EXAMPLE</requestId> <reservedInstancesOfferingsSet> <item> <reservedInstancesOfferingId>253dfbf9-c335-4808-b956-d942cEXAMPLE</reservedInstancesOfferingId> <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId> <createDate>2012-07-06T19:35:29.000Z</createDate> <updateDate>2012-07-06T19:35:30.000Z</updateDate> <status>active</status> <statusMessage>ACTIVE</statusMessage> <instanceCounts> <item> <state>Available</state> <instanceCount>20</instanceCount> </item> <item> <state>Sold</state> <instanceCount>0</instanceCount> </item> <item> <state>Cancelled</state> <instanceCount>0</instanceCount> </item> <item> <state>Pending</state> <instanceCount>0</instanceCount> </item> </instanceCounts> <priceSchedules> <item> <term>8</term> <price>480.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>7</term> <price>420.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>6</term> <price>360.0</price> <currencyCode>USD</currencyCode> <active>active</active> </item> <item> <term>5</term> <price>300.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>4</term> <price>240.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>3</term> <price>180.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>2</term> <price>120.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> <item> <term>1</term> <price>60.0</price> <currencyCode>USD</currencyCode> <active>false</active> </item> </priceSchedules> <tagSet/> <clientToken>myclienttoken1</clientToken> </item> </reservedInstancesOfferingsSet> </DescribeReservedInstancesOfferingsResponse>
Copy
<DescribeReservedInstancesOfferingsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE</requestId> <reservedInstancesOfferingsSet> <item> <reservedInstancesOfferingId>a6ce8269-7b8c-42cd-a7f5-0841cEXAMPLE</reservedInstancesOfferingId> <instanceType>m3.xlarge</instanceType> <availabilityZone>us-east-1e</availabilityZone> <duration>2332800</duration> <fixedPrice>0.0</fixedPrice> <usagePrice>0.0</usagePrice> <productDescription>Linux/UNIX</productDescription> <instanceTenancy>default</instanceTenancy> <currencyCode>USD</currencyCode> <offeringType>No Upfront</offeringType> <recurringCharges> <item> <frequency>Hourly</frequency> <amount>0.19</amount> </item> </recurringCharges> <marketplace>true</marketplace> <pricingDetailsSet> <item> <price>0.0</price> <count>3</count> </item> </pricingDetailsSet> <offeringClass>standard</offeringClass> <scope>Availability Zone</scope> </item> <item> <reservedInstancesOfferingId>2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE</reservedInstancesOfferingId> <instanceType>m3.2xlarge</instanceType> <availabilityZone>us-east-1b</availabilityZone> <duration>15552000</duration> <fixedPrice>1.01</fixedPrice> <usagePrice>0.0</usagePrice> <productDescription>Linux/UNIX</productDescription> <instanceTenancy>default</instanceTenancy> <currencyCode>USD</currencyCode> <offeringType>No Upfront</offeringType> <recurringCharges> <item> <frequency>Hourly</frequency> <amount>0.38</amount> </item> </recurringCharges> <marketplace>true</marketplace> <pricingDetailsSet> <item> <price>1.01</price> <count>1</count> </item> </pricingDetailsSet> <offeringClass>standard</offeringClass> <scope>Availability Zone</scope> </item> </reservedInstancesOfferingsSet> </DescribeReservedInstancesOfferingsResponse>

Example Describing AWS Offerings Only

This example lists AWS offerings only.

Sample Request

Copy
http://ec2.amazonaws.com/doc/2016-11-15/?Action=DescribeReservedInstancesOfferings &IncludeMarketplace=false &AUTHPARAMS

Sample Response

Copy
<DescribeReservedInstancesOfferingsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>2bc7dafa-dafd-4257-b6tf-c0814EXAMPLE</requestId> <reservedInstancesOfferingsSet> <item> <reservedInstancesOfferingId>a6ce8269-7b8c-42cd-a6y5-0841cEXAMPLE</reservedInstancesOfferingId> <instanceType>c1.medium</instanceType> <availabilityZone>us-east-1e</availabilityZone> <duration>94608000</duration> <fixedPrice>631.0</fixedPrice> <usagePrice>0.0</usagePrice> <productDescription>Linux/UNIX</productDescription> <instanceTenancy>default</instanceTenancy> <currencyCode>USD</currencyCode> <offeringType>Partial Upfront</offeringType> <recurringCharges> <item> <frequency>Hourly</frequency> <amount>0.28</amount> </item> </recurringCharges> <marketplace>false</marketplace> <pricingDetailsSet/> <offeringClass>standard</offeringClass> <scope>Availability Zone</scope> </item> <item> <reservedInstancesOfferingId>2bc7dafa-rafd-6t7y-bdf9-c0814EXAMPLE</reservedInstancesOfferingId> <instanceType>c1.medium</instanceType> <availabilityZone>us-east-1b</availabilityZone> <duration>94608000</duration> <fixedPrice>631.0</fixedPrice> <usagePrice>0.0</usagePrice> <productDescription>Linux/UNIX</productDescription> <instanceTenancy>default</instanceTenancy> <currencyCode>USD</currencyCode> <offeringType>Partial Upfront</offeringType> <recurringCharges> <item> <frequency>Hourly</frequency> <amount>0.88</amount> </item> </recurringCharges> <marketplace>false</marketplace> <pricingDetailsSet/> <offeringClass>convertible</offeringClass> <scope>Availability Zone</scope> </reservedInstancesOfferingsSet> </DescribeReservedInstancesOfferingsResponse>

Example Using Tokens to Manage Results

You can use pagination support to query the results sequentially and in parts.

Specify the maximum number of results that are returned in the response. Then, each paginated response contains a token that can be provided as input to a subsequent DescribeReservedInstancesOfferings call to fetch the next page. (Make sure that you use URL encoding for the token value.)

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &MaxResults=5 &AUTHPARAMS

Sample Response

Copy
<DescribeReservedInstancesOfferingsResponse> <requestId>d072f652-cc57-458c-89e0-e6c02EXAMPLE</requestId> <reservedInstancesOfferingsSet> ... <item> <reservedInstancesOfferingId>649fd0c8-7846-46b8-8f84-a6400EXAMPLE</reservedInstancesOfferingId> <instanceType>c1.medium</instanceType> <availabilityZone>us-east-1a</availabilityZone> <duration>94608000</duration> <fixedPrice>631.0</fixedPrice> <usagePrice>0.0</usagePrice> <productDescription>Linux/UNIX (Amazon VPC)</productDescription> <instanceTenancy>default</instanceTenancy> <currencyCode>USD</currencyCode> <offeringType>Partial Upfront</offeringType> <recurringCharges> <item> <frequency>>Hourly</frequency> <amount>0.028</amount> </item> <recurringCharges> <marketplace>false</marketplace> <pricingDetailsSet/> <offeringClass>standard</offeringClass> <scope>Availability Zone</scope> </item> ... </reservedInstancesOfferingsSet> <nextToken>h/C8YKPQBHEjW8xKz1827/Zzyb0VqsqkjRo3TqhFYeE=</nextToken> </DescribeReservedInstancesOfferingsResponse> &MaxResults=5 &NextToken=h%2FC8YKPQBHEjW8xKz1827%2FZzyb0VqsqkjRo3TqhFYeE%3D &AUTHPARAMS

Example Using Filters

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

Sample Request

Copy
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%2FUNIX &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: