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

********************
list_web_experiences
********************



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

  

  Lists one or more Amazon Q Business Web Experiences.

  

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


  **Request Syntax**
  ::

    response = client.list_web_experiences(
        applicationId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type applicationId: string
  :param applicationId: **[REQUIRED]** 

    The identifier of the Amazon Q Business application linked to the listed web experiences.

    

  
  :type nextToken: string
  :param nextToken: 

    If the ``maxResults`` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of Amazon Q Business Web Experiences to return.

    

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

    
    ::

      {
          'webExperiences': [
              {
                  'webExperienceId': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1),
                  'defaultEndpoint': 'string',
                  'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **webExperiences** *(list) --* 

        An array of summary information for one or more Amazon Q Business experiences.

        
        

        - *(dict) --* 

          Provides information for an Amazon Q Business web experience.

          
          

          - **webExperienceId** *(string) --* 

            The identifier of your Amazon Q Business web experience.

            
          

          - **createdAt** *(datetime) --* 

            The Unix timestamp when the Amazon Q Business application was last updated.

            
          

          - **updatedAt** *(datetime) --* 

            The Unix timestamp when your Amazon Q Business web experience was updated.

            
          

          - **defaultEndpoint** *(string) --* 

            The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.

            
          

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

            The status of your Amazon Q Business web experience.

            
      
    
      

      - **nextToken** *(string) --* 

        If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

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

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

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

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

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

  