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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#execution_end_timeTime

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.

Returns:

  • (Time)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  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 isn't populated.

Returns:

  • (Time)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#failure_detailsTypes::FailureDetails

Information about the Automation failure.


18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#inputsHash<String,String>

Fully-resolved values passed into the step before execution.

Returns:

  • (Hash<String,String>)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#is_criticalBoolean

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

Returns:

  • (Boolean)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#is_endBoolean

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

Returns:

  • (Boolean)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  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)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#next_stepString

The next step after the step succeeds.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#on_failureString

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

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#outputsHash<String,Array<String>>

Returned values from the execution of the step.

Returns:

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

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#overridden_parametersHash<String,Array<String>>

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

Returns:

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

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#responseString

A message associated with the response code for an execution.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#response_codeString

The response code returned by the execution of the step.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#step_execution_idString

The unique ID of a step execution.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#step_nameString

The name of this execution step.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#step_statusString

The execution status for this step.

Returns:

  • (String)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#target_locationTypes::TargetLocation

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


18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets for the step execution.

Returns:


18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_secondsInteger

The timeout seconds of the step.

Returns:

  • (Integer)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end

#valid_next_stepsArray<String>

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.

Returns:

  • (Array<String>)

18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
# File 'lib/aws-sdk-ssm/types.rb', line 18957

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,
  :is_end,
  :next_step,
  :is_critical,
  :valid_next_steps,
  :targets,
  :target_location)
  SENSITIVE = []
  include Aws::Structure
end