Skip to content

SendAutomationSignalRequest

Source code in docs_src/capo_ssm/types/send_automation_signal_request.py 
15
16
17
18
19
20
21
22
23
24
25
class SendAutomationSignalRequest(TypedDict, closed=True):
    automation_execution_id: (
        "capo_ssm.types.automation_execution_id.AutomationExecutionId"
    )
    """<p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>"""
    signal_type: "capo_ssm.types.signal_type.SignalType"
    """<p>The type of signal to send to an Automation execution. </p>"""
    payload: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p> <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional comment that you can send with the signal type. For example:</p> <p> <code>Comment="Looks good"</code> </p> <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of the Automation step to start or resume as the payload. For example:</p> <p> <code>StepName="step1"</code> </p> <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p> <p> <code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code> </p>"""

automation_execution_id instance-attribute 

automation_execution_id: AutomationExecutionId

The unique identifier for an existing Automation execution that you want to send the signal to.

payload instance-attribute 

payload: NotRequired[AutomationParameterMap]

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

signal_type instance-attribute 

signal_type: SignalType

The type of signal to send to an Automation execution.