QBusiness / Paginator / ListConversations

ListConversations

class QBusiness.Paginator.ListConversations

paginator = client.get_paginator('list_conversations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QBusiness.Client.list_conversations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    userId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • 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.

  • NextToken (string) –

    A token to resume pagination.