UNPKG

@aws-sdk/client-iot

Version:

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

97 lines (96 loc) 3.94 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { DeleteThingRequest, DeleteThingResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteThingCommand}. */ export interface DeleteThingCommandInput extends DeleteThingRequest { } /** * @public * * The output of {@link DeleteThingCommand}. */ export interface DeleteThingCommandOutput extends DeleteThingResponse, __MetadataBearer { } declare const DeleteThingCommand_base: { new (input: DeleteThingCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingCommandInput, DeleteThingCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: DeleteThingCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingCommandInput, DeleteThingCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Deletes the specified thing. Returns successfully with no error if the deletion is * successful or you specify a thing that doesn't exist.</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">DeleteThing</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, DeleteThingCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, DeleteThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // DeleteThingRequest * thingName: "STRING_VALUE", // required * expectedVersion: Number("long"), * }; * const command = new DeleteThingCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteThingCommandInput - {@link DeleteThingCommandInput} * @returns {@link DeleteThingCommandOutput} * @see {@link DeleteThingCommandInput} for command's `input` shape. * @see {@link DeleteThingCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link InternalFailureException} (server fault) * <p>An unexpected error has occurred.</p> * * @throws {@link InvalidRequestException} (client fault) * <p>The request is not valid.</p> * * @throws {@link ResourceNotFoundException} (client fault) * <p>The specified resource does not exist.</p> * * @throws {@link ServiceUnavailableException} (server fault) * <p>The service is temporarily unavailable.</p> * * @throws {@link ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link UnauthorizedException} (client fault) * <p>You are not authorized to perform this operation.</p> * * @throws {@link VersionConflictException} (client fault) * <p>An exception thrown when the version of an entity specified with the * <code>expectedVersion</code> parameter does not match the latest version in the * system.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * * @public */ export declare class DeleteThingCommand extends DeleteThingCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteThingRequest; output: {}; }; sdk: { input: DeleteThingCommandInput; output: DeleteThingCommandOutput; }; }; }