Amazon Relational Database Service
Command Line Interface Reference (API Version 2012-04-23)
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 DiggDid this page help you?  Yes  No   Tell us about it...

rds-describe-reserved-db-instances

Description

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Syntax

rds-describe-reserved-db-instances ReservedDBInstanceID

[-c (--db-instance-class) value ]

[-d (--duration) value ]

[-m (--multi-az) value ]

[-p (--product-description) value ]

[-o (--reserved-db-instances-offering-id) value ]

[--max-records ] value

[General Options]

Options

NameDescriptionRequired

ReservedDBInstance

--reserved-db-instance-id value

Reserved DB Instance identifier. Provide this parameter to return only information about a specific reserved DB Instance.

You can also set this value using the --reserved-db-instance-id parameter.

Type: String

Default: None

Example: --reserved-db-instance-id myreserveddbinstance

No

-c

--db-instance-class value

DB Instance class filter value. Specify this parameter to show only reservations matching the specified DB Instances class.

Type: String

Default: None

Example: -c db.m1.xlarge

No

-d

--duration value

Duration filter value, specified in years. Specify this parameter to show only reservations for this duration.

Type: String

Default: None

Example: -d 3y

No

-m

--multi-az value

Multi-AZ filter value. Specify this parameter to show only reservations matching the specified multi-AZ parameter.

Type: Boolean

Default: None

Example: -m true

No

-p

--product-description value

Product description filter value. Specify this parameter to show only reservations matching the specified product description.

Type: String

Default: None

Example: -p mysql

No

-o

--reserved-db-instances-offering-id value

Offering identifier filter value. Specify this parameter to show only reservations matching the specified offering identifier.

Type: String

Default: None

Example: --reserved-db-instances-offering-id SampleReservationID

No

Output

The command returns a table with the following information:

  • ReservationId—the unique identifier for the reservation.

  • OfferingID—the offering identifier (only appears when the --show-long parameter is specified).

  • Class—the DB instance class for the reservation.

  • Multi-AZ—indicates if the reservation applies to Multi-AZ deployments.

  • Start Time—the time the reservation started

  • Duration—the duration of the reservation in years

  • Fixed Price—the fixed price charged for each DB Instance in this reservation (only appears when the --show-long parameter is specified).

  • Usage Price—the hourly price to run each reserved DB Instance (only appears when the --show-long parameter is specified).

  • Count—the number of database instances reserved.

  • Status—the status of the reservation.

  • Description—the database engine used by the reservation.

Examples

Describing Reserved Instances

This example returns descriptions of all of your database instance reservations

PROMPT> rds-describe-reserved-db-instances
                    
                

Describing a Specific Reserved Instance

This example returns information about a specific reserved DB Instance.

PROMPT> rds-describe-reserved-db-instances reservation1 --show-long --header