categories

Creates, updates, deletes, gets or lists a categories resource.

Overview

Name	categories
Type	Resource
Id	aws.qapps.categories

Fields

The following fields are returned by SELECT queries:

list_categories

Name	Datatype	Description
categories	array	The categories of a Amazon Q Business application environment instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_categories	select	instance-id, region		Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance-id	string	The unique identifier of the Amazon Q Business application environment instance.
region	string	AWS region (default: us-east-1)

SELECT examples

list_categories

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

SELECT
categories
FROM aws.qapps.categories
WHERE `instance-id` = '{{ instance-id }}' -- required
AND region = '{{ region }}' -- required
;