Class: Aws::IoTEventsData::Types::UpdateDetectorRequest

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

Overview

Note:

When making an API call, you may pass UpdateDetectorRequest data as a hash:

{
  message_id: "MessageId", # required
  detector_model_name: "DetectorModelName", # required
  key_value: "KeyValue",
  state: { # required
    state_name: "StateName", # required
    variables: [ # required
      {
        name: "VariableName", # required
        value: "VariableValue", # required
      },
    ],
    timers: [ # required
      {
        name: "TimerName", # required
        seconds: 1, # required
      },
    ],
  },
}

Information used to update the detector (instance).

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#detector_model_name ⇒ String

The name of the detector model that created the detectors (instances).

Returns:

  • (String) 


575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 575

class UpdateDetectorRequest < Struct.new(
  :message_id,
  :detector_model_name,
  :key_value,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#key_value ⇒ String

The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).

Returns:

  • (String) 


575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 575

class UpdateDetectorRequest < Struct.new(
  :message_id,
  :detector_model_name,
  :key_value,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#message_id ⇒ String

The ID to assign to the detector update "message". Each "messageId" must be unique within each batch sent.

Returns:

  • (String) 


575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 575

class UpdateDetectorRequest < Struct.new(
  :message_id,
  :detector_model_name,
  :key_value,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::DetectorStateDefinition

The new state, variable values, and timer settings of the detector (instance).

Returns:



575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 575

class UpdateDetectorRequest < Struct.new(
  :message_id,
  :detector_model_name,
  :key_value,
  :state)
  SENSITIVE = []
  include Aws::Structure
end