Skip to content

Describe Metric Filters

cloudwatchlogs_describe_metric_filters R Documentation

Lists the specified metric filters

Description

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.

Usage

cloudwatchlogs_describe_metric_filters(logGroupName, filterNamePrefix,
  nextToken, limit, metricName, metricNamespace)

Arguments

logGroupName

The name of the log group.

filterNamePrefix

The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.

nextToken

The token for the next set of items to return. (You received this token from a previous call.)

limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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.

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.

Value

A list with the following syntax: 

list(
  metricFilters = list(
    list(
      filterName = "string",
      filterPattern = "string",
      metricTransformations = list(
        list(
          metricName = "string",
          metricNamespace = "string",
          metricValue = "string",
          defaultValue = 123.0,
          dimensions = list(
            "string"
          ),
          unit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
        )
      ),
      creationTime = 123,
      logGroupName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_metric_filters(
  logGroupName = "string",
  filterNamePrefix = "string",
  nextToken = "string",
  limit = 123,
  metricName = "string",
  metricNamespace = "string"
)