QApps / Client / update_q_app_session

update_q_app_session#

QApps.Client.update_q_app_session(**kwargs)#

Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

See also: AWS API Documentation

Request Syntax

response = client.update_q_app_session(
    instanceId='string',
    sessionId='string',
    values=[
        {
            'cardId': 'string',
            'value': 'string',
            'submissionMutation': {
                'submissionId': 'string',
                'mutationType': 'edit'|'delete'|'add'
            }
        },
    ]
)
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 provide input for.

  • values (list) –

    The input values to provide for the current state of the Q App session.

    • (dict) –

      The value or result associated with a card in a Amazon Q App session.

      • cardId (string) – [REQUIRED]

        The unique identifier of the card.

      • value (string) – [REQUIRED]

        The value or result associated with the card.

      • submissionMutation (dict) –

        The structure that describes how the current form card value is mutated. Only applies for form cards when multiple responses are allowed.

        • submissionId (string) – [REQUIRED]

          The unique identifier of the submission.

        • mutationType (string) – [REQUIRED]

          The operation that is performed on a submission.

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'sessionArn': 'string'
}

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.

Exceptions