Skip to content

update_chat_response_configuration

Operation

update_chat_response_configuration

update_chat_response_configuration(request: UpdateChatResponseConfigurationInput | UpdateChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChatResponseConfigurationInputDict]) -> UpdateChatResponseConfigurationOutput

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.

Parameters:

Name Type Description Default
request UpdateChatResponseConfigurationInput | UpdateChatResponseConfigurationInputDict | 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[UpdateChatResponseConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateChatResponseConfigurationOutput

An instance of UpdateChatResponseConfigurationOutput.

update_chat_response_configuration async

update_chat_response_configuration(request: UpdateChatResponseConfigurationInput | UpdateChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChatResponseConfigurationInputDict]) -> UpdateChatResponseConfigurationOutput

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.

Parameters:

Name Type Description Default
request UpdateChatResponseConfigurationInput | UpdateChatResponseConfigurationInputDict | 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[UpdateChatResponseConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateChatResponseConfigurationOutput

An instance of UpdateChatResponseConfigurationOutput.

Input

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

UpdateChatResponseConfigurationInputDict

Bases: TypedDict

Dictionary form of UpdateChatResponseConfigurationInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application containing the chat response configuration to update.

chat_response_configuration_id instance-attribute
chat_response_configuration_id: Required[str]

The unique identifier of the chat response configuration to update within the specified application.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.

This field is autopopulated if not provided.

display_name instance-attribute
display_name: str | None

The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.

response_configurations instance-attribute

The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.

UpdateChatResponseConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for UpdateChatResponseConfigurationInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The unique identifier of the Amazon Q Business application containing the chat response configuration to update.

chat_response_configuration_id class-attribute instance-attribute
chat_response_configuration_id: str | None = ...

The unique identifier of the chat response configuration to update within the specified application.

client_token class-attribute instance-attribute
client_token: str | None = ...

A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.

This field is autopopulated if not provided.

display_name class-attribute instance-attribute
display_name: str | None = ...

The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.

response_configurations class-attribute instance-attribute
response_configurations: dict[str, ResponseConfiguration] | None = ...

The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.

Output

UpdateChatResponseConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateChatResponseConfigurationOutput structure.

Attributes

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.