[ aws . iot ]

disable-topic-rule

Description

Disables the rule.

Requires permission to access the DisableTopicRule action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  disable-topic-rule
--rule-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rule-name (string)

The name of the rule to disable.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To disable a topic rule

The following disable-topic-rule example disables the specified topic rule.

aws iot disable-topic-rule \
    --rule-name "MyPlantPiMoistureAlertRule"

This command produces no output.

For more information, see Viewing Your Rules in the AWS IoT Developer Guide.

Output

None