QApps / Client / update_q_app_session_metadata

update_q_app_session_metadata#

QApps.Client.update_q_app_session_metadata(**kwargs)#

Updates the configuration metadata of a session for a given Q App sessionId.

See also: AWS API Documentation

Request Syntax

response = client.update_q_app_session_metadata(
    instanceId='string',
    sessionId='string',
    sessionName='string',
    sharingConfiguration={
        'enabled': True|False,
        'acceptResponses': True|False,
        'revealCards': True|False
    }
)
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 update configuration for.

  • sessionName (string) – The new name for the Q App session.

  • sharingConfiguration (dict) –

    [REQUIRED]

    The new sharing configuration for the Q App data collection session.

    • enabled (boolean) – [REQUIRED]

      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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • sessionId (string) –

      The unique identifier of the updated Q App session.

    • sessionArn (string) –

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

    • sessionName (string) –

      The new name of the updated Q App session.

    • sharingConfiguration (dict) –

      The new sharing configuration of the updated 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.

Exceptions