Class: Aws::SSM::Types::StepExecution
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::StepExecution
- Defined in:
- gems/aws-sdk-ssm/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
-
#action ⇒ String
The action this step performs.
-
#execution_end_time ⇒ Time
If a step has finished execution, this contains the time the execution ended.
-
#execution_start_time ⇒ Time
If a step has begun execution, this contains the time the step started.
-
#failure_details ⇒ Types::FailureDetails
Information about the Automation failure.
-
#failure_message ⇒ String
If a step failed, this message explains why the execution failed.
-
#inputs ⇒ Hash<String,String>
Fully-resolved values passed into the step before execution.
-
#is_critical ⇒ Boolean
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
-
#is_end ⇒ Boolean
The flag which can be used to end automation no matter whether the step succeeds or fails.
-
#max_attempts ⇒ Integer
The maximum number of tries to run the action of the step.
-
#next_step ⇒ String
The next step after the step succeeds.
-
#on_failure ⇒ String
The action to take if the step fails.
-
#outputs ⇒ Hash<String,Array<String>>
Returned values from the execution of the step.
-
#overridden_parameters ⇒ Hash<String,Array<String>>
A user-specified list of parameters to override when running a step.
-
#parent_step_details ⇒ Types::ParentStepDetails
Information about the parent step.
-
#response ⇒ String
A message associated with the response code for an execution.
-
#response_code ⇒ String
The response code returned by the execution of the step.
-
#step_execution_id ⇒ String
The unique ID of a step execution.
-
#step_name ⇒ String
The name of this execution step.
-
#step_status ⇒ String
The execution status for this step.
-
#target_location ⇒ Types::TargetLocation
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
-
#targets ⇒ Array<Types::Target>
The targets for the step execution.
-
#timeout_seconds ⇒ Integer
The timeout seconds of the step.
-
#triggered_alarms ⇒ Array<Types::AlarmStateInformation>
The CloudWatch alarms that were invoked by the automation.
-
#valid_next_steps ⇒ Array<String>
Strategies used when step fails, we support Continue and Abort.
Instance Attribute Details
#action ⇒ String
The action this step performs. The action determines the behavior of the step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#execution_end_time ⇒ Time
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.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#execution_start_time ⇒ Time
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.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#failure_details ⇒ Types::FailureDetails
Information about the Automation failure.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#failure_message ⇒ String
If a step failed, this message explains why the execution failed.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#inputs ⇒ Hash<String,String>
Fully-resolved values passed into the step before execution.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#is_critical ⇒ Boolean
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#is_end ⇒ Boolean
The flag which can be used to end automation no matter whether the step succeeds or fails.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#max_attempts ⇒ Integer
The maximum number of tries to run the action of the step. The
default value is 1
.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#next_step ⇒ String
The next step after the step succeeds.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#on_failure ⇒ String
The action to take if the step fails. The default value is Abort
.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#outputs ⇒ Hash<String,Array<String>>
Returned values from the execution of the step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#overridden_parameters ⇒ Hash<String,Array<String>>
A user-specified list of parameters to override when running a step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#parent_step_details ⇒ Types::ParentStepDetails
Information about the parent step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#response ⇒ String
A message associated with the response code for an execution.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#response_code ⇒ String
The response code returned by the execution of the step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#step_execution_id ⇒ String
The unique ID of a step execution.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#step_name ⇒ String
The name of this execution step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#step_status ⇒ String
The execution status for this step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#target_location ⇒ Types::TargetLocation
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The targets for the step execution.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#timeout_seconds ⇒ Integer
The timeout seconds of the step.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#triggered_alarms ⇒ Array<Types::AlarmStateInformation>
The CloudWatch alarms that were invoked by the automation.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |
#valid_next_steps ⇒ Array<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.
17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17816 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, :triggered_alarms, :parent_step_details) SENSITIVE = [] include Aws::Structure end |