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

Class: Aws::CloudWatch::Types::MetricStat

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

Overview

Note:

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

{
  metric: { # required
    namespace: "Namespace",
    metric_name: "MetricName",
    dimensions: [
      {
        name: "DimensionName", # required
        value: "DimensionValue", # required
      },
    ],
  },
  period: 1, # required
  stat: "Stat", # required
  unit: "Seconds", # accepts 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
}

This structure defines the metric to be returned, along with the statistics, period, and units.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#metricTypes::Metric

The metric to return, including the metric name, namespace, and dimensions.

Returns:

  • (Types::Metric)

    The metric to return, including the metric name, namespace, and dimensions.

#periodInteger

The period, in seconds, to use when retrieving the metric.

Returns:

  • (Integer)

    The period, in seconds, to use when retrieving the metric.

#statString

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Returns:

  • (String)

    The statistic to return.

#unitString

The unit to use for the returned data points.

Possible values:

  • 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

Returns:

  • (String)

    The unit to use for the returned data points.