list_messages ¶

def list_messages(
    self,
    conversation_id: "capo_qbusiness.types.conversation_id.ConversationId",
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    user_id: Optional["capo_qbusiness.types.user_id.UserId"] = None,
    next_token: Optional["capo_qbusiness.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_qbusiness.types.max_results_integer_for_list_messages.MaxResultsIntegerForListMessages"
    ] = None,
) -> "capo_qbusiness.types.list_messages_response.ListMessagesResponse":
    """<p>Gets a list of messages associated with an Amazon Q Business web experience.</p>

    Args:
        conversation_id: <p>The identifier of the Amazon Q Business web experience conversation.</p>
        application_id: <p>The identifier for the Amazon Q Business application.</p>
        user_id: <p>The identifier of the user involved in the Amazon Q Business web experience conversation.</p>
        next_token: <p>If the number of messages returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.</p>
        max_results: <p>The maximum number of messages to return.</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.license_not_found_exception.LicenseNotFoundException: <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</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_messages_request.ListMessagesRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.list_messages_response.ListMessagesResponse"
    ]:
        import capo_qbusiness._operations.expert_q.list_messages

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMessages")
    )
    input_: capo_qbusiness.types.list_messages_request.ListMessagesRequest = {
        "conversation_id": conversation_id,
        "application_id": application_id,
    }
    if user_id is not None:
        input_["user_id"] = user_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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