AWS Systems Manager
API Reference (API Version 2014-11-06)

StepExecution

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

Contents

Action

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

Type: String

Pattern: ^aws:[a-zA-Z]{3,25}$

Required: No

ExecutionEndTime

If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

Type: Timestamp

Required: No

ExecutionStartTime

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

Type: Timestamp

Required: No

FailureDetails

Information about the Automation failure.

Type: FailureDetails object

Required: No

FailureMessage

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

Type: String

Required: No

Inputs

Fully-resolved values passed into the step before execution.

Type: String to string map

Required: No

IsCritical

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

Type: Boolean

Required: No

IsEnd

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

Type: Boolean

Required: No

MaxAttempts

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

Type: Integer

Required: No

NextStep

The next step after the step succeeds.

Type: String

Required: No

OnFailure

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

Type: String

Required: No

Outputs

Returned values from the execution of the step.

Type: String to array of strings map

Key Length Constraints: Minimum length of 1. Maximum length of 30.

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

OverriddenParameters

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

Type: String to array of strings map

Key Length Constraints: Minimum length of 1. Maximum length of 30.

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Response

A message associated with the response code for an execution.

Type: String

Required: No

ResponseCode

The response code returned by the execution of the step.

Type: String

Required: No

StepExecutionId

The unique ID of a step execution.

Type: String

Required: No

StepName

The name of this execution step.

Type: String

Required: No

StepStatus

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

Type: String

Valid Values: Pending | InProgress | Waiting | Success | TimedOut | Cancelling | Cancelled | Failed

Required: No

TargetLocation

The combination of AWS Regions and accounts targeted by the current Automation execution.

Type: TargetLocation object

Required: No

Targets

The targets for the step execution.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

TimeoutSeconds

The timeout seconds of the step.

Type: Long

Required: No

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 execute the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 65535.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: