describe_db_capacity_reservations¶
Operation¶
describe_db_capacity_reservations
¶
describe_db_capacity_reservations(request: DescribeDBCapacityReservationsInput | DescribeDBCapacityReservationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBCapacityReservationsInputDict]) -> DescribeDBCapacityReservationsOutput
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 Amazon Web Services account.
This operation supports pagination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBCapacityReservationsInput | DescribeDBCapacityReservationsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeDBCapacityReservationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBCapacityReservationsOutput
|
An instance of |
describe_db_capacity_reservations
async
¶
describe_db_capacity_reservations(request: DescribeDBCapacityReservationsInput | DescribeDBCapacityReservationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBCapacityReservationsInputDict]) -> DescribeDBCapacityReservationsOutput
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 Amazon Web Services account.
This operation supports pagination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBCapacityReservationsInput | DescribeDBCapacityReservationsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeDBCapacityReservationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBCapacityReservationsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeDBCapacityReservationsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBCapacityReservationsInput.
Attributes¶
db_capacity_reservation_identifier
instance-attribute
¶
db_capacity_reservation_identifier: str | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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.
marker
instance-attribute
¶
marker: str | None
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.
max_records
instance-attribute
¶
max_records: int | None
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.
DescribeDBCapacityReservationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBCapacityReservationsInput structure.
Attributes¶
db_capacity_reservation_identifier
class-attribute
instance-attribute
¶
db_capacity_reservation_identifier: str | None = ...
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.
filters
class-attribute
instance-attribute
¶
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.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
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.
Output¶
DescribeDBCapacityReservationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBCapacityReservationsOutput structure.
Attributes¶
db_capacity_reservations
class-attribute
instance-attribute
¶
db_capacity_reservations: list[DBCapacityReservation] | None = ...
A list of DB capacity reservations.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
A pagination token that you can use in a later
DescribeDBCapacityReservations request. If this value is returned,
more records are available beyond this response.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.