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

filter: Statementstmt 0.0% 0 / 27 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::SSM::Command;
3 use Moose;
4 has CloudWatchOutputConfig => (is => 'ro', isa => 'Paws::SSM::CloudWatchOutputConfig');
5 has CommandId => (is => 'ro', isa => 'Str');
6 has Comment => (is => 'ro', isa => 'Str');
7 has CompletedCount => (is => 'ro', isa => 'Int');
8 has DeliveryTimedOutCount => (is => 'ro', isa => 'Int');
9 has DocumentName => (is => 'ro', isa => 'Str');
10 has DocumentVersion => (is => 'ro', isa => 'Str');
11 has ErrorCount => (is => 'ro', isa => 'Int');
12 has ExpiresAfter => (is => 'ro', isa => 'Str');
13 has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14 has MaxConcurrency => (is => 'ro', isa => 'Str');
15 has MaxErrors => (is => 'ro', isa => 'Str');
16 has NotificationConfig => (is => 'ro', isa => 'Paws::SSM::NotificationConfig');
17 has OutputS3BucketName => (is => 'ro', isa => 'Str');
18 has OutputS3KeyPrefix => (is => 'ro', isa => 'Str');
19 has OutputS3Region => (is => 'ro', isa => 'Str');
20 has Parameters => (is => 'ro', isa => 'Paws::SSM::Parameters');
21 has RequestedDateTime => (is => 'ro', isa => 'Str');
22 has ServiceRole => (is => 'ro', isa => 'Str');
23 has Status => (is => 'ro', isa => 'Str');
24 has StatusDetails => (is => 'ro', isa => 'Str');
25 has TargetCount => (is => 'ro', isa => 'Int');
26 has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]');
27 has TimeoutSeconds => (is => 'ro', isa => 'Int');
28  
29 1;
30  
31 ### main pod documentation begin ###
32  
33 =head1 NAME
34  
35 Paws::SSM::Command
36  
37 =head1 USAGE
38  
39 This class represents one of two things:
40  
41 =head3 Arguments in a call to a service
42  
43 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
44 Each attribute should be used as a named argument in the calls that expect this type of object.
45  
46 As an example, if Att1 is expected to be a Paws::SSM::Command object:
47  
48 $service_obj->Method(Att1 => { CloudWatchOutputConfig => $value, ..., TimeoutSeconds => $value });
49  
50 =head3 Results returned from an API call
51  
52 Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::Command object:
53  
54 $result = $service_obj->Method(...);
55 $result->Att1->CloudWatchOutputConfig
56  
57 =head1 DESCRIPTION
58  
59 Describes a command request.
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 CloudWatchOutputConfig => L<Paws::SSM::CloudWatchOutputConfig>
65  
66 CloudWatch Logs information where you want Systems Manager to send the
67 command output.
68  
69  
70 =head2 CommandId => Str
71  
72 A unique identifier for this command.
73  
74  
75 =head2 Comment => Str
76  
77 User-specified information about the command, such as a brief
78 description of what the command should do.
79  
80  
81 =head2 CompletedCount => Int
82  
83 The number of targets for which the command invocation reached a
84 terminal state. Terminal states include the following: Success, Failed,
85 Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or
86 Undeliverable.
87  
88  
89 =head2 DeliveryTimedOutCount => Int
90  
91 The number of targets for which the status is Delivery Timed Out.
92  
93  
94 =head2 DocumentName => Str
95  
96 The name of the document requested for execution.
97  
98  
99 =head2 DocumentVersion => Str
100  
101 The SSM document version.
102  
103  
104 =head2 ErrorCount => Int
105  
106 The number of targets for which the status is Failed or Execution Timed
107 Out.
108  
109  
110 =head2 ExpiresAfter => Str
111  
112 If this time is reached and the command has not already started
113 running, it will not run. Calculated based on the ExpiresAfter user
114 input provided as part of the SendCommand API.
115  
116  
117 =head2 InstanceIds => ArrayRef[Str|Undef]
118  
119 The instance IDs against which this command was requested.
120  
121  
122 =head2 MaxConcurrency => Str
123  
124 The maximum number of instances that are allowed to run the command at
125 the same time. You can specify a number of instances, such as 10, or a
126 percentage of instances, such as 10%. The default value is 50. For more
127 information about how to use MaxConcurrency, see Running commands using
128 Systems Manager Run Command
129 (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
130 in the I<AWS Systems Manager User Guide>.
131  
132  
133 =head2 MaxErrors => Str
134  
135 The maximum number of errors allowed before the system stops sending
136 the command to additional targets. You can specify a number of errors,
137 such as 10, or a percentage or errors, such as 10%. The default value
138 is 0. For more information about how to use MaxErrors, see Running
139 commands using Systems Manager Run Command
140 (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
141 in the I<AWS Systems Manager User Guide>.
142  
143  
144 =head2 NotificationConfig => L<Paws::SSM::NotificationConfig>
145  
146 Configurations for sending notifications about command status changes.
147  
148  
149 =head2 OutputS3BucketName => Str
150  
151 The S3 bucket where the responses to the command executions should be
152 stored. This was requested when issuing the command.
153  
154  
155 =head2 OutputS3KeyPrefix => Str
156  
157 The S3 directory path inside the bucket where the responses to the
158 command executions should be stored. This was requested when issuing
159 the command.
160  
161  
162 =head2 OutputS3Region => Str
163  
164 (Deprecated) You can no longer specify this parameter. The system
165 ignores it. Instead, Systems Manager automatically determines the
166 Region of the S3 bucket.
167  
168  
169 =head2 Parameters => L<Paws::SSM::Parameters>
170  
171 The parameter values to be inserted in the document when running the
172 command.
173  
174  
175 =head2 RequestedDateTime => Str
176  
177 The date and time the command was requested.
178  
179  
180 =head2 ServiceRole => Str
181  
182 The IAM service role that Run Command uses to act on your behalf when
183 sending notifications about command status changes.
184  
185  
186 =head2 Status => Str
187  
188 The status of the command.
189  
190  
191 =head2 StatusDetails => Str
192  
193 A detailed status of the command execution. StatusDetails includes more
194 information than Status because it includes states resulting from error
195 and concurrency control parameters. StatusDetails can show different
196 results than Status. For more information about these statuses, see
197 Understanding command statuses
198 (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
199 in the I<AWS Systems Manager User Guide>. StatusDetails can be one of
200 the following values:
201  
202 =over
203  
204 =item *
205  
206 Pending: The command has not been sent to any instances.
207  
208 =item *
209  
210 In Progress: The command has been sent to at least one instance but has
211 not reached a final state on all instances.
212  
213 =item *
214  
215 Success: The command successfully ran on all invocations. This is a
216 terminal state.
217  
218 =item *
219  
220 Delivery Timed Out: The value of MaxErrors or more command invocations
221 shows a status of Delivery Timed Out. This is a terminal state.
222  
223 =item *
224  
225 Execution Timed Out: The value of MaxErrors or more command invocations
226 shows a status of Execution Timed Out. This is a terminal state.
227  
228 =item *
229  
230 Failed: The value of MaxErrors or more command invocations shows a
231 status of Failed. This is a terminal state.
232  
233 =item *
234  
235 Incomplete: The command was attempted on all instances and one or more
236 invocations does not have a value of Success but not enough invocations
237 failed for the status to be Failed. This is a terminal state.
238  
239 =item *
240  
241 Canceled: The command was terminated before it was completed. This is a
242 terminal state.
243  
244 =item *
245  
246 Rate Exceeded: The number of instances targeted by the command exceeded
247 the account limit for pending invocations. The system has canceled the
248 command before running it on any instance. This is a terminal state.
249  
250 =back
251  
252  
253  
254 =head2 TargetCount => Int
255  
256 The number of targets for the command.
257  
258  
259 =head2 Targets => ArrayRef[L<Paws::SSM::Target>]
260  
261 An array of search criteria that targets instances using a Key,Value
262 combination that you specify. Targets is required if you don't provide
263 one or more instance IDs in the call.
264  
265  
266 =head2 TimeoutSeconds => Int
267  
268 The C<TimeoutSeconds> value specified for a command.
269  
270  
271  
272 =head1 SEE ALSO
273  
274 This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
275  
276 =head1 BUGS and CONTRIBUTIONS
277  
278 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
279  
280 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
281  
282 =cut
283