DescribeAlarm - Amazon IoT Events Data
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Retrieves information about an alarm.

Request Syntax

GET /alarms/alarmModelName/keyValues/?keyValue=keyValue HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the alarm model.

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

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

Required: Yes


The value of the key used as a filter to select only the alarms associated with the key.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "alarm": { "alarmModelName": "string", "alarmModelVersion": "string", "alarmState": { "customerAction": { "acknowledgeActionConfiguration": { "note": "string" }, "actionName": "string", "disableActionConfiguration": { "note": "string" }, "enableActionConfiguration": { "note": "string" }, "resetActionConfiguration": { "note": "string" }, "snoozeActionConfiguration": { "note": "string", "snoozeDuration": number } }, "ruleEvaluation": { "simpleRuleEvaluation": { "inputPropertyValue": "string", "operator": "string", "thresholdValue": "string" } }, "stateName": "string", "systemEvent": { "eventType": "string", "stateChangeConfiguration": { "triggerType": "string" } } }, "creationTime": number, "keyValue": "string", "lastUpdateTime": number, "severity": number } }

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.


Contains information about an alarm.

Type: Alarm object


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


An internal failure occurred.

HTTP Status Code: 500


The request was invalid.

HTTP Status Code: 400


The resource was not found.

HTTP Status Code: 404


The service is currently unavailable.

HTTP Status Code: 503


The request could not be completed due to throttling.

HTTP Status Code: 429

See Also

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