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

rds-describe-reserved-db-instances-offerings

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 available reserved DB instance offerings.

Syntax

rds-describe-reserved-db-instances-offerings reserved-db-instances-offering-id [--reserved-db-instances-offering-id value ]

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

[-d (--duration) value ]

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

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

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

[General Options]

Options

Name Description Required

reserved-db-instances-offering-id value

Offering identifier filter value. Specify this parameter to show only the available offering that matches the specified Reserved DB instances Offering.

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-offerings my-reserved-db-instances-offering-id.

Type: String

Default: None

Example: --reserved-db-instances-offering-id 438012d3-4052-4cc7-b2e3-8d3372e0e706

No

-c

--db-instance-class value

DB instance class filter value. Specify this parameter to show only the available offerings matching 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 the available offerings for this duration.

Type: String

Default: None

Example: -d 3

No

-m

--multi-az value

Multi-AZ filter value. Specify this parameter to show only available offerings 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 available offerings matching the specified product description.

Type: Boolean

Default: None

Example: -p mysql

No

-t

--offering-type value

If specified, only offerings 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.

  • OfferingId—the unique identifier for the offering.

  • Class—the DB instance class for the offering.

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

  • Duration—the length of the duration in years

  • Fixed Price—the fixed price charged to reserve each DB instance.

  • Usage Price—the hourly price to run each reserved DB instance.

  • Description—the database engine used by the offering.

Examples

Describing Reserved Instances Offerings

This example returns descriptions of all reserved database instance offerings.

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

Describing a Specific Reserved Instance Offering

This example returns information about a specific reserved DB instance offering.

Copy
PROMPT> rds-describe-reserved-db-instances-offerings offering-id --headers

Describing Only Multi-AZ Reserved Instance Offerings

This example returns information about Multi-AZ reserved DB instance offerings.

Copy
PROMPT> rds-describe-reserved-db-instances-offerings --multi-az true