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

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

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 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",
    put_item: {
      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",
  },
  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

Instance Attribute Details

#cloudwatch_alarm ⇒ Types::CloudwatchAlarmAction

Change the state of a CloudWatch alarm.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#cloudwatch_metric ⇒ Types::CloudwatchMetricAction

Capture a CloudWatch metric.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :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:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#dynamo_db ⇒ Types::DynamoDBAction

Write to a DynamoDB table.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#elasticsearch ⇒ Types::ElasticsearchAction

Write data to an Amazon Elasticsearch Service domain.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#firehose ⇒ Types::FirehoseAction

Write to an Amazon Kinesis Firehose stream.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#iot_analytics ⇒ Types::IotAnalyticsAction

Sends message data to an AWS IoT Analytics channel.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#kinesis ⇒ Types::KinesisAction

Write data to an Amazon Kinesis stream.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#lambda ⇒ Types::LambdaAction

Invoke a Lambda function.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#republish ⇒ Types::RepublishAction

Publish to another MQTT topic.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#s3 ⇒ Types::S3Action

Write to an Amazon S3 bucket.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#salesforce ⇒ Types::SalesforceAction

Send a message to a Salesforce IoT Cloud Input Stream.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#sns ⇒ Types::SnsAction

Publish to an Amazon SNS topic.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#sqs ⇒ Types::SqsAction

Publish to an Amazon SQS queue.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end

#step_functions ⇒ Types::StepFunctionsAction

Starts execution of a Step Functions state machine.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 192

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,
  :step_functions)
  include Aws::Structure
end