AWS System Manager

Start automation execution

Initiate execution of an Automation runbook.

Inputs

Expand All

Field

Type

Description

region [required]

enum

default: us-east-1

documentName [required]

string

The name of the SSM document to run. This can be a public document or a custom document.

parameters

object

The required and optional parameters in the document being run.

targets

object

The target resource for the rate-controlled execution, and a key-value mapping to target resources.

targetParameterName [required]

string

targetValues [required]

[object]

Key

string

User-defined criteria for sending commands that target managed nodes that meet the criteria.

Values

[string]

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer. Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

maxConcurrency

number

The maximum targets allowed to run this task in parallel. Can be a number, such as 10, or a percentage, such as 10%. The default value is 10.

Outputs

Field

Type

Description

automationExecutionId

string

The unique ID of a newly scheduled automation execution.

amzRequestId [required]

string