describe_db_engine_versions ¶

def describe_db_engine_versions(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    engine: Optional["capo_rds.types.string.String"] = None,
    engine_version: Optional["capo_rds.types.string.String"] = None,
    db_parameter_group_family: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    default_only: Optional["capo_rds.types.boolean.Boolean"] = None,
    list_supported_character_sets: Optional[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ] = None,
    list_supported_timezones: Optional[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ] = None,
    include_all: Optional["capo_rds.types.boolean_optional.BooleanOptional"] = None,
) -> "capo_rds.types.db_engine_version_message.DBEngineVersionMessage":
    """<p>Describes the properties of specific versions of DB engines.</p>

    Args:
        engine: <p>The database engine to return version details for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>custom-oracle-ee</code> </p> </li> <li> <p> <code>custom-oracle-ee-cdb</code> </p> </li> <li> <p> <code>custom-oracle-se2</code> </p> </li> <li> <p> <code>custom-oracle-se2-cdb</code> </p> </li> <li> <p> <code>db2-ae</code> </p> </li> <li> <p> <code>db2-ce</code> </p> </li> <li> <p> <code>db2-se</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> <li> <p> <code>sqlserver-dev-ee</code> </p> </li> </ul>
        engine_version: <p>A specific database engine version to return details for.</p> <p>Example: <code>5.1.49</code> </p>
        db_parameter_group_family: <p>The name of a specific DB parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DB parameter group family.</p> </li> </ul>
        filters: <p>A filter that specifies one or more DB engine versions to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-parameter-group-family</code> - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list only includes information about the DB engine versions for these engines.</p> </li> <li> <p> <code>engine-mode</code> - 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:</p> <ul> <li> <p> <code>global</code> </p> </li> <li> <p> <code>multimaster</code> </p> </li> <li> <p> <code>parallelquery</code> </p> </li> <li> <p> <code>provisioned</code> </p> </li> <li> <p> <code>serverless</code> </p> </li> </ul> </li> <li> <p> <code>engine-version</code> - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.</p> </li> <li> <p> <code>status</code> - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>deprecated</code> </p> </li> </ul> </li> </ul>
        max_records: <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: <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>
        default_only: <p>Specifies whether to return only the default version of the specified engine or the engine and major version combination.</p>
        list_supported_character_sets: <p>Specifies whether to list the supported character sets for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version.</p> <p>For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.</p>
        list_supported_timezones: <p>Specifies whether to list the supported time zones for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version.</p> <p>For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.</p>
        include_all: <p>Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.</p>

    Raises:
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe the DB engine versions for the MySQL DB engine
        The following example displays details about each of the DB engine versions for the specified DB engine.

        >>> client.describe_db_engine_versions(engine='mysql')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_db_engine_versions_message.DescribeDBEngineVersionsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.db_engine_version_message.DBEngineVersionMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_engine_versions

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_db_engine_versions.describe_db_engine_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBEngineVersions")
    )
    input_: capo_rds.types.describe_db_engine_versions_message.DescribeDBEngineVersionsMessage = {}
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if db_parameter_group_family is not None:
        input_["db_parameter_group_family"] = db_parameter_group_family
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker
    if default_only is not None:
        input_["default_only"] = default_only
    if list_supported_character_sets is not None:
        input_["list_supported_character_sets"] = list_supported_character_sets
    if list_supported_timezones is not None:
        input_["list_supported_timezones"] = list_supported_timezones
    if include_all is not None:
        input_["include_all"] = include_all

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output