@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
109 lines (108 loc) • 4.63 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { CreateProvisioningTemplateRequest, CreateProvisioningTemplateResponse } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link CreateProvisioningTemplateCommand}.
*/
export interface CreateProvisioningTemplateCommandInput extends CreateProvisioningTemplateRequest {
}
/**
* @public
*
* The output of {@link CreateProvisioningTemplateCommand}.
*/
export interface CreateProvisioningTemplateCommandOutput extends CreateProvisioningTemplateResponse, __MetadataBearer {
}
declare const CreateProvisioningTemplateCommand_base: {
new (input: CreateProvisioningTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateProvisioningTemplateCommandInput, CreateProvisioningTemplateCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: CreateProvisioningTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateProvisioningTemplateCommandInput, CreateProvisioningTemplateCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Creates a provisioning template.</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">CreateProvisioningTemplate</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, CreateProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, CreateProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // CreateProvisioningTemplateRequest
* templateName: "STRING_VALUE", // required
* description: "STRING_VALUE",
* templateBody: "STRING_VALUE", // required
* enabled: true || false,
* provisioningRoleArn: "STRING_VALUE", // required
* preProvisioningHook: { // ProvisioningHook
* payloadVersion: "STRING_VALUE",
* targetArn: "STRING_VALUE", // required
* },
* tags: [ // TagList
* { // Tag
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE",
* },
* ],
* type: "FLEET_PROVISIONING" || "JITP",
* };
* const command = new CreateProvisioningTemplateCommand(input);
* const response = await client.send(command);
* // { // CreateProvisioningTemplateResponse
* // templateArn: "STRING_VALUE",
* // templateName: "STRING_VALUE",
* // defaultVersionId: Number("int"),
* // };
*
* ```
*
* @param CreateProvisioningTemplateCommandInput - {@link CreateProvisioningTemplateCommandInput}
* @returns {@link CreateProvisioningTemplateCommandOutput}
* @see {@link CreateProvisioningTemplateCommandInput} for command's `input` shape.
* @see {@link CreateProvisioningTemplateCommandOutput} 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 LimitExceededException} (client fault)
* <p>A limit has been exceeded.</p>
*
* @throws {@link ResourceAlreadyExistsException} (client fault)
* <p>The resource already exists.</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 CreateProvisioningTemplateCommand extends CreateProvisioningTemplateCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: CreateProvisioningTemplateRequest;
output: CreateProvisioningTemplateResponse;
};
sdk: {
input: CreateProvisioningTemplateCommandInput;
output: CreateProvisioningTemplateCommandOutput;
};
};
}