/AWS1/CL_CWTMETRICALARM

The details about a metric alarm.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_ALARMNAME TYPE /AWS1/CWTALARMNAME /AWS1/CWTALARMNAME

The name of the alarm.

IV_ALARMARN TYPE /AWS1/CWTALARMARN /AWS1/CWTALARMARN

The Amazon Resource Name (ARN) of the alarm.

IV_ALARMDESCRIPTION TYPE /AWS1/CWTALARMDESCRIPTION /AWS1/CWTALARMDESCRIPTION

The description of the alarm.

IV_ALARMCONFUPDATEDTIMESTAMP TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The time stamp of the last update to the alarm configuration.

IV_ACTIONSENABLED TYPE /AWS1/CWTACTIONSENABLED /AWS1/CWTACTIONSENABLED

Indicates whether actions should be executed during any changes to the alarm state.

IT_OKACTIONS TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

IT_ALARMACTIONS TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

IT_INSUFFICIENTDATAACTIONS TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

IV_STATEVALUE TYPE /AWS1/CWTSTATEVALUE /AWS1/CWTSTATEVALUE

The state value for the alarm.

IV_STATEREASON TYPE /AWS1/CWTSTATEREASON /AWS1/CWTSTATEREASON

An explanation for the alarm state, in text format.

IV_STATEREASONDATA TYPE /AWS1/CWTSTATEREASONDATA /AWS1/CWTSTATEREASONDATA

An explanation for the alarm state, in JSON format.

IV_STATEUPDATEDTIMESTAMP TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

IV_METRICNAME TYPE /AWS1/CWTMETRICNAME /AWS1/CWTMETRICNAME

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

IV_NAMESPACE TYPE /AWS1/CWTNAMESPACE /AWS1/CWTNAMESPACE

The namespace of the metric associated with the alarm.

IV_STATISTIC TYPE /AWS1/CWTSTATISTIC /AWS1/CWTSTATISTIC

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

IV_EXTENDEDSTATISTIC TYPE /AWS1/CWTEXTENDEDSTATISTIC /AWS1/CWTEXTENDEDSTATISTIC

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

IT_DIMENSIONS TYPE /AWS1/CL_CWTDIMENSION=>TT_DIMENSIONS TT_DIMENSIONS

The dimensions for the metric associated with the alarm.

IV_PERIOD TYPE /AWS1/CWTPERIOD /AWS1/CWTPERIOD

The period, in seconds, over which the statistic is applied.

IV_UNIT TYPE /AWS1/CWTSTANDARDUNIT /AWS1/CWTSTANDARDUNIT

The unit of the metric associated with the alarm.

IV_EVALUATIONPERIODS TYPE /AWS1/CWTEVALUATIONPERIODS /AWS1/CWTEVALUATIONPERIODS

The number of periods over which data is compared to the specified threshold.

IV_DATAPOINTSTOALARM TYPE /AWS1/CWTDATAPOINTSTOALARM /AWS1/CWTDATAPOINTSTOALARM

The number of data points that must be breaching to trigger the alarm.

IV_THRESHOLD TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The value to compare with the specified statistic.

IV_COMPARISONOPERATOR TYPE /AWS1/CWTCOMPARISONOPERATOR /AWS1/CWTCOMPARISONOPERATOR

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

IV_TREATMISSINGDATA TYPE /AWS1/CWTTREATMISSINGDATA /AWS1/CWTTREATMISSINGDATA

Sets how this alarm is to handle missing data points. The valid values are breaching, notBreaching, ignore, and missing. For more information, see Configuring how CloudWatch alarms treat missing data.

If this parameter is omitted, the default behavior of missing is used.

IV_EVALUATELOWSAMPLECTPERC00 TYPE /AWS1/CWTEVALUATELOWSAMPLECT00 /AWS1/CWTEVALUATELOWSAMPLECT00

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

IT_METRICS TYPE /AWS1/CL_CWTMETRICDATAQUERY=>TT_METRICDATAQUERIES TT_METRICDATAQUERIES

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression.

One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

IV_THRESHOLDMETRICID TYPE /AWS1/CWTMETRICID /AWS1/CWTMETRICID

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

IV_EVALUATIONSTATE TYPE /AWS1/CWTEVALUATIONSTATE /AWS1/CWTEVALUATIONSTATE

If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.

IV_STATETRANSEDTIMESTAMP TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The date and time that the alarm's StateValue most recently changed.

---

Queryable Attributes

AlarmName

The name of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMNAME()	Getter for ALARMNAME, with configurable default
ASK_ALARMNAME()	Getter for ALARMNAME w/ exceptions if field has no value
HAS_ALARMNAME()	Determine if ALARMNAME has a value

AlarmArn

The Amazon Resource Name (ARN) of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMARN()	Getter for ALARMARN, with configurable default
ASK_ALARMARN()	Getter for ALARMARN w/ exceptions if field has no value
HAS_ALARMARN()	Determine if ALARMARN has a value

AlarmDescription

The description of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMDESCRIPTION()	Getter for ALARMDESCRIPTION, with configurable default
ASK_ALARMDESCRIPTION()	Getter for ALARMDESCRIPTION w/ exceptions if field has no va
HAS_ALARMDESCRIPTION()	Determine if ALARMDESCRIPTION has a value

AlarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

Accessible with the following methods

Method	Description
GET_ALARMCONFUPDATEDTSMP()	Getter for ALARMCONFUPDATEDTIMESTAMP, with configurable defa
ASK_ALARMCONFUPDATEDTSMP()	Getter for ALARMCONFUPDATEDTIMESTAMP w/ exceptions if field
HAS_ALARMCONFUPDATEDTSMP()	Determine if ALARMCONFUPDATEDTIMESTAMP has a value

ActionsEnabled

Indicates whether actions should be executed during any changes to the alarm state.

Accessible with the following methods

Method	Description
GET_ACTIONSENABLED()	Getter for ACTIONSENABLED, with configurable default
ASK_ACTIONSENABLED()	Getter for ACTIONSENABLED w/ exceptions if field has no valu
HAS_ACTIONSENABLED()	Determine if ACTIONSENABLED has a value

OKActions

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_OKACTIONS()	Getter for OKACTIONS, with configurable default
ASK_OKACTIONS()	Getter for OKACTIONS w/ exceptions if field has no value
HAS_OKACTIONS()	Determine if OKACTIONS has a value

AlarmActions

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_ALARMACTIONS()	Getter for ALARMACTIONS, with configurable default
ASK_ALARMACTIONS()	Getter for ALARMACTIONS w/ exceptions if field has no value
HAS_ALARMACTIONS()	Determine if ALARMACTIONS has a value

InsufficientDataActions

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_INSUFFICIENTDATAACTIONS()	Getter for INSUFFICIENTDATAACTIONS, with configurable defaul
ASK_INSUFFICIENTDATAACTIONS()	Getter for INSUFFICIENTDATAACTIONS w/ exceptions if field ha
HAS_INSUFFICIENTDATAACTIONS()	Determine if INSUFFICIENTDATAACTIONS has a value

StateValue

The state value for the alarm.

Accessible with the following methods

Method	Description
GET_STATEVALUE()	Getter for STATEVALUE, with configurable default
ASK_STATEVALUE()	Getter for STATEVALUE w/ exceptions if field has no value
HAS_STATEVALUE()	Determine if STATEVALUE has a value

StateReason

An explanation for the alarm state, in text format.

Accessible with the following methods

Method	Description
GET_STATEREASON()	Getter for STATEREASON, with configurable default
ASK_STATEREASON()	Getter for STATEREASON w/ exceptions if field has no value
HAS_STATEREASON()	Determine if STATEREASON has a value

StateReasonData

An explanation for the alarm state, in JSON format.

Accessible with the following methods

Method	Description
GET_STATEREASONDATA()	Getter for STATEREASONDATA, with configurable default
ASK_STATEREASONDATA()	Getter for STATEREASONDATA w/ exceptions if field has no val
HAS_STATEREASONDATA()	Determine if STATEREASONDATA has a value

StateUpdatedTimestamp

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

Accessible with the following methods

Method	Description
GET_STATEUPDATEDTIMESTAMP()	Getter for STATEUPDATEDTIMESTAMP, with configurable default
ASK_STATEUPDATEDTIMESTAMP()	Getter for STATEUPDATEDTIMESTAMP w/ exceptions if field has
HAS_STATEUPDATEDTIMESTAMP()	Determine if STATEUPDATEDTIMESTAMP has a value

MetricName

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

Accessible with the following methods

Method	Description
GET_METRICNAME()	Getter for METRICNAME, with configurable default
ASK_METRICNAME()	Getter for METRICNAME w/ exceptions if field has no value
HAS_METRICNAME()	Determine if METRICNAME has a value

Namespace

The namespace of the metric associated with the alarm.

Accessible with the following methods

Method	Description
GET_NAMESPACE()	Getter for NAMESPACE, with configurable default
ASK_NAMESPACE()	Getter for NAMESPACE w/ exceptions if field has no value
HAS_NAMESPACE()	Determine if NAMESPACE has a value

Statistic

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

Accessible with the following methods

Method	Description
GET_STATISTIC()	Getter for STATISTIC, with configurable default
ASK_STATISTIC()	Getter for STATISTIC w/ exceptions if field has no value
HAS_STATISTIC()	Determine if STATISTIC has a value

ExtendedStatistic

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Accessible with the following methods

Method	Description
GET_EXTENDEDSTATISTIC()	Getter for EXTENDEDSTATISTIC, with configurable default
ASK_EXTENDEDSTATISTIC()	Getter for EXTENDEDSTATISTIC w/ exceptions if field has no v
HAS_EXTENDEDSTATISTIC()	Determine if EXTENDEDSTATISTIC has a value

Dimensions

The dimensions for the metric associated with the alarm.

Accessible with the following methods

Method	Description
GET_DIMENSIONS()	Getter for DIMENSIONS, with configurable default
ASK_DIMENSIONS()	Getter for DIMENSIONS w/ exceptions if field has no value
HAS_DIMENSIONS()	Determine if DIMENSIONS has a value

Period

The period, in seconds, over which the statistic is applied.

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

Unit

The unit of the metric associated with the alarm.

Accessible with the following methods

Method	Description
GET_UNIT()	Getter for UNIT, with configurable default
ASK_UNIT()	Getter for UNIT w/ exceptions if field has no value
HAS_UNIT()	Determine if UNIT has a value

EvaluationPeriods

The number of periods over which data is compared to the specified threshold.

Accessible with the following methods

Method	Description
GET_EVALUATIONPERIODS()	Getter for EVALUATIONPERIODS, with configurable default
ASK_EVALUATIONPERIODS()	Getter for EVALUATIONPERIODS w/ exceptions if field has no v
HAS_EVALUATIONPERIODS()	Determine if EVALUATIONPERIODS has a value

DatapointsToAlarm

The number of data points that must be breaching to trigger the alarm.

Accessible with the following methods

Method	Description
GET_DATAPOINTSTOALARM()	Getter for DATAPOINTSTOALARM, with configurable default
ASK_DATAPOINTSTOALARM()	Getter for DATAPOINTSTOALARM w/ exceptions if field has no v
HAS_DATAPOINTSTOALARM()	Determine if DATAPOINTSTOALARM has a value

Threshold

The value to compare with the specified statistic.

Accessible with the following methods

Method	Description
GET_THRESHOLD()	Getter for THRESHOLD, with configurable default
ASK_THRESHOLD()	Getter for THRESHOLD w/ exceptions if field has no value
STR_THRESHOLD()	String format for THRESHOLD, with configurable default
HAS_THRESHOLD()	Determine if THRESHOLD has a value

ComparisonOperator

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

Accessible with the following methods

Method	Description
GET_COMPARISONOPERATOR()	Getter for COMPARISONOPERATOR, with configurable default
ASK_COMPARISONOPERATOR()	Getter for COMPARISONOPERATOR w/ exceptions if field has no
HAS_COMPARISONOPERATOR()	Determine if COMPARISONOPERATOR has a value

TreatMissingData

Sets how this alarm is to handle missing data points. The valid values are breaching, notBreaching, ignore, and missing. For more information, see Configuring how CloudWatch alarms treat missing data.

If this parameter is omitted, the default behavior of missing is used.

Accessible with the following methods

Method	Description
GET_TREATMISSINGDATA()	Getter for TREATMISSINGDATA, with configurable default
ASK_TREATMISSINGDATA()	Getter for TREATMISSINGDATA w/ exceptions if field has no va
HAS_TREATMISSINGDATA()	Determine if TREATMISSINGDATA has a value

EvaluateLowSampleCountPercentile

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

Accessible with the following methods

Method	Description
GET_EVALUATELOWSAMPLECTPER00()	Getter for EVALUATELOWSAMPLECTPERCENT00, with configurable d
ASK_EVALUATELOWSAMPLECTPER00()	Getter for EVALUATELOWSAMPLECTPERCENT00 w/ exceptions if fie
HAS_EVALUATELOWSAMPLECTPER00()	Determine if EVALUATELOWSAMPLECTPERCENT00 has a value

Metrics

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression.

One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

Accessible with the following methods

Method	Description
GET_METRICS()	Getter for METRICS, with configurable default
ASK_METRICS()	Getter for METRICS w/ exceptions if field has no value
HAS_METRICS()	Determine if METRICS has a value

ThresholdMetricId

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

Accessible with the following methods

Method	Description
GET_THRESHOLDMETRICID()	Getter for THRESHOLDMETRICID, with configurable default
ASK_THRESHOLDMETRICID()	Getter for THRESHOLDMETRICID w/ exceptions if field has no v
HAS_THRESHOLDMETRICID()	Determine if THRESHOLDMETRICID has a value

EvaluationState

If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.

Accessible with the following methods

Method	Description
GET_EVALUATIONSTATE()	Getter for EVALUATIONSTATE, with configurable default
ASK_EVALUATIONSTATE()	Getter for EVALUATIONSTATE w/ exceptions if field has no val
HAS_EVALUATIONSTATE()	Determine if EVALUATIONSTATE has a value

StateTransitionedTimestamp

The date and time that the alarm's StateValue most recently changed.

Accessible with the following methods

Method	Description
GET_STATETRANSEDTIMESTAMP()	Getter for STATETRANSITIONEDTIMESTAMP, with configurable def
ASK_STATETRANSEDTIMESTAMP()	Getter for STATETRANSITIONEDTIMESTAMP w/ exceptions if field
HAS_STATETRANSEDTIMESTAMP()	Determine if STATETRANSITIONEDTIMESTAMP 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_METRICALARMS

TYPES TT_METRICALARMS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWTMETRICALARM WITH DEFAULT KEY
.