Class: Aws::IoTEventsData::Types::AlarmSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTEventsData::Types::AlarmSummary

Includes:

Structure

Defined in:

lib/aws-sdk-ioteventsdata/types.rb

Overview

Contains a summary of an alarm.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alarm_model_name ⇒ String

  The name of the alarm model.

• #alarm_model_version ⇒ String

  The version of the alarm model.

• #creation_time ⇒ Time

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

• #key_value ⇒ String

  The value of the key used as a filter to select only the alarms associated with the [key].

• #last_update_time ⇒ Time

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

• #state_name ⇒ String

  The name of the alarm state.

Instance Attribute Details

#alarm_model_name ⇒ String

The name of the alarm model.

Returns:

• (String)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_model_version ⇒ String

The version of the alarm model.

Returns:

• (String)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#key_value ⇒ String

The value of the key used as a filter to select only the alarms associated with the [key].

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key

Returns:

• (String)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#state_name ⇒ String

The name of the alarm state. The state name can be one of the following values:

• ‘DISABLED` - When the alarm is in the `DISABLED` state, it isn’t ready to evaluate data. To enable the alarm, you must change the alarm to the ‘NORMAL` state.

• ‘NORMAL` - When the alarm is in the `NORMAL` state, it’s ready to evaluate data.

• ‘ACTIVE` - If the alarm is in the `ACTIVE` state, the alarm is invoked.

• ‘ACKNOWLEDGED` - When the alarm is in the `ACKNOWLEDGED` state, the alarm was invoked and you acknowledged the alarm.

• ‘SNOOZE_DISABLED` - When the alarm is in the `SNOOZE_DISABLED` state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the `NORMAL` state.

• ‘LATCHED` - When the alarm is in the `LATCHED` state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the `NORMAL` state, you must acknowledge the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-ioteventsdata/types.rb', line 212

class AlarmSummary < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :state_name,
  :creation_time,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end