describe_engine_default_parameters ¶

def describe_engine_default_parameters(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_parameter_group_family: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    max_records: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_elasticache.types.string.String"] = None,
) -> "capo_elasticache.types.describe_engine_default_parameters_result.DescribeEngineDefaultParametersResult":
    """<p>Returns the default engine and system parameter information for the specified cache engine.</p>

    Args:
        cache_parameter_group_family: <p>The name of the cache parameter group family.</p> <p>Valid values are: <code>memcached1.4</code> | <code>memcached1.5</code> | <code>memcached1.6</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> | <code>redis4.0</code> | <code>redis5.0</code> | <code>redis6.x</code> | <code>redis6.2</code> | <code>redis7</code> </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 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 marker returned from a prior request. Use this marker for pagination of results from this operation. 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_elasticache.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DescribeEngineDefaultParameters
        Returns the default engine and system parameter information for the specified cache engine.

        >>> client.describe_engine_default_parameters(cache_parameter_group_family='redis2.8', max_records=25)
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.describe_engine_default_parameters_message.DescribeEngineDefaultParametersMessage]",
    ) -> OperationResponse[
        "capo_elasticache.types.describe_engine_default_parameters_result.DescribeEngineDefaultParametersResult"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.describe_engine_default_parameters

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.describe_engine_default_parameters.describe_engine_default_parameters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEngineDefaultParameters")
    )
    input_: capo_elasticache.types.describe_engine_default_parameters_message.DescribeEngineDefaultParametersMessage = {}
    if cache_parameter_group_family is not None:
        input_["cache_parameter_group_family"] = cache_parameter_group_family
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

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