UNPKG

@aws-sdk/client-iot

Version:

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

80 lines (79 loc) 3.69 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { DeleteThingTypeRequest, DeleteThingTypeResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteThingTypeCommand}. */ export interface DeleteThingTypeCommandInput extends DeleteThingTypeRequest { } /** * @public * * The output of {@link DeleteThingTypeCommand}. */ export interface DeleteThingTypeCommandOutput extends DeleteThingTypeResponse, __MetadataBearer { } declare const DeleteThingTypeCommand_base: { new (input: DeleteThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingTypeCommandInput, DeleteThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: DeleteThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingTypeCommandInput, DeleteThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Deletes the specified thing type. You cannot delete a thing type if it has things * associated with it. To delete a thing type, first mark it as deprecated by calling <a>DeprecateThingType</a>, then remove any associated things by calling <a>UpdateThing</a> to change the thing type on any associated thing, and * finally use <a>DeleteThingType</a> to delete the thing type.</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">DeleteThingType</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, DeleteThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, DeleteThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // DeleteThingTypeRequest * thingTypeName: "STRING_VALUE", // required * }; * const command = new DeleteThingTypeCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteThingTypeCommandInput - {@link DeleteThingTypeCommandInput} * @returns {@link DeleteThingTypeCommandOutput} * @see {@link DeleteThingTypeCommandInput} for command's `input` shape. * @see {@link DeleteThingTypeCommandOutput} 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 IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * @public */ export declare class DeleteThingTypeCommand extends DeleteThingTypeCommand_base { }