describe_cache_parameter_groups ¶

def describe_cache_parameter_groups(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_parameter_group_name: 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.cache_parameter_groups_message.CacheParameterGroupsMessage":
    """<p>Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.</p>

    Args:
        cache_parameter_group_name: <p>The name of a specific cache parameter group to return details for.</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.cache_parameter_group_not_found_fault.CacheParameterGroupNotFoundFault: <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
        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:
        DescribeCacheParameterGroups
        Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

        >>> client.describe_cache_parameter_groups(cache_parameter_group_name='custom-mem1-4')
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.describe_cache_parameter_groups_message.DescribeCacheParameterGroupsMessage]",
    ) -> OperationResponse[
        "capo_elasticache.types.cache_parameter_groups_message.CacheParameterGroupsMessage"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.describe_cache_parameter_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCacheParameterGroups")
    )
    input_: capo_elasticache.types.describe_cache_parameter_groups_message.DescribeCacheParameterGroupsMessage = {}
    if cache_parameter_group_name is not None:
        input_["cache_parameter_group_name"] = cache_parameter_group_name
    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