Start Execution Preview

ssm_start_execution_preview

R Documentation

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

Description

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

Usage

ssm_start_execution_preview(DocumentName, DocumentVersion,
  ExecutionInputs)

Arguments

DocumentName

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

DocumentVersion

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

ExecutionInputs

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

Value

A list with the following syntax:

list(
  ExecutionPreviewId = "string"
)

Request syntax

svc$start_execution_preview(
  DocumentName = "string",
  DocumentVersion = "string",
  ExecutionInputs = list(
    Automation = list(
      Parameters = list(
        list(
          "string"
        )
      ),
      TargetParameterName = "string",
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      TargetMaps = list(
        list(
          list(
            "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"
              )
            )
          ),
          IncludeChildOrganizationUnits = TRUE|FALSE,
          ExcludeAccounts = list(
            "string"
          ),
          Targets = list(
            list(
              Key = "string",
              Values = list(
                "string"
              )
            )
          ),
          TargetsMaxConcurrency = "string",
          TargetsMaxErrors = "string"
        )
      ),
      TargetLocationsURL = "string"
    )
  )
)