@aws-sdk/client-opensearchserverless 3.968.0 → 3.970.0

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

@@ -54,7 +54,7 @@ declare const DeleteSecurityPolicyCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -59,7 +59,7 @@ declare const DeleteVpcEndpointCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -0,0 +1,96 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListCollectionGroupsRequest, ListCollectionGroupsResponse } from "../models/models_0";
+import type { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCollectionGroupsCommand}.
+ */
+export interface ListCollectionGroupsCommandInput extends ListCollectionGroupsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCollectionGroupsCommand}.
+ */
+export interface ListCollectionGroupsCommandOutput extends ListCollectionGroupsResponse, __MetadataBearer {
+}
+declare const ListCollectionGroupsCommand_base: {
+    new (input: ListCollectionGroupsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCollectionGroupsCommandInput, ListCollectionGroupsCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListCollectionGroupsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCollectionGroupsCommandInput, ListCollectionGroupsCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of collection groups. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OpenSearchServerlessClient, ListCollectionGroupsCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
+ * // const { OpenSearchServerlessClient, ListCollectionGroupsCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
+ * // import type { OpenSearchServerlessClientConfig } from "@aws-sdk/client-opensearchserverless";
+ * const config = {}; // type is OpenSearchServerlessClientConfig
+ * const client = new OpenSearchServerlessClient(config);
+ * const input = { // ListCollectionGroupsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListCollectionGroupsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCollectionGroupsResponse
+ * //   collectionGroupSummaries: [ // CollectionGroupSummaries
+ * //     { // CollectionGroupSummary
+ * //       id: "STRING_VALUE",
+ * //       arn: "STRING_VALUE",
+ * //       name: "STRING_VALUE",
+ * //       numberOfCollections: Number("int"),
+ * //       createdDate: Number("long"),
+ * //       capacityLimits: { // CollectionGroupCapacityLimits
+ * //         maxIndexingCapacityInOCU: Number("float"),
+ * //         maxSearchCapacityInOCU: Number("float"),
+ * //         minIndexingCapacityInOCU: Number("float"),
+ * //         minSearchCapacityInOCU: Number("float"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCollectionGroupsCommandInput - {@link ListCollectionGroupsCommandInput}
+ * @returns {@link ListCollectionGroupsCommandOutput}
+ * @see {@link ListCollectionGroupsCommandInput} for command's `input` shape.
+ * @see {@link ListCollectionGroupsCommandOutput} for command's `response` shape.
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Thrown when an error internal to the service occurs while processing a request.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
+ *
+ * @throws {@link OpenSearchServerlessServiceException}
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListCollectionGroupsCommand extends ListCollectionGroupsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListCollectionGroupsRequest;
+            output: ListCollectionGroupsResponse;
+        };
+        sdk: {
+            input: ListCollectionGroupsCommandInput;
+            output: ListCollectionGroupsCommandOutput;
+        };
+    };
+}

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

@@ -40,6 +40,7 @@ declare const ListCollectionsCommand_base: {
  *   collectionFilters: { // CollectionFilters
  *     name: "STRING_VALUE",
  *     status: "STRING_VALUE",
+ *     collectionGroupName: "STRING_VALUE",
  *   },
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
@@ -53,6 +54,8 @@ declare const ListCollectionsCommand_base: {
  * //       name: "STRING_VALUE",
  * //       status: "STRING_VALUE",
  * //       arn: "STRING_VALUE",
+ * //       kmsKeyArn: "STRING_VALUE",
+ * //       collectionGroupName: "STRING_VALUE",
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

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

@@ -58,7 +58,7 @@ declare const TagResourceCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -55,7 +55,7 @@ declare const UntagResourceCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -67,7 +67,7 @@ declare const UpdateAccessPolicyCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -65,7 +65,7 @@ declare const UpdateCollectionCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -0,0 +1,107 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateCollectionGroupRequest, UpdateCollectionGroupResponse } from "../models/models_0";
+import type { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCollectionGroupCommand}.
+ */
+export interface UpdateCollectionGroupCommandInput extends UpdateCollectionGroupRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCollectionGroupCommand}.
+ */
+export interface UpdateCollectionGroupCommandOutput extends UpdateCollectionGroupResponse, __MetadataBearer {
+}
+declare const UpdateCollectionGroupCommand_base: {
+    new (input: UpdateCollectionGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCollectionGroupCommandInput, UpdateCollectionGroupCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateCollectionGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCollectionGroupCommandInput, UpdateCollectionGroupCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the description and capacity limits of a collection group.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OpenSearchServerlessClient, UpdateCollectionGroupCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
+ * // const { OpenSearchServerlessClient, UpdateCollectionGroupCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
+ * // import type { OpenSearchServerlessClientConfig } from "@aws-sdk/client-opensearchserverless";
+ * const config = {}; // type is OpenSearchServerlessClientConfig
+ * const client = new OpenSearchServerlessClient(config);
+ * const input = { // UpdateCollectionGroupRequest
+ *   id: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   capacityLimits: { // CollectionGroupCapacityLimits
+ *     maxIndexingCapacityInOCU: Number("float"),
+ *     maxSearchCapacityInOCU: Number("float"),
+ *     minIndexingCapacityInOCU: Number("float"),
+ *     minSearchCapacityInOCU: Number("float"),
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateCollectionGroupCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateCollectionGroupResponse
+ * //   updateCollectionGroupDetail: { // UpdateCollectionGroupDetail
+ * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
+ * //     name: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     capacityLimits: { // CollectionGroupCapacityLimits
+ * //       maxIndexingCapacityInOCU: Number("float"),
+ * //       maxSearchCapacityInOCU: Number("float"),
+ * //       minIndexingCapacityInOCU: Number("float"),
+ * //       minSearchCapacityInOCU: Number("float"),
+ * //     },
+ * //     createdDate: Number("long"),
+ * //     lastModifiedDate: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateCollectionGroupCommandInput - {@link UpdateCollectionGroupCommandInput}
+ * @returns {@link UpdateCollectionGroupCommandOutput}
+ * @see {@link UpdateCollectionGroupCommandInput} for command's `input` shape.
+ * @see {@link UpdateCollectionGroupCommandOutput} for command's `response` shape.
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Thrown when an error internal to the service occurs while processing a request.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
+ *
+ * @throws {@link OpenSearchServerlessServiceException}
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateCollectionGroupCommand extends UpdateCollectionGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateCollectionGroupRequest;
+            output: UpdateCollectionGroupResponse;
+        };
+        sdk: {
+            input: UpdateCollectionGroupCommandInput;
+            output: UpdateCollectionGroupCommandOutput;
+        };
+    };
+}

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

@@ -67,7 +67,7 @@ declare const UpdateLifecyclePolicyCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -98,7 +98,7 @@ declare const UpdateSecurityConfigCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -67,7 +67,7 @@ declare const UpdateSecurityPolicyCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -78,7 +78,7 @@ declare const UpdateVpcEndpointCommand_base: {
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ *  <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>Thrown when an error internal to the service occurs while processing a request.</p>

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

@@ -1,9 +1,11 @@
 export * from "./BatchGetCollectionCommand";
+export * from "./BatchGetCollectionGroupCommand";
 export * from "./BatchGetEffectiveLifecyclePolicyCommand";
 export * from "./BatchGetLifecyclePolicyCommand";
 export * from "./BatchGetVpcEndpointCommand";
 export * from "./CreateAccessPolicyCommand";
 export * from "./CreateCollectionCommand";
+export * from "./CreateCollectionGroupCommand";
 export * from "./CreateIndexCommand";
 export * from "./CreateLifecyclePolicyCommand";
 export * from "./CreateSecurityConfigCommand";
@@ -11,6 +13,7 @@ export * from "./CreateSecurityPolicyCommand";
 export * from "./CreateVpcEndpointCommand";
 export * from "./DeleteAccessPolicyCommand";
 export * from "./DeleteCollectionCommand";
+export * from "./DeleteCollectionGroupCommand";
 export * from "./DeleteIndexCommand";
 export * from "./DeleteLifecyclePolicyCommand";
 export * from "./DeleteSecurityConfigCommand";
@@ -23,6 +26,7 @@ export * from "./GetPoliciesStatsCommand";
 export * from "./GetSecurityConfigCommand";
 export * from "./GetSecurityPolicyCommand";
 export * from "./ListAccessPoliciesCommand";
+export * from "./ListCollectionGroupsCommand";
 export * from "./ListCollectionsCommand";
 export * from "./ListLifecyclePoliciesCommand";
 export * from "./ListSecurityConfigsCommand";
@@ -34,6 +38,7 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateAccessPolicyCommand";
 export * from "./UpdateAccountSettingsCommand";
 export * from "./UpdateCollectionCommand";
+export * from "./UpdateCollectionGroupCommand";
 export * from "./UpdateIndexCommand";
 export * from "./UpdateLifecyclePolicyCommand";
 export * from "./UpdateSecurityConfigCommand";

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

@@ -1,7 +1,7 @@
 import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { OpenSearchServerlessServiceException as __BaseException } from "./OpenSearchServerlessServiceException";
 /**
- * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created.</p>
  * @public
  */
 export declare class ConflictException extends __BaseException {