Up – Package index » awso » Library awso.lightsail » Awso_lightsail » Values » TestAlarmRequest

Module `Values.TestAlarmRequest`Source

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Sourcetype nonrec t = {

alarmName : ResourceName.t;
(*
The name of the alarm to test.
*)
state : AlarmState.t;
(*
The alarm state to test. An alarm has the following possible states that can be tested: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK - The metric is within the defined threshold.
*)

}

Sourceval context_ : string

Sourceval make : alarmName:ResourceName.t -> state:AlarmState.t -> unit -> t

Source

val to_value : 
  t ->
  [> `Structure of
       (string * [> `Enum of string | `String of ResourceName.t ]) list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t