Skip to content

list_chat_response_configurations

Operation

list_chat_response_configurations

list_chat_response_configurations(request: ListChatResponseConfigurationsInput | ListChatResponseConfigurationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListChatResponseConfigurationsInputDict]) -> 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
request ListChatResponseConfigurationsInput | ListChatResponseConfigurationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListChatResponseConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListChatResponseConfigurationsOutput

An instance of ListChatResponseConfigurationsOutput.

list_chat_response_configurations async

list_chat_response_configurations(request: ListChatResponseConfigurationsInput | ListChatResponseConfigurationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListChatResponseConfigurationsInputDict]) -> 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
request ListChatResponseConfigurationsInput | ListChatResponseConfigurationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListChatResponseConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListChatResponseConfigurationsOutput

An instance of ListChatResponseConfigurationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListChatResponseConfigurationsInputDict

Bases: TypedDict

Dictionary form of ListChatResponseConfigurationsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

max_results instance-attribute
max_results: int | 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 instance-attribute
next_token: str | None

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

ListChatResponseConfigurationsInput dataclass

Bases: _SerdeShape

Dataclass for ListChatResponseConfigurationsInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

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 = ...

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

Output

ListChatResponseConfigurationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListChatResponseConfigurationsOutput structure.

Attributes

chat_response_configurations class-attribute instance-attribute
chat_response_configurations: list[ChatResponseConfiguration] | 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 = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.