chat_controls_configurations

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

Overview

Name	chat_controls_configurations
Type	Resource
Id	aws.qbusiness.chat_controls_configurations

Fields

The following fields are returned by SELECT queries:

get_chat_controls_configuration

Name	Datatype	Description
name	string	A name for your topic control configuration. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{0,35}</code>)
description	string	A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. (pattern: <code>\P{C}*</code>)
example_chat_messages	array	A list of example phrases that you expect the end user to use in relation to the topic.
rules	array	Rules defined for a topic configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_chat_controls_configuration	select	application_id, region	maxResults, nextToken	Gets information about chat controls configured for an existing Amazon Q Business application.
update_chat_controls_configuration	update	application_id, region		Updates a set of chat controls configured for an existing Amazon Q Business application.
delete_chat_controls_configuration	delete	application_id, region		Deletes chat controls configured for an existing Amazon Q Business application.

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
application_id	string	The identifier of the application the chat controls have been configured for.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of configured chat controls to return.
nextToken	string	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

SELECT examples

get_chat_controls_configuration

Gets information about chat controls configured for an existing Amazon Q Business application.

SELECT
name,
description,
example_chat_messages,
rules
FROM aws.qbusiness.chat_controls_configurations
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_chat_controls_configuration

Updates a set of chat controls configured for an existing Amazon Q Business application.

UPDATE aws.qbusiness.chat_controls_configurations
SET 
clientToken = '{{ clientToken }}',
responseScope = '{{ responseScope }}',
orchestrationConfiguration = '{{ orchestrationConfiguration }}',
blockedPhrasesConfigurationUpdate = '{{ blockedPhrasesConfigurationUpdate }}',
topicConfigurationsToCreateOrUpdate = '{{ topicConfigurationsToCreateOrUpdate }}',
topicConfigurationsToDelete = '{{ topicConfigurationsToDelete }}',
creatorModeConfiguration = '{{ creatorModeConfiguration }}',
hallucinationReductionConfiguration = '{{ hallucinationReductionConfiguration }}'
WHERE 
application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_chat_controls_configuration

Deletes chat controls configured for an existing Amazon Q Business application.

DELETE FROM aws.qbusiness.chat_controls_configurations
WHERE application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
;