You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::ListMetricsInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListMetricsInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  namespace: "Namespace",
  metric_name: "MetricName",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue",
    },
  ],
  next_token: "NextToken",
  recently_active: "PT3H", # accepts PT3H
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Array<Types::DimensionFilter>

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

Returns:

#metric_name ⇒ String

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

Returns:

  • (String) —

    The name of the metric to filter against.

#namespace ⇒ String

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

Returns:

  • (String) —

    The metric namespace to filter against.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#recently_active ⇒ String

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.

Possible values:

  • PT3H

Returns:

  • (String) —

    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.