| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::StepExecution; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExecutionEndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExecutionStartTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailureDetails => (is => 'ro', isa => 'Paws::SSM::FailureDetails'); | ||
| 8 | has FailureMessage => (is => 'ro', isa => 'Str'); | ||
| 9 | has Inputs => (is => 'ro', isa => 'Paws::SSM::NormalStringMap'); | ||
| 10 | has IsCritical => (is => 'ro', isa => 'Bool'); | ||
| 11 | has IsEnd => (is => 'ro', isa => 'Bool'); | ||
| 12 | has MaxAttempts => (is => 'ro', isa => 'Int'); | ||
| 13 | has NextStep => (is => 'ro', isa => 'Str'); | ||
| 14 | has OnFailure => (is => 'ro', isa => 'Str'); | ||
| 15 | has Outputs => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 16 | has OverriddenParameters => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 17 | has Response => (is => 'ro', isa => 'Str'); | ||
| 18 | has ResponseCode => (is => 'ro', isa => 'Str'); | ||
| 19 | has StepExecutionId => (is => 'ro', isa => 'Str'); | ||
| 20 | has StepName => (is => 'ro', isa => 'Str'); | ||
| 21 | has StepStatus => (is => 'ro', isa => 'Str'); | ||
| 22 | has TargetLocation => (is => 'ro', isa => 'Paws::SSM::TargetLocation'); | ||
| 23 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 24 | has TimeoutSeconds => (is => 'ro', isa => 'Int'); | ||
| 25 | has ValidNextSteps => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 26 | |||
| 27 | 1; | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::SSM::StepExecution | ||
| 34 | |||
| 35 | =head1 USAGE | ||
| 36 | |||
| 37 | This class represents one of two things: | ||
| 38 | |||
| 39 | =head3 Arguments in a call to a service | ||
| 40 | |||
| 41 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 42 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 43 | |||
| 44 | As an example, if Att1 is expected to be a Paws::SSM::StepExecution object: | ||
| 45 | |||
| 46 | $service_obj->Method(Att1 => { Action => $value, ..., ValidNextSteps => $value }); | ||
| 47 | |||
| 48 | =head3 Results returned from an API call | ||
| 49 | |||
| 50 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::StepExecution object: | ||
| 51 | |||
| 52 | $result = $service_obj->Method(...); | ||
| 53 | $result->Att1->Action | ||
| 54 | |||
| 55 | =head1 DESCRIPTION | ||
| 56 | |||
| 57 | Detailed information about an the execution state of an Automation | ||
| 58 | step. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Action => Str | ||
| 64 | |||
| 65 | The action this step performs. The action determines the behavior of | ||
| 66 | the step. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ExecutionEndTime => Str | ||
| 70 | |||
| 71 | If a step has finished execution, this contains the time the execution | ||
| 72 | ended. If the step has not yet concluded, this field is not populated. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ExecutionStartTime => Str | ||
| 76 | |||
| 77 | If a step has begun execution, this contains the time the step started. | ||
| 78 | If the step is in Pending status, this field is not populated. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 FailureDetails => L<Paws::SSM::FailureDetails> | ||
| 82 | |||
| 83 | Information about the Automation failure. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 FailureMessage => Str | ||
| 87 | |||
| 88 | If a step failed, this message explains why the execution failed. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Inputs => L<Paws::SSM::NormalStringMap> | ||
| 92 | |||
| 93 | Fully-resolved values passed into the step before execution. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 IsCritical => Bool | ||
| 97 | |||
| 98 | The flag which can be used to help decide whether the failure of | ||
| 99 | current step leads to the Automation failure. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 IsEnd => Bool | ||
| 103 | |||
| 104 | The flag which can be used to end automation no matter whether the step | ||
| 105 | succeeds or fails. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 MaxAttempts => Int | ||
| 109 | |||
| 110 | The maximum number of tries to run the action of the step. The default | ||
| 111 | value is 1. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 NextStep => Str | ||
| 115 | |||
| 116 | The next step after the step succeeds. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 OnFailure => Str | ||
| 120 | |||
| 121 | The action to take if the step fails. The default value is Abort. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 Outputs => L<Paws::SSM::AutomationParameterMap> | ||
| 125 | |||
| 126 | Returned values from the execution of the step. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 OverriddenParameters => L<Paws::SSM::AutomationParameterMap> | ||
| 130 | |||
| 131 | A user-specified list of parameters to override when running a step. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 Response => Str | ||
| 135 | |||
| 136 | A message associated with the response code for an execution. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 ResponseCode => Str | ||
| 140 | |||
| 141 | The response code returned by the execution of the step. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 StepExecutionId => Str | ||
| 145 | |||
| 146 | The unique ID of a step execution. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 StepName => Str | ||
| 150 | |||
| 151 | The name of this execution step. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 StepStatus => Str | ||
| 155 | |||
| 156 | The execution status for this step. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 TargetLocation => L<Paws::SSM::TargetLocation> | ||
| 160 | |||
| 161 | The combination of AWS Regions and accounts targeted by the current | ||
| 162 | Automation execution. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 166 | |||
| 167 | The targets for the step execution. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 TimeoutSeconds => Int | ||
| 171 | |||
| 172 | The timeout seconds of the step. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 ValidNextSteps => ArrayRef[Str|Undef] | ||
| 176 | |||
| 177 | Strategies used when step fails, we support Continue and Abort. Abort | ||
| 178 | will fail the automation when the step fails. Continue will ignore the | ||
| 179 | failure of current step and allow automation to run the next step. With | ||
| 180 | conditional branching, we add step:stepName to support the automation | ||
| 181 | to go to another specific step. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head1 SEE ALSO | ||
| 186 | |||
| 187 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 188 | |||
| 189 | =head1 BUGS and CONTRIBUTIONS | ||
| 190 | |||
| 191 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 192 | |||
| 193 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 194 | |||
| 195 | =cut | ||
| 196 |