[ aws . logs ]



Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents .

The maximum number of metric filters that can be associated with a log group is 100.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--log-group-name <value>
--filter-name <value>
--filter-pattern <value>
--metric-transformations <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--log-group-name (string)

The name of the log group.

--filter-name (string)

A name for the metric filter.

--filter-pattern (string)

A filter pattern for extracting metric data out of ingested log events.

--metric-transformations (list)

A collection of information that defines how metric data gets emitted.


Indicates how to transform ingested log events to metric data in a CloudWatch metric.

metricName -> (string)

The name of the CloudWatch metric.

metricNamespace -> (string)

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces .

metricValue -> (string)

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

defaultValue -> (double)

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

Shorthand Syntax:

metricName=string,metricNamespace=string,metricValue=string,defaultValue=double ...

JSON Syntax:

    "metricName": "string",
    "metricNamespace": "string",
    "metricValue": "string",
    "defaultValue": double

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.