StepExecution
¶
Source code in docs_src/capo_ssm/types/step_execution.py
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_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.
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.