SSM / Client / send_automation_signal

send_automation_signal

SSM.Client.send_automation_signal(**kwargs)

Sends a signal to an Automation execution to change the current behavior or status of the execution.

See also: AWS API Documentation

Request Syntax

response = client.send_automation_signal(
    AutomationExecutionId='string',
    SignalType='Approve'|'Reject'|'StartStep'|'StopStep'|'Resume',
    Payload={
        'string': [
            'string',
        ]
    }
)

Parameters:

• AutomationExecutionId (string) –

  [REQUIRED]

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

• SignalType (string) –

  [REQUIRED]

  The type of signal to send to an Automation execution.

• Payload (dict) –

  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"

  • (string) –

    • (list) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• SSM.Client.exceptions.AutomationExecutionNotFoundException

• SSM.Client.exceptions.AutomationStepNotFoundException

• SSM.Client.exceptions.InvalidAutomationSignalException

• SSM.Client.exceptions.InternalServerError