Class: Aws::IoT::Types::Action

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::Action

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Describes the actions associated with a rule.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloudwatch_alarm ⇒ Types::CloudwatchAlarmAction

  Change the state of a CloudWatch alarm.

• #cloudwatch_logs ⇒ Types::CloudwatchLogsAction

  Send data to CloudWatch Logs.

• #cloudwatch_metric ⇒ Types::CloudwatchMetricAction

  Capture a CloudWatch metric.

• #dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action

  Write to a DynamoDB table.

• #dynamo_db ⇒ Types::DynamoDBAction

  Write to a DynamoDB table.

• #elasticsearch ⇒ Types::ElasticsearchAction

  Write data to an Amazon OpenSearch Service domain.

• #firehose ⇒ Types::FirehoseAction

  Write to an Amazon Kinesis Firehose stream.

• #http ⇒ Types::HttpAction

  Send data to an HTTPS endpoint.

• #iot_analytics ⇒ Types::IotAnalyticsAction

  Sends message data to an IoT Analytics channel.

• #iot_events ⇒ Types::IotEventsAction

  Sends an input to an IoT Events detector.

• #iot_site_wise ⇒ Types::IotSiteWiseAction

  Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

• #kafka ⇒ Types::KafkaAction

  Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

• #kinesis ⇒ Types::KinesisAction

  Write data to an Amazon Kinesis stream.

• #lambda ⇒ Types::LambdaAction

  Invoke a Lambda function.

• #location ⇒ Types::LocationAction

  The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

• #open_search ⇒ Types::OpenSearchAction

  Write data to an Amazon OpenSearch Service domain.

• #republish ⇒ Types::RepublishAction

  Publish to another MQTT topic.

• #s3 ⇒ Types::S3Action

  Write to an Amazon S3 bucket.

• #salesforce ⇒ Types::SalesforceAction

  Send a message to a Salesforce IoT Cloud Input Stream.

• #sns ⇒ Types::SnsAction

  Publish to an Amazon SNS topic.

• #sqs ⇒ Types::SqsAction

  Publish to an Amazon SQS queue.

• #step_functions ⇒ Types::StepFunctionsAction

  Starts execution of a Step Functions state machine.

• #timestream ⇒ Types::TimestreamAction

  The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table.

Instance Attribute Details

#cloudwatch_alarm ⇒ Types::CloudwatchAlarmAction

Change the state of a CloudWatch alarm.

Returns:

• (Types::CloudwatchAlarmAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#cloudwatch_logs ⇒ Types::CloudwatchLogsAction

Send data to CloudWatch Logs.

Returns:

• (Types::CloudwatchLogsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#cloudwatch_metric ⇒ Types::CloudwatchMetricAction

Capture a CloudWatch metric.

Returns:

• (Types::CloudwatchMetricAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

Returns:

• (Types::DynamoDBv2Action)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#dynamo_db ⇒ Types::DynamoDBAction

Write to a DynamoDB table.

Returns:

• (Types::DynamoDBAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch ⇒ Types::ElasticsearchAction

Write data to an Amazon OpenSearch Service domain.

<note markdown=“1”> The ‘Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction].

</note>

[1]: docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html

Returns:

• (Types::ElasticsearchAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#firehose ⇒ Types::FirehoseAction

Write to an Amazon Kinesis Firehose stream.

Returns:

• (Types::FirehoseAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#http ⇒ Types::HttpAction

Send data to an HTTPS endpoint.

Returns:

• (Types::HttpAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#iot_analytics ⇒ Types::IotAnalyticsAction

Sends message data to an IoT Analytics channel.

Returns:

• (Types::IotAnalyticsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#iot_events ⇒ Types::IotEventsAction

Sends an input to an IoT Events detector.

Returns:

• (Types::IotEventsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#iot_site_wise ⇒ Types::IotSiteWiseAction

Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

Returns:

• (Types::IotSiteWiseAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#kafka ⇒ Types::KafkaAction

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

Returns:

• (Types::KafkaAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis ⇒ Types::KinesisAction

Write data to an Amazon Kinesis stream.

Returns:

• (Types::KinesisAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#lambda ⇒ Types::LambdaAction

Invoke a Lambda function.

Returns:

• (Types::LambdaAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::LocationAction

The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

Returns:

• (Types::LocationAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#open_search ⇒ Types::OpenSearchAction

Write data to an Amazon OpenSearch Service domain.

Returns:

• (Types::OpenSearchAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#republish ⇒ Types::RepublishAction

Publish to another MQTT topic.

Returns:

• (Types::RepublishAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#s3 ⇒ Types::S3Action

Write to an Amazon S3 bucket.

Returns:

• (Types::S3Action)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#salesforce ⇒ Types::SalesforceAction

Send a message to a Salesforce IoT Cloud Input Stream.

Returns:

• (Types::SalesforceAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#sns ⇒ Types::SnsAction

Publish to an Amazon SNS topic.

Returns:

• (Types::SnsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#sqs ⇒ Types::SqsAction

Publish to an Amazon SQS queue.

Returns:

• (Types::SqsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#step_functions ⇒ Types::StepFunctionsAction

Starts execution of a Step Functions state machine.

Returns:

• (Types::StepFunctionsAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#timestream ⇒ Types::TimestreamAction

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the [Timestream] topic rule action documentation.

[1]: docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html

Returns:

• (Types::TimestreamAction)

# File 'lib/aws-sdk-iot/types.rb', line 191

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :cloudwatch_logs,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :iot_site_wise,
  :step_functions,
  :timestream,
  :http,
  :kafka,
  :open_search,
  :location)
  SENSITIVE = []
  include Aws::Structure
end