/rules/{ruleName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

PATCH

/rules/{ruleName}

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Requires permission to access the ReplaceTopicRule action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/rules/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "topicRulePayload": {
        "sql": "string",
        "description": "string",
        "actions": [],
        "ruleDisabled": true,
        "awsIotSqlVersion": "string",
        "errorAction": {}
    }
}'

Response Example

200 - Example 1

{}

Request

Path Params

ruleName

string

required

The name of the rule.

Body Params application/json

topicRulePayload

object

required

Describes a rule.

sql

string

optional

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

description

string

optional

The description of the rule.

<= 2048 characters

actions

array[object (Action) {22}]

optional

The actions associated with the rule.

>= 0 items<= 10 items

ruleDisabled

boolean

optional

Specifies whether the rule is disabled.

awsIotSqlVersion

string

optional

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

errorAction

object

optional

The action to take when an error occurs.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480SqlParseException

🟠481InternalException

🟠482InvalidRequestException

🟠483ServiceUnavailableException

🟠484UnauthorizedException

🟠485ConflictingResourceUpdateException

Modified at 2022-09-10 23:12:15

/rules/{ruleName}

/destinations