Skip to content

stop_q_app_session 

stop_q_app_session(
    instance_id: InstanceId,
    session_id: UUID,
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None

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.

Parameters:

  • instance_id (InstanceId) –

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

  • session_id (UUID) –

    The unique identifier of the Q App session to stop.

Raises:

Source code in docs_src/capo_qapps/_services/q_apps.py 
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
def stop_q_app_session(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    session_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None:
    """<p>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.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        session_id: <p>The unique identifier of the Q App session to stop.</p>

    Raises:
        capo_qapps.errors.access_denied_exception.AccessDeniedException: <p>The client is not authorized to perform the requested operation.</p>
        capo_qapps.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred while processing the request.</p>
        capo_qapps.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_qapps.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
        capo_qapps.errors.throttling_exception.ThrottlingException: <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
        capo_qapps.errors.unauthorized_exception.UnauthorizedException: <p>The client is not authenticated or authorized to perform the requested operation.</p>
        capo_qapps.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by the service.</p>
        capo_qapps.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.stop_q_app_session_input.StopQAppSessionInput]",
    ) -> OperationResponse[None]:
        import capo_qapps._operations.q_apps_service.stop_q_app_session

        output, http_response = (
            capo_qapps._operations.q_apps_service.stop_q_app_session.stop_q_app_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopQAppSession")
    )
    input_: capo_qapps.types.stop_q_app_session_input.StopQAppSessionInput = {
        "instance_id": instance_id,
        "session_id": session_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output