Amazonka.IoT.Types.TopicRulePayload

Documentation

data TopicRulePayload

Describes a rule.

See: newTopicRulePayload smart constructor.

Constructors

TopicRulePayload'

Fields

• awsIotSqlVersion :: Maybe Text

  The version of the SQL rules engine to use when evaluating the rule.

• description :: Maybe Text

  The description of the rule.

• errorAction :: Maybe Action

  The action to take when an error occurs.

• ruleDisabled :: Maybe Bool

  Specifies whether the rule is disabled.

• sql :: Text

  The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

• actions :: [Action]

  The actions associated with the rule.

Instances

ToJSON TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

toJSON :: TopicRulePayload -> Value

toEncoding :: TopicRulePayload -> Encoding

toJSONList :: [TopicRulePayload] -> Value

toEncodingList :: [TopicRulePayload] -> Encoding

Generic TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Associated Types

type Rep TopicRulePayload :: Type -> Type

Methods

from :: TopicRulePayload -> Rep TopicRulePayload x

to :: Rep TopicRulePayload x -> TopicRulePayload

Read TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

readsPrec :: Int -> ReadS TopicRulePayload

readList :: ReadS [TopicRulePayload]

readPrec :: ReadPrec TopicRulePayload

readListPrec :: ReadPrec [TopicRulePayload]

Show TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

showsPrec :: Int -> TopicRulePayload -> ShowS

show :: TopicRulePayload -> String

showList :: [TopicRulePayload] -> ShowS

NFData TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

rnf :: TopicRulePayload -> ()

Eq TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

(==) :: TopicRulePayload -> TopicRulePayload -> Bool

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

Hashable TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

Methods

hashWithSalt :: Int -> TopicRulePayload -> Int

hash :: TopicRulePayload -> Int

type Rep TopicRulePayload

Defined in Amazonka.IoT.Types.TopicRulePayload

type Rep TopicRulePayload = D1 ('MetaData "TopicRulePayload" "Amazonka.IoT.Types.TopicRulePayload" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TopicRulePayload'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsIotSqlVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)))) :*: (S1 ('MetaSel ('Just "ruleDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sql") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Action])))))

newTopicRulePayload

Arguments

:: Text

$sel:sql:TopicRulePayload'

-> TopicRulePayload

Create a value of TopicRulePayload 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:awsIotSqlVersion:TopicRulePayload', topicRulePayload_awsIotSqlVersion - The version of the SQL rules engine to use when evaluating the rule.

$sel:description:TopicRulePayload', topicRulePayload_description - The description of the rule.

$sel:errorAction:TopicRulePayload', topicRulePayload_errorAction - The action to take when an error occurs.

$sel:ruleDisabled:TopicRulePayload', topicRulePayload_ruleDisabled - Specifies whether the rule is disabled.

$sel:sql:TopicRulePayload', topicRulePayload_sql - The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

$sel:actions:TopicRulePayload', topicRulePayload_actions - The actions associated with the rule.

topicRulePayload_awsIotSqlVersion :: Lens' TopicRulePayload (Maybe Text)

The version of the SQL rules engine to use when evaluating the rule.

topicRulePayload_description :: Lens' TopicRulePayload (Maybe Text)

The description of the rule.

topicRulePayload_errorAction :: Lens' TopicRulePayload (Maybe Action)

The action to take when an error occurs.

topicRulePayload_ruleDisabled :: Lens' TopicRulePayload (Maybe Bool)

Specifies whether the rule is disabled.

topicRulePayload_sql :: Lens' TopicRulePayload Text

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

topicRulePayload_actions :: Lens' TopicRulePayload [Action]

The actions associated with the rule.