Skip to content

describe_reserved_db_instances

Operation

describe_reserved_db_instances

describe_reserved_db_instances(request: DescribeReservedDBInstancesInput | DescribeReservedDBInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedDBInstancesInputDict]) -> DescribeReservedDBInstancesOutput

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

Parameters:

Name Type Description Default
request DescribeReservedDBInstancesInput | DescribeReservedDBInstancesInputDict | 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[DescribeReservedDBInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeReservedDBInstancesOutput

An instance of DescribeReservedDBInstancesOutput.

describe_reserved_db_instances async

describe_reserved_db_instances(request: DescribeReservedDBInstancesInput | DescribeReservedDBInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedDBInstancesInputDict]) -> DescribeReservedDBInstancesOutput

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

Parameters:

Name Type Description Default
request DescribeReservedDBInstancesInput | DescribeReservedDBInstancesInputDict | 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[DescribeReservedDBInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeReservedDBInstancesOutput

An instance of DescribeReservedDBInstancesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeReservedDBInstancesInputDict

Bases: TypedDict

Dictionary form of DescribeReservedDBInstancesInput.

Attributes

db_instance_class instance-attribute
db_instance_class: str | None

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

duration instance-attribute
duration: str | None

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

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

lease_id instance-attribute
lease_id: str | None

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.

marker instance-attribute
marker: str | None

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 MaxRecords.

max_records instance-attribute
max_records: int | None

The maximum number of records to include in the response. If more than the MaxRecords 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.

multi_az instance-attribute
multi_az: bool | None

Specifies whether to show only those reservations that support Multi-AZ.

offering_type instance-attribute
offering_type: str | None

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

product_description instance-attribute
product_description: str | None

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

reserved_db_instance_id instance-attribute
reserved_db_instance_id: str | None

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

reserved_db_instances_offering_id instance-attribute
reserved_db_instances_offering_id: str | None

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

DescribeReservedDBInstancesInput dataclass

Bases: _SerdeShape

Attributes

db_instance_class class-attribute instance-attribute
db_instance_class: str | None = ...

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

duration class-attribute instance-attribute
duration: str | None = ...

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

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

lease_id class-attribute instance-attribute
lease_id: str | None = ...

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.

marker class-attribute instance-attribute
marker: str | None = ...

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 MaxRecords.

max_records class-attribute instance-attribute
max_records: int | None = ...

The maximum number of records to include in the response. If more than the MaxRecords 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.

multi_az class-attribute instance-attribute
multi_az: bool | None = ...

Specifies whether to show only those reservations that support Multi-AZ.

offering_type class-attribute instance-attribute
offering_type: str | None = ...

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

product_description class-attribute instance-attribute
product_description: str | None = ...

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

reserved_db_instance_id class-attribute instance-attribute
reserved_db_instance_id: str | None = ...

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

reserved_db_instances_offering_id class-attribute instance-attribute
reserved_db_instances_offering_id: str | None = ...

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

Output

DescribeReservedDBInstancesOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

Attributes

marker class-attribute instance-attribute
marker: str | None = ...

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 MaxRecords.

reserved_db_instances class-attribute instance-attribute
reserved_db_instances: list[ReservedDBInstance] | None = ...

A list of reserved DB instances.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.