UNPKG

@aws-sdk/client-iot

Version:

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

87 lines (86 loc) 3.62 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { DeleteThingGroupRequest, DeleteThingGroupResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteThingGroupCommand}. */ export interface DeleteThingGroupCommandInput extends DeleteThingGroupRequest { } /** * @public * * The output of {@link DeleteThingGroupCommand}. */ export interface DeleteThingGroupCommandOutput extends DeleteThingGroupResponse, __MetadataBearer { } declare const DeleteThingGroupCommand_base: { new (input: DeleteThingGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingGroupCommandInput, DeleteThingGroupCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: DeleteThingGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingGroupCommandInput, DeleteThingGroupCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Deletes a thing group.</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">DeleteThingGroup</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, DeleteThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, DeleteThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // DeleteThingGroupRequest * thingGroupName: "STRING_VALUE", // required * expectedVersion: Number("long"), * }; * const command = new DeleteThingGroupCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteThingGroupCommandInput - {@link DeleteThingGroupCommandInput} * @returns {@link DeleteThingGroupCommandOutput} * @see {@link DeleteThingGroupCommandInput} for command's `input` shape. * @see {@link DeleteThingGroupCommandOutput} 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 ThrottlingException} (client fault) * <p>The rate exceeds the limit.</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 DeleteThingGroupCommand extends DeleteThingGroupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteThingGroupRequest; output: {}; }; sdk: { input: DeleteThingGroupCommandInput; output: DeleteThingGroupCommandOutput; }; }; }