SendAutomationSignalCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, SendAutomationSignalCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, SendAutomationSignalCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // SendAutomationSignalRequest
  AutomationExecutionId: "STRING_VALUE", // required
  SignalType: "Approve" || "Reject" || "StartStep" || "StopStep" || "Resume", // required
  Payload: { // AutomationParameterMap
    "<keys>": [ // AutomationParameterValueList
      "STRING_VALUE",
    ],
  },
};
const command = new SendAutomationSignalCommand(input);
const response = await client.send(command);
// {};

SendAutomationSignalCommand Input

See SendAutomationSignalCommandInput for more details

Parameter
Type
Description
AutomationExecutionId
Required
string | undefined

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

SignalType
Required
SignalType | undefined

The type of signal to send to an Automation execution.

Payload
Record<string, string[]> | undefined

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"

SendAutomationSignalCommand Output

See SendAutomationSignalCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AutomationExecutionNotFoundException
client

There is no automation execution information for the requested automation execution ID.

AutomationStepNotFoundException
client

The specified step name and execution ID don't exist. Verify the information and try again.

InternalServerError
server

An error occurred on the server side.

InvalidAutomationSignalException
client

The signal isn't valid for the current Automation execution.

SSMServiceException
Base exception class for all service exceptions from SSM service.