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

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 MetricDatum data as a hash:

{
  metric_name: "MetricName", # required
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  timestamp: Time.now,
  value: 1.0,
  statistic_values: {
    sample_count: 1.0, # required
    sum: 1.0, # required
    minimum: 1.0, # required
    maximum: 1.0, # required
  },
  values: [1.0],
  counts: [1.0],
  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
  storage_resolution: 1,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#countsArray<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>)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#dimensionsArray<Types::Dimension>

The dimensions associated with the metric.

Returns:



2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#metric_nameString

The name of the metric.

Returns:

  • (String)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#statistic_valuesTypes::StatisticSet

The statistical values for the metric.

Returns:



2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#storage_resolutionInteger

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)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#timestampTime

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

Returns:

  • (Time)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#unitString

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)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#valueFloat

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 -2360 to 2360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

  • (Float)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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

#valuesArray<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 -2360 to 2360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

  • (Array<Float>)


2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2639

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