SendAutomationSignal
Sends a signal to an Automation execution to change the current behavior or status of the execution.
Request Syntax
{
"AutomationExecutionId": "string",
"Payload": {
"string" : [ "string" ]
},
"SignalType": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AutomationExecutionId
-
The unique identifier for an existing Automation execution that you want to send the signal to.
Type: String
Length Constraints: Fixed length of 36.
Required: Yes
- Payload
-
The data sent with the signal. The data schema depends on the type of signal used in the request.
For
ApproveandRejectsignal types, the payload is an optional comment that you can send with the signal type. For example:Comment="Looks good"For
StartStepandResumesignal types, you must send the name of the Automation step to start or resume as the payload. For example:StepName="step1"For the
StopStepsignal type, you must send the step execution ID as the payload. For example:StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"Type: String to array of strings map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- SignalType
-
The type of signal to send to an Automation execution.
Type: String
Valid Values:
Approve | Reject | StartStep | StopStep | ResumeRequired: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AutomationExecutionNotFoundException
-
There is no automation execution information for the requested automation execution ID.
HTTP Status Code: 400
- AutomationStepNotFoundException
-
The specified step name and execution ID don't exist. Verify the information and try again.
HTTP Status Code: 400
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidAutomationSignalException
-
The signal isn't valid for the current Automation execution.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of SendAutomationSignal.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.SendAutomationSignal
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T162449Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 165
{
"AutomationExecutionId": "b2bc0e75-4d48-4b7b-be9b-0cb5cEXAMPLE",
"SignalType": "StopStep",
"Payload": {
"StepExecutionId": [
"33d93afd-9535-4dd5-a06b-c91bdEXAMPLE"
]
}
}Sample Response
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
