software.amazon.awssdk.services.ssm.model

Class StepExecution

java.lang.Object

software.amazon.awssdk.services.ssm.model.StepExecution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StepExecution.Builder,StepExecution>

@Generated(value="software.amazon.awssdk:codegen")
public final class StepExecution
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StepExecution.Builder,StepExecution>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StepExecution.Builder

Method Summary

Modifier and Type	Method and Description
String	action() The action this step performs.
static StepExecution.Builder	builder()
boolean	equals(Object obj)
Instant	executionEndTime() If a step has finished execution, this contains the time the execution ended.
Instant	executionStartTime() If a step has begun execution, this contains the time the step started.
FailureDetails	failureDetails() Information about the Automation failure.
String	failureMessage() If a step failed, this message explains why the execution failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,String>	inputs() Fully-resolved values passed into the step before execution.
Boolean	isCritical() The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
Boolean	isEnd() The flag which can be used to end automation no matter whether the step succeeds or fails.
Integer	maxAttempts() The maximum number of tries to run the action of the step.
String	nextStep() The next step after the step succeeds.
String	onFailure() The action to take if the step fails.
Map<String,List<String>>	outputs() Returned values from the execution of the step.
Map<String,List<String>>	overriddenParameters() A user-specified list of parameters to override when executing a step.
String	response() A message associated with the response code for an execution.
String	responseCode() The response code returned by the execution of the step.
List<SdkField<?>>	sdkFields()
static Class<? extends StepExecution.Builder>	serializableBuilderClass()
String	stepExecutionId() The unique ID of a step execution.
String	stepName() The name of this execution step.
AutomationExecutionStatus	stepStatus() The execution status for this step.
String	stepStatusAsString() The execution status for this step.
TargetLocation	targetLocation() The combination of AWS Regions and accounts targeted by the current Automation execution.
List<Target>	targets() The targets for the step execution.
Long	timeoutSeconds() The timeout seconds of the step.
StepExecution.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<String>	validNextSteps() Strategies used when step fails, we support Continue and Abort.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stepName

public String stepName()

The name of this execution step.

Returns:

The name of this execution step.

action

public String action()

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

Returns:

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

timeoutSeconds

public Long timeoutSeconds()

The timeout seconds of the step.

Returns:

The timeout seconds of the step.

onFailure

public String onFailure()

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

Returns:

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

maxAttempts

public Integer maxAttempts()

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

Returns:

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

executionStartTime

public Instant 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.

Returns:

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.

executionEndTime

public Instant 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.

Returns:

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.

stepStatus

public AutomationExecutionStatus stepStatus()

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

If the service returns an enum value that is not available in the current SDK version, stepStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

Returns:

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

See Also:

AutomationExecutionStatus

stepStatusAsString

public String stepStatusAsString()

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

If the service returns an enum value that is not available in the current SDK version, stepStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

Returns:

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

See Also:

AutomationExecutionStatus

responseCode

public String responseCode()

The response code returned by the execution of the step.

Returns:

The response code returned by the execution of the step.

inputs

public Map<String,String> inputs()

Fully-resolved values passed into the step before execution.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Fully-resolved values passed into the step before execution.

outputs

public Map<String,List<String>> outputs()

Returned values from the execution of the step.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Returned values from the execution of the step.

response

public String response()

A message associated with the response code for an execution.

Returns:

A message associated with the response code for an execution.

failureMessage

public String failureMessage()

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

Returns:

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

failureDetails

public FailureDetails failureDetails()

Information about the Automation failure.

Returns:

Information about the Automation failure.

stepExecutionId

public String stepExecutionId()

The unique ID of a step execution.

Returns:

The unique ID of a step execution.

overriddenParameters

public Map<String,List<String>> overriddenParameters()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

isEnd

public Boolean isEnd()

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

Returns:

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

nextStep

public String nextStep()

The next step after the step succeeds.

Returns:

The next step after the step succeeds.

isCritical

public Boolean isCritical()

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

Returns:

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

validNextSteps

public List<String> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

targets

public List<Target> targets()

The targets for the step execution.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The targets for the step execution.

targetLocation

public TargetLocation targetLocation()

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

Returns:

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

toBuilder

public StepExecution.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StepExecution.Builder,StepExecution>

Returns:

a builder for type T

builder

public static StepExecution.Builder builder()

serializableBuilderClass

public static Class<? extends StepExecution.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.