describe_db_engine_versions ¶

def describe_db_engine_versions(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    engine: Optional["capo_docdb.types.string.String"] = None,
    engine_version: Optional["capo_docdb.types.string.String"] = None,
    db_parameter_group_family: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
    default_only: Optional["capo_docdb.types.boolean.Boolean"] = None,
    list_supported_character_sets: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
    list_supported_timezones: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_docdb.types.db_engine_version_message.DBEngineVersionMessage":
    """<p>Returns a list of the available engines.</p>

    Args:
        engine: <p>The database engine to return.</p>
        engine_version: <p>The database engine version to return.</p> <p>Example: <code>3.6.0</code> </p>
        db_parameter_group_family: <p>The name of a specific parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBParameterGroupFamily</code>.</p> </li> </ul>
        filters: <p>This parameter is not currently supported.</p>
        max_records: <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</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>Indicates that only the default version of the specified engine or engine and major version combination is returned.</p>
        list_supported_character_sets: <p>If this parameter is specified 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>
        list_supported_timezones: <p>If this parameter is specified 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>

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

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

        output, http_response = (
            capo_docdb._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_docdb.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

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