Initializing help system before first use

# xpressinsight.scenario.InsightRestClient.wait_for_scenario

Purpose
Wait until any queued or in-progress scenario execution has completed.
Synopsis
`xpressinsight.scenario.InsightRestClient.wait_for_scenario(self, scenario_id: str, timeout: datetime.timedelta) -> None`
Arguments

scenario_id | The ID of the scenario being executed.
timeout | Amount of time to wait for scenario to complete.

Return value

This function may raise the following errors:

scenario.ScenarioTimeOutError

  If the Insight scenario execution did not complete within the given wait time.

scenario.InsightServerError

  If the REST client credentials do not have permission to perform this operation, or there is an issue communicating with the Insight server.

Example
Wait up to 30 minutes for the scenario to complete.

    >>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
    ...     client.wait_for_scenario('570b9100-46e3-4643-baee-2e24aa538f25',
    ...                              timedelta(minutes=30))

Further information
1. The method wait_for_scenario is part of the class xpressinsight.scenario.InsightRestClient.
2. If the scenario is still queued or executing after the timeout period has elapsed, ScenarioTimeOutError is raised.
3. If the scenario is not queued or executing when this function is called, it returns immediately.
Related topics
scenario.InsightRestClient.execute_scenario,
scenario.InsightRestClient.is_scenario_executing
Parent Topic Insight Scenario REST API client

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.