@aws-sdk/client-opensearch 3.932.0 → 3.933.0

package/dist-types/commands/GetIndexCommand.d.ts

@@ -0,0 +1,96 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetIndexRequest, GetIndexResponse } from "../models/models_0";
+import { 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/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetIndexCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>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.</p>
+ * @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)
+ *  <p>An error occurred because you don't have permissions to access the resource.</p>
+ *
+ * @throws {@link DependencyFailureException} (client fault)
+ *  <p>An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.</p>
+ *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
+ *
+ * @throws {@link InternalException} (server fault)
+ *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link OpenSearchServiceException}
+ * <p>Base exception class for all service exceptions from OpenSearch service.</p>
+ *
+ *
+ * @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;
+        };
+    };
+}

package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts

@@ -27,10 +27,10 @@ declare const GetPackageVersionHistoryCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of Amazon OpenSearch Service package versions, along with their
- *             creation time, commit message, and plugin properties (if the package is a zip plugin
- *             package). For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
- *                 for Amazon OpenSearch Service</a>.</p>
+ * <p>Returns a list of Amazon OpenSearch Service package versions, along with their creation
+ *    time, commit message, and plugin properties (if the package is a zip plugin package). For more
+ *    information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon
+ *     OpenSearch Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetUpgradeHistoryCommand.d.ts

@@ -27,8 +27,8 @@ declare const GetUpgradeHistoryCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Retrieves the complete history of the last 10 upgrades performed on an Amazon
- *             OpenSearch Service domain.</p>
+ * <p>Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch
+ *    Service domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetUpgradeStatusCommand.d.ts

@@ -27,8 +27,8 @@ declare const GetUpgradeStatusCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns the most recent status of the last upgrade or upgrade eligibility check
- *             performed on an Amazon OpenSearch Service domain.</p>
+ * <p>Returns the most recent status of the last upgrade or upgrade eligibility check performed on
+ *    an Amazon OpenSearch Service domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListDataSourcesCommand.d.ts

@@ -1,6 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_0";
+import { ListDataSourcesRequest } from "../models/models_0";
+import { ListDataSourcesResponse } from "../models/models_1";
 import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
 /**
  * @public

package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListDirectQueryDataSourcesRequest, ListDirectQueryDataSourcesResponse } from "../models/models_0";
+import { ListDirectQueryDataSourcesRequest, ListDirectQueryDataSourcesResponse } from "../models/models_1";
 import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
 /**
  * @public

package/dist-types/commands/ListDomainMaintenancesCommand.d.ts

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListDomainMaintenancesRequest, ListDomainMaintenancesResponse } from "../models/models_0";
+import { ListDomainMaintenancesRequest, ListDomainMaintenancesResponse } from "../models/models_1";
 import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
 /**
  * @public

package/dist-types/commands/UpdateIndexCommand.d.ts

@@ -0,0 +1,97 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateIndexRequest, UpdateIndexResponse } from "../models/models_1";
+import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateIndexCommand}.
+ */
+export interface UpdateIndexCommandInput extends UpdateIndexRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateIndexCommand}.
+ */
+export interface UpdateIndexCommandOutput extends UpdateIndexResponse, __MetadataBearer {
+}
+declare const UpdateIndexCommand_base: {
+    new (input: UpdateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIndexCommandInput, UpdateIndexCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIndexCommandInput, UpdateIndexCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OpenSearchClient, UpdateIndexCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
+ * // const { OpenSearchClient, UpdateIndexCommand } = 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 = { // UpdateIndexRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   IndexName: "STRING_VALUE", // required
+ *   IndexSchema: "DOCUMENT_VALUE", // required
+ * };
+ * const command = new UpdateIndexCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateIndexResponse
+ * //   Status: "CREATED" || "UPDATED" || "DELETED", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateIndexCommandInput - {@link UpdateIndexCommandInput}
+ * @returns {@link UpdateIndexCommandOutput}
+ * @see {@link UpdateIndexCommandInput} for command's `input` shape.
+ * @see {@link UpdateIndexCommandOutput} for command's `response` shape.
+ * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An error occurred because you don't have permissions to access the resource.</p>
+ *
+ * @throws {@link DependencyFailureException} (client fault)
+ *  <p>An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.</p>
+ *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
+ *
+ * @throws {@link InternalException} (server fault)
+ *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link OpenSearchServiceException}
+ * <p>Base exception class for all service exceptions from OpenSearch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateIndexCommand extends UpdateIndexCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateIndexRequest;
+            output: UpdateIndexResponse;
+        };
+        sdk: {
+            input: UpdateIndexCommandInput;
+            output: UpdateIndexCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -9,6 +9,7 @@ export * from "./CancelDomainConfigChangeCommand";
 export * from "./CancelServiceSoftwareUpdateCommand";
 export * from "./CreateApplicationCommand";
 export * from "./CreateDomainCommand";
+export * from "./CreateIndexCommand";
 export * from "./CreateOutboundConnectionCommand";
 export * from "./CreatePackageCommand";
 export * from "./CreateVpcEndpointCommand";
@@ -17,6 +18,7 @@ export * from "./DeleteDataSourceCommand";
 export * from "./DeleteDirectQueryDataSourceCommand";
 export * from "./DeleteDomainCommand";
 export * from "./DeleteInboundConnectionCommand";
+export * from "./DeleteIndexCommand";
 export * from "./DeleteOutboundConnectionCommand";
 export * from "./DeletePackageCommand";
 export * from "./DeleteVpcEndpointCommand";
@@ -43,6 +45,7 @@ export * from "./GetDataSourceCommand";
 export * from "./GetDefaultApplicationSettingCommand";
 export * from "./GetDirectQueryDataSourceCommand";
 export * from "./GetDomainMaintenanceStatusCommand";
+export * from "./GetIndexCommand";
 export * from "./GetPackageVersionHistoryCommand";
 export * from "./GetUpgradeHistoryCommand";
 export * from "./GetUpgradeStatusCommand";
@@ -71,6 +74,7 @@ export * from "./UpdateApplicationCommand";
 export * from "./UpdateDataSourceCommand";
 export * from "./UpdateDirectQueryDataSourceCommand";
 export * from "./UpdateDomainConfigCommand";
+export * from "./UpdateIndexCommand";
 export * from "./UpdatePackageCommand";
 export * from "./UpdatePackageScopeCommand";
 export * from "./UpdateScheduledActionCommand";