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

DescribeAlarm

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.

alarmModelName

The name of the alarm model.

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

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

Required: Yes

keyValue

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.

alarm

Contains information about an alarm.

Type: Alarm object

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