Values.MetricAlarmSourceThe details about a metric alarm.
type nonrec t = {alarmName : AlarmName.t option;The name of the alarm.
*)alarmArn : AlarmArn.t option;The Amazon Resource Name (ARN) of the alarm.
*)alarmDescription : AlarmDescription.t option;The description of the alarm.
*)alarmConfigurationUpdatedTimestamp : Timestamp.t option;The time stamp of the last update to the alarm configuration.
*)actionsEnabled : ActionsEnabled.t option;Indicates whether actions should be executed during any changes to the alarm state.
*)oKActions : ResourceList.t option;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).
*)alarmActions : ResourceList.t option;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).
*)insufficientDataActions : ResourceList.t option;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).
*)stateValue : StateValue.t option;The state value for the alarm.
*)stateReason : StateReason.t option;An explanation for the alarm state, in text format.
*)stateReasonData : StateReasonData.t option;An explanation for the alarm state, in JSON format.
*)stateUpdatedTimestamp : Timestamp.t option;The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
*)metricName : MetricName.t option;The name of the metric associated with the alarm, if this is an alarm based on a single metric.
*)namespace : Namespace.t option;The namespace of the metric associated with the alarm.
*)statistic : Statistic.t option;The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
*)extendedStatistic : ExtendedStatistic.t option;The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
*)dimensions : Dimensions.t option;The dimensions for the metric associated with the alarm.
*)period : Period.t option;The period, in seconds, over which the statistic is applied.
*)unit : StandardUnit.t option;The unit of the metric associated with the alarm.
*)evaluationPeriods : EvaluationPeriods.t option;The number of periods over which data is compared to the specified threshold.
*)datapointsToAlarm : DatapointsToAlarm.t option;The number of data points that must be breaching to trigger the alarm.
*)threshold : Threshold.t option;The value to compare with the specified statistic.
*)comparisonOperator : ComparisonOperator.t option;The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
*)treatMissingData : TreatMissingData.t option;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. This parameter is not applicable to PromQL alarms.
*)evaluateLowSampleCountPercentile : EvaluateLowSampleCountPercentile.t option;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.
*)metrics : MetricDataQueries.t option;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.
*)thresholdMetricId : MetricId.t option;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.
*)evaluationState : EvaluationState.t option;If the value of this field is PARTIAL_DATA, it indicates that not all the available data was able to be retrieved due to quota limitations. For more information, see Create alarms on Metrics Insights queries. If the value of this field is EVALUATION_ERROR, it indicates configuration errors in alarm setup that require review and correction. Refer to StateReason field of the alarm for more details. If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved
*)stateTransitionedTimestamp : Timestamp.t option;The date and time that the alarm's StateValue most recently changed.
*)evaluationCriteria : EvaluationCriteria.t option;The evaluation criteria for the alarm.
*)evaluationInterval : EvaluationInterval.t option;The frequency, in seconds, at which the alarm is evaluated.
*)}val make :
?alarmName:??? ->
?alarmArn:??? ->
?alarmDescription:??? ->
?alarmConfigurationUpdatedTimestamp:??? ->
?actionsEnabled:??? ->
?oKActions:??? ->
?alarmActions:??? ->
?insufficientDataActions:??? ->
?stateValue:??? ->
?stateReason:??? ->
?stateReasonData:??? ->
?stateUpdatedTimestamp:??? ->
?metricName:??? ->
?namespace:??? ->
?statistic:??? ->
?extendedStatistic:??? ->
?dimensions:??? ->
?period:??? ->
?unit:??? ->
?evaluationPeriods:??? ->
?datapointsToAlarm:??? ->
?threshold:??? ->
?comparisonOperator:??? ->
?treatMissingData:??? ->
?evaluateLowSampleCountPercentile:??? ->
?metrics:??? ->
?thresholdMetricId:??? ->
?evaluationState:??? ->
?stateTransitionedTimestamp:??? ->
?evaluationCriteria:??? ->
?evaluationInterval:??? ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of ActionsEnabled.t
| `Double of Threshold.t
| `Enum of string
| `Integer of Period.t
| `List of
[> `String of ResourceName.t
| `Structure of
(string
* [> `Boolean of ReturnData.t
| `Integer of Period.t
| `String of DimensionName.t
| `Structure of
(string
* [> `Enum of string
| `Integer of Period.t
| `String of Stat.t
| `Structure of
(string
* [> `List of
[> `Structure of
(string * [> `String of DimensionName.t ])
list ]
list
| `String of Namespace.t ])
list ])
list ])
list ]
list
| `String of AlarmName.t
| `Structure of
(string
* [> `Structure of
(string
* [> `Integer of PendingPeriod.t | `String of Query.t ])
list ])
list
| `Timestamp of Timestamp.t ])
list ]