QApps / Client / list_categories

list_categories#

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.

Request Syntax

response = client.list_categories(
    instanceId='string'
)

Parameters:

instanceId (string) –

[REQUIRED]

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

Return type:

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

QApps.Client.exceptions.ResourceNotFoundException
QApps.Client.exceptions.AccessDeniedException
QApps.Client.exceptions.ValidationException
QApps.Client.exceptions.InternalServerException
QApps.Client.exceptions.UnauthorizedException
QApps.Client.exceptions.ThrottlingException