- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
EnableTopicRuleCommand
Enables the rule.
Requires permission to access the EnableTopicRule action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, EnableTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, EnableTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // EnableTopicRuleRequest
ruleName: "STRING_VALUE", // required
};
const command = new EnableTopicRuleCommand(input);
const response = await client.send(command);
// {};
EnableTopicRuleCommand Input
See EnableTopicRuleCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ruleNameRequired | string | undefined | The name of the topic rule to enable. |
EnableTopicRuleCommand Output
See EnableTopicRuleCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConflictingResourceUpdateException | client | A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict. |
| InternalException | server | An unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ServiceUnavailableException | server | The service is temporarily unavailable. |
| UnauthorizedException | client | You are not authorized to perform this operation. |
| IoTServiceException | Base exception class for all service exceptions from IoT service. |