Skip to content

Get Execution Preview

ssm_get_execution_preview R Documentation

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources

Description

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

Usage

ssm_get_execution_preview(ExecutionPreviewId)

Arguments

ExecutionPreviewId

[required] The ID of the existing execution preview.

Value

A list with the following syntax: 

list(
  ExecutionPreviewId = "string",
  EndedAt = as.POSIXct(
    "2015-01-01"
  ),
  Status = "Pending"|"InProgress"|"Success"|"Failed",
  StatusMessage = "string",
  ExecutionPreview = list(
    Automation = list(
      StepPreviews = list(
        123
      ),
      Regions = list(
        "string"
      ),
      TargetPreviews = list(
        list(
          Count = 123,
          TargetType = "string"
        )
      ),
      TotalAccounts = 123
    )
  )
)

Request syntax

svc$get_execution_preview(
  ExecutionPreviewId = "string"
)