get_chat_response_configuration¶
Operation¶
get_chat_response_configuration
¶
get_chat_response_configuration(request: GetChatResponseConfigurationInput | GetChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChatResponseConfigurationInputDict]) -> GetChatResponseConfigurationOutput
Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetChatResponseConfigurationInput | GetChatResponseConfigurationInputDict | 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[GetChatResponseConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetChatResponseConfigurationOutput
|
An instance of |
get_chat_response_configuration
async
¶
get_chat_response_configuration(request: GetChatResponseConfigurationInput | GetChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChatResponseConfigurationInputDict]) -> GetChatResponseConfigurationOutput
Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetChatResponseConfigurationInput | GetChatResponseConfigurationInputDict | 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[GetChatResponseConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetChatResponseConfigurationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetChatResponseConfigurationInput
dataclass
¶
Output¶
GetChatResponseConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetChatResponseConfigurationOutput structure.
Attributes¶
chat_response_configuration_arn
class-attribute
instance-attribute
¶
chat_response_configuration_arn: str | None = ...
The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
chat_response_configuration_id
class-attribute
instance-attribute
¶
chat_response_configuration_id: str | None = ...
The unique identifier of the retrieved chat response configuration.
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The timestamp indicating when the chat response configuration was initially created.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.
in_use_configuration
class-attribute
instance-attribute
¶
in_use_configuration: ChatResponseConfigurationDetail | None = ...
The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.
last_update_configuration
class-attribute
instance-attribute
¶
last_update_configuration: ChatResponseConfigurationDetail | None = ...
Information about the most recent update to the configuration, including timestamp and modification details.
response_metadata
class-attribute
instance-attribute
¶
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.