Skip to content

/AWS1/CL_CWSMETRICDATAQUERY

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 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, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

For more information about metric math expressions, see CloudWatchUse metric math.

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_id TYPE /AWS1/CWSMETRICID /AWS1/CWSMETRICID

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

Optional arguments:

io_metricstat TYPE REF TO /AWS1/CL_CWSMETRICSTAT /AWS1/CL_CWSMETRICSTAT

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

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

iv_expression TYPE /AWS1/CWSMETRICEXPRESSION /AWS1/CWSMETRICEXPRESSION

This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

A math expression can use the Id of the other metrics or queries 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.

iv_label TYPE /AWS1/CWSMETRICLABEL /AWS1/CWSMETRICLABEL

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.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

iv_returndata TYPE /AWS1/CWSRETURNDATA /AWS1/CWSRETURNDATA

Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

iv_period TYPE /AWS1/CWSPERIOD /AWS1/CWSPERIOD

The granularity, in seconds, of the returned data points for this metric. 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).

iv_accountid TYPE /AWS1/CWSACCOUNTID /AWS1/CWSACCOUNTID

The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.

Queryable Attributes

Id

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

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

MetricStat

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

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

Accessible with the following methods

Method Description
GET_METRICSTAT() Getter for METRICSTAT

Expression

This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

A math expression can use the Id of the other metrics or queries 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.

Accessible with the following methods

Method Description
GET_EXPRESSION() Getter for EXPRESSION, with configurable default
ASK_EXPRESSION() Getter for EXPRESSION w/ exceptions if field has no value
HAS_EXPRESSION() Determine if EXPRESSION has a value

Label

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.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

Accessible with the following methods

Method Description
GET_LABEL() Getter for LABEL, with configurable default
ASK_LABEL() Getter for LABEL w/ exceptions if field has no value
HAS_LABEL() Determine if LABEL has a value

ReturnData

Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

Accessible with the following methods

Method Description
GET_RETURNDATA() Getter for RETURNDATA, with configurable default
ASK_RETURNDATA() Getter for RETURNDATA w/ exceptions if field has no value
HAS_RETURNDATA() Determine if RETURNDATA has a value

Period

The granularity, in seconds, of the returned data points for this metric. 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).

Accessible with the following methods

Method Description
GET_PERIOD() Getter for PERIOD, with configurable default
ASK_PERIOD() Getter for PERIOD w/ exceptions if field has no value
HAS_PERIOD() Determine if PERIOD has a value

AccountId

The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.

Accessible with the following methods

Method Description
GET_ACCOUNTID() Getter for ACCOUNTID, with configurable default
ASK_ACCOUNTID() Getter for ACCOUNTID w/ exceptions if field has no value
HAS_ACCOUNTID() Determine if ACCOUNTID has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_METRICDATAQUERIES

TYPES TT_METRICDATAQUERIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWSMETRICDATAQUERY WITH DEFAULT KEY
.