libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.Types.IotEventsAction

Description

 
Synopsis

Documentation

data IotEventsAction Source #

Sends an input to an IoT Events detector.

See: newIotEventsAction smart constructor.

Constructors

IotEventsAction' 

Fields

  • batchMode :: Maybe Bool

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

    When batchMode is true, you can't specify a messageId.

    When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

  • messageId :: Maybe Text

    The ID of the message. The default messageId is a new UUID value.

    When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

    Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

  • inputName :: Text

    The name of the IoT Events input.

  • roleArn :: Text

    The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Instances

Instances details
Eq IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

Read IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

Show IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

Generic IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

Associated Types

type Rep IotEventsAction :: Type -> Type #

NFData IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

Methods

rnf :: IotEventsAction -> () #

Hashable IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

ToJSON IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

FromJSON IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

type Rep IotEventsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.IotEventsAction

type Rep IotEventsAction = D1 ('MetaData "IotEventsAction" "Amazonka.IoT.Types.IotEventsAction" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "IotEventsAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newIotEventsAction Source #

Create a value of IotEventsAction 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:IotEventsAction', iotEventsAction_batchMode - Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

$sel:messageId:IotEventsAction', iotEventsAction_messageId - The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

$sel:inputName:IotEventsAction', iotEventsAction_inputName - The name of the IoT Events input.

$sel:roleArn:IotEventsAction', iotEventsAction_roleArn - The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

iotEventsAction_batchMode :: Lens' IotEventsAction (Maybe Bool) Source #

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

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

iotEventsAction_messageId :: Lens' IotEventsAction (Maybe Text) Source #

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

iotEventsAction_inputName :: Lens' IotEventsAction Text Source #

The name of the IoT Events input.

iotEventsAction_roleArn :: Lens' IotEventsAction Text Source #

The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").