QBusiness / Client / list_conversations

list_conversations#

QBusiness.Client.list_conversations(**kwargs)#

Lists one or more Amazon Q conversations.

Request Syntax

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

Parameters:

applicationId (string) –
[REQUIRED]

The identifier of the Amazon Q application.
maxResults (integer) – The maximum number of Amazon Q conversations to return.
nextToken (string) – If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
userId (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- conversations (list) –
  
  An array of summary information on the configuration of one or more Amazon Q web experiences.
  - (dict) –
    
    A conversation in an Amazon Q application.
    - conversationId (string) –
      
      The identifier of the Amazon Q conversation.
    - startTime (datetime) –
      
      The start time of the conversation.
    - title (string) –
      
      The title of the conversation.
- nextToken (string) –
  
  If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.

Exceptions

QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.LicenseNotFoundException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException