class Aws::CloudWatch::Types::MetricDatum

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

@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,
    }

@!attribute [rw] metric_name

The name of the metric.
@return [String]

@!attribute [rw] dimensions

The dimensions associated with the metric.
@return [Array<Types::Dimension>]

@!attribute [rw] timestamp

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

@!attribute [rw] value

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^360 to 2^360. In addition, special values (for
example, NaN, +Infinity, -Infinity) are not supported.
@return [Float]

@!attribute [rw] statistic_values

The statistical values for the metric.
@return [Types::StatisticSet]

@!attribute [rw] values

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^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
@return [Array<Float>]

@!attribute [rw] counts

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.
@return [Array<Float>]

@!attribute [rw] unit

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.
@return [String]

@!attribute [rw] storage_resolution

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][1] in the
*Amazon CloudWatch User Guide*.

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

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDatum AWS API Documentation

Constants

SENSITIVE