File Coverage

blib/lib/Paws/SSM/Command.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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