@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
90 lines (89 loc) • 4.16 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { UpdateTopicRuleDestinationRequest, UpdateTopicRuleDestinationResponse } from "../models/models_2";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link UpdateTopicRuleDestinationCommand}.
*/
export interface UpdateTopicRuleDestinationCommandInput extends UpdateTopicRuleDestinationRequest {
}
/**
* @public
*
* The output of {@link UpdateTopicRuleDestinationCommand}.
*/
export interface UpdateTopicRuleDestinationCommandOutput extends UpdateTopicRuleDestinationResponse, __MetadataBearer {
}
declare const UpdateTopicRuleDestinationCommand_base: {
new (input: UpdateTopicRuleDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTopicRuleDestinationCommandInput, UpdateTopicRuleDestinationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: UpdateTopicRuleDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTopicRuleDestinationCommandInput, UpdateTopicRuleDestinationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Updates a topic rule destination. You use this to change the status, endpoint URL, or
* confirmation URL of the destination.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateTopicRuleDestination</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, UpdateTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, UpdateTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // UpdateTopicRuleDestinationRequest
* arn: "STRING_VALUE", // required
* status: "ENABLED" || "IN_PROGRESS" || "DISABLED" || "ERROR" || "DELETING", // required
* };
* const command = new UpdateTopicRuleDestinationCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param UpdateTopicRuleDestinationCommandInput - {@link UpdateTopicRuleDestinationCommandInput}
* @returns {@link UpdateTopicRuleDestinationCommandOutput}
* @see {@link UpdateTopicRuleDestinationCommandInput} for command's `input` shape.
* @see {@link UpdateTopicRuleDestinationCommandOutput} for command's `response` shape.
* @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
*
* @throws {@link ConflictingResourceUpdateException} (client fault)
* <p>A conflicting resource update exception. This exception is thrown when two pending
* updates cause a conflict.</p>
*
* @throws {@link InternalException} (server fault)
* <p>An unexpected error has occurred.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is temporarily unavailable.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>You are not authorized to perform this operation.</p>
*
* @throws {@link IoTServiceException}
* <p>Base exception class for all service exceptions from IoT service.</p>
*
*
* @public
*/
export declare class UpdateTopicRuleDestinationCommand extends UpdateTopicRuleDestinationCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: UpdateTopicRuleDestinationRequest;
output: {};
};
sdk: {
input: UpdateTopicRuleDestinationCommandInput;
output: UpdateTopicRuleDestinationCommandOutput;
};
};
}