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
- Struct
- Aws::SSM::Types::StepExecution
- Defined in:
- (unknown)
Overview
Detailed information about an the execution state of an Automation step.
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.
-
#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 AWS Regions and 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.
-
#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.
#execution_end_time ⇒ Time
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.
#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 is not populated.
#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. The default value is 1.
#next_step ⇒ String
The next step after the step succeeds.
#on_failure ⇒ String
The action to take if the step fails. The default value is Abort.
#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.
#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.
Possible values:
- Pending
- InProgress
- Waiting
- Success
- TimedOut
- Cancelling
- Cancelled
- Failed
#target_location ⇒ Types::TargetLocation
The combination of AWS Regions and 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.
#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.