GET

/#Action=DescribeReservedDBInstances

http://rds.{region}.amazonaws.com/#Action=DescribeReservedDBInstances

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

Access Token Required: API Key

Query Params

ReservedDBInstanceIdstring

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

ReservedDBInstancesOfferingIdstring

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

DBInstanceClassstring

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Durationstring

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: <code>1 | 3 | 31536000 | 94608000</code>

ProductDescriptionstring

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

OfferingTypestring

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code>

MultiAZboolean

A value that indicates whether to show only those reservations that support Multi-AZ.

LeaseIdstring

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. <note> Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. </note>

Filtersarray

This parameter isn't currently supported.

MaxRecordsinteger

The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.

Markerstring

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://rds.{region}.amazonaws.com/#Action=DescribeReservedDBInstances' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}