:doc:`QBusiness <../../qbusiness>` / Client / update_index

************
update_index
************



.. py:method:: QBusiness.Client.update_index(**kwargs)

  

  Updates an Amazon Q Business index.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndex>`_  


  **Request Syntax**
  ::

    response = client.update_index(
        applicationId='string',
        indexId='string',
        displayName='string',
        description='string',
        capacityConfiguration={
            'units': 123
        },
        documentAttributeConfigurations=[
            {
                'name': 'string',
                'type': 'STRING'|'STRING_LIST'|'NUMBER'|'DATE',
                'search': 'ENABLED'|'DISABLED'
            },
        ]
    )
    
  :type applicationId: string
  :param applicationId: **[REQUIRED]** 

    The identifier of the Amazon Q Business application connected to the index.

    

  
  :type indexId: string
  :param indexId: **[REQUIRED]** 

    The identifier of the Amazon Q Business index.

    

  
  :type displayName: string
  :param displayName: 

    The name of the Amazon Q Business index.

    

  
  :type description: string
  :param description: 

    The description of the Amazon Q Business index.

    

  
  :type capacityConfiguration: dict
  :param capacityConfiguration: 

    The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

    

  
    - **units** *(integer) --* 

      The number of storage units configured for an Amazon Q Business index.

      

    
  
  :type documentAttributeConfigurations: list
  :param documentAttributeConfigurations: 

    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes>`__.

    

  
    - *(dict) --* 

      Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

       

      For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html>`__.

      

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

        The name of the document attribute.

        

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

        The type of document attribute.

        

      
      - **search** *(string) --* 

        Information about whether the document attribute can be used by an end user to search for information on their web experience.

        

      
    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`QBusiness.Client.exceptions.InternalServerException`

  
  *   :py:class:`QBusiness.Client.exceptions.ResourceNotFoundException`

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

  
  *   :py:class:`QBusiness.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`QBusiness.Client.exceptions.AccessDeniedException`

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

  