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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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` ][1] to the IoT Analytics channel. The resulting array can’t have more than 100 messages.

[1]: docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html

Returns:

  • (Boolean) 


8217
8218
8219
8220
8221
8222
8223
8224
 
# File 'lib/aws-sdk-iot/types.rb', line 8217

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) 


8217
8218
8219
8220
8221
8222
8223
8224
 
# File 'lib/aws-sdk-iot/types.rb', line 8217

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) 


8217
8218
8219
8220
8221
8222
8223
8224
 
# File 'lib/aws-sdk-iot/types.rb', line 8217

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) 


8217
8218
8219
8220
8221
8222
8223
8224
 
# File 'lib/aws-sdk-iot/types.rb', line 8217

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