Skip to content
SHAMPOO

Tool catalogue

reflect_cancel

Write · Advanced · Reflection

reflect_cancel

  • Category: reflection
  • Access: write
  • Audience: advanced (ordinary users do not normally call this directly)

Purpose

Cancels a pending or running run. Call it before discarding when a run should not proceed; terminal runs are rejected.

Arguments

Required: run_id.

  • run_id.

Result

Object with run_id and status (canceled).

Boundaries

Run access follows the input-project gate: foreign or unfiltered runs read as not-found for non-star callers.

Lifecycle / side effects

Moves a pending or running entry to canceled with an end stamp. Terminal entries are rejected, never rewritten.

Errors

Unknown, discarded, or foreign runs fail as run_not_found. Terminal runs fail as cannot_cancel_terminal_run. Shapes are normal invalid_state_transition payloads.

Example

{
  "run_id": "<uuid>"
}

Result shape:

{
  "run_id": "<uuid>",
  "status": "canceled"
}

See also

reflect_archive, reflect_status, reflect_start, reflect_discard.

On this page