QApps / Client / list_q_app_session_data

list_q_app_session_data

QApps.Client.list_q_app_session_data(**kwargs)

Lists the collected data of a Q App data collection session.

See also: AWS API Documentation

Request Syntax

response = client.list_q_app_session_data(
    instanceId='string',
    sessionId='string'
)

Parameters:

• instanceId (string) –

  [REQUIRED]

  The unique identifier of the Amazon Q Business application environment instance.

• sessionId (string) –

  [REQUIRED]

  The unique identifier of the Q App data collection session.

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'sessionArn': 'string',
    'sessionData': [
        {
            'cardId': 'string',
            'value': {...}|[...]|123|123.4|'string'|True|None,
            'user': {
                'userId': 'string'
            },
            'submissionId': 'string',
            'timestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • sessionId (string) –

    The unique identifier of the Q App data collection session.

  • sessionArn (string) –

    The Amazon Resource Name (ARN) of the Q App data collection session.

  • sessionData (list) –

    The collected responses of a Q App session.

    • (dict) –

      The response collected for a Amazon Q App session. This container represents a single response to a Q App session.

      • cardId (string) –

        The card Id associated with the response submitted for a Q App session.

      • value (document) –

        The response submitted for a Q App session.

      • user (dict) –

        The user who submitted the response for a Q App session.

        • userId (string) –

          The unique identifier of a user.

      • submissionId (string) –

        The unique identifier of the submission.

      • timestamp (datetime) –

        The date and time when the session data is submitted.

  • nextToken (string) –

    The pagination token that indicates the next set of results to retrieve.

Exceptions

• QApps.Client.exceptions.ResourceNotFoundException

• QApps.Client.exceptions.AccessDeniedException

• QApps.Client.exceptions.ValidationException

• QApps.Client.exceptions.InternalServerException

• QApps.Client.exceptions.UnauthorizedException

• QApps.Client.exceptions.ServiceQuotaExceededException

• QApps.Client.exceptions.ThrottlingException