UNPKG

@aws-sdk/client-iot

Version:

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

92 lines (91 loc) 4.11 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { RemoveThingFromThingGroupRequest, RemoveThingFromThingGroupResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link RemoveThingFromThingGroupCommand}. */ export interface RemoveThingFromThingGroupCommandInput extends RemoveThingFromThingGroupRequest { } /** * @public * * The output of {@link RemoveThingFromThingGroupCommand}. */ export interface RemoveThingFromThingGroupCommandOutput extends RemoveThingFromThingGroupResponse, __MetadataBearer { } declare const RemoveThingFromThingGroupCommand_base: { new (input: RemoveThingFromThingGroupCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveThingFromThingGroupCommandInput, RemoveThingFromThingGroupCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (...[input]: [] | [RemoveThingFromThingGroupCommandInput]): import("@smithy/smithy-client").CommandImpl<RemoveThingFromThingGroupCommandInput, RemoveThingFromThingGroupCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Remove the specified thing from the specified group.</p> * <p>You must specify either a <code>thingGroupArn</code> or a * <code>thingGroupName</code> to identify the thing group and * either a <code>thingArn</code> or a <code>thingName</code> to * identify the thing to remove from the 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">RemoveThingFromThingGroup</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, RemoveThingFromThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, RemoveThingFromThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // RemoveThingFromThingGroupRequest * thingGroupName: "STRING_VALUE", * thingGroupArn: "STRING_VALUE", * thingName: "STRING_VALUE", * thingArn: "STRING_VALUE", * }; * const command = new RemoveThingFromThingGroupCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param RemoveThingFromThingGroupCommandInput - {@link RemoveThingFromThingGroupCommandInput} * @returns {@link RemoveThingFromThingGroupCommandOutput} * @see {@link RemoveThingFromThingGroupCommandInput} for command's `input` shape. * @see {@link RemoveThingFromThingGroupCommandOutput} 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 ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * * @public */ export declare class RemoveThingFromThingGroupCommand extends RemoveThingFromThingGroupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: RemoveThingFromThingGroupRequest; output: {}; }; sdk: { input: RemoveThingFromThingGroupCommandInput; output: RemoveThingFromThingGroupCommandOutput; }; }; }