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

Class: Aws::CloudWatch::Types::DescribeAlarmsForMetricInput

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

Overview

Note:

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

{
  metric_name: "MetricName", # required
  namespace: "Namespace", # required
  statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistic: "ExtendedStatistic",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  period: 1,
  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
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Array<Types::Dimension>

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Returns:

#extended_statistic ⇒ String

The percentile statistic for the metric. Specify a value between p0.0 and p100.

Returns:

  • (String) —

    The percentile statistic for the metric.

#metric_name ⇒ String

The name of the metric.

Returns:

  • (String) —

    The name of the metric.

#namespace ⇒ String

The namespace of the metric.

Returns:

  • (String) —

    The namespace of the metric.

#period ⇒ Integer

The period, in seconds, over which the statistic is applied.

Returns:

  • (Integer) —

    The period, in seconds, over which the statistic is applied.

#statistic ⇒ String

The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Possible values:

  • SampleCount
  • Average
  • Sum
  • Minimum
  • Maximum

Returns:

  • (String) —

    The statistic for the metric, other than percentiles.

#unit ⇒ String

The unit for the metric.

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 for the metric.