Skip to content

list_chat_response_configurations

list_chat_response_configurations(
    application_id: ApplicationId,
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[NextToken] = None,
) -> ListChatResponseConfigurationsResponse

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:

  • application_id (ApplicationId) –

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

  • max_results (Optional[Integer], default: 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 (Optional[NextToken], default: None ) –

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

Raises:

  • AccessDeniedException –

    You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

  • ResourceNotFoundException –

    The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException –

    The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_qbusiness/_services/q_business.py
def list_chat_response_configurations(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    max_results: Optional["capo_qbusiness.types.integer.Integer"] = None,
    next_token: Optional["capo_qbusiness.types.next_token.NextToken"] = None,
) -> "capo_qbusiness.types.list_chat_response_configurations_response.ListChatResponseConfigurationsResponse":
    """<p>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.</p>

    Args:
        application_id: <p>The unique identifier of the Amazon Q Business application for which to list available chat response configurations.</p>
        max_results: <p>The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.</p>
        next_token: <p>A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified <code>maxResults</code> value.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.list_chat_response_configurations_request.ListChatResponseConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.list_chat_response_configurations_response.ListChatResponseConfigurationsResponse"
    ]:
        import capo_qbusiness._operations.expert_q.list_chat_response_configurations

        output, http_response = (
            capo_qbusiness._operations.expert_q.list_chat_response_configurations.list_chat_response_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListChatResponseConfigurations")
    )
    input_: capo_qbusiness.types.list_chat_response_configurations_request.ListChatResponseConfigurationsRequest = {
        "application_id": application_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output