UNPKG

@aws-sdk/client-iot

Version:

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

94 lines (93 loc) 3.8 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { CreateThingTypeRequest, CreateThingTypeResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateThingTypeCommand}. */ export interface CreateThingTypeCommandInput extends CreateThingTypeRequest { } /** * @public * * The output of {@link CreateThingTypeCommand}. */ export interface CreateThingTypeCommandOutput extends CreateThingTypeResponse, __MetadataBearer { } declare const CreateThingTypeCommand_base: { new (input: CreateThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<CreateThingTypeCommandInput, CreateThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: CreateThingTypeCommandInput): import("@smithy/smithy-client").CommandImpl<CreateThingTypeCommandInput, CreateThingTypeCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Creates a new 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">CreateThingType</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, CreateThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, CreateThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // CreateThingTypeRequest * thingTypeName: "STRING_VALUE", // required * thingTypeProperties: { // ThingTypeProperties * thingTypeDescription: "STRING_VALUE", * searchableAttributes: [ // SearchableAttributes * "STRING_VALUE", * ], * }, * tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", * }, * ], * }; * const command = new CreateThingTypeCommand(input); * const response = await client.send(command); * // { // CreateThingTypeResponse * // thingTypeName: "STRING_VALUE", * // thingTypeArn: "STRING_VALUE", * // thingTypeId: "STRING_VALUE", * // }; * * ``` * * @param CreateThingTypeCommandInput - {@link CreateThingTypeCommandInput} * @returns {@link CreateThingTypeCommandOutput} * @see {@link CreateThingTypeCommandInput} for command's `input` shape. * @see {@link CreateThingTypeCommandOutput} 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 ResourceAlreadyExistsException} (client fault) * <p>The resource already exists.</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 CreateThingTypeCommand extends CreateThingTypeCommand_base { }