Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
AWS Documentation » Amazon EC2 » Command Line Reference » Commands (CLI Tools) » ec2-describe-reserved-instances
« 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...

ec2-describe-reserved-instances

Description

Describes the Reserved Instances that you purchased.

Starting with the 2011-11-01 API version, AWS expanded its offering for 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. 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.

The short version of this command is ec2dri.

Syntax

ec2-describe-reserved-instances [reservation_id ...] [[--filter "name=value"] ...]

Options

NameDescription

reservation_id

The IDs of the Reserved Instances.

Type: String

Default: Describes all your Reserved Instances.

Required: No

Example: 4b2293b4-5813-4cc8-9ce3-1957fexample

-F, --filter name=value

A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value").

Type: String

Default: Describes all your Reserved Instances, or only those you specified by ID.

Required: No

Example: --filter "tag-key=Production"

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 tag:Purpose=X

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

--filter tag:Purpose=X --filter tag:Purpose=Y

usage-price

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

Type: Double

Common Options

OptionDescription

--region REGION

Overrides the region specified by the EC2_URL environment variable and the URL specified by the -U option.

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are.

Default: The value of the EC2_PRIVATE_KEY environment variable. If EC2_PRIVATE_KEY isn't set, you must specify this option.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate that identifies you to Amazon EC2.

Default: The value of the EC2_CERT environment variable. If EC2_CERT isn't set, you must specify this option.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns a table that contains the following information:

  • The RESERVEDINSTANCES identifier

  • The ID of the Reserved Instance

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

  • The instance type

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

  • The duration of the Reserved Instance

  • The upfront fee (fixed price) you pay for the Reserved Instance

  • The fee (usage price) you pay per hour for using your Reserved Instance

  • The number of Reserved Instances purchased

  • The start date of the Reserved Instance term

  • The state of the Reserved Instance purchase (payment-pending, active, payment-failed)

  • The currency of the Reserved Instance purchased. It's specified using ISO 4217 standard code (for example, USD, JPY).

  • The tenancy of the reserved instance purchased. An instance with a tenancy of dedicated runs on single-tenant hardware.

  • The instance offering type

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example describes Reserved Instances owned by your account.

PROMPT> ec2-describe-reserved-instances
RESERVEDINSTANCES	1ba8e2e3-2538-4a35-b749-1f444example	us-east-1a	m1.small	Linux/UNIX	3y	350.0	0.03	1	2009-03-13T16:01:39+0000	payment-pending	USD	default	Light Utilization
RESERVEDINSTANCES	af9f760e-c1c1-449b-8128-1342dexample	us-east-1d	m1.xlarge	Linux/UNIX	1y	1820.0	0.24	1	2009-03-13T16:01:39+0000	active	USD	default	Medium Utilization

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).

PROMPT> ec2-describe-reserved-instances --filter "duration=31536000" --filter "instance-type=m1.small" --filter "product-description=Linux/UNIX"

Related Topics

Download

Related Action

Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...