describe_db_engine_versions¶
Operation¶
async
¶
describe_db_engine_versions(input: DescribeDBEngineVersionsInput, plugins: list[Plugin] | None = None) -> DescribeDBEngineVersionsOutput
Describes the properties of specific versions of DB engines.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeDBEngineVersionsInput
|
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 |
|---|---|
DescribeDBEngineVersionsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_parameter_group_family: str | None = ...
The name of a specific DB parameter group family to return details for.
Constraints:
- If supplied, must match an existing DB parameter group family.
class-attribute
instance-attribute
¶
default_only: bool | None = ...
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
class-attribute
instance-attribute
¶
engine: str | None = ...
The database engine to return version details 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 -
sqlserver-dev-ee
class-attribute
instance-attribute
¶
engine_version: str | None = ...
A specific database engine version to return details for.
Example: 5.1.49
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
A filter that specifies one or more DB engine versions to describe.
Supported filters:
-
db-parameter-group-family- Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families. -
engine- Accepts engine names. The results list only includes information about the DB engine versions for these engines. -
engine-mode- Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following: -
global -
multimaster -
parallelquery -
provisioned -
serverless -
engine-version- Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions. -
status- Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following: -
available -
deprecated
class-attribute
instance-attribute
¶
include_all: bool | None = ...
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
class-attribute
instance-attribute
¶
list_supported_character_sets: bool | None = ...
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName parameter for CreateDBInstance, the response
includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
class-attribute
instance-attribute
¶
list_supported_timezones: bool | None = ...
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZone parameter for CreateDBInstance, the response includes a
list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
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.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeDBEngineVersions action.
Attributes¶
class-attribute
instance-attribute
¶
db_engine_versions: list[DBEngineVersion] | None = ...
A list of DBEngineVersion elements.
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.
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.