Skip to content

Start Automation Execution

ssm_start_automation_execution R Documentation

Initiates execution of an Automation runbook

Description

Initiates execution of an Automation runbook.

Usage

ssm_start_automation_execution(DocumentName, DocumentVersion,
  Parameters, ClientToken, Mode, TargetParameterName, Targets, TargetMaps,
  MaxConcurrency, MaxErrors, TargetLocations, Tags, AlarmConfiguration)

Arguments

DocumentName

[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 Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

DocumentVersion

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

Parameters

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

ClientToken

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

Mode

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

TargetParameterName

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

Targets

A key-value mapping to target resources. Required if you specify TargetParameterName.

TargetMaps

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

MaxConcurrency

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 10.

MaxErrors

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.

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.

TargetLocations

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

Tags

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • ⁠Key=environment,Value=test⁠

  • ⁠Key=OS,Value=Windows⁠

To add tags to an existing automation, use the add_tags_to_resource operation.

AlarmConfiguration

The CloudWatch alarm you want to apply to your automation.

Value

A list with the following syntax: 

list(
  AutomationExecutionId = "string"
)

Request syntax

svc$start_automation_execution(
  DocumentName = "string",
  DocumentVersion = "string",
  Parameters = list(
    list(
      "string"
    )
  ),
  ClientToken = "string",
  Mode = "Auto"|"Interactive",
  TargetParameterName = "string",
  Targets = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  TargetMaps = list(
    list(
      list(
        "string"
      )
    )
  ),
  MaxConcurrency = "string",
  MaxErrors = "string",
  TargetLocations = list(
    list(
      Accounts = list(
        "string"
      ),
      Regions = list(
        "string"
      ),
      TargetLocationMaxConcurrency = "string",
      TargetLocationMaxErrors = "string",
      ExecutionRoleName = "string",
      TargetLocationAlarmConfiguration = list(
        IgnorePollAlarmFailure = TRUE|FALSE,
        Alarms = list(
          list(
            Name = "string"
          )
        )
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  AlarmConfiguration = list(
    IgnorePollAlarmFailure = TRUE|FALSE,
    Alarms = list(
      list(
        Name = "string"
      )
    )
  )
)