Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

Initiates execution of an Automation runbook.

post/#X-Amz-Target=AmazonSSM.StartAutomationExecution

Headers

X-Amz-Target'AmazonSSM.StartAutomationExecution' required

Request body

DocumentNamestring required

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Using shared SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.

DocumentVersionstring

The version of the Automation runbook to use for this execution.

Parametersobject

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

ClientTokenstring

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Mode'Auto' | 'Interactive'

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

TargetParameterNamestring

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

TargetMapsTargetMap[]

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

MaxConcurrencystring

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is <code>10</code>.

MaxErrorsstring
<p>The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.</p> <p>Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.</p>

Response

Success

AutomationExecutionIdstring

The unique ID of a newly scheduled automation execution.