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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass DescribeAlarmsForMetricInput data as a 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<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:



300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#extended_statisticString

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

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#metric_nameString

The name of the metric.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#namespaceString

The namespace of the metric.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#periodInteger

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

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#statisticString

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

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end

#unitString

The unit for the metric.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 300

class DescribeAlarmsForMetricInput < Struct.new(
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit)
  include Aws::Structure
end