QApps / Client / stop_q_app_session

stop_q_app_session#

QApps.Client.stop_q_app_session(**kwargs)#

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

See also: AWS API Documentation

Request Syntax

response = client.stop_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 stop.

Returns:

None

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