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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MetricDatum as input to an Aws::Client method, you can use a vanilla 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.

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

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

#dimensionsArray<Types::Dimension>

The dimensions associated with the metric.

Returns:

#metric_nameString

The name of the metric.

Returns:

  • (String)

    The name of the metric.

#statistic_valuesTypes::StatisticSet

The statistical values for the metric.

Returns:

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

    Valid values are 1 and 60.

#timestampTime

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

Returns:

  • (Time)

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

#unitString

The unit of the metric.

Possible values:

  • 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

Returns:

  • (String)

    The unit of the metric.

#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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

  • (Float)

    The value for the metric.

#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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

Returns:

  • (Array<Float>)

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