import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetIndexRequest, GetIndexResponse } from "../models/models_0"; import type { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetIndexCommand}. */ export interface GetIndexCommandInput extends GetIndexRequest { } /** * @public * * The output of {@link GetIndexCommand}. */ export interface GetIndexCommandOutput extends GetIndexResponse, __MetadataBearer { } declare const GetIndexCommand_base: { new (input: GetIndexCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetIndexCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { OpenSearchClient, GetIndexCommand } from "@aws-sdk/client-opensearch"; // ES Modules import * // const { OpenSearchClient, GetIndexCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import * // import type { OpenSearchClientConfig } from "@aws-sdk/client-opensearch"; * const config = {}; // type is OpenSearchClientConfig * const client = new OpenSearchClient(config); * const input = { // GetIndexRequest * DomainName: "STRING_VALUE", // required * IndexName: "STRING_VALUE", // required * }; * const command = new GetIndexCommand(input); * const response = await client.send(command); * // { // GetIndexResponse * // IndexSchema: "DOCUMENT_VALUE", // required * // }; * * ``` * * @param GetIndexCommandInput - {@link GetIndexCommandInput} * @returns {@link GetIndexCommandOutput} * @see {@link GetIndexCommandInput} for command's `input` shape. * @see {@link GetIndexCommandOutput} for command's `response` shape. * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

An error occurred because you don't have permissions to access the resource.

* * @throws {@link DependencyFailureException} (client fault) *

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

* * @throws {@link DisabledOperationException} (client fault) *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling. Reduce the frequency of your requests and try again.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

* * * @public */ export declare class GetIndexCommand extends GetIndexCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetIndexRequest; output: GetIndexResponse; }; sdk: { input: GetIndexCommandInput; output: GetIndexCommandOutput; }; }; }