list_messages ¶

def list_messages(
    self,
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    session_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    *,
    config_overrides: Optional[QConnectClientConfig] = None,
    next_token: Optional["capo_qconnect.types.next_token.NextToken"] = None,
    max_results: Optional["capo_qconnect.types.max_results.MaxResults"] = None,
    filter: Optional[
        "capo_qconnect.types.message_filter_type.MessageFilterType"
    ] = None,
) -> "capo_qconnect.types.list_messages_response.ListMessagesResponse":
    """<p>Lists messages on an Amazon Q in Connect session.</p>

    Args:
        assistant_id: <p>The identifier of the Amazon Q in Connect assistant.</p>
        session_id: <p>The identifier of the Amazon Q in Connect session.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        filter: <p>The filter criteria for listing messages.</p>

    Raises:
        capo_qconnect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_qconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_qconnect.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by a service.</p>
        capo_qconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qconnect.types.list_messages_request.ListMessagesRequest]",
    ) -> OperationResponse[
        "capo_qconnect.types.list_messages_response.ListMessagesResponse"
    ]:
        import capo_qconnect._operations.wisdom_service.list_messages

        output, http_response = (
            capo_qconnect._operations.wisdom_service.list_messages.list_messages(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_qconnect.types.list_messages_response.ListMessagesResponse",
    ) -> dict[str, Any]:
        import capo_qconnect.types.list_messages_response

        return capo_qconnect.types.list_messages_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListMessages", redact_output=_redact_output),
    )
    input_: capo_qconnect.types.list_messages_request.ListMessagesRequest = {
        "assistant_id": assistant_id,
        "session_id": session_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter

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