describe_reserved_db_instances_offerings¶
Operation¶
describe_reserved_db_instances_offerings
¶
describe_reserved_db_instances_offerings(request: DescribeReservedDBInstancesOfferingsInput | DescribeReservedDBInstancesOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedDBInstancesOfferingsInputDict]) -> DescribeReservedDBInstancesOfferingsOutput
Lists available reserved DB instance offerings.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeReservedDBInstancesOfferingsInput | DescribeReservedDBInstancesOfferingsInputDict | 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[DescribeReservedDBInstancesOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeReservedDBInstancesOfferingsOutput
|
An instance of |
describe_reserved_db_instances_offerings
async
¶
describe_reserved_db_instances_offerings(request: DescribeReservedDBInstancesOfferingsInput | DescribeReservedDBInstancesOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedDBInstancesOfferingsInputDict]) -> DescribeReservedDBInstancesOfferingsOutput
Lists available reserved DB instance offerings.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeReservedDBInstancesOfferingsInput | DescribeReservedDBInstancesOfferingsInputDict | 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[DescribeReservedDBInstancesOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeReservedDBInstancesOfferingsOutput
|
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.
DescribeReservedDBInstancesOfferingsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeReservedDBInstancesOfferingsInput.
Attributes¶
db_instance_class
instance-attribute
¶
db_instance_class: str | None
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
duration
instance-attribute
¶
duration: str | None
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.
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"
DescribeReservedDBInstancesOfferingsInput
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 the available offerings matching the specified DB instance class.
duration
class-attribute
instance-attribute
¶
duration: str | None = ...
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
¶
This parameter isn't currently supported.
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 = ...
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
Note
The results show offerings that partially match the filter value.
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 the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Output¶
DescribeReservedDBInstancesOfferingsOutput
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeReservedDBInstancesOfferings 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_offerings
class-attribute
instance-attribute
¶
reserved_db_instances_offerings: list[ReservedDBInstancesOffering] | None = ...
A list of reserved DB instance offerings.
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.