| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::AutomationExecution; | ||
| 3 | use Moose; | ||
| 4 | has AssociationId => (is => 'ro', isa => 'Str'); | ||
| 5 | has AutomationExecutionId => (is => 'ro', isa => 'Str'); | ||
| 6 | has AutomationExecutionStatus => (is => 'ro', isa => 'Str'); | ||
| 7 | has AutomationSubtype => (is => 'ro', isa => 'Str'); | ||
| 8 | has ChangeRequestName => (is => 'ro', isa => 'Str'); | ||
| 9 | has CurrentAction => (is => 'ro', isa => 'Str'); | ||
| 10 | has CurrentStepName => (is => 'ro', isa => 'Str'); | ||
| 11 | has DocumentName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 13 | has ExecutedBy => (is => 'ro', isa => 'Str'); | ||
| 14 | has ExecutionEndTime => (is => 'ro', isa => 'Str'); | ||
| 15 | has ExecutionStartTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has FailureMessage => (is => 'ro', isa => 'Str'); | ||
| 17 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 18 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 19 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 20 | has OpsItemId => (is => 'ro', isa => 'Str'); | ||
| 21 | has Outputs => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 22 | has Parameters => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 23 | has ParentAutomationExecutionId => (is => 'ro', isa => 'Str'); | ||
| 24 | has ProgressCounters => (is => 'ro', isa => 'Paws::SSM::ProgressCounters'); | ||
| 25 | has ResolvedTargets => (is => 'ro', isa => 'Paws::SSM::ResolvedTargets'); | ||
| 26 | has Runbooks => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Runbook]'); | ||
| 27 | has ScheduledTime => (is => 'ro', isa => 'Str'); | ||
| 28 | has StepExecutions => (is => 'ro', isa => 'ArrayRef[Paws::SSM::StepExecution]'); | ||
| 29 | has StepExecutionsTruncated => (is => 'ro', isa => 'Bool'); | ||
| 30 | has Target => (is => 'ro', isa => 'Str'); | ||
| 31 | has TargetLocations => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetLocation]'); | ||
| 32 | has TargetMaps => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetMap]'); | ||
| 33 | has TargetParameterName => (is => 'ro', isa => 'Str'); | ||
| 34 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 35 | |||
| 36 | 1; | ||
| 37 | |||
| 38 | ### main pod documentation begin ### | ||
| 39 | |||
| 40 | =head1 NAME | ||
| 41 | |||
| 42 | Paws::SSM::AutomationExecution | ||
| 43 | |||
| 44 | =head1 USAGE | ||
| 45 | |||
| 46 | This class represents one of two things: | ||
| 47 | |||
| 48 | =head3 Arguments in a call to a service | ||
| 49 | |||
| 50 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 51 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 52 | |||
| 53 | As an example, if Att1 is expected to be a Paws::SSM::AutomationExecution object: | ||
| 54 | |||
| 55 | $service_obj->Method(Att1 => { AssociationId => $value, ..., Targets => $value }); | ||
| 56 | |||
| 57 | =head3 Results returned from an API call | ||
| 58 | |||
| 59 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::AutomationExecution object: | ||
| 60 | |||
| 61 | $result = $service_obj->Method(...); | ||
| 62 | $result->Att1->AssociationId | ||
| 63 | |||
| 64 | =head1 DESCRIPTION | ||
| 65 | |||
| 66 | Detailed information about the current state of an individual | ||
| 67 | Automation execution. | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AssociationId => Str | ||
| 73 | |||
| 74 | The ID of a State Manager association used in the Automation operation. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 AutomationExecutionId => Str | ||
| 78 | |||
| 79 | The execution ID. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 AutomationExecutionStatus => Str | ||
| 83 | |||
| 84 | The execution status of the Automation. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 AutomationSubtype => Str | ||
| 88 | |||
| 89 | The subtype of the Automation operation. Currently, the only supported | ||
| 90 | value is C<ChangeRequest>. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ChangeRequestName => Str | ||
| 94 | |||
| 95 | The name of the Change Manager change request. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 CurrentAction => Str | ||
| 99 | |||
| 100 | The action of the step that is currently running. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 CurrentStepName => Str | ||
| 104 | |||
| 105 | The name of the step that is currently running. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 DocumentName => Str | ||
| 109 | |||
| 110 | The name of the Automation document used during the execution. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 DocumentVersion => Str | ||
| 114 | |||
| 115 | The version of the document to use during execution. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 ExecutedBy => Str | ||
| 119 | |||
| 120 | The Amazon Resource Name (ARN) of the user who ran the automation. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 ExecutionEndTime => Str | ||
| 124 | |||
| 125 | The time the execution finished. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 ExecutionStartTime => Str | ||
| 129 | |||
| 130 | The time the execution started. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 FailureMessage => Str | ||
| 134 | |||
| 135 | A message describing why an execution has failed, if the status is set | ||
| 136 | to Failed. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 MaxConcurrency => Str | ||
| 140 | |||
| 141 | The MaxConcurrency value specified by the user when the execution | ||
| 142 | started. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 MaxErrors => Str | ||
| 146 | |||
| 147 | The MaxErrors value specified by the user when the execution started. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 Mode => Str | ||
| 151 | |||
| 152 | The automation execution mode. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 OpsItemId => Str | ||
| 156 | |||
| 157 | The ID of an OpsItem that is created to represent a Change Manager | ||
| 158 | change request. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 Outputs => L<Paws::SSM::AutomationParameterMap> | ||
| 162 | |||
| 163 | The list of execution outputs as defined in the automation document. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 Parameters => L<Paws::SSM::AutomationParameterMap> | ||
| 167 | |||
| 168 | The key-value map of execution parameters, which were supplied when | ||
| 169 | calling StartAutomationExecution. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 ParentAutomationExecutionId => Str | ||
| 173 | |||
| 174 | The AutomationExecutionId of the parent automation. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 ProgressCounters => L<Paws::SSM::ProgressCounters> | ||
| 178 | |||
| 179 | An aggregate of step execution statuses displayed in the AWS Console | ||
| 180 | for a multi-Region and multi-account Automation execution. | ||
| 181 | |||
| 182 | |||
| 183 | =head2 ResolvedTargets => L<Paws::SSM::ResolvedTargets> | ||
| 184 | |||
| 185 | A list of resolved targets in the rate control execution. | ||
| 186 | |||
| 187 | |||
| 188 | =head2 Runbooks => ArrayRef[L<Paws::SSM::Runbook>] | ||
| 189 | |||
| 190 | Information about the Automation runbooks (Automation documents) that | ||
| 191 | are run as part of a runbook workflow. | ||
| 192 | |||
| 193 | The Automation runbooks specified for the runbook workflow can't run | ||
| 194 | until all required approvals for the change request have been received. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 ScheduledTime => Str | ||
| 198 | |||
| 199 | The date and time the Automation operation is scheduled to start. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 StepExecutions => ArrayRef[L<Paws::SSM::StepExecution>] | ||
| 203 | |||
| 204 | A list of details about the current state of all steps that comprise an | ||
| 205 | execution. An Automation document contains a list of steps that are run | ||
| 206 | in order. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 StepExecutionsTruncated => Bool | ||
| 210 | |||
| 211 | A boolean value that indicates if the response contains the full list | ||
| 212 | of the Automation step executions. If true, use the | ||
| 213 | DescribeAutomationStepExecutions API action to get the full list of | ||
| 214 | step executions. | ||
| 215 | |||
| 216 | |||
| 217 | =head2 Target => Str | ||
| 218 | |||
| 219 | The target of the execution. | ||
| 220 | |||
| 221 | |||
| 222 | =head2 TargetLocations => ArrayRef[L<Paws::SSM::TargetLocation>] | ||
| 223 | |||
| 224 | The combination of AWS Regions and/or AWS accounts where you want to | ||
| 225 | run the Automation. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 TargetMaps => ArrayRef[L<Paws::SSM::TargetMap>] | ||
| 229 | |||
| 230 | The specified key-value mapping of document parameters to target | ||
| 231 | resources. | ||
| 232 | |||
| 233 | |||
| 234 | =head2 TargetParameterName => Str | ||
| 235 | |||
| 236 | The parameter name. | ||
| 237 | |||
| 238 | |||
| 239 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 240 | |||
| 241 | The specified targets. | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head1 SEE ALSO | ||
| 246 | |||
| 247 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 248 | |||
| 249 | =head1 BUGS and CONTRIBUTIONS | ||
| 250 | |||
| 251 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 252 | |||
| 253 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 254 | |||
| 255 | =cut | ||
| 256 |