AWS SDK for C++
1.9.110
AWS SDK for C++

#include <MetricDataQuery.h>
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.
Definition at line 56 of file MetricDataQuery.h.
Aws::CloudWatch::Model::MetricDataQuery::MetricDataQuery  (  ) 
Aws::CloudWatch::Model::MetricDataQuery::MetricDataQuery  (  const Aws::Utils::Xml::XmlNode &  xmlNode  ) 

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 511 of file MetricDataQuery.h.

inline 
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.
Definition at line 227 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 504 of file MetricDataQuery.h.

inline 
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.
Definition at line 214 of file MetricDataQuery.h.

inline 
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.
Definition at line 75 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 318 of file MetricDataQuery.h.

inline 
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.
Definition at line 155 of file MetricDataQuery.h.

inline 
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
PutMetricData
operation that includes a StorageResolution of 1 second
.Definition at line 463 of file MetricDataQuery.h.

inline 
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.
Definition at line 415 of file MetricDataQuery.h.

inline 
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.
Definition at line 85 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 330 of file MetricDataQuery.h.

inline 
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.
Definition at line 164 of file MetricDataQuery.h.
MetricDataQuery& Aws::CloudWatch::Model::MetricDataQuery::operator=  (  const Aws::Utils::Xml::XmlNode &  xmlNode  ) 
void Aws::CloudWatch::Model::MetricDataQuery::OutputToStream  (  Aws::OStream &  oStream, 
const char *  location  
)  const 
void Aws::CloudWatch::Model::MetricDataQuery::OutputToStream  (  Aws::OStream &  ostream, 
const char *  location,  
unsigned  index,  
const char *  locationValue  
)  const 

inline 
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
PutMetricData
operation that includes a StorageResolution of 1 second
.Definition at line 474 of file MetricDataQuery.h.

inline 
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.
Definition at line 427 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 525 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 518 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 532 of file MetricDataQuery.h.

inline 
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.
Definition at line 253 of file MetricDataQuery.h.

inline 
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.
Definition at line 240 of file MetricDataQuery.h.

inline 
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.
Definition at line 266 of file MetricDataQuery.h.

inline 
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.
Definition at line 105 of file MetricDataQuery.h.

inline 
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.
Definition at line 95 of file MetricDataQuery.h.

inline 
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.
Definition at line 115 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 354 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 342 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 366 of file MetricDataQuery.h.

inline 
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.
Definition at line 173 of file MetricDataQuery.h.

inline 
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.
Definition at line 182 of file MetricDataQuery.h.

inline 
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
PutMetricData
operation that includes a StorageResolution of 1 second
.Definition at line 485 of file MetricDataQuery.h.

inline 
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.
Definition at line 439 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 546 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 539 of file MetricDataQuery.h.

inline 
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Definition at line 553 of file MetricDataQuery.h.

inline 
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.
Definition at line 292 of file MetricDataQuery.h.

inline 
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.
Definition at line 279 of file MetricDataQuery.h.

inline 
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.
Definition at line 305 of file MetricDataQuery.h.

inline 
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.
Definition at line 135 of file MetricDataQuery.h.

inline 
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.
Definition at line 125 of file MetricDataQuery.h.

inline 
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.
Definition at line 145 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 390 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 378 of file MetricDataQuery.h.

inline 
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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
Definition at line 402 of file MetricDataQuery.h.

inline 
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.
Definition at line 191 of file MetricDataQuery.h.

inline 
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.
Definition at line 200 of file MetricDataQuery.h.

inline 
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
PutMetricData
operation that includes a StorageResolution of 1 second
.Definition at line 496 of file MetricDataQuery.h.

inline 
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.
Definition at line 451 of file MetricDataQuery.h.