Skip to content

ListMessagesRequest

Source code in docs_src/capo_qbusiness/types/list_messages_request.py
class ListMessagesRequest(TypedDict, closed=True):
    conversation_id: "capo_qbusiness.types.conversation_id.ConversationId"
    """<p>The identifier of the Amazon Q Business web experience conversation.</p>"""
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier for the Amazon Q Business application.</p>"""
    user_id: NotRequired["capo_qbusiness.types.user_id.UserId"]
    """<p>The identifier of the user involved in the Amazon Q Business web experience conversation.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<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: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_messages.MaxResultsIntegerForListMessages"
    ]
    """<p>The maximum number of messages to return.</p>"""

application_id instance-attribute

application_id: ApplicationId

The identifier for the Amazon Q Business application.

conversation_id instance-attribute

conversation_id: ConversationId

The identifier of the Amazon Q Business web experience conversation.

max_results instance-attribute

max_results: NotRequired[MaxResultsIntegerForListMessages]

The maximum number of messages to return.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the number of messages returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

user_id instance-attribute

user_id: NotRequired[UserId]

The identifier of the user involved in the Amazon Q Business web experience conversation.