AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

MetricDataQuery

import "github.com/aws/aws-sdk-go/service/cloudwatch"

type MetricDataQuery struct { Expression *string `min:"1" type:"string"` Id *string `min:"1" type:"string" required:"true"` Label *string `type:"string"` MetricStat *MetricStat `type:"structure"` ReturnData *bool `type:"boolean"` }

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 100 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) 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.

Expression

Type: *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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

Id

Type: *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.

Id is a required field

Label

Type: *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.

MetricStat

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

ReturnData

Type: *bool

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.

Method

GoString

func (s MetricDataQuery) GoString() string

GoString returns the string representation

SetExpression

func (s *MetricDataQuery) SetExpression(v string) *MetricDataQuery

SetExpression sets the Expression field's value.

SetId

func (s *MetricDataQuery) SetId(v string) *MetricDataQuery

SetId sets the Id field's value.

SetLabel

func (s *MetricDataQuery) SetLabel(v string) *MetricDataQuery

SetLabel sets the Label field's value.

SetMetricStat

func (s *MetricDataQuery) SetMetricStat(v *MetricStat) *MetricDataQuery

SetMetricStat sets the MetricStat field's value.

SetReturnData

func (s *MetricDataQuery) SetReturnData(v bool) *MetricDataQuery

SetReturnData sets the ReturnData field's value.

String

func (s MetricDataQuery) String() string

String returns the string representation

Validate

func (s *MetricDataQuery) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: