describe_metric_filters ¶

def describe_metric_filters(
    self,
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    log_group_name: Optional[
        "capo_cloudwatch_logs.types.log_group_name.LogGroupName"
    ] = None,
    filter_name_prefix: Optional[
        "capo_cloudwatch_logs.types.filter_name.FilterName"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
    limit: Optional[
        "capo_cloudwatch_logs.types.describe_limit.DescribeLimit"
    ] = None,
    metric_name: Optional[
        "capo_cloudwatch_logs.types.metric_name.MetricName"
    ] = None,
    metric_namespace: Optional[
        "capo_cloudwatch_logs.types.metric_namespace.MetricNamespace"
    ] = None,
) -> "capo_cloudwatch_logs.types.describe_metric_filters_response.DescribeMetricFiltersResponse":
    """<p>Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.</p>

    Args:
        log_group_name: <p>The name of the log group.</p>
        filter_name_prefix: <p>The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the <code>logGroupName</code> parameter in your request.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        limit: <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
        metric_name: <p>Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the <code>metricNamespace</code> parameter.</p>
        metric_namespace: <p>Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the <code>metricName</code> parameter.</p>

    Raises:
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service cannot complete the request.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatch_logs.types.describe_metric_filters_request.DescribeMetricFiltersRequest]",
    ) -> OperationResponse[
        "capo_cloudwatch_logs.types.describe_metric_filters_response.DescribeMetricFiltersResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_metric_filters

        output, http_response = (
            capo_cloudwatch_logs._operations.logs_20140328.describe_metric_filters.describe_metric_filters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMetricFilters")
    )
    input_: capo_cloudwatch_logs.types.describe_metric_filters_request.DescribeMetricFiltersRequest = {}
    if log_group_name is not None:
        input_["log_group_name"] = log_group_name
    if filter_name_prefix is not None:
        input_["filter_name_prefix"] = filter_name_prefix
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit
    if metric_name is not None:
        input_["metric_name"] = metric_name
    if metric_namespace is not None:
        input_["metric_namespace"] = metric_namespace

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