Amazonka.IoT.Types.IotAnalyticsAction

Documentation

data IotAnalyticsAction

Sends message data to an IoT Analytics channel.

See: newIotAnalyticsAction smart constructor.

Constructors

IotAnalyticsAction'

Fields

• batchMode :: Maybe Bool

  Whether to process the action as a batch. The default value is false.

  When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

• channelArn :: Maybe Text

  (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

• channelName :: Maybe Text

  The name of the IoT Analytics channel to which message data will be sent.

• roleArn :: Maybe Text

  The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Instances

FromJSON IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

parseJSON :: Value -> Parser IotAnalyticsAction

parseJSONList :: Value -> Parser [IotAnalyticsAction]

ToJSON IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

toJSON :: IotAnalyticsAction -> Value

toEncoding :: IotAnalyticsAction -> Encoding

toJSONList :: [IotAnalyticsAction] -> Value

toEncodingList :: [IotAnalyticsAction] -> Encoding

Generic IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Associated Types

type Rep IotAnalyticsAction :: Type -> Type

Methods

from :: IotAnalyticsAction -> Rep IotAnalyticsAction x

to :: Rep IotAnalyticsAction x -> IotAnalyticsAction

Read IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

readsPrec :: Int -> ReadS IotAnalyticsAction

readList :: ReadS [IotAnalyticsAction]

readPrec :: ReadPrec IotAnalyticsAction

readListPrec :: ReadPrec [IotAnalyticsAction]

Show IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

showsPrec :: Int -> IotAnalyticsAction -> ShowS

show :: IotAnalyticsAction -> String

showList :: [IotAnalyticsAction] -> ShowS

NFData IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

rnf :: IotAnalyticsAction -> ()

Eq IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

(==) :: IotAnalyticsAction -> IotAnalyticsAction -> Bool

(/=) :: IotAnalyticsAction -> IotAnalyticsAction -> Bool

Hashable IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

hashWithSalt :: Int -> IotAnalyticsAction -> Int

hash :: IotAnalyticsAction -> Int

type Rep IotAnalyticsAction

Defined in Amazonka.IoT.Types.IotAnalyticsAction

type Rep IotAnalyticsAction = D1 ('MetaData "IotAnalyticsAction" "Amazonka.IoT.Types.IotAnalyticsAction" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "IotAnalyticsAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newIotAnalyticsAction :: IotAnalyticsAction

Create a value of IotAnalyticsAction 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:batchMode:IotAnalyticsAction', iotAnalyticsAction_batchMode - Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

$sel:channelArn:IotAnalyticsAction', iotAnalyticsAction_channelArn - (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

$sel:channelName:IotAnalyticsAction', iotAnalyticsAction_channelName - The name of the IoT Analytics channel to which message data will be sent.

$sel:roleArn:IotAnalyticsAction', iotAnalyticsAction_roleArn - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

iotAnalyticsAction_batchMode :: Lens' IotAnalyticsAction (Maybe Bool)

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

iotAnalyticsAction_channelArn :: Lens' IotAnalyticsAction (Maybe Text)

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

iotAnalyticsAction_channelName :: Lens' IotAnalyticsAction (Maybe Text)

The name of the IoT Analytics channel to which message data will be sent.

iotAnalyticsAction_roleArn :: Lens' IotAnalyticsAction (Maybe Text)

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).