DescribeMetricFilters
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
Request Syntax
{ "filterNamePrefix": "
string
", "limit":number
, "logGroupName": "string
", "metricName": "string
", "metricNamespace": "string
", "nextToken": "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.
- filterNamePrefix
-
The prefix to match.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[^:*]*
Required: No
- limit
-
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- logGroupName
-
The name of the log group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\.\-_/#A-Za-z0-9]+
Required: No
- metricName
-
Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the
metricNamespace
parameter.Type: String
Length Constraints: Maximum length of 255.
Pattern:
[^:*$]*
Required: No
- metricNamespace
-
Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the
metricName
parameter.Type: String
Length Constraints: Maximum length of 255.
Pattern:
[^:*$]*
Required: No
- nextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{ "metricFilters": [ { "creationTime": number, "filterName": "string", "filterPattern": "string", "logGroupName": "string", "metricTransformations": [ { "defaultValue": number, "metricName": "string", "metricNamespace": "string", "metricValue": "string" } ] } ], "nextToken": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- metricFilters
-
The metric filters.
Type: Array of MetricFilter objects
- nextToken
-
The token for the next set of items to return. The token expires after 24 hours.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
A parameter is specified incorrectly.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service cannot complete the request.
HTTP Status Code: 500
Example
To list the metric filters for a log group
The following example lists the metric filters for the specified log group.
Sample Request
POST / HTTP/1.1 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.DescribeMetricFilters { "logGroupName": "my-log-group" }
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "metricFilters": [ { "creationTime": 1396224000000, "filterName": "my-metric-filter", "filterPattern": "[ip, identity, user_id, timestamp, request, status_code, size]", "logGroupName": "my-log-group", "metricTransformations": [ { "defaultValue": "0", "metricValue": "$size", "metricNamespace": "my-app", "metricName": "Volume" } ] } ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: