Amazon CloudWatch Logs
API Reference (API Version 2014-03-28)


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 requests.

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

Request Syntax

   "filterName": "string",
   "filterPattern": "string",
   "logGroupName": "string",
   "metricTransformations": [ 
         "defaultValue": number,
         "metricName": "string",
         "metricNamespace": "string",
         "metricValue": "string"

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


A name for the metric filter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [^:*]*

Required: Yes


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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: Yes


The name of the log group to associate the metric filter with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\.\-_/#A-Za-z0-9]+

Required: Yes


A collection of information needed to define how metric data gets emitted.

Type: array of MetricTransformation objects

Array Members: Fixed number of 1 item.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


Returned if a parameter of the request is incorrectly specified.

HTTP Status Code: 400


Returned if you have reached the maximum number of resources that can be created.

HTTP Status Code: 400


Returned if multiple requests to update the same resource were in conflict.

HTTP Status Code: 400


Returned if the specified resource does not exist.

HTTP Status Code: 400


Returned if the service cannot complete the request.

HTTP Status Code: 500


Create or update a metric filter

The following is an example of a PutMetricFilter request and response.

Sample Request

Host: logs.<region>.<domain>
X-Amz-Date: <DATE>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Accept: application/json
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: Logs_20140328.PutMetricFilter
  "logGroupName": "exampleLogGroupName",
  "filterName": "exampleMetricFilterName",
  "filterPattern": "[ip, identity, user_id, timestamp, request, status_code, size]",
  "metricTransformations": [
      "defaultValue": "0",
      "metricValue": "$size", 
      "metricNamespace": "MyApp", 
      "metricName": "Volume"

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>