Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-describe-reserved-db-instances

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Syntax

rds-describe-reserved-db-instances reserved-db-instance-id

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

[-d (--duration) value ]

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

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

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

[-t (--offering-type) value ]

[General Options]

Options

Name Description Required

--reserved-db-instance-id value

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

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-describe-reserved-db-instances my-reserved-db-instance-id.

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

-t

--offering-type value

If specified, only reserved DB instances for this offering type will be shown.

Type: String

Default: None

Example: --offering-type "Partial Upfront"

No

Output

The command returns a table with the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • 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

Copy
PROMPT> rds-describe-reserved-db-instances

Describing a Specific Reserved Instance

This example returns information about a specific reserved DB instance.

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