QApps / Client / start_q_app_session

start_q_app_session

QApps.Client.start_q_app_session(**kwargs)

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Note

Each Q App session will be condensed into a single conversation in the web experience.

See also: AWS API Documentation

Request Syntax

response = client.start_q_app_session(
    instanceId='string',
    appId='string',
    appVersion=123,
    initialValues=[
        {
            'cardId': 'string',
            'value': 'string',
            'submissionMutation': {
                'submissionId': 'string',
                'mutationType': 'edit'|'delete'|'add'
            }
        },
    ],
    sessionId='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• instanceId (string) –

  [REQUIRED]

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

• appId (string) –

  [REQUIRED]

  The unique identifier of the Q App to start a session for.

• appVersion (integer) –

  [REQUIRED]

  The version of the Q App to use for the session.

• initialValues (list) –

  Optional initial input values to provide for 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.

• sessionId (string) – The unique identifier of the a Q App session.

• tags (dict) –

  Optional tags to associate with the new Q App session.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • sessionId (string) –

    The unique identifier of the new or retrieved Q App session.

  • sessionArn (string) –

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

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