ProductionMu Mutation

cancelScenarioSimulation

Topics: Jobs

Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.

Returns

CancelScenarioSimulationPayload!

Arguments

The QUEUED or RUNNING run to cancel

Exact field SDL
"""
Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.
"""
cancelScenarioSimulation(
  """The QUEUED or RUNNING run to cancel"""
  id: ScenarioSimulationRunID!
): CancelScenarioSimulationPayload! @topic(names: ["jobs"])

Declared on Mutation. Access is checked by the platform for each operation.