You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing IotEventsAction as input to an Aws::Client method, you can use a vanilla Hash:

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

Sends an input to an AWS IoT Events detector.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_mode ⇒ Boolean

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 AWS IoT Events by calling BatchPutMessage . The resulting array can\'t have more than 10 messages.

Returns:

  • (Boolean) —

    Whether to process the event actions as a batch.

#input_name ⇒ String

The name of the AWS IoT Events input.

Returns:

  • (String) —

    The name of the AWS IoT Events input.

#message_id ⇒ String

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 AWS IoT Events detector.

Returns:

  • (String) —

    The ID of the message.

#role_arn ⇒ String

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

Returns:

  • (String) —

    The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.