aws-sdk-opensearchserverless 1.52.0 → 1.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a9b6a6fb62dc2b91ff9127bee8edef371c20e1b2bd55cafeea1432da5c8052f
-  data.tar.gz: 00f620ec85452399a6aef41bd9e0c94949b2c302e9039bf26144daa4a6a5ab10
+  metadata.gz: 7bdee76156e1e359e5ac45bfe1d8255f7cef310a7cb19be8150be4879be3215c
+  data.tar.gz: 67b0ac671653814ffc6e98a526db24df74d9e907c0c7a500e2a6bae37d02a25c
 SHA512:
-  metadata.gz: 49cfb16abbdeefcc8ca4a95161eb6521c7df759b5a8e29ff28c0a345fee1df1f7184bec5c27e2c228be09bf34c7387a464435da662f245a1369f7e79127fc215
-  data.tar.gz: 28dcd88f681a08a8b0e4eb6f86dcf4d0d48b31a8a3d9791f5a90a83a495975158b867a346b75465e414fbc6c81268522df474fd30d373dda128ad6eb91da0372
+  metadata.gz: 70d4b5e1ad72d15cbcbfb6623167d133f4fbc1d3b1fc8ff0331f9d4608816c3d686153318e0816739deda0d89db5d6b9036452ab41d9f29771c350825dd8fd38
+  data.tar.gz: d0837e1ba0f6fe85979f5ba49650d20452ded26cd36f7f46f1ab40c00715b286fc4c4ac1e18ba413983170c53fa25db4f5738437b6287d2bce8372ef0623f5c8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.53.0 (2026-01-15)
+------------------
+
+* Feature - Collection groups in Amazon OpenSearch Serverless enables to organize multiple collections and enable compute resource sharing across collections with different KMS keys. This shared compute model reduces costs by eliminating the need for separate OpenSearch Compute Units (OCUs) for each KMS key.
+
 1.52.0 (2026-01-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.52.0
+1.53.0

data/lib/aws-sdk-opensearchserverless/client.rb

@@ -537,6 +537,7 @@ module Aws::OpenSearchServerless
     #   resp.collection_details[0].fips_endpoints.dashboard_endpoint #=> String
     #   resp.collection_details[0].failure_code #=> String
     #   resp.collection_details[0].failure_message #=> String
+    #   resp.collection_details[0].collection_group_name #=> String
     #   resp.collection_error_details #=> Array
     #   resp.collection_error_details[0].id #=> String
     #   resp.collection_error_details[0].name #=> String
@@ -552,6 +553,67 @@ module Aws::OpenSearchServerless
       req.send_request(options)
     end
 
+    # Returns attributes for one or more collection groups, including
+    # capacity limits and the number of collections in each group. For more
+    # information, see [Creating and managing Amazon OpenSearch Serverless
+    # collections][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
+    #
+    # @option params [Array<String>] :ids
+    #   A list of collection group IDs. You can't provide names and IDs in
+    #   the same request.
+    #
+    # @option params [Array<String>] :names
+    #   A list of collection group names. You can't provide names and IDs in
+    #   the same request.
+    #
+    # @return [Types::BatchGetCollectionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetCollectionGroupResponse#collection_group_details #collection_group_details} => Array&lt;Types::CollectionGroupDetail&gt;
+    #   * {Types::BatchGetCollectionGroupResponse#collection_group_error_details #collection_group_error_details} => Array&lt;Types::CollectionGroupErrorDetail&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_collection_group({
+    #     ids: ["CollectionGroupId"],
+    #     names: ["CollectionGroupName"],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.collection_group_details #=> Array
+    #   resp.collection_group_details[0].id #=> String
+    #   resp.collection_group_details[0].arn #=> String
+    #   resp.collection_group_details[0].name #=> String
+    #   resp.collection_group_details[0].standby_replicas #=> String, one of "ENABLED", "DISABLED"
+    #   resp.collection_group_details[0].description #=> String
+    #   resp.collection_group_details[0].tags #=> Array
+    #   resp.collection_group_details[0].tags[0].key #=> String
+    #   resp.collection_group_details[0].tags[0].value #=> String
+    #   resp.collection_group_details[0].created_date #=> Integer
+    #   resp.collection_group_details[0].capacity_limits.max_indexing_capacity_in_ocu #=> Float
+    #   resp.collection_group_details[0].capacity_limits.max_search_capacity_in_ocu #=> Float
+    #   resp.collection_group_details[0].capacity_limits.min_indexing_capacity_in_ocu #=> Float
+    #   resp.collection_group_details[0].capacity_limits.min_search_capacity_in_ocu #=> Float
+    #   resp.collection_group_details[0].number_of_collections #=> Integer
+    #   resp.collection_group_error_details #=> Array
+    #   resp.collection_group_error_details[0].id #=> String
+    #   resp.collection_group_error_details[0].name #=> String
+    #   resp.collection_group_error_details[0].error_message #=> String
+    #   resp.collection_group_error_details[0].error_code #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollectionGroup AWS API Documentation
+    #
+    # @overload batch_get_collection_group(params = {})
+    # @param [Hash] params ({})
+    def batch_get_collection_group(params = {}, options = {})
+      req = build_request(:batch_get_collection_group, params)
+      req.send_request(options)
+    end
+
     # Returns a list of successful and failed retrievals for the OpenSearch
     # Serverless indexes. For more information, see [Viewing data lifecycle
     # policies][1].
@@ -794,6 +856,12 @@ module Aws::OpenSearchServerless
     #   Configuration options for vector search capabilities in the
     #   collection.
     #
+    # @option params [String] :collection_group_name
+    #   The name of the collection group to associate with the collection.
+    #
+    # @option params [Types::EncryptionConfig] :encryption_config
+    #   Encryption settings for the collection.
+    #
     # @option params [String] :client_token
     #   Unique, case-sensitive identifier to ensure idempotency of the
     #   request.
@@ -821,6 +889,11 @@ module Aws::OpenSearchServerless
     #     vector_options: {
     #       serverless_vector_acceleration: "ENABLED", # required, accepts ENABLED, DISABLED, ALLOWED
     #     },
+    #     collection_group_name: "CollectionGroupName",
+    #     encryption_config: {
+    #       a_ws_owned_key: false,
+    #       kms_key_arn: "EncryptionConfigKmsKeyArnString",
+    #     },
     #     client_token: "ClientToken",
     #   })
     #
@@ -837,6 +910,7 @@ module Aws::OpenSearchServerless
     #   resp.create_collection_detail.vector_options.serverless_vector_acceleration #=> String, one of "ENABLED", "DISABLED", "ALLOWED"
     #   resp.create_collection_detail.created_date #=> Integer
     #   resp.create_collection_detail.last_modified_date #=> Integer
+    #   resp.create_collection_detail.collection_group_name #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollection AWS API Documentation
     #
@@ -847,6 +921,92 @@ module Aws::OpenSearchServerless
       req.send_request(options)
     end
 
+    # Creates a collection group within OpenSearch Serverless. Collection
+    # groups let you manage OpenSearch Compute Units (OCUs) at a group
+    # level, with multiple collections sharing the group's capacity limits.
+    #
+    # For more information, see [Managing collection groups][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collection-groups.html
+    #
+    # @option params [required, String] :name
+    #   The name of the collection group.
+    #
+    # @option params [required, String] :standby_replicas
+    #   Indicates whether standby replicas should be used for a collection
+    #   group.
+    #
+    # @option params [String] :description
+    #   A description of the collection group.
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   An arbitrary set of tags (key–value pairs) to associate with the
+    #   OpenSearch Serverless collection group.
+    #
+    # @option params [Types::CollectionGroupCapacityLimits] :capacity_limits
+    #   The capacity limits for the collection group, in OpenSearch Compute
+    #   Units (OCUs). These limits control the maximum and minimum capacity
+    #   for collections within the group.
+    #
+    # @option params [String] :client_token
+    #   Unique, case-sensitive identifier to ensure idempotency of the
+    #   request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::CreateCollectionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateCollectionGroupResponse#create_collection_group_detail #create_collection_group_detail} => Types::CreateCollectionGroupDetail
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_collection_group({
+    #     name: "CollectionGroupName", # required
+    #     standby_replicas: "ENABLED", # required, accepts ENABLED, DISABLED
+    #     description: "CreateCollectionGroupRequestDescriptionString",
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
+    #     capacity_limits: {
+    #       max_indexing_capacity_in_ocu: 1.0,
+    #       max_search_capacity_in_ocu: 1.0,
+    #       min_indexing_capacity_in_ocu: 1.0,
+    #       min_search_capacity_in_ocu: 1.0,
+    #     },
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.create_collection_group_detail.id #=> String
+    #   resp.create_collection_group_detail.arn #=> String
+    #   resp.create_collection_group_detail.name #=> String
+    #   resp.create_collection_group_detail.standby_replicas #=> String, one of "ENABLED", "DISABLED"
+    #   resp.create_collection_group_detail.description #=> String
+    #   resp.create_collection_group_detail.tags #=> Array
+    #   resp.create_collection_group_detail.tags[0].key #=> String
+    #   resp.create_collection_group_detail.tags[0].value #=> String
+    #   resp.create_collection_group_detail.created_date #=> Integer
+    #   resp.create_collection_group_detail.capacity_limits.max_indexing_capacity_in_ocu #=> Float
+    #   resp.create_collection_group_detail.capacity_limits.max_search_capacity_in_ocu #=> Float
+    #   resp.create_collection_group_detail.capacity_limits.min_indexing_capacity_in_ocu #=> Float
+    #   resp.create_collection_group_detail.capacity_limits.min_search_capacity_in_ocu #=> Float
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionGroup AWS API Documentation
+    #
+    # @overload create_collection_group(params = {})
+    # @param [Hash] params ({})
+    def create_collection_group(params = {}, options = {})
+      req = build_request(:create_collection_group, params)
+      req.send_request(options)
+    end
+
     # Creates an index within an OpenSearch Serverless collection. Unlike
     # other OpenSearch indexes, indexes created by this API are
     # automatically configured to conduct automatic semantic enrichment
@@ -972,13 +1132,13 @@ module Aws::OpenSearchServerless
     #   A description of the security configuration.
     #
     # @option params [Types::SamlConfigOptions] :saml_options
-    #   Describes SAML options in in the form of a key-value map. This field
-    #   is required if you specify `SAML` for the `type` parameter.
+    #   Describes SAML options in the form of a key-value map. This field is
+    #   required if you specify `SAML` for the `type` parameter.
     #
     # @option params [Types::CreateIamIdentityCenterConfigOptions] :iam_identity_center_options
     #   Describes IAM Identity Center options in the form of a key-value map.
-    #   This field is required if you specify iamidentitycenter for the type
-    #   parameter.
+    #   This field is required if you specify `iamidentitycenter` for the
+    #   `type` parameter.
     #
     # @option params [Types::IamFederationConfigOptions] :iam_federation_options
     #   Describes IAM federation options in the form of a key-value map. This
@@ -1264,6 +1424,42 @@ module Aws::OpenSearchServerless
       req.send_request(options)
     end
 
+    # Deletes a collection group. You can only delete empty collection
+    # groups that contain no collections. For more information, see
+    # [Creating and managing Amazon OpenSearch Serverless collections][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
+    #
+    # @option params [required, String] :id
+    #   The unique identifier of the collection group to delete.
+    #
+    # @option params [String] :client_token
+    #   Unique, case-sensitive identifier to ensure idempotency of the
+    #   request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_collection_group({
+    #     id: "CollectionGroupId", # required
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollectionGroup AWS API Documentation
+    #
+    # @overload delete_collection_group(params = {})
+    # @param [Hash] params ({})
+    def delete_collection_group(params = {}, options = {})
+      req = build_request(:delete_collection_group, params)
+      req.send_request(options)
+    end
+
     # Deletes an index from an OpenSearch Serverless collection. Be aware
     # that the index might be configured to conduct automatic semantic
     # enrichment ingestion and search. For more information, see [About
@@ -1738,6 +1934,60 @@ module Aws::OpenSearchServerless
       req.send_request(options)
     end
 
+    # Returns a list of collection groups. For more information, see
+    # [Creating and managing Amazon OpenSearch Serverless collections][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
+    #
+    # @option params [String] :next_token
+    #   If your initial `ListCollectionGroups` operation returns a
+    #   `nextToken`, you can include the returned `nextToken` in subsequent
+    #   `ListCollectionGroups` operations, which returns results in the next
+    #   page.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return. Default is 20. You can use
+    #   `nextToken` to get the next page of results.
+    #
+    # @return [Types::ListCollectionGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCollectionGroupsResponse#collection_group_summaries #collection_group_summaries} => Array&lt;Types::CollectionGroupSummary&gt;
+    #   * {Types::ListCollectionGroupsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_collection_groups({
+    #     next_token: "String",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.collection_group_summaries #=> Array
+    #   resp.collection_group_summaries[0].id #=> String
+    #   resp.collection_group_summaries[0].arn #=> String
+    #   resp.collection_group_summaries[0].name #=> String
+    #   resp.collection_group_summaries[0].number_of_collections #=> Integer
+    #   resp.collection_group_summaries[0].created_date #=> Integer
+    #   resp.collection_group_summaries[0].capacity_limits.max_indexing_capacity_in_ocu #=> Float
+    #   resp.collection_group_summaries[0].capacity_limits.max_search_capacity_in_ocu #=> Float
+    #   resp.collection_group_summaries[0].capacity_limits.min_indexing_capacity_in_ocu #=> Float
+    #   resp.collection_group_summaries[0].capacity_limits.min_search_capacity_in_ocu #=> Float
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollectionGroups AWS API Documentation
+    #
+    # @overload list_collection_groups(params = {})
+    # @param [Hash] params ({})
+    def list_collection_groups(params = {}, options = {})
+      req = build_request(:list_collection_groups, params)
+      req.send_request(options)
+    end
+
     # Lists all OpenSearch Serverless collections. For more information, see
     # [Creating and managing Amazon OpenSearch Serverless collections][1].
     #
@@ -1775,6 +2025,7 @@ module Aws::OpenSearchServerless
     #     collection_filters: {
     #       name: "CollectionName",
     #       status: "CREATING", # accepts CREATING, DELETING, ACTIVE, FAILED
+    #       collection_group_name: "CollectionGroupName",
     #     },
     #     next_token: "String",
     #     max_results: 1,
@@ -1787,6 +2038,8 @@ module Aws::OpenSearchServerless
     #   resp.collection_summaries[0].name #=> String
     #   resp.collection_summaries[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
     #   resp.collection_summaries[0].arn #=> String
+    #   resp.collection_summaries[0].kms_key_arn #=> String
+    #   resp.collection_summaries[0].collection_group_name #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollections AWS API Documentation
@@ -2298,6 +2551,65 @@ module Aws::OpenSearchServerless
       req.send_request(options)
     end
 
+    # Updates the description and capacity limits of a collection group.
+    #
+    # @option params [required, String] :id
+    #   The unique identifier of the collection group to update.
+    #
+    # @option params [String] :description
+    #   A new description for the collection group.
+    #
+    # @option params [Types::CollectionGroupCapacityLimits] :capacity_limits
+    #   Updated capacity limits for the collection group, in OpenSearch
+    #   Compute Units (OCUs).
+    #
+    # @option params [String] :client_token
+    #   Unique, case-sensitive identifier to ensure idempotency of the
+    #   request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::UpdateCollectionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateCollectionGroupResponse#update_collection_group_detail #update_collection_group_detail} => Types::UpdateCollectionGroupDetail
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_collection_group({
+    #     id: "CollectionGroupId", # required
+    #     description: "UpdateCollectionGroupRequestDescriptionString",
+    #     capacity_limits: {
+    #       max_indexing_capacity_in_ocu: 1.0,
+    #       max_search_capacity_in_ocu: 1.0,
+    #       min_indexing_capacity_in_ocu: 1.0,
+    #       min_search_capacity_in_ocu: 1.0,
+    #     },
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.update_collection_group_detail.id #=> String
+    #   resp.update_collection_group_detail.arn #=> String
+    #   resp.update_collection_group_detail.name #=> String
+    #   resp.update_collection_group_detail.description #=> String
+    #   resp.update_collection_group_detail.capacity_limits.max_indexing_capacity_in_ocu #=> Float
+    #   resp.update_collection_group_detail.capacity_limits.max_search_capacity_in_ocu #=> Float
+    #   resp.update_collection_group_detail.capacity_limits.min_indexing_capacity_in_ocu #=> Float
+    #   resp.update_collection_group_detail.capacity_limits.min_search_capacity_in_ocu #=> Float
+    #   resp.update_collection_group_detail.created_date #=> Integer
+    #   resp.update_collection_group_detail.last_modified_date #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionGroup AWS API Documentation
+    #
+    # @overload update_collection_group(params = {})
+    # @param [Hash] params ({})
+    def update_collection_group(params = {}, options = {})
+      req = build_request(:update_collection_group, params)
+      req.send_request(options)
+    end
+
     # Updates an existing index in an OpenSearch Serverless collection. This
     # operation allows you to modify the index schema, including adding new
     # fields or changing field mappings. You can also enable automatic
@@ -2656,7 +2968,7 @@ module Aws::OpenSearchServerless
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-opensearchserverless'
-      context[:gem_version] = '1.52.0'
+      context[:gem_version] = '1.53.0'
       Seahorse::Client::Request.new(handlers, context)
     end