Skip to content

AutomationExecutionPreview

Source code in docs_src/capo_ssm/types/automation_execution_preview.py
class AutomationExecutionPreview(TypedDict, closed=True):
    step_previews: NotRequired["capo_ssm.types.step_preview_map.StepPreviewMap"]
    """<p>Information about the type of impact a runbook step would have on a resource.</p> <ul> <li> <p> <code>Mutating</code>: The runbook step would make changes to the targets through actions that create, modify, or delete resources.</p> </li> <li> <p> <code>Non_Mutating</code>: The runbook step would retrieve data about resources but not make changes to them. This category generally includes <code>Describe*</code>, <code>List*</code>, <code>Get*</code>, and similar read-only API actions.</p> </li> <li> <p> <code>Undetermined</code>: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services 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.</p> </li> </ul>"""
    regions: NotRequired["capo_ssm.types.region_list.RegionList"]
    """<p>Information about the Amazon Web Services Regions targeted by the execution preview.</p>"""
    target_previews: NotRequired["capo_ssm.types.target_preview_list.TargetPreviewList"]
    """<p>Information that provides a preview of what the impact of running the specified Automation runbook would be.</p>"""
    total_accounts: "capo_ssm.types.integer.Integer"
    """<p>Information about the Amazon Web Services accounts that were included in the execution preview.</p>"""

regions instance-attribute

regions: NotRequired[RegionList]

Information about the Amazon Web Services Regions targeted by the execution preview.

step_previews instance-attribute

step_previews: NotRequired[StepPreviewMap]

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 Lambda, Step Functions, or Amazon Web Services 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.

target_previews instance-attribute

target_previews: NotRequired[TargetPreviewList]

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

total_accounts instance-attribute

total_accounts: Integer

Information about the Amazon Web Services accounts that were included in the execution preview.