Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14159650798.5 KB

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.

post/#X-Amz-Target=Lightsail_20161128.GetAlarms

Headers

X-Amz-Target'Lightsail_20161128.GetAlarms' required

Request body

alarmNamestring
<p>The name of the alarm.</p> <p>Specify an alarm name to return information about a specific alarm.</p>
pageTokenstring
<p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetAlarms</code> 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.</p>
monitoredResourceNamestring
<p>The name of the Lightsail resource being monitored by the alarm.</p> <p>Specify a monitored resource name to return information about all alarms for a specific resource.</p>

Response

Success

nextPageTokenstring
<p>The token to advance to the next page of results from your request.</p> <p>A next page token is not returned if there are no more results to display.</p> <p>To get the next page of results, perform another <code>GetAlarms</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>