Skip to content

DescribeReservedDBInstancesMessage

Source code in docs_src/capo_rds/types/describe_reserved_db_instances_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class DescribeReservedDBInstancesMessage(TypedDict, closed=True):
    reserved_db_instance_id: NotRequired["capo_rds.types.string.String"]
    """<p>The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.</p>"""
    reserved_db_instances_offering_id: NotRequired["capo_rds.types.string.String"]
    """<p>The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.</p>"""
    db_instance_class: NotRequired["capo_rds.types.string.String"]
    """<p>The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.</p>"""
    duration: NotRequired["capo_rds.types.string.String"]
    """<p>The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.</p> <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code> </p>"""
    product_description: NotRequired["capo_rds.types.string.String"]
    """<p>The product description filter value. Specify this parameter to show only those reservations matching the specified product description.</p>"""
    offering_type: NotRequired["capo_rds.types.string.String"]
    """<p>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.</p> <p>Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code> </p>"""
    multi_az: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether to show only those reservations that support Multi-AZ.</p>"""
    lease_id: NotRequired["capo_rds.types.string.String"]
    """<p>The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.</p> <note> <p>Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.</p> </note>"""
    filters: NotRequired["capo_rds.types.filter_list.FilterList"]
    """<p>This parameter isn't currently supported.</p>"""
    max_records: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>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.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"""
    marker: NotRequired["capo_rds.types.string.String"]
    """<p>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>.</p>"""

db_instance_class instance-attribute 

db_instance_class: NotRequired[String]

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

duration instance-attribute 

duration: NotRequired[String]

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: NotRequired[FilterList]

This parameter isn't currently supported.

lease_id instance-attribute 

lease_id: NotRequired[String]

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

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

marker instance-attribute 

marker: NotRequired[String]

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: NotRequired[IntegerOptional]

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: NotRequired[BooleanOptional]

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

offering_type instance-attribute 

offering_type: NotRequired[String]

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: NotRequired[String]

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: NotRequired[String]

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: NotRequired[String]

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