put_metric_filter ¶

def put_metric_filter(
    self,
    log_group_name: "capo_cloudwatch_logs.types.log_group_name.LogGroupName",
    filter_name: "capo_cloudwatch_logs.types.filter_name.FilterName",
    filter_pattern: "capo_cloudwatch_logs.types.filter_pattern.FilterPattern",
    metric_transformations: "capo_cloudwatch_logs.types.metric_transformations.MetricTransformations",
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    apply_on_transformed_logs: Optional[
        "capo_cloudwatch_logs.types.apply_on_transformed_logs.ApplyOnTransformedLogs"
    ] = None,
    field_selection_criteria: Optional[
        "capo_cloudwatch_logs.types.field_selection_criteria.FieldSelectionCriteria"
    ] = None,
    emit_system_field_dimensions: Optional[
        "capo_cloudwatch_logs.types.emit_system_fields.EmitSystemFields"
    ] = None,
) -> None:
    """<p>Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p> <p>The maximum number of metric filters that can be associated with a log group is 100.</p> <p>Using regular expressions in filter patterns is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in filter patterns, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p> <p>When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.</p> <important> <p>Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. </p> <p>CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.</p> <p>You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html"> Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>. </p> </important>

    Args:
        log_group_name: <p>The name of the log group.</p>
        filter_name: <p>A name for the metric filter.</p>
        filter_pattern: <p>A filter pattern for extracting metric data out of ingested log events.</p>
        metric_transformations: <p>A collection of information that defines how metric data gets emitted.</p>
        apply_on_transformed_logs: <p>This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>.</p> <p>If the log group uses either a log-group level or account-level transformer, and you specify <code>true</code>, the metric filter will be applied on the transformed version of the log events instead of the original ingested log events.</p>
        field_selection_criteria: <p>A filter expression that specifies which log events should be processed by this metric filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like <code>=</code>, <code>!=</code>, <code>AND</code>, <code>OR</code>, <code>IN</code>, <code>NOT IN</code>. Example: <code>@aws.region = "us-east-1"</code> or <code>@aws.account IN ["123456789012", "987654321098"]</code>. Maximum length: 2000 characters.</p>
        emit_system_field_dimensions: <p>A list of system fields to emit as additional dimensions in the generated metrics. Valid values are <code>@aws.account</code> and <code>@aws.region</code>. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.</p>

    Raises:
        capo_cloudwatch_logs.errors.invalid_operation_exception.InvalidOperationException: <p>The operation is not valid on the specified resource.</p>
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.limit_exceeded_exception.LimitExceededException: <p>You have reached the maximum number of resources that can be created.</p>
        capo_cloudwatch_logs.errors.operation_aborted_exception.OperationAbortedException: <p>Multiple concurrent requests to update the same resource were in conflict.</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.put_metric_filter_request.PutMetricFilterRequest]",
    ) -> OperationResponse[None]:
        import capo_cloudwatch_logs._operations.logs_20140328.put_metric_filter

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutMetricFilter")
    )
    input_: capo_cloudwatch_logs.types.put_metric_filter_request.PutMetricFilterRequest = {
        "log_group_name": log_group_name,
        "filter_name": filter_name,
        "filter_pattern": filter_pattern,
        "metric_transformations": metric_transformations,
    }
    if apply_on_transformed_logs is not None:
        input_["apply_on_transformed_logs"] = apply_on_transformed_logs
    if field_selection_criteria is not None:
        input_["field_selection_criteria"] = field_selection_criteria
    if emit_system_field_dimensions is not None:
        input_["emit_system_field_dimensions"] = emit_system_field_dimensions

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