DescribeReservedDBInstances - Amazon Relational Database Service

Description

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

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name	Description	Required
`DBInstanceClass`	The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class. Type: String	No
`Duration`	The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: `1 \| 3 \| 31536000 \| 94608000` Type: String	No
`Marker`	The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to `MaxRecords`. Type: String	No
`MaxRecords`	The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer	No
`MultiAZ`	The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. Type: Boolean	No
`OfferingType`	The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: `"Light Utilization" \| "Medium Utilization" \| "Heavy Utilization"` Type: String	No
`ProductDescription`	The product description filter value. Specify this parameter to show only those reservations matching the specified product description. Type: String	No
`ReservedDBInstanceId`	The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. Type: String	No
`ReservedDBInstancesOfferingId`	The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. Type: String	No

Response Elements

The following elements come wrapped in a DescribeReservedDBInstancesResult structure.

Name Description

Name	Description
`Marker`	The marker provided for paginated results. Type: String
`ReservedDBInstances`	A list of of reserved DB Instances. Type: ReservedDBInstance list

Marker

The marker provided for paginated results.

Type: String

ReservedDBInstances

A list of of reserved DB Instances.

Type: ReservedDBInstance list

Errors

For information about the common errors that all actions use, see Common Errors.

Error	Description	HTTP Status Code
`ReservedDBInstanceNotFound`	The specified reserved DB Instance not found.	404

Examples

Sample Request

https://rds.amazonaws.com/
   ?Action=DescribeReservedDBInstances
   &ReservedDBInstanceId=customerSpecifiedID
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2012-12-18T18%3A31%3A36.118Z
   &AWSAccessKeyId=<AWS Access Key ID>
   &Signature=<Signature>

Sample Response

<DescribeReservedDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeReservedDBInstancesResult>
    <ReservedDBInstances>
      <ReservedDBInstance>
        <OfferingType>Medium Utilization</OfferingType>
        <CurrencyCode>USD</CurrencyCode>
        <RecurringCharges/>
        <ProductDescription>mysql</ProductDescription>
        <ReservedDBInstancesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedDBInstancesOfferingId>
        <MultiAZ>false</MultiAZ>
        <State>active</State>
        <ReservedDBInstanceId>myreservationid</ReservedDBInstanceId>
        <DBInstanceCount>1</DBInstanceCount>
        <StartTime>2010-12-15T00:25:14.131Z</StartTime>
        <Duration>31536000</Duration>
        <FixedPrice>227.5</FixedPrice>
        <UsagePrice>0.046</UsagePrice>
        <DBInstanceClass>db.m1.small</DBInstanceClass>
      </ReservedDBInstance>      
  </DescribeReservedDBInstancesResult>
  <ResponseMetadata>
    <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedDBInstancesResponse>