MetricAlarm#

Description#

The data structure describing the alarm.

Contents#

  • ActionsEnabled — Indicates whether actions should be executed during any changes to the alarm state.

    • Type: Boolean

  • AlarmActions — List of actions, which must be executed when this alarm transitions to the alarm state.

    • Type: Array of strings

    • Length constraints (list): from 0 to 5 items

    • Length constraints (element): from 1 to 1024 symbols

  • AlarmConfigurationUpdatedTimestamp — The time of the last update to the alarm configuration.

    • Type: Double

  • AlarmDescription — The alarm description.

    • Type: String

    • Length constraints (element): from 1 to 255 symbols

  • AlarmName — The name of the alarm.

    • Type: String

    • Length constraints (element): from 1 to 255 symbols

  • ComparisonOperator — The arithmetic operation to use when comparing the specified statistic and threshold.

    • Type: String

    • Valid values: GreaterThanThreshold | GreaterThanOrEqualToThreshold | LessThanOrEqualToThreshold | LessThanThreshold

  • DatapointsToAlarm — Number of datapoints that must be breaching to trigger the alarm.

    • Required: No

    • Type: Integer

    • Valid range: Minimum value — 1, maximum value — EvaluationPeriods

    • Default value: EvaluationPeriods

  • Dimensions.member.N — Dimensions of the metrics associated with the alarm (for details, see user documentation).

    • Type: List of Dimension objects

    • Length constraints: from 0 to 10 items

  • EvaluationPeriods — The number of periods which is compared to the threshold.

    • Type: Integer

    • Constraints: The time period, that is set via EvaluationPeriods and Period should not exceed one day

  • InsufficientDataActions — List of actions, which must be executed when this alarm transitions to the insufficient_data state.

    • Type: Array of strings

    • Length constraints (list): from 0 to 5 items

    • Length constraints (element): from 1 to 1024 symbols

  • MetricName — The name of the metric that associated with the alarm.

    • Type: String

    • Length constraints: from 1 to 255 symbols

  • Namespace — The namespace of the metric with which the alarm is associated.

    • Type: String

    • Length constraints: from 1 to 255 symbols

  • OKActions — List of actions, which must be executed when this alarm transitions to the ok state.

    • Type: Array of strings

    • Length constraints (list): from 0 to 5 items

    • Length constraints (element): from 1 to 1024 symbols

  • Period — The period in seconds over which the statistic is applied.

    • Type: Integer

    • Constraints: The time period, that is set via EvaluationPeriods and Period should not exceed one day

    • Valid range: Value must be divisible by 60, minimum value is 60.

  • StateReason — The description of the reason for the alarm state.

    • Type: String

    • Length constraints: from 1 to 1023 symbols

  • StateReasonData — The description of the reason for switching of the alarm state (in JSON format).

    • Type: String

    • Length constraints: from 0 to 4000 symbols

  • StateUpdatedTimestamp — The transition time of alarm current state.

    • Type: Integer

  • StateValue — The alarm state.

    • Type: String

    • Valid values: ok | alarm | insufficient_data

  • Statistic — The statistic for the metric.

    • Type: String

    • Valid values: Average | Sum | SampleCount | Maximum | Minimum

  • Threshold — The value, to which metric values will be compared.

    • Type: Double

  • TreatMissingData — This parameter defines how periods without values would be interpreted. There’re four possible options: keep considering them periods without values, ignore such periods, consider them breaching, consider them non-breaching.

    • Required: No

    • Type: String

    • Valid values: missing | ignore | breaching | non_breaching

    • Default value: missing

  • Unit — The unit of the metric associated with the alarm.

    • Required: No

    • Type: String

    • Valid values: Percent | Bytes | Count