Class: Aws::IoTEvents::Types::Action
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTEvents::Types::Action
- Defined in:
- gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb
Overview
When making an API call, you may pass Action data as a hash:
{
set_variable: {
variable_name: "VariableName", # required
value: "VariableValue", # required
},
sns: {
target_arn: "AmazonResourceName", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
iot_topic_publish: {
mqtt_topic: "MQTTTopic", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
set_timer: {
timer_name: "TimerName", # required
seconds: 1,
duration_expression: "VariableValue",
},
clear_timer: {
timer_name: "TimerName", # required
},
reset_timer: {
timer_name: "TimerName", # required
},
lambda: {
function_arn: "AmazonResourceName", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
iot_events: {
input_name: "InputName", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
sqs: {
queue_url: "QueueUrl", # required
use_base_64: false,
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
firehose: {
delivery_stream_name: "DeliveryStreamName", # required
separator: "FirehoseSeparator",
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
dynamo_db: {
hash_key_type: "DynamoKeyType",
hash_key_field: "DynamoKeyField", # required
hash_key_value: "DynamoKeyValue", # required
range_key_type: "DynamoKeyType",
range_key_field: "DynamoKeyField",
range_key_value: "DynamoKeyValue",
operation: "DynamoOperation",
payload_field: "DynamoKeyField",
table_name: "DynamoTableName", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
dynamo_d_bv_2: {
table_name: "DynamoTableName", # required
payload: {
content_expression: "ContentExpression", # required
type: "STRING", # required, accepts STRING, JSON
},
},
iot_site_wise: {
entry_id: "AssetPropertyEntryId",
asset_id: "AssetId",
property_id: "AssetPropertyId",
property_alias: "AssetPropertyAlias",
property_value: {
value: {
string_value: "AssetPropertyStringValue",
integer_value: "AssetPropertyIntegerValue",
double_value: "AssetPropertyDoubleValue",
boolean_value: "AssetPropertyBooleanValue",
},
timestamp: {
time_in_seconds: "AssetPropertyTimeInSeconds", # required
offset_in_nanos: "AssetPropertyOffsetInNanos",
},
quality: "AssetPropertyQuality",
},
},
}
An action to be performed when the condition
is TRUE.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#clear_timer ⇒ Types::ClearTimerAction
Information needed to clear the timer.
-
#dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action
Writes to the DynamoDB table that you created.
-
#dynamo_db ⇒ Types::DynamoDBAction
Writes to the DynamoDB table that you created.
-
#firehose ⇒ Types::FirehoseAction
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
-
#iot_events ⇒ Types::IotEventsAction
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
-
#iot_site_wise ⇒ Types::IotSiteWiseAction
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
-
#iot_topic_publish ⇒ Types::IotTopicPublishAction
Publishes an MQTT message with the given topic to the AWS IoT message broker.
-
#lambda ⇒ Types::LambdaAction
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
-
#reset_timer ⇒ Types::ResetTimerAction
Information needed to reset the timer.
-
#set_timer ⇒ Types::SetTimerAction
Information needed to set the timer.
-
#set_variable ⇒ Types::SetVariableAction
Sets a variable to a specified value.
-
#sns ⇒ Types::SNSTopicPublishAction
Sends an Amazon SNS message.
-
#sqs ⇒ Types::SqsAction
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Instance Attribute Details
#clear_timer ⇒ Types::ClearTimerAction
Information needed to clear the timer.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#dynamo_db ⇒ Types::DynamoDBAction
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#firehose ⇒ Types::FirehoseAction
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#iot_events ⇒ Types::IotEventsAction
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#iot_site_wise ⇒ Types::IotSiteWiseAction
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#iot_topic_publish ⇒ Types::IotTopicPublishAction
Publishes an MQTT message with the given topic to the AWS IoT message broker.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#lambda ⇒ Types::LambdaAction
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#reset_timer ⇒ Types::ResetTimerAction
Information needed to reset the timer.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#set_timer ⇒ Types::SetTimerAction
Information needed to set the timer.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#set_variable ⇒ Types::SetVariableAction
Sets a variable to a specified value.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#sns ⇒ Types::SNSTopicPublishAction
Sends an Amazon SNS message.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |
#sqs ⇒ Types::SqsAction
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 226 class Action < Struct.new( :set_variable, :sns, :iot_topic_publish, :set_timer, :clear_timer, :reset_timer, :lambda, :iot_events, :sqs, :firehose, :dynamo_db, :dynamo_d_bv_2, :iot_site_wise) SENSITIVE = [] include Aws::Structure end |