stop-automation-execution¶

Description¶

Stop an Automation that is currently running.

Synopsis¶

  stop-automation-execution
--automation-execution-id <value>
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--automation-execution-id (string)

The execution ID of the Automation to stop.

--type (string)

The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

Possible values:

Complete

Cancel

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To stop an automation execution

The following stop-automation-execution example stops an Automation document.

aws ssm stop-automation-execution
    --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"

This command produces no output.

For more information, see Running an Automation Workflow Manually in the AWS Systems Manager User Guide.

Output¶

None

Table of Contents

Feedback

User Guide