chat_response_configurations

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

Overview

Name	chat_response_configurations
Type	Resource
Id	aws.qbusiness.chat_response_configurations

Fields

The following fields are returned by SELECT queries:

get_chat_response_configuration

Name	Datatype	Description
chat_response_configuration_arn	string	The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
chat_response_configuration_id	string	The unique identifier of the retrieved chat response configuration. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
created_at	string (date-time)	The timestamp indicating when the chat response configuration was initially created.
display_name	string	The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.
in_use_configuration	object	The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.
last_update_configuration	object	Information about the most recent update to the configuration, including timestamp and modification details.

list_chat_response_configurations

Name	Datatype	Description
chat_response_configuration_arn	string	The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
chat_response_configuration_id	string	A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
created_at	string (date-time)	The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.
display_name	string	A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.
response_configuration_summary	string	A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.
status	string	The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions. (CREATING, UPDATING, FAILED, ACTIVE)
updated_at	string (date-time)	The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_chat_response_configuration	select	application_id, chat_response_configuration_id, region		Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
list_chat_response_configurations	select	application_id, region	maxResults, nextToken	Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
create_chat_response_configuration	insert	application_id, region, displayName, responseConfigurations		Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
update_chat_response_configuration	update	application_id, chat_response_configuration_id, region, responseConfigurations		Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
delete_chat_response_configuration	delete	application_id, chat_response_configuration_id, region		Deletes a specified chat response configuration from an 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 unique identifier of theAmazon Q Business application from which to delete the chat response configuration.
chat_response_configuration_id	string	The unique identifier of the chat response configuration to delete from the specified application.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.
nextToken	string	A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.

SELECT examples

get_chat_response_configuration

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

SELECT
chat_response_configuration_arn,
chat_response_configuration_id,
created_at,
display_name,
in_use_configuration,
last_update_configuration
FROM aws.qbusiness.chat_response_configurations
WHERE application_id = '{{ application_id }}' -- required
AND chat_response_configuration_id = '{{ chat_response_configuration_id }}' -- required
AND region = '{{ region }}' -- required
;

list_chat_response_configurations

Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.

SELECT
chat_response_configuration_arn,
chat_response_configuration_id,
created_at,
display_name,
response_configuration_summary,
status,
updated_at
FROM aws.qbusiness.chat_response_configurations
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_chat_response_configuration

Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.

INSERT INTO aws.qbusiness.chat_response_configurations (
displayName,
clientToken,
responseConfigurations,
tags,
application_id,
region
)
SELECT 
'{{ displayName }}' /* required */,
'{{ clientToken }}',
'{{ responseConfigurations }}' /* required */,
'{{ tags }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
chat_response_configuration_arn,
chat_response_configuration_id
;

Manifest

# Description fields are for documentation purposes
- name: chat_response_configurations
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the chat_response_configurations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the chat_response_configurations resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: responseConfigurations
    value: "{{ responseConfigurations }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_chat_response_configuration

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

UPDATE aws.qbusiness.chat_response_configurations
SET 
displayName = '{{ displayName }}',
responseConfigurations = '{{ responseConfigurations }}',
clientToken = '{{ clientToken }}'
WHERE 
application_id = '{{ application_id }}' --required
AND chat_response_configuration_id = '{{ chat_response_configuration_id }}' --required
AND region = '{{ region }}' --required
AND responseConfigurations = '{{ responseConfigurations }}' --required;

DELETE examples

delete_chat_response_configuration

Deletes a specified chat response configuration from an Amazon Q Business application.

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