QApps / Client / batch_create_category

batch_create_category

QApps.Client.batch_create_category(**kwargs)

Creates 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_create_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 category objects to be created

  • (dict) –

    The category object to be created.

    • id (string) –

      The unique identifier to be associated with a category. If you don’t include a value, the category is automatically assigned a unique identifier.

    • title (string) – [REQUIRED]

      The name of the category.

    • color (string) –

      The color to be associated with a category. The color must be 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