Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AlarmDimensionStatesEntry

A timestamped alarm state entry for a metric stream.

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}.

dimensions

dimensions: object

Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs.

Type declaration

  • [key: string]: string

ruleName

ruleName: string

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}.

status

status: Status

Transition state (status value) associated with the alarm state entry.

Example: {@code FIRING}

timestamp

timestamp: Date

Transition time associated with the alarm state entry. Format defined by RFC3339.

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

Functions

getDeserializedJsonObj

getJsonObj