Skip to contents

Returns information about the configured alarms

Source: R/lightsail_operations.R
lightsail_get_alarms.Rd

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.

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

Usage

lightsail_get_alarms(
  alarmName = NULL,
  pageToken = NULL,
  monitoredResourceName = NULL
)

Arguments

alarmName

The name of the alarm.

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

pageToken

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

To get a page token, perform an initial get_alarms 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.

monitoredResourceName

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.