UNPKG

@aws-sdk/client-iot

Version:

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

79 lines (78 loc) 3.67 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { ListThingRegistrationTasksRequest, ListThingRegistrationTasksResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListThingRegistrationTasksCommand}. */ export interface ListThingRegistrationTasksCommandInput extends ListThingRegistrationTasksRequest { } /** * @public * * The output of {@link ListThingRegistrationTasksCommand}. */ export interface ListThingRegistrationTasksCommandOutput extends ListThingRegistrationTasksResponse, __MetadataBearer { } declare const ListThingRegistrationTasksCommand_base: { new (input: ListThingRegistrationTasksCommandInput): import("@smithy/smithy-client").CommandImpl<ListThingRegistrationTasksCommandInput, ListThingRegistrationTasksCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (...[input]: [] | [ListThingRegistrationTasksCommandInput]): import("@smithy/smithy-client").CommandImpl<ListThingRegistrationTasksCommandInput, ListThingRegistrationTasksCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>List bulk thing provisioning tasks.</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">ListThingRegistrationTasks</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, ListThingRegistrationTasksCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, ListThingRegistrationTasksCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // ListThingRegistrationTasksRequest * nextToken: "STRING_VALUE", * maxResults: Number("int"), * status: "InProgress" || "Completed" || "Failed" || "Cancelled" || "Cancelling", * }; * const command = new ListThingRegistrationTasksCommand(input); * const response = await client.send(command); * // { // ListThingRegistrationTasksResponse * // taskIds: [ // TaskIdList * // "STRING_VALUE", * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param ListThingRegistrationTasksCommandInput - {@link ListThingRegistrationTasksCommandInput} * @returns {@link ListThingRegistrationTasksCommandOutput} * @see {@link ListThingRegistrationTasksCommandInput} for command's `input` shape. * @see {@link ListThingRegistrationTasksCommandOutput} 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 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 ListThingRegistrationTasksCommand extends ListThingRegistrationTasksCommand_base { }