UNPKG

@aws-sdk/client-iot

Version:

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

93 lines (92 loc) 3.6 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { ListIndicesRequest, ListIndicesResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListIndicesCommand}. */ export interface ListIndicesCommandInput extends ListIndicesRequest { } /** * @public * * The output of {@link ListIndicesCommand}. */ export interface ListIndicesCommandOutput extends ListIndicesResponse, __MetadataBearer { } declare const ListIndicesCommand_base: { new (input: ListIndicesCommandInput): import("@smithy/smithy-client").CommandImpl<ListIndicesCommandInput, ListIndicesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (...[input]: [] | [ListIndicesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListIndicesCommandInput, ListIndicesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Lists the search indices.</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">ListIndices</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, ListIndicesCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, ListIndicesCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // ListIndicesRequest * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; * const command = new ListIndicesCommand(input); * const response = await client.send(command); * // { // ListIndicesResponse * // indexNames: [ // IndexNamesList * // "STRING_VALUE", * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param ListIndicesCommandInput - {@link ListIndicesCommandInput} * @returns {@link ListIndicesCommandOutput} * @see {@link ListIndicesCommandInput} for command's `input` shape. * @see {@link ListIndicesCommandOutput} 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 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 ListIndicesCommand extends ListIndicesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListIndicesRequest; output: ListIndicesResponse; }; sdk: { input: ListIndicesCommandInput; output: ListIndicesCommandOutput; }; }; }