Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm ]

start-execution-preview¶

Description¶

Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.

Synopsis¶

  start-execution-preview
--document-name <value>
[--document-version <value>]
[--execution-inputs <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--document-name (string)

The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.

--document-version (string)

The version of the Automation runbook to run. The default value is $DEFAULT .

--execution-inputs (tagged union structure)

Information about the inputs that can be specified for the preview operation.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Automation.

Automation -> (structure)

Information about the optional inputs that can be specified for an automation execution preview.

Parameters -> (map)

Information about parameters that can be specified for the preview operation.

key -> (string)

value -> (list)

(string)

TargetParameterName -> (string)

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

Targets -> (list)

Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be specified together.

(structure)

An array of search criteria that targets managed nodes using a key-value pair that you specify.

Note
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide .

Supported formats include the following.

For all Systems Manager capabilities:

Key=tag-key,Values=tag-value-1,tag-value-2

For Automation and Change Manager:

Key=tag:tag-key,Values=tag-value

Key=ResourceGroup,Values=resource-group-name

Key=ParameterValues,Values=value-1,value-2,value-3

To target all instances in the Amazon Web Services Region:

Key=AWS::EC2::Instance,Values=*

Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Key=tag:tag-key,Values=tag-value-1,tag-value-2

Key=resource-groups:Name,Values=resource-group-name

Additionally, Maintenance Windows support targeting resource types:

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Key=tag:tag-key,Values=tag-value-1,tag-value-2

To target all instances in the Amazon Web Services Region:

Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide .

Key -> (string)

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

Values -> (list)

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.

(string)

TargetMaps -> (list)

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

(map)

key -> (string)

value -> (list)

(string)

TargetLocations -> (list)

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution preview operation.

(structure)

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

Accounts -> (list)

The Amazon Web Services accounts targeted by the current Automation execution.

(string)

Regions -> (list)

The Amazon Web Services Regions targeted by the current Automation execution.

(string)

TargetLocationMaxConcurrency -> (string)

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

TargetLocationMaxErrors -> (string)

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

ExecutionRoleName -> (string)

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole .

TargetLocationAlarmConfiguration -> (structure)

The details for the CloudWatch alarm you want to apply to an automation or command.

IgnorePollAlarmFailure -> (boolean)

When this value is true , your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false .

Alarms -> (list)

The name of the CloudWatch alarm specified in the configuration.

(structure)

A CloudWatch alarm you apply to an automation or command.

Name -> (string)

The name of your CloudWatch alarm.

IncludeChildOrganizationUnits -> (boolean)

Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false .

ExcludeAccounts -> (list)

Amazon Web Services accounts or organizational units to exclude as expanded targets.

(string)

Targets -> (list)

A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName .

This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.

(structure)

An array of search criteria that targets managed nodes using a key-value pair that you specify.

Note
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide .

Supported formats include the following.

For all Systems Manager capabilities:

Key=tag-key,Values=tag-value-1,tag-value-2

For Automation and Change Manager:

Key=tag:tag-key,Values=tag-value

Key=ResourceGroup,Values=resource-group-name

Key=ParameterValues,Values=value-1,value-2,value-3

To target all instances in the Amazon Web Services Region:

Key=AWS::EC2::Instance,Values=*

Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Key=tag:tag-key,Values=tag-value-1,tag-value-2

Key=resource-groups:Name,Values=resource-group-name

Additionally, Maintenance Windows support targeting resource types:

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Key=tag:tag-key,Values=tag-value-1,tag-value-2

To target all instances in the Amazon Web Services Region:

Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide .

Key -> (string)

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

Values -> (list)

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.

(string)

TargetsMaxConcurrency -> (string)

The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.

TargetsMaxErrors -> (string)

The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.

TargetLocationsURL -> (string)

A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported.

JSON Syntax:

{
  "Automation": {
    "Parameters": {"string": ["string", ...]
      ...},
    "TargetParameterName": "string",
    "Targets": [
      {
        "Key": "string",
        "Values": ["string", ...]
      }
      ...
    ],
    "TargetMaps": [
      {"string": ["string", ...]
        ...}
      ...
    ],
    "TargetLocations": [
      {
        "Accounts": ["string", ...],
        "Regions": ["string", ...],
        "TargetLocationMaxConcurrency": "string",
        "TargetLocationMaxErrors": "string",
        "ExecutionRoleName": "string",
        "TargetLocationAlarmConfiguration": {
          "IgnorePollAlarmFailure": true|false,
          "Alarms": [
            {
              "Name": "string"
            }
            ...
          ]
        },
        "IncludeChildOrganizationUnits": true|false,
        "ExcludeAccounts": ["string", ...],
        "Targets": [
          {
            "Key": "string",
            "Values": ["string", ...]
          }
          ...
        ],
        "TargetsMaxConcurrency": "string",
        "TargetsMaxErrors": "string"
      }
      ...
    ],
    "TargetLocationsURL": "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.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

ExecutionPreviewId -> (string)

The ID of the execution preview generated by the system.

Table Of Contents

Feedback

User Guide

Note:

start-execution-preview¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Output¶