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

Class: Aws::IoT::Types::IotAnalyticsAction

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

Overview

Note:

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

{
  channel_arn: "AwsArn",
  channel_name: "ChannelName",
  batch_mode: false,
  role_arn: "AwsArn",
}

Sends message data to an AWS IoT Analytics channel.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_mode ⇒ Boolean

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can\'t have more than 100 messages.

Returns:

  • (Boolean) —

    Whether to process the action as a batch.

#channel_arn ⇒ String

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Returns:

  • (String) —

    (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

#channel_name ⇒ String

The name of the IoT Analytics channel to which message data will be sent.

Returns:

  • (String) —

    The name of the IoT Analytics channel to which message data will be sent.

#role_arn ⇒ String

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Returns:

  • (String) —

    The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).