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

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

See Also:

Instance Attribute Summary collapse

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


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

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

#dimensions ⇒ Array<Types::Dimension>

The dimensions associated with the metric.

Returns:



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

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

#metric_name ⇒ String

The name of the metric.

Returns:

  • (String) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

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

#statistic_values ⇒ Types::StatisticSet

The statistical values for the metric.

Returns:



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  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.

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

Returns:

  • (Integer) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  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) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

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

#unit ⇒ String

The unit of the metric.

Returns:

  • (String) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  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 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) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

class MetricDatum < Struct.new(
  :metric_name,
  :dimensions,
  :timestamp,
  :value,
  :statistic_values,
  :values,
  :counts,
  :unit,
  :storage_resolution)
  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 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>) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1460

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