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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass Action data as a hash:

{
  dynamo_db: {
    table_name: "TableName", # required
    role_arn: "AwsArn", # required
    operation: "DynamoOperation",
    hash_key_field: "HashKeyField", # required
    hash_key_value: "HashKeyValue", # required
    hash_key_type: "STRING", # accepts STRING, NUMBER
    range_key_field: "RangeKeyField",
    range_key_value: "RangeKeyValue",
    range_key_type: "STRING", # accepts STRING, NUMBER
    payload_field: "PayloadField",
  },
  dynamo_d_bv_2: {
    role_arn: "AwsArn", # required
    put_item: { # required
      table_name: "TableName", # required
    },
  },
  lambda: {
    function_arn: "FunctionArn", # required
  },
  sns: {
    target_arn: "AwsArn", # required
    role_arn: "AwsArn", # required
    message_format: "RAW", # accepts RAW, JSON
  },
  sqs: {
    role_arn: "AwsArn", # required
    queue_url: "QueueUrl", # required
    use_base_64: false,
  },
  kinesis: {
    role_arn: "AwsArn", # required
    stream_name: "StreamName", # required
    partition_key: "PartitionKey",
  },
  republish: {
    role_arn: "AwsArn", # required
    topic: "TopicPattern", # required
  },
  s3: {
    role_arn: "AwsArn", # required
    bucket_name: "BucketName", # required
    key: "Key", # required
    canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
  },
  firehose: {
    role_arn: "AwsArn", # required
    delivery_stream_name: "DeliveryStreamName", # required
    separator: "FirehoseSeparator",
  },
  cloudwatch_metric: {
    role_arn: "AwsArn", # required
    metric_namespace: "String", # required
    metric_name: "String", # required
    metric_value: "String", # required
    metric_unit: "String", # required
    metric_timestamp: "String",
  },
  cloudwatch_alarm: {
    role_arn: "AwsArn", # required
    alarm_name: "AlarmName", # required
    state_reason: "StateReason", # required
    state_value: "StateValue", # required
  },
  elasticsearch: {
    role_arn: "AwsArn", # required
    endpoint: "ElasticsearchEndpoint", # required
    index: "ElasticsearchIndex", # required
    type: "ElasticsearchType", # required
    id: "ElasticsearchId", # required
  },
  salesforce: {
    token: "SalesforceToken", # required
    url: "SalesforceEndpoint", # required
  },
  iot_analytics: {
    channel_arn: "AwsArn",
    channel_name: "ChannelName",
    role_arn: "AwsArn",
  },
  iot_events: {
    input_name: "InputName", # required
    message_id: "MessageId",
    role_arn: "AwsArn", # required
  },
  step_functions: {
    execution_name_prefix: "ExecutionNamePrefix",
    state_machine_name: "StateMachineName", # required
    role_arn: "AwsArn", # required
  },
}

Describes the actions associated with a rule.

Instance Attribute Summary collapse

#cloudwatch_alarm ⇒ Types::CloudwatchAlarmAction

Change the state of a CloudWatch alarm.
#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 Elasticsearch Service domain.
#firehose ⇒ Types::FirehoseAction

Write to an Amazon Kinesis Firehose stream.
#iot_analytics ⇒ Types::IotAnalyticsAction

Sends message data to an AWS IoT Analytics channel.
#iot_events ⇒ Types::IotEventsAction

Sends an input to an AWS IoT Events detector.
#kinesis ⇒ Types::KinesisAction

Write data to an Amazon Kinesis stream.
#lambda ⇒ Types::LambdaAction

Invoke a Lambda function.
#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.

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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#cloudwatch_metric ⇒ `Types::CloudwatchMetricAction`

Capture a CloudWatch metric.

Returns:

(Types::CloudwatchMetricAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#dynamo_db ⇒ `Types::DynamoDBAction`

Write to a DynamoDB table.

Returns:

(Types::DynamoDBAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#elasticsearch ⇒ `Types::ElasticsearchAction`

Write data to an Amazon Elasticsearch Service domain.

Returns:

(Types::ElasticsearchAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#iot_analytics ⇒ `Types::IotAnalyticsAction`

Sends message data to an AWS IoT Analytics channel.

Returns:

(Types::IotAnalyticsAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#iot_events ⇒ `Types::IotEventsAction`

Sends an input to an AWS IoT Events detector.

Returns:

(Types::IotEventsAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#lambda ⇒ `Types::LambdaAction`

Invoke a Lambda function.

Returns:

(Types::LambdaAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#republish ⇒ `Types::RepublishAction`

Publish to another MQTT topic.

Returns:

(Types::RepublishAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#s3 ⇒ `Types::S3Action`

Write to an Amazon S3 bucket.

Returns:

(Types::S3Action)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

Publish to an Amazon SNS topic.

Returns:

(Types::SnsAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

#sqs ⇒ `Types::SqsAction`

Publish to an Amazon SQS queue.

Returns:

(Types::SqsAction)

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

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  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 267

class Action < Struct.new(
  :dynamo_db,
  :dynamo_d_bv_2,
  :lambda,
  :sns,
  :sqs,
  :kinesis,
  :republish,
  :s3,
  :firehose,
  :cloudwatch_metric,
  :cloudwatch_alarm,
  :elasticsearch,
  :salesforce,
  :iot_analytics,
  :iot_events,
  :step_functions)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cloudwatch_alarm ⇒ Types::CloudwatchAlarmAction

#cloudwatch_metric ⇒ Types::CloudwatchMetricAction

#dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action

#dynamo_db ⇒ Types::DynamoDBAction

#elasticsearch ⇒ Types::ElasticsearchAction

#firehose ⇒ Types::FirehoseAction

#iot_analytics ⇒ Types::IotAnalyticsAction

#iot_events ⇒ Types::IotEventsAction

#kinesis ⇒ Types::KinesisAction

#lambda ⇒ Types::LambdaAction

#republish ⇒ Types::RepublishAction

#s3 ⇒ Types::S3Action

#salesforce ⇒ Types::SalesforceAction

#sns ⇒ Types::SnsAction

#sqs ⇒ Types::SqsAction

#step_functions ⇒ Types::StepFunctionsAction

#cloudwatch_alarm ⇒ `Types::CloudwatchAlarmAction`

#cloudwatch_metric ⇒ `Types::CloudwatchMetricAction`

#dynamo_d_bv_2 ⇒ `Types::DynamoDBv2Action`

#dynamo_db ⇒ `Types::DynamoDBAction`

#elasticsearch ⇒ `Types::ElasticsearchAction`

#firehose ⇒ `Types::FirehoseAction`

#iot_analytics ⇒ `Types::IotAnalyticsAction`

#iot_events ⇒ `Types::IotEventsAction`

#kinesis ⇒ `Types::KinesisAction`

#lambda ⇒ `Types::LambdaAction`

#republish ⇒ `Types::RepublishAction`

#s3 ⇒ `Types::S3Action`

#salesforce ⇒ `Types::SalesforceAction`

#sns ⇒ `Types::SnsAction`

#sqs ⇒ `Types::SqsAction`

#step_functions ⇒ `Types::StepFunctionsAction`