Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

send-automation-signal

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-automation-signal
--automation-execution-id <value>
--signal-type <value>
[--payload <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--automation-execution-id (string)

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

--signal-type (string)

The type of signal to send to an Automation execution.

Possible values:

  • Approve
  • Reject
  • StartStep
  • StopStep
  • Resume

--payload (map)

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"

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To send a signal to an Automation execution

This example sends the Approve signal to an Automation execution. There is no output if the command succeeds.

Command:

aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Approve"

To send an approve signal with a comment to an Automation execution

This example sends the Approve signal with a comment to an Automation execution. There is no output if the command succeeds.

Command:

aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Approve" --payload "Comment=Approved"

To start an Automation step

This example starts the specified step in an Automation execution. There is no output if the command succeeds.

Command:

aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "StartStep" --payload "StepName=stopInstances"

To resume an Automation step

This example resumes the specified step in an Automation execution. There is no output if the command succeeds.

Command:

aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Resume" --payload "StepName=stopInstances"

To stop an Automation step

This example stops the specified step that is currently in progress within an Automation execution. There is no output if the command succeeds.

Command:

aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "StopStep" --payload "StepExecutionId=35de5ba9-e3de-45ae-8c95-0123456789ab"

Output