Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAlarms

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

Request Syntax


GET /alarms/alarmModelName?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

alarmModelName

The name of the alarm model.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

maxResults

The maximum number of results to be returned per request.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token that you can use to return the next set of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "alarmSummaries": [ 
      { 
         "alarmModelName": "string",
         "alarmModelVersion": "string",
         "creationTime": number,
         "keyValue": "string",
         "lastUpdateTime": number,
         "stateName": "string"
      }
   ],
   "nextToken": "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.

alarmSummaries

A list that summarizes each alarm.

Type: Array of AlarmSummary objects

nextToken

The token that you can use to return the next set of results, or null if there are no more results.

Type: String

Errors

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidRequestException

The request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429