cloudwatch_list_metrics: List the specified metrics

Description Usage Arguments Value Request syntax

View source: R/cloudwatch_operations.R

Description

List the specified metrics. You can use the returned metrics with get_metric_data or get_metric_statistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using get_metric_data or get_metric_statistics.

list_metrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use get_metric_data or get_metric_statistics.

Usage

1
2
cloudwatch_list_metrics(Namespace, MetricName, Dimensions, NextToken,
  RecentlyActive)

Arguments

Namespace

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

MetricName

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Dimensions

The dimensions to filter against. Only the dimensions that match exactly will be returned.

NextToken

The token returned by a previous call to indicate that there is more data available.

RecentlyActive

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  Metrics = list(
    list(
      Namespace = "string",
      MetricName = "string",
      Dimensions = list(
        list(
          Name = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$list_metrics(
  Namespace = "string",
  MetricName = "string",
  Dimensions = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  NextToken = "string",
  RecentlyActive = "PT3H"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.