/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AutomationExecutionId": "string",
    "SignalType": "Approve",
    "Payload": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    }
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

AutomationExecutionId

string

required

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

>= 36 characters<= 36 characters

SignalType

enum<string>

required

The type of signal to send to an Automation execution.

Allowed values:

ApproveRejectStartStepStopStepResume

Payload

object

optional

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"

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480AutomationExecutionNotFoundException

🟠481AutomationStepNotFoundException

🟠482InvalidAutomationSignalException

🟠483InternalServerError