AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::IoT::Types::TimestreamAction

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

Overview

Note:

When passing TimestreamAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  role_arn: "AwsArn", # required
  database_name: "TimestreamDatabaseName", # required
  table_name: "TimestreamTableName", # required
  dimensions: [ # required
    {
      name: "TimestreamDimensionName", # required
      value: "TimestreamDimensionValue", # required
    },
  ],
  timestamp: {
    value: "TimestreamTimestampValue", # required
    unit: "TimestreamTimestampUnit", # required
  },
}

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#database_nameString

The name of an Amazon Timestream database.

Returns:

  • (String)

    The name of an Amazon Timestream database.

#dimensionsArray<Types::TimestreamDimension>

Metadata attributes of the time series that are written in each measure record.

Returns:

#role_arnString

The ARN of the role that grants permission to write to the Amazon Timestream database table.

Returns:

  • (String)

    The ARN of the role that grants permission to write to the Amazon Timestream database table.

#table_nameString

The name of the database table into which to write the measure records.

Returns:

  • (String)

    The name of the database table into which to write the measure records.

#timestampTypes::TimestreamTimestamp

Specifies an application-defined value to replace the default value assigned to the Timestream record\'s timestamp in the time column.

You can use this property to specify the value and the precision of the Timestream record\'s timestamp. You can specify a value from the message payload or a value computed by a substitution template.

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

Returns:

  • (Types::TimestreamTimestamp)

    Specifies an application-defined value to replace the default value assigned to the Timestream record\'s timestamp in the time column.