QConnect / Paginator / ListMessages

ListMessages

class QConnect.Paginator.ListMessages

paginator = client.get_paginator('list_messages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QConnect.Client.list_messages().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• assistantId (string) –

  [REQUIRED]

  The identifier of the Amazon Q in Connect assistant.

• sessionId (string) –

  [REQUIRED]

  The identifier of the Amazon Q in Connect session.

• 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

{
    'messages': [
        {
            'messageId': 'string',
            'participant': 'CUSTOMER'|'AGENT'|'BOT',
            'timestamp': datetime(2015, 1, 1),
            'value': {
                'text': {
                    'value': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • messages (list) –

    The message information.

    • (dict) –

      The message output.

      • messageId (string) –

        The identifier of a message.

      • participant (string) –

        The participant of a message.

      • timestamp (datetime) –

        The timestamp of a message.

      • value (dict) –

        The value of a message data.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: text. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • text (dict) –

          The message data in text type.

          • value (string) –

            The value of the message data in text type.

  • NextToken (string) –

    A token to resume pagination.