describe_engine_default_cluster_parameters async ¶

async def describe_engine_default_cluster_parameters(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = 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,
) -> "capo_rds.types.describe_engine_default_cluster_parameters_result.DescribeEngineDefaultClusterParametersResult":
    """<p>Returns the default engine and system parameter information for the cluster database engine.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>

    Args:
        db_parameter_group_family: <p>The name of the DB cluster parameter group family to return engine parameter information for.</p>
        filters: <p>This parameter isn't 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 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 <code>DescribeEngineDefaultClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>

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

    Examples:
        To describe the default engine and system parameter information for the Aurora database engine
        The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.

        >>> await client.describe_engine_default_cluster_parameters(db_parameter_group_family='aurora-mysql5.7')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_engine_default_cluster_parameters_message.DescribeEngineDefaultClusterParametersMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.describe_engine_default_cluster_parameters_result.DescribeEngineDefaultClusterParametersResult"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_engine_default_cluster_parameters

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.describe_engine_default_cluster_parameters.async_describe_engine_default_cluster_parameters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEngineDefaultClusterParameters")
    )
    input_: capo_rds.types.describe_engine_default_cluster_parameters_message.DescribeEngineDefaultClusterParametersMessage = {}
    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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output