Skip to content

ListConversationsRequest

Source code in docs_src/capo_qbusiness/types/list_conversations_request.py 
14
15
16
17
18
19
20
21
22
23
24
class ListConversationsRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of 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 <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.</p>"""
    max_results: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_conversations.MaxResultsIntegerForListConversations"
    ]
    """<p>The maximum number of Amazon Q Business conversations to return.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the Amazon Q Business application.

max_results instance-attribute 

max_results: NotRequired[MaxResultsIntegerForListConversations]

The maximum number of Amazon Q Business conversations to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

user_id instance-attribute 

user_id: NotRequired[UserId]

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