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

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

Overview

Note:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#metric ⇒ Types::Metric

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

Returns:



1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1515

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  include Aws::Structure
end

#period ⇒ Integer

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

Returns:

  • (Integer) 


1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1515

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  include Aws::Structure
end

#stat ⇒ String

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

Returns:

  • (String) 


1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1515

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  include Aws::Structure
end

#unit ⇒ String

The unit to use for the returned data points.

Returns:

  • (String) 


1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1515

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  include Aws::Structure
end