describe_orderable_db_instance_options¶
Operation¶
async
¶
describe_orderable_db_instance_options(input: DescribeOrderableDBInstanceOptionsInput, plugins: list[Plugin] | None = None) -> DescribeOrderableDBInstanceOptionsOutput
Describes the orderable DB instance options for a specified DB engine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeOrderableDBInstanceOptionsInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
DescribeOrderableDBInstanceOptionsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
availability_zone_group: str | None = ...
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
Omit this parameter to show the available options in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
class-attribute
instance-attribute
¶
db_instance_class: str | None = ...
A filter to include only the available options for the specified DB instance class.
class-attribute
instance-attribute
¶
engine: str | None = ...
The name of the database engine to describe DB instance options for.
Valid Values:
-
aurora-mysql -
aurora-postgresql -
custom-oracle-ee -
custom-oracle-ee-cdb -
custom-oracle-se2 -
custom-oracle-se2-cdb -
db2-ae -
db2-ce -
db2-se -
mariadb -
mysql -
oracle-ee -
oracle-ee-cdb -
oracle-se2 -
oracle-se2-cdb -
postgres -
sqlserver-ee -
sqlserver-se -
sqlserver-ex -
sqlserver-web
class-attribute
instance-attribute
¶
engine_version: str | None = ...
A filter to include only the available options for the specified engine version.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
This parameter isn't currently supported.
class-attribute
instance-attribute
¶
license_model: str | None = ...
A filter to include only the available options for the specified license model.
RDS Custom supports only the BYOL licensing model.
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
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: Minimum 20, maximum 1000.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeOrderableDBInstanceOptions action.
Attributes¶
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
OrderableDBInstanceOptions request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
class-attribute
instance-attribute
¶
orderable_db_instance_options: list[OrderableDBInstanceOption] | None = ...
An OrderableDBInstanceOption structure containing information about
orderable options for the DB instance.
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.