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

*****************
update_collection
*****************



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

  

  Updates an OpenSearch Serverless collection.

  

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


  **Request Syntax**
  ::

    response = client.update_collection(
        id='string',
        description='string',
        clientToken='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The unique identifier of the collection.

    

  
  :type description: string
  :param description: 

    A description of the collection.

    

  
  :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**

    
    ::

      {
          'updateCollectionDetail': {
              'id': 'string',
              'name': 'string',
              'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
              'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH',
              'description': 'string',
              'arn': 'string',
              'createdDate': 123,
              'lastModifiedDate': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **updateCollectionDetail** *(dict) --* 

        Details about the updated collection.

        
        

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

          The unique identifier of the collection.

          
        

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

          The name of the collection.

          
        

        - **status** *(string) --* 

          The current status of the collection.

          
        

        - **type** *(string) --* 

          The collection type.

          
        

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

          The description of the collection.

          
        

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

          The Amazon Resource Name (ARN) of the collection.

          
        

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

          The date and time when the collection was created.

          
        

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

          The date and time when the collection was last modified.

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

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

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

  