amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Types.IotAnalyticsAction

Description

 
Synopsis

Documentation

data IotAnalyticsAction Source #

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

Instances details
FromJSON IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

ToJSON IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Generic IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Associated Types

type Rep IotAnalyticsAction :: Type -> Type #

Read IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Show IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

NFData IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Methods

rnf :: IotAnalyticsAction -> () #

Eq IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

Hashable IotAnalyticsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotAnalyticsAction

type Rep IotAnalyticsAction Source # 
Instance details

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 Source #

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) Source #

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) Source #

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

iotAnalyticsAction_channelName :: Lens' IotAnalyticsAction (Maybe Text) Source #

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

iotAnalyticsAction_roleArn :: Lens' IotAnalyticsAction (Maybe Text) Source #

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