Skip to content

batch_create_category 

batch_create_category(
    instance_id: InstanceId,
    categories: BatchCreateCategoryInputCategoryList,
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None

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.

Parameters:

Raises:

  • AccessDeniedException –

    The client is not authorized to perform the requested operation.

  • ConflictException –

    The requested operation could not be completed due to a conflict with the current state of the resource.

  • InternalServerException –

    An internal service error occurred while processing the request.

  • ResourceNotFoundException –

    The requested resource could not be found.

  • ThrottlingException –

    The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

  • UnauthorizedException –

    The client is not authenticated or authorized to perform the requested operation.

  • ValidationException –

    The input failed to satisfy the constraints specified by the service.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

Creates the categories for the library

>>> client.batch_create_category(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', categories=[{'id': '549abfe0-f5c4-45a2-bb9b-c05987a49c6d', 'title': 'HR'}, {'id': '18cbebaa-196a-4aa5-a840-88d548e07f8f', 'title': 'Marketing'}])
Source code in docs_src/capo_qapps/_services/q_apps.py 
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
def batch_create_category(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    categories: "capo_qapps.types.batch_create_category_input_category_list.BatchCreateCategoryInputCategoryList",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None:
    """<p>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 <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        categories: <p>The list of category objects to be created</p>

    Raises:
        capo_qapps.errors.access_denied_exception.AccessDeniedException: <p>The client is not authorized to perform the requested operation.</p>
        capo_qapps.errors.conflict_exception.ConflictException: <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
        capo_qapps.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred while processing the request.</p>
        capo_qapps.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_qapps.errors.throttling_exception.ThrottlingException: <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
        capo_qapps.errors.unauthorized_exception.UnauthorizedException: <p>The client is not authenticated or authorized to perform the requested operation.</p>
        capo_qapps.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by the service.</p>
        capo_qapps.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Creates the categories for the library

        >>> client.batch_create_category(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', categories=[{'id': '549abfe0-f5c4-45a2-bb9b-c05987a49c6d', 'title': 'HR'}, {'id': '18cbebaa-196a-4aa5-a840-88d548e07f8f', 'title': 'Marketing'}])
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.batch_create_category_input.BatchCreateCategoryInput]",
    ) -> OperationResponse[None]:
        import capo_qapps._operations.q_apps_service.batch_create_category

        output, http_response = (
            capo_qapps._operations.q_apps_service.batch_create_category.batch_create_category(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchCreateCategory")
    )
    input_: capo_qapps.types.batch_create_category_input.BatchCreateCategoryInput = {
        "instance_id": instance_id,
        "categories": categories,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output