Menu
AWS IoT
Developer Guide

DisableTopicRule

Disables the rule.

Request syntax:

POST /rules/ruleName/disable

URI Request Parameters:

Name

Type

Req?

Description

ruleName

RuleName

yes

The name of the rule to disable.

Errors:

InternalException

An unexpected error has occurred.

HTTP response code: 500

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

CLI

Synopsis:

aws iot disable-topic-rule \ --rule-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "ruleName": "string" }

cli-input-json fields:

Name

Type

Description

ruleName

string

length max:128 min:1

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

The name of the rule to disable.

Output:

None

On this page: