Class: Aws::CloudWatch::Types::MetricDatum

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatch::Types::MetricDatum

Defined in:

gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #counts ⇒ Array<Float>

  Array of numbers that is used along with the Values array.

• #dimensions ⇒ Array<Types::Dimension>

  The dimensions associated with the metric.

• #metric_name ⇒ String

  The name of the metric.

• #statistic_values ⇒ Types::StatisticSet

  The statistical values for the metric.

• #storage_resolution ⇒ Integer

  Valid values are 1 and 60.

• #timestamp ⇒ Time

  The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

• #unit ⇒ String

  When you are using a Put operation, this defines what unit you want to use when storing the metric.

• #value ⇒ Float

  The value for the metric.

• #values ⇒ Array<Float>

  Array of numbers representing the values for the metric during the period.

Instance Attribute Details

#counts ⇒ Array<Float>

Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::Dimension>

The dimensions associated with the metric.

Returns:

• (Array<Types::Dimension>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the metric.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#statistic_values ⇒ Types::StatisticSet

The statistical values for the metric.

Returns:

• (Types::StatisticSet)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#storage_resolution ⇒ Integer

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Float

The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 2³⁶⁰. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

• (Float)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ Array<Float>

Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 2³⁶⁰. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2952

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  SENSITIVE = []
  include Aws::Structure
end