Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

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.

Type: String to array of strings map

Key Length Constraints: Minimum length of 1. Maximum length of 30.

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

SignalType

The type of signal. Valid signal types include the following: Approve and Reject

Type: String

Valid Values: Approve | Reject | StartStep | StopStep | Resume

Required: 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 is not valid for the current Automation execution.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: