QApps / Client / get_q_app_session

get_q_app_session#

QApps.Client.get_q_app_session(**kwargs)#

Retrieves the current state and results for an active session of an Amazon Q App.

See also: AWS API Documentation

Request Syntax

response = client.get_q_app_session(
    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 session to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'sessionArn': 'string',
    'status': 'IN_PROGRESS'|'WAITING'|'COMPLETED',
    'cardStatus': {
        'string': {
            'currentState': 'IN_PROGRESS'|'WAITING'|'COMPLETED',
            'currentValue': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • sessionId (string) –

      The unique identifier of the Q App session.

    • sessionArn (string) –

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

    • status (string) –

      The current status of the Q App session.

    • cardStatus (dict) –

      The current status for each card in the Q App session.

      • (string) –

        • (dict) –

          The current status and value of a card in an active Amazon Q App session.

          • currentState (string) –

            The current state of the card.

          • currentValue (string) –

            The current value or result associated with the card.

Exceptions