QConnect / Client / list_messages

list_messages#

QConnect.Client.list_messages(**kwargs)#

Lists messages on an Amazon Q in Connect session.

See also: AWS API Documentation

Request Syntax

response = client.list_messages(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    sessionId='string'
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • sessionId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect session.

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) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException