Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

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

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

Overview

Sends message data to an IoT Analytics channel.

Constant Summary collapse

SENSITIVE = 
[]

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 IoT Analytics channel. The resulting array can't have more than 100 messages.

Returns:

  • (Boolean) 

9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9146

class IotAnalyticsAction < Struct.new(
  :channel_arn,
  :channel_name,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#channel_arn ⇒ String

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

Returns:

  • (String) 

9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9146

class IotAnalyticsAction < Struct.new(
  :channel_arn,
  :channel_name,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

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

Returns:

  • (String) 

9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9146

class IotAnalyticsAction < Struct.new(
  :channel_arn,
  :channel_name,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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) 

9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9146

class IotAnalyticsAction < Struct.new(
  :channel_arn,
  :channel_name,
  :batch_mode,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end