:doc:`QApps <../../qapps>` / Client / update_q_app_session_metadata

*****************************
update_q_app_session_metadata
*****************************



.. py:method:: QApps.Client.update_q_app_session_metadata(**kwargs)

  

  Updates the configuration metadata of a session for a given Q App ``sessionId``.

  

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


  **Request Syntax**
  ::

    response = client.update_q_app_session_metadata(
        instanceId='string',
        sessionId='string',
        sessionName='string',
        sharingConfiguration={
            'enabled': True|False,
            'acceptResponses': True|False,
            'revealCards': True|False
        }
    )
    
  :type instanceId: string
  :param instanceId: **[REQUIRED]** 

    The unique identifier of the Amazon Q Business application environment instance.

    

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

    The unique identifier of the Q App session to update configuration for.

    

  
  :type sessionName: string
  :param sessionName: 

    The new name for the Q App session.

    

  
  :type sharingConfiguration: dict
  :param sharingConfiguration: **[REQUIRED]** 

    The new sharing configuration for the Q App data collection session.

    

  
    - **enabled** *(boolean) --* **[REQUIRED]** 

      Indicates whether an Q App session is shareable with other users.

      

    
    - **acceptResponses** *(boolean) --* 

      Indicates whether an Q App session can accept responses from users.

      

    
    - **revealCards** *(boolean) --* 

      Indicates whether collected responses for an Q App session are revealed for all users.

      

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

    
    ::

      {
          'sessionId': 'string',
          'sessionArn': 'string',
          'sessionName': 'string',
          'sharingConfiguration': {
              'enabled': True|False,
              'acceptResponses': True|False,
              'revealCards': True|False
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **sessionId** *(string) --* 

        The unique identifier of the updated Q App session.

        
      

      - **sessionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the updated Q App session.

        
      

      - **sessionName** *(string) --* 

        The new name of the updated Q App session.

        
      

      - **sharingConfiguration** *(dict) --* 

        The new sharing configuration of the updated Q App data collection session.

        
        

        - **enabled** *(boolean) --* 

          Indicates whether an Q App session is shareable with other users.

          
        

        - **acceptResponses** *(boolean) --* 

          Indicates whether an Q App session can accept responses from users.

          
        

        - **revealCards** *(boolean) --* 

          Indicates whether collected responses for an Q App session are revealed for all users.

          
    
  
  **Exceptions**
  
  *   :py:class:`QApps.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`QApps.Client.exceptions.InternalServerException`

  
  *   :py:class:`QApps.Client.exceptions.UnauthorizedException`

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

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

  