Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426220141.8 KB

Retrieves information about an alarm model. If you don't specify a value for the <code>alarmModelVersion</code> parameter, the latest version is returned.

get/alarm-models/{alarmModelName}

Path parameters

alarmModelNamestring required

The name of the alarm model.

Query parameters

versionstring

The version of the alarm model.

Response

Success

creationTimestring date-time

The time the alarm model was created, in the Unix epoch format.

alarmModelArnstring

The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.

alarmModelVersionstring

The version of the alarm model.

lastUpdateTimestring date-time

The time the alarm model was last updated, in the Unix epoch format.

status'ACTIVE' | 'ACTIVATING' | 'INACTIVE' | 'FAILED'
<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>
statusMessagestring

Contains information about the status of the alarm model.

alarmModelNamestring

The name of the alarm model.

alarmModelDescriptionstring

The description of the alarm model.

roleArnstring

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.

keystring

An input attribute used as a key to create an alarm. AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a> associated with this key to the alarm.

severityinteger

A non-negative integer that reflects the severity level of the alarm.