GetAlarms - Amazon Lightsail

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.

Request Syntax

{ "alarmName": "string", "monitoredResourceName": "string", "pageToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

alarmName

The name of the alarm.

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

Type: String

Pattern: \w[\w\-]*\w

Required: No

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.

Type: String

Pattern: \w[\w\-]*\w

Required: No

pageToken

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.

Type: String

Required: No

Response Syntax

{ "alarms": [ { "arn": "string", "comparisonOperator": "string", "contactProtocols": [ "string" ], "createdAt": number, "datapointsToAlarm": number, "evaluationPeriods": number, "location": { "availabilityZone": "string", "regionName": "string" }, "metricName": "string", "monitoredResourceInfo": { "arn": "string", "name": "string", "resourceType": "string" }, "name": "string", "notificationEnabled": boolean, "notificationTriggers": [ "string" ], "period": number, "resourceType": "string", "state": "string", "statistic": "string", "supportCode": "string", "threshold": number, "treatMissingData": "string", "unit": "string" } ], "nextPageToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

alarms

An array of objects that describe the alarms.

Type: Array of Alarm objects

nextPageToken

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

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: