« blib/lib/Paws/SSM/AutomationExecutionFilter.pm
↑ Summary
blib/lib/Paws/SSM/AutomationParameterMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::AutomationExecutionMetadata; | ||
| 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 AutomationType => (is => 'ro', isa => 'Str'); | ||
| 9 | has ChangeRequestName => (is => 'ro', isa => 'Str'); | ||
| 10 | has CurrentAction => (is => 'ro', isa => 'Str'); | ||
| 11 | has CurrentStepName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DocumentName => (is => 'ro', isa => 'Str'); | ||
| 13 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 14 | has ExecutedBy => (is => 'ro', isa => 'Str'); | ||
| 15 | has ExecutionEndTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has ExecutionStartTime => (is => 'ro', isa => 'Str'); | ||
| 17 | has FailureMessage => (is => 'ro', isa => 'Str'); | ||
| 18 | has LogFile => (is => 'ro', isa => 'Str'); | ||
| 19 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 20 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 21 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 22 | has OpsItemId => (is => 'ro', isa => 'Str'); | ||
| 23 | has Outputs => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 24 | has ParentAutomationExecutionId => (is => 'ro', isa => 'Str'); | ||
| 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 Target => (is => 'ro', isa => 'Str'); | ||
| 29 | has TargetMaps => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetMap]'); | ||
| 30 | has TargetParameterName => (is => 'ro', isa => 'Str'); | ||
| 31 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 32 | |||
| 33 | 1; | ||
| 34 | |||
| 35 | ### main pod documentation begin ### | ||
| 36 | |||
| 37 | =head1 NAME | ||
| 38 | |||
| 39 | Paws::SSM::AutomationExecutionMetadata | ||
| 40 | |||
| 41 | =head1 USAGE | ||
| 42 | |||
| 43 | This class represents one of two things: | ||
| 44 | |||
| 45 | =head3 Arguments in a call to a service | ||
| 46 | |||
| 47 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 48 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 49 | |||
| 50 | As an example, if Att1 is expected to be a Paws::SSM::AutomationExecutionMetadata object: | ||
| 51 | |||
| 52 | $service_obj->Method(Att1 => { AssociationId => $value, ..., Targets => $value }); | ||
| 53 | |||
| 54 | =head3 Results returned from an API call | ||
| 55 | |||
| 56 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::AutomationExecutionMetadata object: | ||
| 57 | |||
| 58 | $result = $service_obj->Method(...); | ||
| 59 | $result->Att1->AssociationId | ||
| 60 | |||
| 61 | =head1 DESCRIPTION | ||
| 62 | |||
| 63 | Details about a specific Automation execution. | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AssociationId => Str | ||
| 69 | |||
| 70 | The ID of a State Manager association used in the Automation operation. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AutomationExecutionId => Str | ||
| 74 | |||
| 75 | The execution ID. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 AutomationExecutionStatus => Str | ||
| 79 | |||
| 80 | The status of the execution. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 AutomationSubtype => Str | ||
| 84 | |||
| 85 | The subtype of the Automation operation. Currently, the only supported | ||
| 86 | value is C<ChangeRequest>. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 AutomationType => Str | ||
| 90 | |||
| 91 | Use this filter with DescribeAutomationExecutions. Specify either Local | ||
| 92 | or CrossAccount. CrossAccount is an Automation that runs in multiple | ||
| 93 | AWS Regions and accounts. For more information, see Running Automation | ||
| 94 | workflows in multiple AWS Regions and accounts | ||
| 95 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) | ||
| 96 | in the I<AWS Systems Manager User Guide>. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 ChangeRequestName => Str | ||
| 100 | |||
| 101 | The name of the Change Manager change request. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 CurrentAction => Str | ||
| 105 | |||
| 106 | The action of the step that is currently running. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 CurrentStepName => Str | ||
| 110 | |||
| 111 | The name of the step that is currently running. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 DocumentName => Str | ||
| 115 | |||
| 116 | The name of the Automation document used during execution. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 DocumentVersion => Str | ||
| 120 | |||
| 121 | The document version used during the execution. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ExecutedBy => Str | ||
| 125 | |||
| 126 | The IAM role ARN of the user who ran the Automation. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 ExecutionEndTime => Str | ||
| 130 | |||
| 131 | The time the execution finished. This is not populated if the execution | ||
| 132 | is still in progress. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 ExecutionStartTime => Str | ||
| 136 | |||
| 137 | The time the execution started. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 FailureMessage => Str | ||
| 141 | |||
| 142 | The list of execution outputs as defined in the Automation document. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 LogFile => Str | ||
| 146 | |||
| 147 | An S3 bucket where execution information is stored. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 MaxConcurrency => Str | ||
| 151 | |||
| 152 | The MaxConcurrency value specified by the user when starting the | ||
| 153 | Automation. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 MaxErrors => Str | ||
| 157 | |||
| 158 | The MaxErrors value specified by the user when starting the Automation. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 Mode => Str | ||
| 162 | |||
| 163 | The Automation execution mode. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 OpsItemId => Str | ||
| 167 | |||
| 168 | The ID of an OpsItem that is created to represent a Change Manager | ||
| 169 | change request. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 Outputs => L<Paws::SSM::AutomationParameterMap> | ||
| 173 | |||
| 174 | The list of execution outputs as defined in the Automation document. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 ParentAutomationExecutionId => Str | ||
| 178 | |||
| 179 | The ExecutionId of the parent Automation. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 ResolvedTargets => L<Paws::SSM::ResolvedTargets> | ||
| 183 | |||
| 184 | A list of targets that resolved during the execution. | ||
| 185 | |||
| 186 | |||
| 187 | =head2 Runbooks => ArrayRef[L<Paws::SSM::Runbook>] | ||
| 188 | |||
| 189 | Information about the Automation runbooks (Automation documents) that | ||
| 190 | are run during a runbook workflow in Change Manager. | ||
| 191 | |||
| 192 | The Automation runbooks specified for the runbook workflow can't run | ||
| 193 | until all required approvals for the change request have been received. | ||
| 194 | |||
| 195 | |||
| 196 | =head2 ScheduledTime => Str | ||
| 197 | |||
| 198 | The date and time the Automation operation is scheduled to start. | ||
| 199 | |||
| 200 | |||
| 201 | =head2 Target => Str | ||
| 202 | |||
| 203 | The list of execution outputs as defined in the Automation document. | ||
| 204 | |||
| 205 | |||
| 206 | =head2 TargetMaps => ArrayRef[L<Paws::SSM::TargetMap>] | ||
| 207 | |||
| 208 | The specified key-value mapping of document parameters to target | ||
| 209 | resources. | ||
| 210 | |||
| 211 | |||
| 212 | =head2 TargetParameterName => Str | ||
| 213 | |||
| 214 | The list of execution outputs as defined in the Automation document. | ||
| 215 | |||
| 216 | |||
| 217 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 218 | |||
| 219 | The targets defined by the user when starting the Automation. | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head1 SEE ALSO | ||
| 224 | |||
| 225 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 226 | |||
| 227 | =head1 BUGS and CONTRIBUTIONS | ||
| 228 | |||
| 229 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 230 | |||
| 231 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 232 | |||
| 233 | =cut | ||
| 234 |