Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AlarmHistoryEntry

An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.

Properties

alarmSummary

alarmSummary: string

Customizable alarm summary ({@code alarmSummary} alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.

summary

summary: string

Description for this alarm history entry.

Example 1 - alarm state history entry: {@code The alarm state is FIRING}

Example 2 - alarm state transition history entry: {@code State transitioned from OK to Firing}

timestamp

timestamp: Date

Timestamp for this alarm history entry. Format defined by RFC3339.

Example: {@code 2023-02-01T01:02:29.600Z}

Optional timestampTriggered

timestampTriggered: Date

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.

Example: {@code 2023-02-01T0:59:00.789Z}

Functions

getDeserializedJsonObj

getJsonObj