Skip to content

ChatResponseConfiguration

Source code in docs_src/capo_qbusiness/types/chat_response_configuration.py
class ChatResponseConfiguration(TypedDict, closed=True):
    chat_response_configuration_id: "capo_qbusiness.types.chat_response_configuration_id.ChatResponseConfigurationId"
    """<p>A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.</p>"""
    chat_response_configuration_arn: "capo_qbusiness.types.chat_response_configuration_arn.ChatResponseConfigurationArn"
    """<p>The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.</p>"""
    display_name: "capo_qbusiness.types.display_name.DisplayName"
    """<p>A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.</p>"""
    response_configuration_summary: NotRequired[
        "capo_qbusiness.types.response_configuration_summary.ResponseConfigurationSummary"
    ]
    """<p>A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.</p>"""
    status: "capo_qbusiness.types.chat_response_configuration_status.ChatResponseConfigurationStatus"
    """<p>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.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.</p>"""

chat_response_configuration_arn instance-attribute

chat_response_configuration_arn: ChatResponseConfigurationArn

The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.

chat_response_configuration_id instance-attribute

chat_response_configuration_id: ChatResponseConfigurationId

A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.

display_name instance-attribute

display_name: DisplayName

A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.

response_configuration_summary instance-attribute

response_configuration_summary: NotRequired[ResponseConfigurationSummary]

A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.

status instance-attribute

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.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.