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

Class: Aws::IoTEvents::Types::Action

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

Overview

Note:

When passing Action as input to an Aws::Client method, you can use a vanilla 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: { # required
      value: { # required
        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.

Instance Attribute Summary collapse

Instance Attribute Details

#clear_timer ⇒ Types::ClearTimerAction

Information needed to clear the timer.

Returns:

#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 also 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.

Returns:

#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 also 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.

Returns:

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

Returns:

  • (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.

Returns:

  • (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 .

Returns:

  • (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.

Returns:

#lambda ⇒ Types::LambdaAction

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

Returns:

  • (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.

Returns:

#set_timer ⇒ Types::SetTimerAction

Information needed to set the timer.

Returns:

#set_variable ⇒ Types::SetVariableAction

Sets a variable to a specified value.

Returns:

#sns ⇒ Types::SNSTopicPublishAction

Sends an Amazon SNS message.

Returns:

#sqs ⇒ Types::SqsAction

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Returns:

  • (Types::SqsAction) —

    Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.