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

Class: Aws::IoT::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:

{
  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: "MetricNamespace", # required
    metric_name: "MetricName", # required
    metric_value: "MetricValue", # required
    metric_unit: "MetricUnit", # required
    metric_timestamp: "MetricTimestamp",
  },
  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
  },
}

Describes the actions associated with a rule.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#cloudwatch_alarmTypes::CloudwatchAlarmAction

Change the state of a CloudWatch alarm.

Returns:

#cloudwatch_metricTypes::CloudwatchMetricAction

Capture a CloudWatch metric.

Returns:

#dynamo_d_bv_2Types::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:

#dynamo_dbTypes::DynamoDBAction

Write to a DynamoDB table.

Returns:

#elasticsearchTypes::ElasticsearchAction

Write data to an Amazon Elasticsearch Service domain.

Returns:

#firehoseTypes::FirehoseAction

Write to an Amazon Kinesis Firehose stream.

Returns:

#kinesisTypes::KinesisAction

Write data to an Amazon Kinesis stream.

Returns:

#lambdaTypes::LambdaAction

Invoke a Lambda function.

Returns:

#republishTypes::RepublishAction

Publish to another MQTT topic.

Returns:

#s3Types::S3Action

Write to an Amazon S3 bucket.

Returns:

#salesforceTypes::SalesforceAction

Send a message to a Salesforce IoT Cloud Input Stream.

Returns:

#snsTypes::SnsAction

Publish to an Amazon SNS topic.

Returns:

#sqsTypes::SqsAction

Publish to an Amazon SQS queue.

Returns: