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

***************
list_categories
***************



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

  

  Lists the categories of a Amazon Q Business application environment instance. For more information, see `Custom labels for Amazon Q Apps <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_categories(
        instanceId='string'
    )
    
  :type instanceId: string
  :param instanceId: **[REQUIRED]** 

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

    

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

    
    ::

      {
          'categories': [
              {
                  'id': 'string',
                  'title': 'string',
                  'color': 'string',
                  'appCount': 123
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **categories** *(list) --* 

        The categories of a Amazon Q Business application environment instance.

        
        

        - *(dict) --* 

          A category used to classify and filter library items for Amazon Q Apps.

          
          

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

            The unique identifier of the category.

            
          

          - **title** *(string) --* 

            The title or name of the category.

            
          

          - **color** *(string) --* 

            The color of the category

            
          

          - **appCount** *(integer) --* 

            The number of published Amazon Q Apps associated with a category

            
      
    
  
  **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.ThrottlingException`

  