QBusiness / Client / list_conversations

list_conversations#

QBusiness.Client.list_conversations(**kwargs)#

Lists one or more Amazon Q Business conversations.

See also: AWS API Documentation

Request Syntax

response = client.list_conversations(
    applicationId='string',
    userId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application.

  • userId (string) – The identifier of the user involved in the Amazon Q Business web experience conversation.

  • nextToken (string) – 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.

  • maxResults (integer) – The maximum number of Amazon Q Business conversations to return.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'conversations': [
        {
            'conversationId': 'string',
            'title': 'string',
            'startTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

    • conversations (list) –

      An array of summary information on the configuration of one or more Amazon Q Business web experiences.

      • (dict) –

        A conversation in an Amazon Q Business application.

        • conversationId (string) –

          The identifier of the Amazon Q Business conversation.

        • title (string) –

          The title of the conversation.

        • startTime (datetime) –

          The start time of the conversation.

Exceptions