TopicRulePayload - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Describes a rule.



The actions associated with the rule.

Type: Array of Action objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: Yes


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

Type: String

Required: Yes


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

Type: String

Required: No


The description of the rule.

Type: String

Required: No


The action to take when an error occurs.

Type: Action object

Required: No


Specifies whether the rule is disabled.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: