Request Parameters Response Elements Errors See Also

DescribeDBCapacityReservations

Describes one or more DB capacity reservations. A DB capacity reservation reserves capacity for Amazon RDS DB instances in one or more Availability Zones.

If you don't specify a DBCapacityReservationIdentifier, this operation returns information about all DB capacity reservations for your AWS account.

This operation supports pagination.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBCapacityReservationIdentifier

The identifier or the name of the DB capacity reservation to describe. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-z](?:-?[a-z0-9]+){0,15}

Required: No

Filters.Filter.N

A filter that specifies which DB capacity reservations to describe.

Supported filters:

db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.
state - Accepts reservation states. The response includes only the reservations in these states.
engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.
db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.
availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

Note

The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

Type: Array of Filter objects

Required: No

Marker

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

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints:

Must be a minimum of 20.
Can't exceed 100.

Type: Integer

Valid Range: Minimum value of 20. Maximum value of 100.

Required: No

Response Elements

The following elements are returned by the service.

DBCapacityReservations.member.N

A list of DB capacity reservations.

Type: Array of DBCapacityReservation objects

Marker

A pagination token that you can use in a later DescribeDBCapacityReservations request. If this value is returned, more records are available beyond this response.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

DBCapacityReservationNotFound

DBCapacityReservationIdentifier doesn't refer to an existing DB capacity reservation.

HTTP Status Code: 404