Skip to contents

Tests an alarm by displaying a banner on the Amazon Lightsail console

Source: R/lightsail_operations.R
lightsail_test_alarm.Rd

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.

See https://www.paws-r-sdk.com/docs/lightsail_test_alarm/ for full documentation.

Usage

lightsail_test_alarm(alarmName, state)

Arguments

alarmName

[required] The name of the alarm to test.

state

[required] 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.