QBusiness / Client / list_chat_response_configurations

list_chat_response_configurations

QBusiness.Client.list_chat_response_configurations(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_chat_response_configurations(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.

  • nextToken (string) – A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.

Return type:

dict

Returns:

Response Syntax

{
    'chatResponseConfigurations': [
        {
            'chatResponseConfigurationId': 'string',
            'chatResponseConfigurationArn': 'string',
            'displayName': 'string',
            'responseConfigurationSummary': 'string',
            'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • chatResponseConfigurations (list) –

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

      • (dict) –

        Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.

        • chatResponseConfigurationId (string) –

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

        • chatResponseConfigurationArn (string) –

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

        • displayName (string) –

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

        • responseConfigurationSummary (string) –

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

        • status (string) –

          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.

        • createdAt (datetime) –

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

        • updatedAt (datetime) –

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

    • nextToken (string) –

      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.

Exceptions