/rules/{ruleName}

The AWS IoT Wireless multi-region endpoint

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

GET

/rules/{ruleName}

Gets information about the rule.

Requires permission to access the GetTopicRule action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/rules/'

Response Example

200 - Example 1

{
    "ruleArn": "string",
    "rule": {
        "ruleName": "string",
        "sql": "string",
        "description": "string",
        "createdAt": "string",
        "actions": [],
        "ruleDisabled": true,
        "awsIotSqlVersion": "string",
        "errorAction": {}
    }
}

Request

Path Params

ruleName

string

required

The name of the rule.

Responses

🟢200Success

application/json

Body

The output from the GetTopicRule operation.

ruleArn

string

optional

The rule ARN.

rule

object

optional

The rule.

ruleName

string

optional

The name of the rule.

>= 1 characters<= 128 characters

Match pattern:

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

sql

string

optional

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

description

string

optional

The description of the rule.

<= 2048 characters

createdAt

string <date-time>

optional

The date and time the rule was created.

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 perform when an error occurs.

🟠480InternalException

🟠481InvalidRequestException

🟠482ServiceUnavailableException

🟠483UnauthorizedException

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

/rules/{ruleName}