Skip to content

SignalWorkflowExecutionInput

Source code in docs_src/capo_swf/types/signal_workflow_execution_input.py
class SignalWorkflowExecutionInput(TypedDict, closed=True):
    domain: "capo_swf.types.domain_name.DomainName"
    """<p>The name of the domain containing the workflow execution to signal.</p>"""
    workflow_id: "capo_swf.types.workflow_id.WorkflowId"
    """<p>The workflowId of the workflow execution to signal.</p>"""
    run_id: NotRequired["capo_swf.types.workflow_run_id_optional.WorkflowRunIdOptional"]
    """<p>The runId of the workflow execution to signal.</p>"""
    signal_name: "capo_swf.types.signal_name.SignalName"
    """<p>The name of the signal. This name must be meaningful to the target workflow.</p>"""
    input: NotRequired["capo_swf.types.data.Data"]
    """<p>Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target workflow execution's history.</p>"""

domain instance-attribute

domain: DomainName

The name of the domain containing the workflow execution to signal.

input instance-attribute

input: NotRequired[Data]

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

run_id instance-attribute

run_id: NotRequired[WorkflowRunIdOptional]

The runId of the workflow execution to signal.

signal_name instance-attribute

signal_name: SignalName

The name of the signal. This name must be meaningful to the target workflow.

workflow_id instance-attribute

workflow_id: WorkflowId

The workflowId of the workflow execution to signal.