You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudWatch::Types::MetricDataQuery
 Inherits:

Struct
 Object
 Struct
 Aws::CloudWatch::Types::MetricDataQuery
 Defined in:
 (unknown)
Overview
When passing MetricDataQuery as input to an Aws::Client method, you can use a vanilla Hash:
{
id: "MetricId", # required
metric_stat: {
metric: { # required
namespace: "Namespace",
metric_name: "MetricName",
dimensions: [
{
name: "DimensionName", # required
value: "DimensionValue", # required
},
],
},
period: 1, # required
stat: "Stat", # 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
},
expression: "MetricExpression",
label: "MetricLabel",
return_data: false,
period: 1,
}
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it 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 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 20 MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat
parameter to retrieve a metric, and as many as 10 structures that contain the Expression
parameter to perform a math expression. Of those Expression
structures, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Instance Attribute Summary collapse

#expression ⇒ String
The math expression to be performed on the returned data, if this object is performing a math expression.

#id ⇒ String
A short name used to tie this object to the results in the response.

#label ⇒ String
A humanreadable label for this metric or expression.

#metric_stat ⇒ Types::MetricStat
The metric to be returned, along with statistics, period, and units.

#period ⇒ Integer
The granularity, in seconds, of the returned data points.

#return_data ⇒ Boolean
When used in
GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric.
Instance Attribute Details
#expression ⇒ String
The math expression to be performed on the returned data, if this object
is performing a math expression. This expression can use the Id
of the
other metrics to refer to those metrics, and can also use the Id
of
other expressions to use the result of those expressions. For more
information about metric math expressions, see Metric Math Syntax and
Functions in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
#id ⇒ String
A short name used to tie this object 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 ⇒ String
A humanreadable 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 ⇒ Types::MetricStat
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
#period ⇒ Integer
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 highresolution 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. Highresolution metrics are those
metrics stored by a PutMetricData
operation that includes a
StorageResolution of 1 second
.
#return_data ⇒ Boolean
When used in GetMetricData
, this option indicates whether to return
the timestamps 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.
When used in PutMetricAlarm
, specify True
for the one expression
result to use as the alarm. For all other metrics and expressions in the
same PutMetricAlarm
operation, specify ReturnData
as False.