TopicRule - 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.

TopicRule

Describes a rule.

Contents

actions

The actions associated with the rule.

Type: Array of Action objects

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

Required: No

awsIotSqlVersion

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

Type: String

Required: No

createdAt

The date and time the rule was created.

Type: Timestamp

Required: No

description

The description of the rule.

Type: String

Required: No

errorAction

The action to perform when an error occurs.

Type: Action object

Required: No

ruleDisabled

Specifies whether the rule is disabled.

Type: Boolean

Required: No

ruleName

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No

sql

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Type: String

Required: No

See Also

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