QApps / Client / get_q_app_session_metadata

get_q_app_session_metadata#

QApps.Client.get_q_app_session_metadata(**kwargs)#

Retrieves the current configuration of a Q App session.

See also: AWS API Documentation

Request Syntax

response = client.get_q_app_session_metadata(
    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.

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'sessionArn': 'string',
    'sessionName': 'string',
    'sharingConfiguration': {
        'enabled': True|False,
        'acceptResponses': True|False,
        'revealCards': True|False
    },
    'sessionOwner': True|False
}

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.

    • sessionName (string) –

      The name of the Q App session.

    • sharingConfiguration (dict) –

      The sharing configuration of the Q App data collection session.

      • enabled (boolean) –

        Indicates whether an Q App session is shareable with other users.

      • acceptResponses (boolean) –

        Indicates whether an Q App session can accept responses from users.

      • revealCards (boolean) –

        Indicates whether collected responses for an Q App session are revealed for all users.

    • sessionOwner (boolean) –

      Indicates whether the current user is the owner of the Q App session.

Exceptions