@aws-sdk/client-opensearch 3.1020.0 → 3.1021.0

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

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { RegisterCapabilityRequest, RegisterCapabilityResponse } from "../models/models_0";
+import type { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RegisterCapabilityCommand}.
+ */
+export interface RegisterCapabilityCommandInput extends RegisterCapabilityRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RegisterCapabilityCommand}.
+ */
+export interface RegisterCapabilityCommandOutput extends RegisterCapabilityResponse, __MetadataBearer {
+}
+declare const RegisterCapabilityCommand_base: {
+    new (input: RegisterCapabilityCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterCapabilityCommandInput, RegisterCapabilityCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: RegisterCapabilityCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterCapabilityCommandInput, RegisterCapabilityCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Registers a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The capability configuration defines the type and settings of the capability to register. For more information about the AI features, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application-ai-assistant.html">Agentic AI for OpenSearch UI</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OpenSearchClient, RegisterCapabilityCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
+ * // const { OpenSearchClient, RegisterCapabilityCommand } = 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 = { // RegisterCapabilityRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   capabilityName: "STRING_VALUE", // required
+ *   capabilityConfig: { // CapabilityBaseRequestConfig Union: only one key present
+ *     aiConfig: {},
+ *   },
+ * };
+ * const command = new RegisterCapabilityCommand(input);
+ * const response = await client.send(command);
+ * // { // RegisterCapabilityResponse
+ * //   capabilityName: "STRING_VALUE",
+ * //   applicationId: "STRING_VALUE",
+ * //   status: "creating" || "create_failed" || "active" || "updating" || "update_failed" || "deleting" || "delete_failed",
+ * //   capabilityConfig: { // CapabilityBaseResponseConfig Union: only one key present
+ * //     aiConfig: {},
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param RegisterCapabilityCommandInput - {@link RegisterCapabilityCommandInput}
+ * @returns {@link RegisterCapabilityCommandOutput}
+ * @see {@link RegisterCapabilityCommandInput} for command's `input` shape.
+ * @see {@link RegisterCapabilityCommandOutput} 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 ConflictException} (client fault)
+ *  <p>An error occurred because the client attempts to remove a resource that is currently in use.</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 ServiceQuotaExceededException} (client fault)
+ *  <p>An exception for when a request would cause a service quota to be exceeded.</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 RegisterCapabilityCommand extends RegisterCapabilityCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RegisterCapabilityRequest;
+            output: RegisterCapabilityResponse;
+        };
+        sdk: {
+            input: RegisterCapabilityCommandInput;
+            output: RegisterCapabilityCommandOutput;
+        };
+    };
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -22,6 +22,7 @@ export * from "./DeleteIndexCommand";
 export * from "./DeleteOutboundConnectionCommand";
 export * from "./DeletePackageCommand";
 export * from "./DeleteVpcEndpointCommand";
+export * from "./DeregisterCapabilityCommand";
 export * from "./DescribeDomainAutoTunesCommand";
 export * from "./DescribeDomainChangeProgressCommand";
 export * from "./DescribeDomainCommand";
@@ -41,6 +42,7 @@ export * from "./DescribeVpcEndpointsCommand";
 export * from "./DissociatePackageCommand";
 export * from "./DissociatePackagesCommand";
 export * from "./GetApplicationCommand";
+export * from "./GetCapabilityCommand";
 export * from "./GetCompatibleVersionsCommand";
 export * from "./GetDataSourceCommand";
 export * from "./GetDefaultApplicationSettingCommand";
@@ -67,6 +69,7 @@ export * from "./ListVpcEndpointsCommand";
 export * from "./ListVpcEndpointsForDomainCommand";
 export * from "./PurchaseReservedInstanceOfferingCommand";
 export * from "./PutDefaultApplicationSettingCommand";
+export * from "./RegisterCapabilityCommand";
 export * from "./RejectInboundConnectionCommand";
 export * from "./RemoveTagsCommand";
 export * from "./RevokeVpcEndpointAccessCommand";

package/dist-types/models/enums.d.ts

@@ -612,6 +612,23 @@ export declare const VpcEndpointStatus: {
  * @public
  */
 export type VpcEndpointStatus = (typeof VpcEndpointStatus)[keyof typeof VpcEndpointStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const CapabilityStatus: {
+    readonly ACTIVE: "active";
+    readonly CREATE_FAILED: "create_failed";
+    readonly CREATING: "creating";
+    readonly DELETE_FAILED: "delete_failed";
+    readonly DELETING: "deleting";
+    readonly UPDATE_FAILED: "update_failed";
+    readonly UPDATING: "updating";
+};
+/**
+ * @public
+ */
+export type CapabilityStatus = (typeof CapabilityStatus)[keyof typeof CapabilityStatus];
 /**
  * @public
  * @enum
@@ -833,6 +850,17 @@ export declare const ApplicationStatus: {
  * @public
  */
 export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const CapabilityFailureReason: {
+    readonly KMS_KEY_INSUFFICIENT_PERMISSION: "KMS_KEY_INSUFFICIENT_PERMISSION";
+};
+/**
+ * @public
+ */
+export type CapabilityFailureReason = (typeof CapabilityFailureReason)[keyof typeof CapabilityFailureReason];
 /**
  * @public
  * @enum

package/dist-types/models/errors.d.ts

@@ -156,6 +156,18 @@ export declare class InvalidPaginationTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
 }
+/**
+ * <p>An exception for when a request would cause a service quota to be exceeded.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
 /**
  * <p>An exception for attempting to schedule a domain action during an unavailable time slot.</p>
  * @public