Struct rusoto_cloudwatch::MetricDataQuery

pub struct MetricDataQuery {
    pub expression: Option<String>,
    pub id: String,
    pub label: Option<String>,
    pub metric_stat: Option<MetricStat>,
    pub return_data: Option<bool>,
}

This structure indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 100 MetricDataQuery structures.

Fields

expression: Option<String>

The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.

id: String

A short name used to tie this structure to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

label: Option<String>

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

metric_stat: Option<MetricStat>

The metric to be returned, along with statistics, period, and units. Use this parameter only if this structure is performing a data retrieval and not performing a math expression on the returned data.

Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.

return_data: Option<bool>

Indicates whether to return the time stamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

Trait Implementations

impl Default for MetricDataQuery

fn default() -> MetricDataQuery

Returns the "default value" for a type.

impl Debug for MetricDataQuery

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

Formats the value using the given formatter.

impl Clone for MetricDataQuery

fn clone(&self) -> MetricDataQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for MetricDataQuery

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

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

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

This method tests for !=.