UNPKG

@aws-sdk/client-iot

Version:

AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native

96 lines (95 loc) 3.74 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { UpdateCommandRequest, UpdateCommandResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateCommandCommand}. */ export interface UpdateCommandCommandInput extends UpdateCommandRequest { } /** * @public * * The output of {@link UpdateCommandCommand}. */ export interface UpdateCommandCommandOutput extends UpdateCommandResponse, __MetadataBearer { } declare const UpdateCommandCommand_base: { new (input: UpdateCommandCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCommandCommandInput, UpdateCommandCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: UpdateCommandCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCommandCommandInput, UpdateCommandCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Update information about a command or mark a command for deprecation.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, UpdateCommandCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, UpdateCommandCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // UpdateCommandRequest * commandId: "STRING_VALUE", // required * displayName: "STRING_VALUE", * description: "STRING_VALUE", * deprecated: true || false, * }; * const command = new UpdateCommandCommand(input); * const response = await client.send(command); * // { // UpdateCommandResponse * // commandId: "STRING_VALUE", * // displayName: "STRING_VALUE", * // description: "STRING_VALUE", * // deprecated: true || false, * // lastUpdatedAt: new Date("TIMESTAMP"), * // }; * * ``` * * @param UpdateCommandCommandInput - {@link UpdateCommandCommandInput} * @returns {@link UpdateCommandCommandOutput} * @see {@link UpdateCommandCommandInput} for command's `input` shape. * @see {@link UpdateCommandCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link ConflictException} (client fault) * <p>The request conflicts with the current state of the resource.</p> * * @throws {@link InternalServerException} (server fault) * <p>Internal error from the service that indicates an unexpected error or that the service * is unavailable.</p> * * @throws {@link ResourceNotFoundException} (client fault) * <p>The specified resource does not exist.</p> * * @throws {@link ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link ValidationException} (client fault) * <p>The request is not valid.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * * @public */ export declare class UpdateCommandCommand extends UpdateCommandCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateCommandRequest; output: UpdateCommandResponse; }; sdk: { input: UpdateCommandCommandInput; output: UpdateCommandCommandOutput; }; }; }