QApps / Client / batch_update_category

batch_update_category

QApps.Client.batch_update_category(**kwargs)

Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_category(
    instanceId='string',
    categories=[
        {
            'id': 'string',
            'title': 'string',
            'color': 'string'
        },
    ]
)

Parameters:

• instanceId (string) –

  [REQUIRED]

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

• categories (list) –

  [REQUIRED]

  The list of categories to be updated with their new values.

  • (dict) –

    A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

    • id (string) – [REQUIRED]

      The unique identifier of the category.

    • title (string) – [REQUIRED]

      The name of the category.

    • color (string) –

      The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

Returns:

None

Exceptions

• QApps.Client.exceptions.ResourceNotFoundException

• QApps.Client.exceptions.AccessDeniedException

• QApps.Client.exceptions.ConflictException

• QApps.Client.exceptions.ValidationException

• QApps.Client.exceptions.InternalServerException

• QApps.Client.exceptions.UnauthorizedException

• QApps.Client.exceptions.ThrottlingException