Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.Types.TimestreamAction

Description

Documentation

data TimestreamAction Source #

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.

See: newTimestreamAction smart constructor.

Constructors

TimestreamAction'

Fields

timestamp :: Maybe 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.
roleArn :: Text
The ARN of the role that grants permission to write to the Amazon Timestream database table.
databaseName :: Text
The name of an Amazon Timestream database.
tableName :: Text
The name of the database table into which to write the measure records.
dimensions :: NonEmpty TimestreamDimension
Metadata attributes of the time series that are written in each measure record.

Instances

Instances details

Eq TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods (==) :: TimestreamAction -> TimestreamAction -> Bool # (/=) :: TimestreamAction -> TimestreamAction -> Bool #
Read TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods readsPrec :: Int -> ReadS TimestreamAction # readList :: ReadS [TimestreamAction] # readPrec :: ReadPrec TimestreamAction # readListPrec :: ReadPrec [TimestreamAction] #
Show TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods showsPrec :: Int -> TimestreamAction -> ShowS # show :: TimestreamAction -> String # showList :: [TimestreamAction] -> ShowS #
Generic TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Associated Types type Rep TimestreamAction :: Type -> Type # Methods from :: TimestreamAction -> Rep TimestreamAction x # to :: Rep TimestreamAction x -> TimestreamAction #
NFData TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods rnf :: TimestreamAction -> () #
Hashable TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods hashWithSalt :: Int -> TimestreamAction -> Int # hash :: TimestreamAction -> Int #
ToJSON TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods toJSON :: TimestreamAction -> Value # toEncoding :: TimestreamAction -> Encoding # toJSONList :: [TimestreamAction] -> Value # toEncodingList :: [TimestreamAction] -> Encoding #
FromJSON TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction Methods parseJSON :: Value -> Parser TimestreamAction # parseJSONList :: Value -> Parser [TimestreamAction] #
type Rep TimestreamAction Source #
Instance details Defined in Amazonka.IoT.Types.TimestreamAction type Rep TimestreamAction = D1 ('MetaData "TimestreamAction" "Amazonka.IoT.Types.TimestreamAction" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "TimestreamAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimestreamTimestamp)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty TimestreamDimension))))))

newTimestreamAction Source #

Arguments

:: Text	`$sel:roleArn:TimestreamAction'`
-> Text	`$sel:databaseName:TimestreamAction'`
-> Text	`$sel:tableName:TimestreamAction'`
-> NonEmpty TimestreamDimension	`$sel:dimensions:TimestreamAction'`
-> TimestreamAction

Create a value of TimestreamAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timestamp:TimestreamAction', timestreamAction_timestamp - 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.

$sel:roleArn:TimestreamAction', timestreamAction_roleArn - The ARN of the role that grants permission to write to the Amazon Timestream database table.

$sel:databaseName:TimestreamAction', timestreamAction_databaseName - The name of an Amazon Timestream database.

$sel:tableName:TimestreamAction', timestreamAction_tableName - The name of the database table into which to write the measure records.

$sel:dimensions:TimestreamAction', timestreamAction_dimensions - Metadata attributes of the time series that are written in each measure record.

timestreamAction_timestamp :: Lens' TimestreamAction (Maybe TimestreamTimestamp) Source #

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.

timestreamAction_roleArn :: Lens' TimestreamAction Text Source #

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

timestreamAction_databaseName :: Lens' TimestreamAction Text Source #

The name of an Amazon Timestream database.

timestreamAction_tableName :: Lens' TimestreamAction Text Source #

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

timestreamAction_dimensions :: Lens' TimestreamAction (NonEmpty TimestreamDimension) Source #

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