blib/lib/Paws/SSM/StartChangeRequestExecution.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::StartChangeRequestExecution;
3 use Moose;
4 has ChangeDetails => (is => 'ro', isa => 'Str');
5 has ChangeRequestName => (is => 'ro', isa => 'Str');
6 has ClientToken => (is => 'ro', isa => 'Str');
7 has DocumentName => (is => 'ro', isa => 'Str', required => 1);
8 has DocumentVersion => (is => 'ro', isa => 'Str');
9 has Parameters => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap');
10 has Runbooks => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Runbook]', required => 1);
11 has ScheduledEndTime => (is => 'ro', isa => 'Str');
12 has ScheduledTime => (is => 'ro', isa => 'Str');
13 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartChangeRequestExecution');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::StartChangeRequestExecutionResult');
19 class_has _result_key => (isa => 'Str', is => 'ro');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::SSM::StartChangeRequestExecution - Arguments for method StartChangeRequestExecution on L<Paws::SSM>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method StartChangeRequestExecution on the
31 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
32 as arguments to method StartChangeRequestExecution.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartChangeRequestExecution.
35  
36 =head1 SYNOPSIS
37  
38 my $ssm = Paws->service('SSM');
39 my $StartChangeRequestExecutionResult = $ssm->StartChangeRequestExecution(
40 DocumentName => 'MyDocumentARN',
41 Runbooks => [
42 {
43 DocumentName => 'MyDocumentARN',
44 DocumentVersion => 'MyDocumentVersion', # OPTIONAL
45 MaxConcurrency => 'MyMaxConcurrency', # min: 1, max: 7; OPTIONAL
46 MaxErrors => 'MyMaxErrors', # min: 1, max: 7; OPTIONAL
47 Parameters => {
48 'MyAutomationParameterKey' => [
49 'MyAutomationParameterValue', ... # min: 1, max: 512
50 ], # key: min: 1, max: 50, value: max: 50
51 }, # min: 1, max: 200; OPTIONAL
52 TargetLocations => [
53 {
54 Accounts => [ 'MyAccount', ... ], # min: 1, max: 50; OPTIONAL
55 ExecutionRoleName =>
56 'MyExecutionRoleName', # min: 1, max: 64; OPTIONAL
57 Regions => [ 'MyRegion', ... ], # min: 1, max: 50; OPTIONAL
58 TargetLocationMaxConcurrency =>
59 'MyMaxConcurrency', # min: 1, max: 7; OPTIONAL
60 TargetLocationMaxErrors =>
61 'MyMaxErrors', # min: 1, max: 7; OPTIONAL
62 },
63 ...
64 ], # min: 1, max: 100; OPTIONAL
65 TargetParameterName => 'MyAutomationParameterKey', # min: 1, max: 50
66 Targets => [
67 {
68 Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL
69 Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL
70 },
71 ...
72 ], # max: 5; OPTIONAL
73 },
74 ...
75 ],
76 ChangeDetails => 'MyChangeDetailsValue', # OPTIONAL
77 ChangeRequestName => 'MyChangeRequestName', # OPTIONAL
78 ClientToken => 'MyIdempotencyToken', # OPTIONAL
79 DocumentVersion => 'MyDocumentVersion', # OPTIONAL
80 Parameters => {
81 'MyAutomationParameterKey' => [
82 'MyAutomationParameterValue', ... # min: 1, max: 512
83 ], # key: min: 1, max: 50, value: max: 50
84 }, # OPTIONAL
85 ScheduledEndTime => '1970-01-01T01:00:00', # OPTIONAL
86 ScheduledTime => '1970-01-01T01:00:00', # OPTIONAL
87 Tags => [
88 {
89 Key => 'MyTagKey', # min: 1, max: 128
90 Value => 'MyTagValue', # min: 1, max: 256
91  
92 },
93 ...
94 ], # OPTIONAL
95 );
96  
97 # Results:
98 my $AutomationExecutionId =
99 $StartChangeRequestExecutionResult->AutomationExecutionId;
100  
101 # Returns a L<Paws::SSM::StartChangeRequestExecutionResult> object.
102  
103 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.
104 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/StartChangeRequestExecution>
105  
106 =head1 ATTRIBUTES
107  
108  
109 =head2 ChangeDetails => Str
110  
111 User-provided details about the change. If no details are provided,
112 content specified in the B<Template information> section of the
113 associated change template is added.
114  
115  
116  
117 =head2 ChangeRequestName => Str
118  
119 The name of the change request associated with the runbook workflow to
120 be run.
121  
122  
123  
124 =head2 ClientToken => Str
125  
126 The user-provided idempotency token. The token must be unique, is case
127 insensitive, enforces the UUID format, and can't be reused.
128  
129  
130  
131 =head2 B<REQUIRED> DocumentName => Str
132  
133 The name of the change template document to run during the runbook
134 workflow.
135  
136  
137  
138 =head2 DocumentVersion => Str
139  
140 The version of the change template document to run during the runbook
141 workflow.
142  
143  
144  
145 =head2 Parameters => L<Paws::SSM::AutomationParameterMap>
146  
147 A key-value map of parameters that match the declared parameters in the
148 change template document.
149  
150  
151  
152 =head2 B<REQUIRED> Runbooks => ArrayRef[L<Paws::SSM::Runbook>]
153  
154 Information about the Automation runbooks (Automation documents) that
155 are run during the runbook workflow.
156  
157 The Automation runbooks specified for the runbook workflow can't run
158 until all required approvals for the change request have been received.
159  
160  
161  
162 =head2 ScheduledEndTime => Str
163  
164 The time that the requester expects the runbook workflow related to the
165 change request to complete. The time is an estimate only that the
166 requester provides for reviewers.
167  
168  
169  
170 =head2 ScheduledTime => Str
171  
172 The date and time specified in the change request to run the Automation
173 runbooks.
174  
175 The Automation runbooks specified for the runbook workflow can't run
176 until all required approvals for the change request have been received.
177  
178  
179  
180 =head2 Tags => ArrayRef[L<Paws::SSM::Tag>]
181  
182 Optional metadata that you assign to a resource. You can specify a
183 maximum of five tags for a change request. Tags enable you to
184 categorize a resource in different ways, such as by purpose, owner, or
185 environment. For example, you might want to tag a change request to
186 identify an environment or target AWS Region. In this case, you could
187 specify the following key-value pairs:
188  
189 =over
190  
191 =item *
192  
193 C<Key=Environment,Value=Production>
194  
195 =item *
196  
197 C<Key=Region,Value=us-east-2>
198  
199 =back
200  
201  
202  
203  
204  
205 =head1 SEE ALSO
206  
207 This class forms part of L<Paws>, documenting arguments for method StartChangeRequestExecution in L<Paws::SSM>
208  
209 =head1 BUGS and CONTRIBUTIONS
210  
211 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
212  
213 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
214  
215 =cut
216