strands.interrupt

Human-in-the-loop interrupt system for agent workflows.

Interrupt

@dataclass
class Interrupt()

Represents an interrupt that can pause agent execution for human-in-the-loop workflows.

Attributes:

id - Unique identifier.
name - User defined name.
reason - User provided reason for raising the interrupt.
response - Human response provided when resuming the agent after an interrupt.

def to_dict() -> dict[str, Any]

Serialize to dict for session management.

class InterruptException(Exception)

Exception raised when human input is required.

def __init__(interrupt: Interrupt) -> None

Set the interrupt.

@dataclass
class _InterruptState()

Track the state of interrupt events raised by the user.

Note, interrupt state is cleared after resuming.

Attributes:

def activate() -> None

Activate the interrupt state.

def deactivate() -> None

Deacitvate the interrupt state.

Interrupts and context are cleared.

def resume(prompt: "AgentInput") -> None

Configure the interrupt state if resuming from an interrupt event.

Arguments:

Raises:

def to_dict() -> dict[str, Any]

Serialize to dict for session management.

@classmethod
def from_dict(cls, data: dict[str, Any]) -> "_InterruptState"

Initiailize interrupt state from serialized interrupt state.

Interrupt state can be serialized with the to_dict method.