Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

TopicRule

Focus mode
TopicRule - AWS IoT

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 AWS SDKs, see the following:

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.