Class: Aws::IoT::Types::IotEventsAction

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

Overview

Note:

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

{
  input_name: "InputName", # required
  message_id: "MessageId",
  batch_mode: false,
  role_arn: "AwsArn", # required
}

Sends an input to an IoT Events detector.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_modeBoolean

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Returns:

  • (Boolean)


9821
9822
9823
9824
9825
9826
9827
9828
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9821

class IotEventsAction < Struct.new(
  :input_name,
  :message_id,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#input_nameString

The name of the IoT Events input.

Returns:

  • (String)


9821
9822
9823
9824
9825
9826
9827
9828
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9821

class IotEventsAction < Struct.new(
  :input_name,
  :message_id,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#message_idString

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

Returns:

  • (String)


9821
9822
9823
9824
9825
9826
9827
9828
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9821

class IotEventsAction < Struct.new(
  :input_name,
  :message_id,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Returns:

  • (String)


9821
9822
9823
9824
9825
9826
9827
9828
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9821

class IotEventsAction < Struct.new(
  :input_name,
  :message_id,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end