Skip to content

/AWS1/CL_LSA=>GETALARMS()

About GetAlarms

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

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

Optional arguments:

IV_ALARMNAME TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

IV_PAGETOKEN TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

IV_MONITOREDRESOURCENAME TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_LSAGETALARMSRESULT /AWS1/CL_LSAGETALARMSRESULT