Class: Aws::IoTEventsData::Types::Alarm

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ioteventsdata/types.rb

Overview

Contains information about an alarm.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_model_name ⇒ String

The name of the alarm model.

Returns:

  • (String) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

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

#alarm_model_version ⇒ String

The version of the alarm model.

Returns:

  • (String) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

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

#alarm_state ⇒ Types::AlarmState

Contains information about the current state of the alarm.

Returns:



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

class Alarm < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :alarm_state,
  :severity,
  :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) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

class Alarm < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :alarm_state,
  :severity,
  :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) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

class Alarm < Struct.new(
  :alarm_model_name,
  :alarm_model_version,
  :key_value,
  :alarm_state,
  :severity,
  :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) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

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

#severity ⇒ Integer

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

Returns:

  • (Integer) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 93

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