Skip to content

AutomationExecution

Source code in docs_src/capo_ssm/types/automation_execution.py
class AutomationExecution(TypedDict, closed=True):
    automation_execution_id: NotRequired[
        "capo_ssm.types.automation_execution_id.AutomationExecutionId"
    ]
    """<p>The execution ID.</p>"""
    document_name: NotRequired["capo_ssm.types.document_name.DocumentName"]
    """<p>The name of the Automation runbook used during the execution.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The version of the document to use during execution.</p>"""
    execution_start_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time the execution started.</p>"""
    execution_end_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time the execution finished.</p>"""
    automation_execution_status: NotRequired[
        "capo_ssm.types.automation_execution_status.AutomationExecutionStatus"
    ]
    """<p>The execution status of the Automation.</p>"""
    step_executions: NotRequired["capo_ssm.types.step_execution_list.StepExecutionList"]
    """<p>A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.</p>"""
    step_executions_truncated: "capo_ssm.types.boolean.Boolean"
    """<p>A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.</p>"""
    parameters: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>The key-value map of execution parameters, which were supplied when calling <a>StartAutomationExecution</a>.</p>"""
    outputs: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>The list of execution outputs as defined in the Automation runbook.</p>"""
    failure_message: NotRequired["capo_ssm.types.string.String"]
    """<p>A message describing why an execution has failed, if the status is set to Failed.</p>"""
    warning_message: NotRequired["capo_ssm.types.string.String"]
    """<p>A message that describes a non-critical issue that occurred during the automation execution.</p>"""
    mode: NotRequired["capo_ssm.types.execution_mode.ExecutionMode"]
    """<p>The automation execution mode.</p>"""
    parent_automation_execution_id: NotRequired[
        "capo_ssm.types.automation_execution_id.AutomationExecutionId"
    ]
    """<p>The AutomationExecutionId of the parent automation.</p>"""
    executed_by: NotRequired["capo_ssm.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the user who ran the automation.</p>"""
    current_step_name: NotRequired["capo_ssm.types.string.String"]
    """<p>The name of the step that is currently running.</p>"""
    current_action: NotRequired["capo_ssm.types.string.String"]
    """<p>The action of the step that is currently running.</p>"""
    target_parameter_name: NotRequired[
        "capo_ssm.types.automation_parameter_key.AutomationParameterKey"
    ]
    """<p>The parameter name.</p>"""
    targets: NotRequired["capo_ssm.types.targets.Targets"]
    """<p>The specified targets.</p>"""
    target_maps: NotRequired["capo_ssm.types.target_maps.TargetMaps"]
    """<p>The specified key-value mapping of document parameters to target resources.</p>"""
    resolved_targets: NotRequired["capo_ssm.types.resolved_targets.ResolvedTargets"]
    """<p>A list of resolved targets in the rate control execution.</p>"""
    max_concurrency: NotRequired["capo_ssm.types.max_concurrency.MaxConcurrency"]
    """<p>The <code>MaxConcurrency</code> value specified by the user when the execution started.</p>"""
    max_errors: NotRequired["capo_ssm.types.max_errors.MaxErrors"]
    """<p>The MaxErrors value specified by the user when the execution started.</p>"""
    target: NotRequired["capo_ssm.types.string.String"]
    """<p>The target of the execution.</p>"""
    target_locations: NotRequired["capo_ssm.types.target_locations.TargetLocations"]
    """<p>The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.</p>"""
    progress_counters: NotRequired["capo_ssm.types.progress_counters.ProgressCounters"]
    """<p>An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.</p>"""
    alarm_configuration: NotRequired[
        "capo_ssm.types.alarm_configuration.AlarmConfiguration"
    ]
    """<p>The details for the CloudWatch alarm applied to your automation.</p>"""
    triggered_alarms: NotRequired[
        "capo_ssm.types.alarm_state_information_list.AlarmStateInformationList"
    ]
    """<p>The CloudWatch alarm that was invoked by the automation.</p>"""
    target_locations_url: NotRequired[
        "capo_ssm.types.target_locations_url.TargetLocationsURL"
    ]
    """<p>A publicly accessible URL for a file that contains the <code>TargetLocations</code> body. Currently, only files in presigned Amazon S3 buckets are supported</p>"""
    automation_subtype: NotRequired[
        "capo_ssm.types.automation_subtype.AutomationSubtype"
    ]
    """<p>The subtype of the Automation operation. Currently, the only supported value is <code>ChangeRequest</code>.</p>"""
    scheduled_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time the Automation operation is scheduled to start.</p>"""
    runbooks: NotRequired["capo_ssm.types.runbooks.Runbooks"]
    """<p>Information about the Automation runbooks that are run as part of a runbook workflow.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>"""
    ops_item_id: NotRequired["capo_ssm.types.string.String"]
    """<p>The ID of an OpsItem that is created to represent a Change Manager change request.</p>"""
    association_id: NotRequired["capo_ssm.types.string.String"]
    """<p>The ID of a State Manager association used in the Automation operation.</p>"""
    change_request_name: NotRequired[
        "capo_ssm.types.change_request_name.ChangeRequestName"
    ]
    """<p>The name of the Change Manager change request.</p>"""
    variables: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>Variables defined for the automation.</p>"""

alarm_configuration instance-attribute

alarm_configuration: NotRequired[AlarmConfiguration]

The details for the CloudWatch alarm applied to your automation.

association_id instance-attribute

association_id: NotRequired[String]

The ID of a State Manager association used in the Automation operation.

automation_execution_id instance-attribute

automation_execution_id: NotRequired[AutomationExecutionId]

The execution ID.

automation_execution_status instance-attribute

automation_execution_status: NotRequired[AutomationExecutionStatus]

The execution status of the Automation.

automation_subtype instance-attribute

automation_subtype: NotRequired[AutomationSubtype]

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

change_request_name instance-attribute

change_request_name: NotRequired[ChangeRequestName]

The name of the Change Manager change request.

current_action instance-attribute

current_action: NotRequired[String]

The action of the step that is currently running.

current_step_name instance-attribute

current_step_name: NotRequired[String]

The name of the step that is currently running.

document_name instance-attribute

document_name: NotRequired[DocumentName]

The name of the Automation runbook used during the execution.

document_version instance-attribute

document_version: NotRequired[DocumentVersion]

The version of the document to use during execution.

executed_by instance-attribute

executed_by: NotRequired[String]

The Amazon Resource Name (ARN) of the user who ran the automation.

execution_end_time instance-attribute

execution_end_time: NotRequired[DateTime]

The time the execution finished.

execution_start_time instance-attribute

execution_start_time: NotRequired[DateTime]

The time the execution started.

failure_message instance-attribute

failure_message: NotRequired[String]

A message describing why an execution has failed, if the status is set to Failed.

max_concurrency instance-attribute

max_concurrency: NotRequired[MaxConcurrency]

The MaxConcurrency value specified by the user when the execution started.

max_errors instance-attribute

max_errors: NotRequired[MaxErrors]

The MaxErrors value specified by the user when the execution started.

mode instance-attribute

mode: NotRequired[ExecutionMode]

The automation execution mode.

ops_item_id instance-attribute

ops_item_id: NotRequired[String]

The ID of an OpsItem that is created to represent a Change Manager change request.

outputs instance-attribute

outputs: NotRequired[AutomationParameterMap]

The list of execution outputs as defined in the Automation runbook.

parameters instance-attribute

parameters: NotRequired[AutomationParameterMap]

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

parent_automation_execution_id instance-attribute

parent_automation_execution_id: NotRequired[AutomationExecutionId]

The AutomationExecutionId of the parent automation.

progress_counters instance-attribute

progress_counters: NotRequired[ProgressCounters]

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

resolved_targets instance-attribute

resolved_targets: NotRequired[ResolvedTargets]

A list of resolved targets in the rate control execution.

runbooks instance-attribute

runbooks: NotRequired[Runbooks]

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

scheduled_time instance-attribute

scheduled_time: NotRequired[DateTime]

The date and time the Automation operation is scheduled to start.

step_executions instance-attribute

step_executions: NotRequired[StepExecutionList]

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

step_executions_truncated instance-attribute

step_executions_truncated: Boolean

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

target instance-attribute

target: NotRequired[String]

The target of the execution.

target_locations instance-attribute

target_locations: NotRequired[TargetLocations]

The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

target_locations_url instance-attribute

target_locations_url: NotRequired[TargetLocationsURL]

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

target_maps instance-attribute

target_maps: NotRequired[TargetMaps]

The specified key-value mapping of document parameters to target resources.

target_parameter_name instance-attribute

target_parameter_name: NotRequired[AutomationParameterKey]

The parameter name.

targets instance-attribute

targets: NotRequired[Targets]

The specified targets.

triggered_alarms instance-attribute

triggered_alarms: NotRequired[AlarmStateInformationList]

The CloudWatch alarm that was invoked by the automation.

variables instance-attribute

variables: NotRequired[AutomationParameterMap]

Variables defined for the automation.

warning_message instance-attribute

warning_message: NotRequired[String]

A message that describes a non-critical issue that occurred during the automation execution.