Amazon Elastic Compute Cloud
API Reference (API Version 2013-02-01)
AWS Documentation » Amazon EC2 » API Reference » Actions » DescribeReservedInstances
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

DescribeReservedInstances

Description

Describes one or more of the Reserved Instances that you purchased.

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. 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, you only have access to the Medium Utilization Reserved Instance offering type.

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

Request Parameters

ReservedInstancesId.n

One or more Reserved Instance IDs.

Type: String

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

Required: No

offeringType

The Reserved Instance offering type.

Type: String

Valid values: Heavy Utilization | Medium Utilization | Light Utilization

Required: No

Filter.n.Name

The name of a filter. See the Supported Filters section for a list of supported filter names.

Type: String

Default: None

Required: No

Filter.n.Value.m

A value for the filter. See the Supported Filters section for a list of supported values for each filter.

Type: String

Default: None

Required: No

Supported Filters

You can specify filter so that the response includes information for only certain Reserved Instances. For example, you can use a filter to specify that you're interested in Reserved Instances in a specific Availability Zone. You can specify multiple values for a filter. The response includes information for a Reserved Instance only if it matches at least one of the filter values that you specified.

You can specify multiple filters; for example, specify Reserved Instances that are in a specific Availability Zone and have a specific tag. The response includes information for a Reserved Instance only if it matches all of the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.

availability-zone

The Availability Zone where the Reserved Instance can be used.

Type: String

duration

The duration of the Reserved Instance (one year or three years), in seconds.

Type: Long

Valid values: 31536000 | 94608000

fixed-price

The purchase price of the Reserved Instance (for example, 9800.0)

Type: Double

instance-type

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

Type: String

product-description

The product description of the Reserved Instance.

Type: String

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

reserved-instances-id

The ID of the Reserved Instance.

Type: String

start

The time at which the Reserved Instance purchase request was placed (for example, 2010-08-07T11:54:42.000Z).

Type: DateTime

state

The state of the Reserved Instance.

Type: String

Valid values: pending-payment | active | payment-failed | retired

tag-key

The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key filter.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the response based on a specific tag/value combination.

Example: To list just the resources that have been assigned tag Purpose=X, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Filter.1.Value.2=Y

usage-price

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

Type: Double

Response Elements

The following elements are returned in a DescribeReservedInstancesResponse element.

requestId

The ID of the request.

Type: xsd:string

reservedInstancesSet

A list of Reserved Instances, each one wrapped in an item element.

Type: DescribeReservedInstancesResponseSetItemType

Examples

Example Request

This example describes Reserved Instances owned by your account.

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

Example Response

<DescribeReservedInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/">
   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
   <reservedInstancesSet>         
      <item>
         <reservedInstancesId>4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8EXAMPLE</reservedInstancesId>
         <instanceType>m1.xlarge</instanceType>
         <availabilityZone>us-east-1a</availabilityZone>
         <duration>31536000</duration>
         <fixedPrice>1820.0</fixedPrice>
         <usagePrice>0.24</usagePrice>
         <instanceCount>3</instanceCount>
         <productDescription>Linux/UNIX</productDescription>
         <state>active</state> 
         <instanceTenancy>default</instanceTenancy>
         <currencyCode>USD</currencyCode>
         <offeringType>Light Utilization</offeringType>
         <recurringCharges/>
      </item>
   </reservedInstancesSet> 
</DescribeReservedInstancesResponse>

Example Request

This example filters the response to include only one-year, m1.small 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).

https://ec2.amazonaws.com/?Action=DescribeReservedInstances
&Filter.1.Name=duration
&Filter.1.Value.1=31536000
&Filter.2.Name=instance-type
&Filter.2.Value.1=m1.small
&Filter.3.Name=product-description
&Filter.3.Value.1=Linux/UNIX
&AUTHPARAMS
Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...