Class: Aws::CloudWatch::Types::DescribeAlarmsForMetricInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatch::Types::DescribeAlarmsForMetricInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudwatch/types.rb
Overview
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
-
#dimensions ⇒ Array<Types::Dimension>
The dimensions associated with the metric.
-
#extended_statistic ⇒ String
The percentile statistic for the metric.
-
#metric_name ⇒ String
The name of the metric.
-
#namespace ⇒ String
The namespace of the metric.
-
#period ⇒ Integer
The period, in seconds, over which the statistic is applied.
-
#statistic ⇒ String
The statistic for the metric, other than percentiles.
-
#unit ⇒ String
The unit for the metric.
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.
300 301 302 303 304 305 306 307 308 309 |
# File '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_statistic ⇒ String
The percentile statistic for the metric. Specify a value between p0.0 and p100.
300 301 302 303 304 305 306 307 308 309 |
# File '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_name ⇒ String
The name of the metric.
300 301 302 303 304 305 306 307 308 309 |
# File '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 |
#namespace ⇒ String
The namespace of the metric.
300 301 302 303 304 305 306 307 308 309 |
# File '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 |
#period ⇒ Integer
The period, in seconds, over which the statistic is applied.
300 301 302 303 304 305 306 307 308 309 |
# File '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 |
#statistic ⇒ String
The statistic for the metric, other than percentiles. For percentile statistics, use ‘ExtendedStatistics`.
300 301 302 303 304 305 306 307 308 309 |
# File '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 |
#unit ⇒ String
The unit for the metric.
300 301 302 303 304 305 306 307 308 309 |
# File '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 |