« blib/lib/Paws/SSM/StartAssociationsOnceResult.pm
↑ Summary
blib/lib/Paws/SSM/StartAutomationExecutionResult.pm »
| 1 | |||
| 2 | package Paws::SSM::StartAutomationExecution; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DocumentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 9 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 10 | has Parameters => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]'); | ||
| 12 | has TargetLocations => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetLocation]'); | ||
| 13 | has TargetMaps => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetMap]'); | ||
| 14 | has TargetParameterName => (is => 'ro', isa => 'Str'); | ||
| 15 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartAutomationExecution'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::StartAutomationExecutionResult'); | ||
| 21 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::SSM::StartAutomationExecution - Arguments for method StartAutomationExecution on L<Paws::SSM> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method StartAutomationExecution on the | ||
| 33 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 34 | as arguments to method StartAutomationExecution. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartAutomationExecution. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $ssm = Paws->service('SSM'); | ||
| 41 | my $StartAutomationExecutionResult = $ssm->StartAutomationExecution( | ||
| 42 | DocumentName => 'MyDocumentARN', | ||
| 43 | ClientToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 44 | DocumentVersion => 'MyDocumentVersion', # OPTIONAL | ||
| 45 | MaxConcurrency => 'MyMaxConcurrency', # OPTIONAL | ||
| 46 | MaxErrors => 'MyMaxErrors', # OPTIONAL | ||
| 47 | Mode => 'Auto', # OPTIONAL | ||
| 48 | Parameters => { | ||
| 49 | 'MyAutomationParameterKey' => [ | ||
| 50 | 'MyAutomationParameterValue', ... # min: 1, max: 512 | ||
| 51 | ], # key: min: 1, max: 50, value: max: 50 | ||
| 52 | }, # OPTIONAL | ||
| 53 | Tags => [ | ||
| 54 | { | ||
| 55 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 56 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | TargetLocations => [ | ||
| 62 | { | ||
| 63 | Accounts => [ 'MyAccount', ... ], # min: 1, max: 50; OPTIONAL | ||
| 64 | ExecutionRoleName => | ||
| 65 | 'MyExecutionRoleName', # min: 1, max: 64; OPTIONAL | ||
| 66 | Regions => [ 'MyRegion', ... ], # min: 1, max: 50; OPTIONAL | ||
| 67 | TargetLocationMaxConcurrency => 'MyMaxConcurrency', # min: 1, max: 7 | ||
| 68 | TargetLocationMaxErrors => 'MyMaxErrors', # min: 1, max: 7 | ||
| 69 | }, | ||
| 70 | ... | ||
| 71 | ], # OPTIONAL | ||
| 72 | TargetMaps => [ | ||
| 73 | { | ||
| 74 | 'MyTargetMapKey' => [ | ||
| 75 | 'MyTargetMapValue', ... # min: 1, max: 50 | ||
| 76 | ], # key: min: 1, max: 50, value: max: 25 | ||
| 77 | }, | ||
| 78 | ... # min: 1, max: 20 | ||
| 79 | ], # OPTIONAL | ||
| 80 | TargetParameterName => 'MyAutomationParameterKey', # OPTIONAL | ||
| 81 | Targets => [ | ||
| 82 | { | ||
| 83 | Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL | ||
| 84 | Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL | ||
| 85 | }, | ||
| 86 | ... | ||
| 87 | ], # OPTIONAL | ||
| 88 | ); | ||
| 89 | |||
| 90 | # Results: | ||
| 91 | my $AutomationExecutionId = | ||
| 92 | $StartAutomationExecutionResult->AutomationExecutionId; | ||
| 93 | |||
| 94 | # Returns a L<Paws::SSM::StartAutomationExecutionResult> object. | ||
| 95 | |||
| 96 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 97 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/StartAutomationExecution> | ||
| 98 | |||
| 99 | =head1 ATTRIBUTES | ||
| 100 | |||
| 101 | |||
| 102 | =head2 ClientToken => Str | ||
| 103 | |||
| 104 | User-provided idempotency token. The token must be unique, is case | ||
| 105 | insensitive, enforces the UUID format, and can't be reused. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> DocumentName => Str | ||
| 110 | |||
| 111 | The name of the Systems Manager document to run. This can be a public | ||
| 112 | document or a custom document. To run a shared document belonging to | ||
| 113 | another account, specify the document ARN. For more information about | ||
| 114 | how to use shared documents, see Using shared SSM documents | ||
| 115 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) | ||
| 116 | in the I<AWS Systems Manager User Guide>. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 DocumentVersion => Str | ||
| 121 | |||
| 122 | The version of the Automation document to use for this execution. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 MaxConcurrency => Str | ||
| 127 | |||
| 128 | The maximum number of targets allowed to run this task in parallel. You | ||
| 129 | can specify a number, such as 10, or a percentage, such as 10%. The | ||
| 130 | default value is 10. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 MaxErrors => Str | ||
| 135 | |||
| 136 | The number of errors that are allowed before the system stops running | ||
| 137 | the automation on additional targets. You can specify either an | ||
| 138 | absolute number of errors, for example 10, or a percentage of the | ||
| 139 | target set, for example 10%. If you specify 3, for example, the system | ||
| 140 | stops running the automation when the fourth error is received. If you | ||
| 141 | specify 0, then the system stops running the automation on additional | ||
| 142 | targets after the first error result is returned. If you run an | ||
| 143 | automation on 50 resources and set max-errors to 10%, then the system | ||
| 144 | stops running the automation on additional targets when the sixth error | ||
| 145 | is received. | ||
| 146 | |||
| 147 | Executions that are already running an automation when max-errors is | ||
| 148 | reached are allowed to complete, but some of these executions may fail | ||
| 149 | as well. If you need to ensure that there won't be more than max-errors | ||
| 150 | failed executions, set max-concurrency to 1 so the executions proceed | ||
| 151 | one at a time. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 Mode => Str | ||
| 156 | |||
| 157 | The execution mode of the automation. Valid modes include the | ||
| 158 | following: Auto and Interactive. The default mode is Auto. | ||
| 159 | |||
| 160 | Valid values are: C<"Auto">, C<"Interactive"> | ||
| 161 | |||
| 162 | =head2 Parameters => L<Paws::SSM::AutomationParameterMap> | ||
| 163 | |||
| 164 | A key-value map of execution parameters, which match the declared | ||
| 165 | parameters in the Automation document. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 Tags => ArrayRef[L<Paws::SSM::Tag>] | ||
| 170 | |||
| 171 | Optional metadata that you assign to a resource. You can specify a | ||
| 172 | maximum of five tags for an automation. Tags enable you to categorize a | ||
| 173 | resource in different ways, such as by purpose, owner, or environment. | ||
| 174 | For example, you might want to tag an automation to identify an | ||
| 175 | environment or operating system. In this case, you could specify the | ||
| 176 | following key name/value pairs: | ||
| 177 | |||
| 178 | =over | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | C<Key=environment,Value=test> | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<Key=OS,Value=Windows> | ||
| 187 | |||
| 188 | =back | ||
| 189 | |||
| 190 | To add tags to an existing patch baseline, use the AddTagsToResource | ||
| 191 | action. | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | =head2 TargetLocations => ArrayRef[L<Paws::SSM::TargetLocation>] | ||
| 196 | |||
| 197 | A location is a combination of AWS Regions and/or AWS accounts where | ||
| 198 | you want to run the Automation. Use this action to start an Automation | ||
| 199 | in multiple Regions and multiple accounts. For more information, see | ||
| 200 | Running Automation workflows in multiple AWS Regions and accounts | ||
| 201 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) | ||
| 202 | in the I<AWS Systems Manager User Guide>. | ||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | =head2 TargetMaps => ArrayRef[L<Paws::SSM::TargetMap>] | ||
| 207 | |||
| 208 | A key-value mapping of document parameters to target resources. Both | ||
| 209 | Targets and TargetMaps cannot be specified together. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 TargetParameterName => Str | ||
| 214 | |||
| 215 | The name of the parameter used as the target resource for the | ||
| 216 | rate-controlled execution. Required if you specify targets. | ||
| 217 | |||
| 218 | |||
| 219 | |||
| 220 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 221 | |||
| 222 | A key-value mapping to target resources. Required if you specify | ||
| 223 | TargetParameterName. | ||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | |||
| 228 | =head1 SEE ALSO | ||
| 229 | |||
| 230 | This class forms part of L<Paws>, documenting arguments for method StartAutomationExecution in L<Paws::SSM> | ||
| 231 | |||
| 232 | =head1 BUGS and CONTRIBUTIONS | ||
| 233 | |||
| 234 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 235 | |||
| 236 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 237 | |||
| 238 | =cut | ||
| 239 |