Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.Types.StepExecution

Description

Synopsis

data StepExecution = StepExecution' {
- failureDetails :: Maybe FailureDetails
- isEnd :: Maybe Bool
- inputs :: Maybe (HashMap Text Text)
- stepName :: Maybe Text
- executionEndTime :: Maybe POSIX
- failureMessage :: Maybe Text
- response :: Maybe Text
- action :: Maybe Text
- responseCode :: Maybe Text
- stepStatus :: Maybe AutomationExecutionStatus
- targetLocation :: Maybe TargetLocation
- overriddenParameters :: Maybe (HashMap Text [Text])
- outputs :: Maybe (HashMap Text [Text])
- executionStartTime :: Maybe POSIX
- maxAttempts :: Maybe Int
- targets :: Maybe [Target]
- nextStep :: Maybe Text
- stepExecutionId :: Maybe Text
- validNextSteps :: Maybe [Text]
- timeoutSeconds :: Maybe Integer
- onFailure :: Maybe Text
- isCritical :: Maybe Bool
}
newStepExecution :: StepExecution
stepExecution_failureDetails :: Lens' StepExecution (Maybe FailureDetails)
stepExecution_isEnd :: Lens' StepExecution (Maybe Bool)
stepExecution_inputs :: Lens' StepExecution (Maybe (HashMap Text Text))
stepExecution_stepName :: Lens' StepExecution (Maybe Text)
stepExecution_executionEndTime :: Lens' StepExecution (Maybe UTCTime)
stepExecution_failureMessage :: Lens' StepExecution (Maybe Text)
stepExecution_response :: Lens' StepExecution (Maybe Text)
stepExecution_action :: Lens' StepExecution (Maybe Text)
stepExecution_responseCode :: Lens' StepExecution (Maybe Text)
stepExecution_stepStatus :: Lens' StepExecution (Maybe AutomationExecutionStatus)
stepExecution_targetLocation :: Lens' StepExecution (Maybe TargetLocation)
stepExecution_overriddenParameters :: Lens' StepExecution (Maybe (HashMap Text [Text]))
stepExecution_outputs :: Lens' StepExecution (Maybe (HashMap Text [Text]))
stepExecution_executionStartTime :: Lens' StepExecution (Maybe UTCTime)
stepExecution_maxAttempts :: Lens' StepExecution (Maybe Int)
stepExecution_targets :: Lens' StepExecution (Maybe [Target])
stepExecution_nextStep :: Lens' StepExecution (Maybe Text)
stepExecution_stepExecutionId :: Lens' StepExecution (Maybe Text)
stepExecution_validNextSteps :: Lens' StepExecution (Maybe [Text])
stepExecution_timeoutSeconds :: Lens' StepExecution (Maybe Integer)
stepExecution_onFailure :: Lens' StepExecution (Maybe Text)
stepExecution_isCritical :: Lens' StepExecution (Maybe Bool)

Documentation

data StepExecution Source #

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

See: newStepExecution smart constructor.

Constructors

StepExecution'

Fields

failureDetails :: Maybe FailureDetails
Information about the Automation failure.
isEnd :: Maybe Bool
The flag which can be used to end automation no matter whether the step succeeds or fails.
inputs :: Maybe (HashMap Text Text)
Fully-resolved values passed into the step before execution.
stepName :: Maybe Text
The name of this execution step.
executionEndTime :: Maybe POSIX
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.
failureMessage :: Maybe Text
If a step failed, this message explains why the execution failed.
response :: Maybe Text
A message associated with the response code for an execution.
action :: Maybe Text
The action this step performs. The action determines the behavior of the step.
responseCode :: Maybe Text
The response code returned by the execution of the step.
stepStatus :: Maybe AutomationExecutionStatus
The execution status for this step.
targetLocation :: Maybe TargetLocation
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
overriddenParameters :: Maybe (HashMap Text [Text])
A user-specified list of parameters to override when running a step.
outputs :: Maybe (HashMap Text [Text])
Returned values from the execution of the step.
executionStartTime :: Maybe POSIX
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.
maxAttempts :: Maybe Int
The maximum number of tries to run the action of the step. The default value is 1.
targets :: Maybe [Target]
The targets for the step execution.
nextStep :: Maybe Text
The next step after the step succeeds.
stepExecutionId :: Maybe Text
The unique ID of a step execution.
validNextSteps :: Maybe [Text]
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.
timeoutSeconds :: Maybe Integer
The timeout seconds of the step.
onFailure :: Maybe Text
The action to take if the step fails. The default value is Abort.
isCritical :: Maybe Bool
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

Instances

Instances details

Eq StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods (==) :: StepExecution -> StepExecution -> Bool # (/=) :: StepExecution -> StepExecution -> Bool #
Read StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods readsPrec :: Int -> ReadS StepExecution # readList :: ReadS [StepExecution] # readPrec :: ReadPrec StepExecution # readListPrec :: ReadPrec [StepExecution] #
Show StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods showsPrec :: Int -> StepExecution -> ShowS # show :: StepExecution -> String # showList :: [StepExecution] -> ShowS #
Generic StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Associated Types type Rep StepExecution :: Type -> Type # Methods from :: StepExecution -> Rep StepExecution x # to :: Rep StepExecution x -> StepExecution #
NFData StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods rnf :: StepExecution -> () #
Hashable StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods hashWithSalt :: Int -> StepExecution -> Int # hash :: StepExecution -> Int #
FromJSON StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution Methods parseJSON :: Value -> Parser StepExecution # parseJSONList :: Value -> Parser [StepExecution] #
type Rep StepExecution Source #
Instance details Defined in Amazonka.SSM.Types.StepExecution type Rep StepExecution = D1 ('MetaData "StepExecution" "Amazonka.SSM.Types.StepExecution" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "StepExecution'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDetails)) :: S1 ('MetaSel ('Just "isEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "stepName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "executionEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "response") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "responseCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stepStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationExecutionStatus)) :: S1 ('MetaSel ('Just "targetLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetLocation)))))) :: (((S1 ('MetaSel ('Just "overriddenParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :: (S1 ('MetaSel ('Just "executionStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "maxAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target]))))) :: ((S1 ('MetaSel ('Just "nextStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stepExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "validNextSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "onFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isCritical") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))))

newStepExecution :: StepExecution Source #

Create a value of StepExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureDetails:StepExecution', stepExecution_failureDetails - Information about the Automation failure.

$sel:isEnd:StepExecution', stepExecution_isEnd - The flag which can be used to end automation no matter whether the step succeeds or fails.

$sel:inputs:StepExecution', stepExecution_inputs - Fully-resolved values passed into the step before execution.

$sel:stepName:StepExecution', stepExecution_stepName - The name of this execution step.

$sel:executionEndTime:StepExecution', stepExecution_executionEndTime - 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.

$sel:failureMessage:StepExecution', stepExecution_failureMessage - If a step failed, this message explains why the execution failed.

$sel:response:StepExecution', stepExecution_response - A message associated with the response code for an execution.

$sel:action:StepExecution', stepExecution_action - The action this step performs. The action determines the behavior of the step.

$sel:responseCode:StepExecution', stepExecution_responseCode - The response code returned by the execution of the step.

$sel:stepStatus:StepExecution', stepExecution_stepStatus - The execution status for this step.

$sel:targetLocation:StepExecution', stepExecution_targetLocation - The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

$sel:overriddenParameters:StepExecution', stepExecution_overriddenParameters - A user-specified list of parameters to override when running a step.

$sel:outputs:StepExecution', stepExecution_outputs - Returned values from the execution of the step.

$sel:executionStartTime:StepExecution', stepExecution_executionStartTime - 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.

$sel:maxAttempts:StepExecution', stepExecution_maxAttempts - The maximum number of tries to run the action of the step. The default value is 1.

$sel:targets:StepExecution', stepExecution_targets - The targets for the step execution.

$sel:nextStep:StepExecution', stepExecution_nextStep - The next step after the step succeeds.

$sel:stepExecutionId:StepExecution', stepExecution_stepExecutionId - The unique ID of a step execution.

$sel:validNextSteps:StepExecution', stepExecution_validNextSteps - 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.

$sel:timeoutSeconds:StepExecution', stepExecution_timeoutSeconds - The timeout seconds of the step.

$sel:onFailure:StepExecution', stepExecution_onFailure - The action to take if the step fails. The default value is Abort.

$sel:isCritical:StepExecution', stepExecution_isCritical - The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

stepExecution_failureDetails :: Lens' StepExecution (Maybe FailureDetails) Source #

Information about the Automation failure.

stepExecution_isEnd :: Lens' StepExecution (Maybe Bool) Source #

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

stepExecution_inputs :: Lens' StepExecution (Maybe (HashMap Text Text)) Source #

Fully-resolved values passed into the step before execution.

stepExecution_stepName :: Lens' StepExecution (Maybe Text) Source #

The name of this execution step.

stepExecution_executionEndTime :: Lens' StepExecution (Maybe UTCTime) Source #

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.

stepExecution_failureMessage :: Lens' StepExecution (Maybe Text) Source #

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

stepExecution_response :: Lens' StepExecution (Maybe Text) Source #

A message associated with the response code for an execution.

stepExecution_action :: Lens' StepExecution (Maybe Text) Source #

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

stepExecution_responseCode :: Lens' StepExecution (Maybe Text) Source #

The response code returned by the execution of the step.

stepExecution_stepStatus :: Lens' StepExecution (Maybe AutomationExecutionStatus) Source #

The execution status for this step.

stepExecution_targetLocation :: Lens' StepExecution (Maybe TargetLocation) Source #

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

stepExecution_overriddenParameters :: Lens' StepExecution (Maybe (HashMap Text [Text])) Source #

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

stepExecution_outputs :: Lens' StepExecution (Maybe (HashMap Text [Text])) Source #

Returned values from the execution of the step.

stepExecution_executionStartTime :: Lens' StepExecution (Maybe UTCTime) Source #

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.

stepExecution_maxAttempts :: Lens' StepExecution (Maybe Int) Source #

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

stepExecution_targets :: Lens' StepExecution (Maybe [Target]) Source #

The targets for the step execution.

stepExecution_nextStep :: Lens' StepExecution (Maybe Text) Source #

The next step after the step succeeds.

stepExecution_stepExecutionId :: Lens' StepExecution (Maybe Text) Source #

The unique ID of a step execution.

stepExecution_validNextSteps :: Lens' StepExecution (Maybe [Text]) Source #

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.

stepExecution_timeoutSeconds :: Lens' StepExecution (Maybe Integer) Source #

The timeout seconds of the step.

stepExecution_onFailure :: Lens' StepExecution (Maybe Text) Source #

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

stepExecution_isCritical :: Lens' StepExecution (Maybe Bool) Source #

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