Struct aws_sdk_cloudwatch::model::MetricDatum

#[non_exhaustive]
pub struct MetricDatum {
    pub metric_name: Option<String>,
    pub dimensions: Option<Vec<Dimension>>,
    pub timestamp: Option<DateTime>,
    pub value: Option<f64>,
    pub statistic_values: Option<StatisticSet>,
    pub values: Option<Vec<f64>>,
    pub counts: Option<Vec<f64>>,
    pub unit: Option<StandardUnit>,
    pub storage_resolution: Option<i32>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metric_name: Option<String>

The name of the metric.

dimensions: Option<Vec<Dimension>>

The dimensions associated with the metric.

timestamp: Option<DateTime>

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

value: Option<f64>

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.

statistic_values: Option<StatisticSet>

The statistical values for the metric.

values: Option<Vec<f64>>

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.

counts: Option<Vec<f64>>

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.

unit: Option<StandardUnit>

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.

storage_resolution: Option<i32>

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.

Implementations

impl MetricDatum

pub fn metric_name(&self) -> Option<&str>

The name of the metric.

pub fn dimensions(&self) -> Option<&[Dimension]>

The dimensions associated with the metric.

pub fn timestamp(&self) -> Option<&DateTime>

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

pub fn value(&self) -> Option<f64>

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.

pub fn statistic_values(&self) -> Option<&StatisticSet>

The statistical values for the metric.

pub fn values(&self) -> Option<&[f64]>

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.

pub fn counts(&self) -> Option<&[f64]>

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.

pub fn unit(&self) -> Option<&StandardUnit>

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.

pub fn storage_resolution(&self) -> Option<i32>

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.

impl MetricDatum

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MetricDatum

Trait Implementations

impl Clone for MetricDatum

fn clone(&self) -> MetricDatum

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricDatum

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<MetricDatum> for MetricDatum

fn eq(&self, other: &MetricDatum) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MetricDatum) -> bool

This method tests for !=.

impl StructuralPartialEq for MetricDatum