AutomationExecutionPreview - AWS Systems Manager
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

AutomationExecutionPreview

Information about the results of the execution preview.

Contents

Regions

Information about the AWS Regions targeted by the execution preview.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

StepPreviews

Information about the type of impact a runbook step would have on a resource.

  • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

  • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

  • Undetermined: An undetermined step invokes executions performed by another orchestration service like AWS Lambda, AWS Step Functions, or AWS Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

Type: String to integer map

Valid Keys: Mutating | NonMutating | Undetermined

Required: No

TargetPreviews

Information that provides a preview of what the impact of running the specified Automation runbook would be.

Type: Array of TargetPreview objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

TotalAccounts

Information about the AWS accounts that were included in the execution preview.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: