Documentation

Detailed information about an the execution state of an Automation step.

See: newStepExecution smart constructor.

Create a value of StepExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:action:StepExecution', stepExecution_action - The action this step performs. The action determines the behavior of the step.

$sel:executionEndTime:StepExecution', stepExecution_executionEndTime - 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.

$sel:executionStartTime:StepExecution', stepExecution_executionStartTime - 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.

$sel:failureDetails:StepExecution', stepExecution_failureDetails - Information about the Automation failure.

$sel:failureMessage:StepExecution', stepExecution_failureMessage - If a step failed, this message explains why the execution failed.

$sel:inputs:StepExecution', stepExecution_inputs - Fully-resolved values passed into the step before execution.

$sel:isCritical:StepExecution', stepExecution_isCritical - The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

$sel:isEnd:StepExecution', stepExecution_isEnd - The flag which can be used to end automation no matter whether the step succeeds or fails.

$sel:maxAttempts:StepExecution', stepExecution_maxAttempts - The maximum number of tries to run the action of the step. The default value is 1.

$sel:nextStep:StepExecution', stepExecution_nextStep - The next step after the step succeeds.

$sel:onFailure:StepExecution', stepExecution_onFailure - The action to take if the step fails. The default value is Abort.

$sel:outputs:StepExecution', stepExecution_outputs - Returned values from the execution of the step.

$sel:overriddenParameters:StepExecution', stepExecution_overriddenParameters - A user-specified list of parameters to override when running a step.

$sel:response:StepExecution', stepExecution_response - A message associated with the response code for an execution.

$sel:responseCode:StepExecution', stepExecution_responseCode - The response code returned by the execution of the step.

$sel:stepExecutionId:StepExecution', stepExecution_stepExecutionId - The unique ID of a step execution.

$sel:stepName:StepExecution', stepExecution_stepName - The name of this execution step.

$sel:stepStatus:StepExecution', stepExecution_stepStatus - The execution status for this step.

$sel:targetLocation:StepExecution', stepExecution_targetLocation - The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

$sel:targets:StepExecution', stepExecution_targets - The targets for the step execution.

$sel:timeoutSeconds:StepExecution', stepExecution_timeoutSeconds - The timeout seconds of the step.

$sel:triggeredAlarms:StepExecution', stepExecution_triggeredAlarms - The CloudWatch alarms that were invoked by the automation.

$sel:validNextSteps:StepExecution', stepExecution_validNextSteps - 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.

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

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.

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.

Information about the Automation failure.

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

Fully-resolved values passed into the step before execution.

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

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

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

The next step after the step succeeds.

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

Returned values from the execution of the step.

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

A message associated with the response code for an execution.

The response code returned by the execution of the step.

The unique ID of a step execution.

The name of this execution step.

The execution status for this step.

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

The targets for the step execution.

The timeout seconds of the step.

The CloudWatch alarms that were invoked by the automation.

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.