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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

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)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#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)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#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)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#failure_detailsTypes::FailureDetails

Information about the Automation failure.



9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#inputsHash<String,String>

Fully-resolved values passed into the step before execution.

Returns:

  • (Hash<String,String>)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#max_attemptsInteger

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

Returns:

  • (Integer)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#on_failureString

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

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#outputsHash<String,Array<String>>

Returned values from the execution of the step.

Returns:

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


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#overridden_parametersHash<String,Array<String>>

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

Returns:

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


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#responseString

A message associated with the response code for an execution.

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#response_codeString

The response code returned by the execution of the step.

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#step_execution_idString

The unique ID of a step execution.

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#step_nameString

The name of this execution step.

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#step_statusString

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

Returns:

  • (String)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end

#timeout_secondsInteger

The timeout seconds of the step.

Returns:

  • (Integer)


9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9790

class StepExecution < Struct.new(
  :step_name,
  :action,
  :timeout_seconds,
  :on_failure,
  :max_attempts,
  :execution_start_time,
  :execution_end_time,
  :step_status,
  :response_code,
  :inputs,
  :outputs,
  :response,
  :failure_message,
  :failure_details,
  :step_execution_id,
  :overridden_parameters)
  include Aws::Structure
end