:doc:`OpenSearchServiceServerless <../../opensearchserverless>` / Client / update_collection_group

***********************
update_collection_group
***********************



.. py:method:: OpenSearchServiceServerless.Client.update_collection_group(**kwargs)

  

  Updates the description and capacity limits of a collection group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionGroup>`_  


  **Request Syntax**
  ::

    response = client.update_collection_group(
        id='string',
        description='string',
        capacityLimits={
            'maxIndexingCapacityInOCU': ...,
            'maxSearchCapacityInOCU': ...,
            'minIndexingCapacityInOCU': ...,
            'minSearchCapacityInOCU': ...
        },
        clientToken='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The unique identifier of the collection group to update.

    

  
  :type description: string
  :param description: 

    A new description for the collection group.

    

  
  :type capacityLimits: dict
  :param capacityLimits: 

    Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

    

  
    - **maxIndexingCapacityInOCU** *(float) --* 

      The maximum indexing capacity for collections in the group.

      

    
    - **maxSearchCapacityInOCU** *(float) --* 

      The maximum search capacity for collections in the group.

      

    
    - **minIndexingCapacityInOCU** *(float) --* 

      The minimum indexing capacity for collections in the group.

      

    
    - **minSearchCapacityInOCU** *(float) --* 

      The minimum search capacity for collections in the group.

      

    
  
  :type clientToken: string
  :param clientToken: 

    Unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'updateCollectionGroupDetail': {
              'id': 'string',
              'arn': 'string',
              'name': 'string',
              'description': 'string',
              'capacityLimits': {
                  'maxIndexingCapacityInOCU': ...,
                  'maxSearchCapacityInOCU': ...,
                  'minIndexingCapacityInOCU': ...,
                  'minSearchCapacityInOCU': ...
              },
              'createdDate': 123,
              'lastModifiedDate': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **updateCollectionGroupDetail** *(dict) --* 

        Details about the updated collection group.

        
        

        - **id** *(string) --* 

          The unique identifier of the collection group.

          
        

        - **arn** *(string) --* 

          The Amazon Resource Name (ARN) of the collection group.

          
        

        - **name** *(string) --* 

          The name of the collection group.

          
        

        - **description** *(string) --* 

          The description of the collection group.

          
        

        - **capacityLimits** *(dict) --* 

          The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

          
          

          - **maxIndexingCapacityInOCU** *(float) --* 

            The maximum indexing capacity for collections in the group.

            
          

          - **maxSearchCapacityInOCU** *(float) --* 

            The maximum search capacity for collections in the group.

            
          

          - **minIndexingCapacityInOCU** *(float) --* 

            The minimum indexing capacity for collections in the group.

            
          

          - **minSearchCapacityInOCU** *(float) --* 

            The minimum search capacity for collections in the group.

            
      
        

        - **createdDate** *(integer) --* 

          The Epoch time when the collection group was created.

          
        

        - **lastModifiedDate** *(integer) --* 

          The date and time when the collection group was last modified.

          
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ConflictException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExceededException`

  