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

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

#dimensionsArray<Types::Dimension>

The dimensions associated with the metric.

Returns:



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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

#metric_nameString

The name of the metric.

Returns:

  • (String)


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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

#statistic_valuesTypes::StatisticSet

The statistical values for the metric.

Returns:



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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

#unitString

The unit of the metric.

Returns:

  • (String)


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1028

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