Skip to content

StepExecution

Source code in docs_src/capo_ssm/types/step_execution.py
class StepExecution(TypedDict, closed=True):
    step_name: NotRequired["capo_ssm.types.string.String"]
    """<p>The name of this execution step.</p>"""
    action: NotRequired["capo_ssm.types.automation_action_name.AutomationActionName"]
    """<p>The action this step performs. The action determines the behavior of the step.</p>"""
    timeout_seconds: NotRequired["capo_ssm.types.long.Long"]
    """<p>The timeout seconds of the step.</p>"""
    on_failure: NotRequired["capo_ssm.types.string.String"]
    """<p>The action to take if the step fails. The default value is <code>Abort</code>.</p>"""
    max_attempts: NotRequired["capo_ssm.types.integer.Integer"]
    """<p>The maximum number of tries to run the action of the step. The default value is <code>1</code>.</p>"""
    execution_start_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.</p>"""
    execution_end_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.</p>"""
    step_status: NotRequired[
        "capo_ssm.types.automation_execution_status.AutomationExecutionStatus"
    ]
    """<p>The execution status for this step.</p>"""
    response_code: NotRequired["capo_ssm.types.string.String"]
    """<p>The response code returned by the execution of the step.</p>"""
    inputs: NotRequired["capo_ssm.types.normal_string_map.NormalStringMap"]
    """<p>Fully-resolved values passed into the step before execution.</p>"""
    outputs: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>Returned values from the execution of the step.</p>"""
    response: NotRequired["capo_ssm.types.string.String"]
    """<p>A message associated with the response code for an execution.</p>"""
    failure_message: NotRequired["capo_ssm.types.string.String"]
    """<p>If a step failed, this message explains why the execution failed.</p>"""
    warning_message: NotRequired["capo_ssm.types.string.String"]
    """<p>A message that describes a non-critical issue that occurred during the step execution. Present only if the step status includes a warning.</p>"""
    failure_details: NotRequired["capo_ssm.types.failure_details.FailureDetails"]
    """<p>Information about the Automation failure.</p>"""
    step_execution_id: NotRequired["capo_ssm.types.string.String"]
    """<p>The unique ID of a step execution.</p>"""
    overridden_parameters: NotRequired[
        "capo_ssm.types.automation_parameter_map.AutomationParameterMap"
    ]
    """<p>A user-specified list of parameters to override when running a step.</p>"""
    is_end: NotRequired["capo_ssm.types.boolean.Boolean"]
    """<p>The flag which can be used to end automation no matter whether the step succeeds or fails.</p>"""
    next_step: NotRequired["capo_ssm.types.string.String"]
    """<p>The next step after the step succeeds.</p>"""
    is_critical: NotRequired["capo_ssm.types.boolean.Boolean"]
    """<p>The flag which can be used to help decide whether the failure of current step leads to the Automation failure.</p>"""
    valid_next_steps: NotRequired[
        "capo_ssm.types.valid_next_step_list.ValidNextStepList"
    ]
    """<p>Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.</p>"""
    targets: NotRequired["capo_ssm.types.targets.Targets"]
    """<p>The targets for the step execution.</p>"""
    target_location: NotRequired["capo_ssm.types.target_location.TargetLocation"]
    """<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.</p>"""
    triggered_alarms: NotRequired[
        "capo_ssm.types.alarm_state_information_list.AlarmStateInformationList"
    ]
    """<p>The CloudWatch alarms that were invoked by the automation.</p>"""
    parent_step_details: NotRequired[
        "capo_ssm.types.parent_step_details.ParentStepDetails"
    ]
    """<p>Information about the parent step.</p>"""

action instance-attribute

action: NotRequired[AutomationActionName]

The action this step performs. The action determines the behavior of the step.

execution_end_time instance-attribute

execution_end_time: NotRequired[DateTime]

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

execution_start_time instance-attribute

execution_start_time: NotRequired[DateTime]

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

failure_details instance-attribute

failure_details: NotRequired[FailureDetails]

Information about the Automation failure.

failure_message instance-attribute

failure_message: NotRequired[String]

If a step failed, this message explains why the execution failed.

inputs instance-attribute

inputs: NotRequired[NormalStringMap]

Fully-resolved values passed into the step before execution.

is_critical instance-attribute

is_critical: NotRequired[Boolean]

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

is_end instance-attribute

is_end: NotRequired[Boolean]

The flag which can be used to end automation no matter whether the step succeeds or fails.

max_attempts instance-attribute

max_attempts: NotRequired[Integer]

The maximum number of tries to run the action of the step. The default value is 1.

next_step instance-attribute

next_step: NotRequired[String]

The next step after the step succeeds.

on_failure instance-attribute

on_failure: NotRequired[String]

The action to take if the step fails. The default value is Abort.

outputs instance-attribute

outputs: NotRequired[AutomationParameterMap]

Returned values from the execution of the step.

overridden_parameters instance-attribute

overridden_parameters: NotRequired[AutomationParameterMap]

A user-specified list of parameters to override when running a step.

parent_step_details instance-attribute

parent_step_details: NotRequired[ParentStepDetails]

Information about the parent step.

response instance-attribute

response: NotRequired[String]

A message associated with the response code for an execution.

response_code instance-attribute

response_code: NotRequired[String]

The response code returned by the execution of the step.

step_execution_id instance-attribute

step_execution_id: NotRequired[String]

The unique ID of a step execution.

step_name instance-attribute

step_name: NotRequired[String]

The name of this execution step.

step_status instance-attribute

step_status: NotRequired[AutomationExecutionStatus]

The execution status for this step.

target_location instance-attribute

target_location: NotRequired[TargetLocation]

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

targets instance-attribute

targets: NotRequired[Targets]

The targets for the step execution.

timeout_seconds instance-attribute

timeout_seconds: NotRequired[Long]

The timeout seconds of the step.

triggered_alarms instance-attribute

triggered_alarms: NotRequired[AlarmStateInformationList]

The CloudWatch alarms that were invoked by the automation.

valid_next_steps instance-attribute

valid_next_steps: NotRequired[ValidNextStepList]

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

warning_message instance-attribute

warning_message: NotRequired[String]

A message that describes a non-critical issue that occurred during the step execution. Present only if the step status includes a warning.