You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::StepExecution

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Returns:

  • (String)

    The action this step performs.

#execution_end_timeTime

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:

  • (Time)

    If a step has finished execution, this contains the time the execution ended.

#execution_start_timeTime

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:

  • (Time)

    If a step has begun execution, this contains the time the step started.

#failure_detailsTypes::FailureDetails

Information about the Automation failure.

Returns:

#failure_messageString

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

Returns:

  • (String)

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

#inputsHash<String,String>

Fully-resolved values passed into the step before execution.

Returns:

  • (Hash<String,String>)

    Fully-resolved values passed into the step before execution.

#max_attemptsInteger

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

Returns:

  • (Integer)

    The maximum number of tries to run the action of the step.

#on_failureString

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

Returns:

  • (String)

    The action to take if the step fails.

#outputsHash<String,Array<String>>

Returned values from the execution of the step.

Returns:

  • (Hash<String,Array<String>>)

    Returned values from the execution of the step.

#overridden_parametersHash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>)

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

#responseString

A message associated with the response code for an execution.

Returns:

  • (String)

    A message associated with the response code for an execution.

#response_codeString

The response code returned by the execution of the step.

Returns:

  • (String)

    The response code returned by the execution of the step.

#step_execution_idString

The unique ID of a step execution.

Returns:

  • (String)

    The unique ID of a step execution.

#step_nameString

The name of this execution step.

Returns:

  • (String)

    The name of this execution step.

#step_statusString

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

Possible values:

  • Pending
  • InProgress
  • Waiting
  • Success
  • TimedOut
  • Cancelling
  • Cancelled
  • Failed

Returns:

  • (String)

    The execution status for this step.

#timeout_secondsInteger

The timeout seconds of the step.

Returns:

  • (Integer)

    The timeout seconds of the step.