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 Digg

DescribeReservedInstances

Description

Describes Reserved Instances that you purchased. For more information about Reserved Instances, go to Reserving Amazon EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

You can filter the results to return information only about Reserved Instances that match criteria you specify. For example, you could get information about only Reserved Instances in a particular Availability Zone. You can specify multiple values for a filter. A Reserved Instance must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the instance is in a particular Availability Zone and is tagged with a particular value). The result includes information for a particular instance only if it matches all your 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-id

Reserved Instance's ID.

Type: String

start

Time the Reserved Instance purchase request was placed, e.g., 2010-08-07T11:54:42.000Z.

Type: xsd:dateTime

state

State of the Reserved Instance.

Type: String

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

tag-key

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=X, see the tag:key filter later in this table.

For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

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

Type: String

tag:key

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

Example: To list just the resources assigned tag Purpose=X, then specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Filter.1.Value.2=Y

usage-price

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

Type: xs:double

Request Parameters

NameDescriptionRequired

ReservedInstancesId.n

One or more Reserved Instance IDs.

Type: String

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

No

Filter.n.Name

Name of a filter. See the preceding table for a list of allowed filter names.

Type: String

Default: None

No

Filter.n.Value.m

A value for the filter. See the preceding table for a list of allowed values for each filter.

Type: String

Default: None

No

Response Elements

The elements in the following table are wrapped in a DescribeReservedInstancesResponse structure.

NameDescription

requestId

The ID of the request.

Type: xsd:string

reservedInstancesSet

A list of Reserved Instances. Each Reserved Instance's information is 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/2011-01-01/">
   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
   <reservedInstancesSet>         
      <item>
         <reservedInstancesId>4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8</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> 
         <tagSet/>
      </item>
   </reservedInstancesSet> 
</DescribeReservedInstancesResponse>

Example Request

This example filters the results to display only one-year, m1.small 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=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