Struct aws_sdk_cloudwatch::model::MetricStat

#[non_exhaustive]
pub struct MetricStat {
    pub metric: Option<Metric>,
    pub period: Option<i32>,
    pub stat: Option<String>,
    pub unit: Option<StandardUnit>,
}

This structure defines the metric to be returned, along with the statistics, period, and units.

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: Option<Metric>

The metric to return, including the metric name, namespace, and dimensions.

period: Option<i32>

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

stat: Option<String>

The statistic to return. It can include any CloudWatch statistic or extended statistic.

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, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Implementations

impl MetricStat

pub fn metric(&self) -> Option<&Metric>

The metric to return, including the metric name, namespace, and dimensions.

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

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

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

The statistic to return. It can include any CloudWatch statistic or extended statistic.

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, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

impl MetricStat

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MetricStat

Trait Implementations

impl Clone for MetricStat

fn clone(&self) -> MetricStat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricStat

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

Formats the value using the given formatter.

impl PartialEq<MetricStat> for MetricStat

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

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

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

This method tests for !=.

impl StructuralPartialEq for MetricStat