Qbusiness  >  Operations  >  list_chat_response_configurations

list_chat_response_configurations

Operation

list_chat_response_configurations async

list_chat_response_configurations(input: ListChatResponseConfigurationsInput, plugins: list[Plugin] | None = None) -> ListChatResponseConfigurationsOutput

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.

Parameters:

Name	Type	Description	Default
input	ListChatResponseConfigurationsInput	An instance of ListChatResponseConfigurationsInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
ListChatResponseConfigurationsOutput	An instance of ListChatResponseConfigurationsOutput.

Input

ListChatResponseConfigurationsInput dataclass

Dataclass for ListChatResponseConfigurationsInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The unique identifier of the Amazon Q Business application for which to list available chat response configurations.

max_results class-attribute instance-attribute

max_results: int | None = None

The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.

next_token class-attribute instance-attribute

next_token: str | None = None

A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.

Output

ListChatResponseConfigurationsOutput dataclass

Dataclass for ListChatResponseConfigurationsOutput structure.

Attributes

chat_response_configurations class-attribute instance-attribute

chat_response_configurations: list[ChatResponseConfiguration] | None = None

A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.

next_token class-attribute instance-attribute

next_token: str | None = None

A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the maxResults parameter.