Skip to content

AutomationExecutionMetadata

Source code in docs_src/capo_ssm/types/automation_execution_metadata.py
class AutomationExecutionMetadata(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 execution.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The document version used during the execution.</p>"""
    automation_execution_status: NotRequired[
        "capo_ssm.types.automation_execution_status.AutomationExecutionStatus"
    ]
    """<p>The status of the 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. This isn't populated if the execution is still in progress.</p>"""
    executed_by: NotRequired["capo_ssm.types.string.String"]
    """<p>The IAM role ARN of the user who ran the automation.</p>"""
    log_file: NotRequired["capo_ssm.types.string.String"]
    """<p>An S3 bucket where execution information is stored.</p>"""
    outputs: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>The list of execution outputs as defined in the Automation runbook.</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 execution ID of the parent 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>"""
    failure_message: NotRequired["capo_ssm.types.string.String"]
    """<p>A message that describes a failure that occurred during the automation execution.</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>"""
    target_parameter_name: NotRequired[
        "capo_ssm.types.automation_parameter_key.AutomationParameterKey"
    ]
    """<p>The list of execution outputs as defined in the Automation runbook.</p>"""
    targets: NotRequired["capo_ssm.types.targets.Targets"]
    """<p>The targets defined by the user when starting the automation.</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 targets that resolved during the execution.</p>"""
    max_concurrency: NotRequired["capo_ssm.types.max_concurrency.MaxConcurrency"]
    """<p>The <code>MaxConcurrency</code> value specified by the user when starting the automation.</p>"""
    max_errors: NotRequired["capo_ssm.types.max_errors.MaxErrors"]
    """<p>The <code>MaxErrors</code> value specified by the user when starting the automation.</p>"""
    target: NotRequired["capo_ssm.types.string.String"]
    """<p>The list of execution outputs as defined in the Automation runbook.</p>"""
    automation_type: NotRequired["capo_ssm.types.automation_type.AutomationType"]
    """<p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html">Running automations in multiple Amazon Web Services Regions and accounts</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </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 during a runbook workflow in Change Manager.</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>"""

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 status of the execution.

automation_subtype instance-attribute

automation_subtype: NotRequired[AutomationSubtype]

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

automation_type instance-attribute

automation_type: NotRequired[AutomationType]

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

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 execution.

document_version instance-attribute

document_version: NotRequired[DocumentVersion]

The document version used during the execution.

executed_by instance-attribute

executed_by: NotRequired[String]

The IAM role ARN of the user who ran the automation.

execution_end_time instance-attribute

execution_end_time: NotRequired[DateTime]

The time the execution finished. This isn't populated if the execution is still in progress.

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 that describes a failure that occurred during the automation execution.

log_file instance-attribute

log_file: NotRequired[String]

An S3 bucket where execution information is stored.

max_concurrency instance-attribute

max_concurrency: NotRequired[MaxConcurrency]

The MaxConcurrency value specified by the user when starting the automation.

max_errors instance-attribute

max_errors: NotRequired[MaxErrors]

The MaxErrors value specified by the user when starting the automation.

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.

parent_automation_execution_id instance-attribute

parent_automation_execution_id: NotRequired[AutomationExecutionId]

The execution ID of the parent automation.

resolved_targets instance-attribute

resolved_targets: NotRequired[ResolvedTargets]

A list of targets that resolved during the execution.

runbooks instance-attribute

runbooks: NotRequired[Runbooks]

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

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.

target instance-attribute

target: NotRequired[String]

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

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 list of execution outputs as defined in the Automation runbook.

targets instance-attribute

targets: NotRequired[Targets]

The targets defined by the user when starting the automation.

triggered_alarms instance-attribute

triggered_alarms: NotRequired[AlarmStateInformationList]

The CloudWatch alarm that was invoked by the automation.

warning_message instance-attribute

warning_message: NotRequired[String]

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