batch_delete_category ¶

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

Deletes 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:

instance_id (InstanceId) –

The unique identifier of the Amazon Q Business application environment instance.
categories (DeleteCategoryInputList) –

The list of IDs of the categories to be deleted.

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:

Deletes the categories in the library

>>> client.batch_delete_category(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', categories=['9c871ed4-1c41-4065-aefe-321cd4b61cf8'])

Source code in docs_src/capo_qapps/_services/q_apps.py

def batch_delete_category(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    categories: "capo_qapps.types.delete_category_input_list.DeleteCategoryInputList",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None:
    """<p>Deletes 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 IDs of the categories to be deleted.</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:
        Deletes the categories in the library

        >>> client.batch_delete_category(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', categories=['9c871ed4-1c41-4065-aefe-321cd4b61cf8'])
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.batch_delete_category_input.BatchDeleteCategoryInput]",
    ) -> OperationResponse[None]:
        import capo_qapps._operations.q_apps_service.batch_delete_category

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDeleteCategory")
    )
    input_: capo_qapps.types.batch_delete_category_input.BatchDeleteCategoryInput = {
        "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