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

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 IotAnalyticsAction data as a hash:

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

Sends message data to an IoT Analytics channel.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_modeBoolean

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)


9997
9998
9999
10000
10001
10002
10003
10004
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9997

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

#channel_arnString

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

Returns:

  • (String)


9997
9998
9999
10000
10001
10002
10003
10004
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9997

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

#channel_nameString

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

Returns:

  • (String)


9997
9998
9999
10000
10001
10002
10003
10004
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9997

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

#role_arnString

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)


9997
9998
9999
10000
10001
10002
10003
10004
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9997

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