@aws-sdk/client-iot/dist-types/commands/GetIndexingConfigurationCommand.d.ts

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

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { GetIndexingConfigurationRequest, GetIndexingConfigurationResponse } from "../models/models_1";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link GetIndexingConfigurationCommand}.
 */
export interface GetIndexingConfigurationCommandInput extends GetIndexingConfigurationRequest {
}
/**
 * @public
 *
 * The output of {@link GetIndexingConfigurationCommand}.
 */
export interface GetIndexingConfigurationCommandOutput extends GetIndexingConfigurationResponse, __MetadataBearer {
}
declare const GetIndexingConfigurationCommand_base: {
    new (input: GetIndexingConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexingConfigurationCommandInput, GetIndexingConfigurationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (...[input]: [] | [GetIndexingConfigurationCommandInput]): import("@smithy/smithy-client").CommandImpl<GetIndexingConfigurationCommandInput, GetIndexingConfigurationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Gets the indexing configuration.</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">GetIndexingConfiguration</a> action.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { IoTClient, GetIndexingConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import
 * // const { IoTClient, GetIndexingConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import
 * const client = new IoTClient(config);
 * const input = {};
 * const command = new GetIndexingConfigurationCommand(input);
 * const response = await client.send(command);
 * // { // GetIndexingConfigurationResponse
 * //   thingIndexingConfiguration: { // ThingIndexingConfiguration
 * //     thingIndexingMode: "OFF" || "REGISTRY" || "REGISTRY_AND_SHADOW", // required
 * //     thingConnectivityIndexingMode: "OFF" || "STATUS",
 * //     deviceDefenderIndexingMode: "OFF" || "VIOLATIONS",
 * //     namedShadowIndexingMode: "OFF" || "ON",
 * //     managedFields: [ // Fields
 * //       { // Field
 * //         name: "STRING_VALUE",
 * //         type: "Number" || "String" || "Boolean",
 * //       },
 * //     ],
 * //     customFields: [
 * //       {
 * //         name: "STRING_VALUE",
 * //         type: "Number" || "String" || "Boolean",
 * //       },
 * //     ],
 * //     filter: { // IndexingFilter
 * //       namedShadowNames: [ // NamedShadowNamesFilter
 * //         "STRING_VALUE",
 * //       ],
 * //       geoLocations: [ // GeoLocationsFilter
 * //         { // GeoLocationTarget
 * //           name: "STRING_VALUE",
 * //           order: "LatLon" || "LonLat",
 * //         },
 * //       ],
 * //     },
 * //   },
 * //   thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration
 * //     thingGroupIndexingMode: "OFF" || "ON", // required
 * //     managedFields: [
 * //       {
 * //         name: "STRING_VALUE",
 * //         type: "Number" || "String" || "Boolean",
 * //       },
 * //     ],
 * //     customFields: [
 * //       {
 * //         name: "STRING_VALUE",
 * //         type: "Number" || "String" || "Boolean",
 * //       },
 * //     ],
 * //   },
 * // };
 *
 * ```
 *
 * @param GetIndexingConfigurationCommandInput - {@link GetIndexingConfigurationCommandInput}
 * @returns {@link GetIndexingConfigurationCommandOutput}
 * @see {@link GetIndexingConfigurationCommandInput} for command's `input` shape.
 * @see {@link GetIndexingConfigurationCommandOutput} 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 GetIndexingConfigurationCommand extends GetIndexingConfigurationCommand_base {
}