Skip to content

/AWS1/CL_LSA=>TESTALARM()

About TestAlarm

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.

Method Signature

IMPORTING

Required arguments:

IV_ALARMNAME TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the alarm to test.

IV_STATE TYPE /AWS1/LSAALARMSTATE /AWS1/LSAALARMSTATE

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_LSATESTALARMRESULT /AWS1/CL_LSATESTALARMRESULT