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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 20 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::CommandInvocation;
3 use Moose;
4 has CloudWatchOutputConfig => (is => 'ro', isa => 'Paws::SSM::CloudWatchOutputConfig');
5 has CommandId => (is => 'ro', isa => 'Str');
6 has CommandPlugins => (is => 'ro', isa => 'ArrayRef[Paws::SSM::CommandPlugin]');
7 has Comment => (is => 'ro', isa => 'Str');
8 has DocumentName => (is => 'ro', isa => 'Str');
9 has DocumentVersion => (is => 'ro', isa => 'Str');
10 has InstanceId => (is => 'ro', isa => 'Str');
11 has InstanceName => (is => 'ro', isa => 'Str');
12 has NotificationConfig => (is => 'ro', isa => 'Paws::SSM::NotificationConfig');
13 has RequestedDateTime => (is => 'ro', isa => 'Str');
14 has ServiceRole => (is => 'ro', isa => 'Str');
15 has StandardErrorUrl => (is => 'ro', isa => 'Str');
16 has StandardOutputUrl => (is => 'ro', isa => 'Str');
17 has Status => (is => 'ro', isa => 'Str');
18 has StatusDetails => (is => 'ro', isa => 'Str');
19 has TraceOutput => (is => 'ro', isa => 'Str');
20  
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::SSM::CommandInvocation
28  
29 =head1 USAGE
30  
31 This class represents one of two things:
32  
33 =head3 Arguments in a call to a service
34  
35 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
36 Each attribute should be used as a named argument in the calls that expect this type of object.
37  
38 As an example, if Att1 is expected to be a Paws::SSM::CommandInvocation object:
39  
40 $service_obj->Method(Att1 => { CloudWatchOutputConfig => $value, ..., TraceOutput => $value });
41  
42 =head3 Results returned from an API call
43  
44 Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::CommandInvocation object:
45  
46 $result = $service_obj->Method(...);
47 $result->Att1->CloudWatchOutputConfig
48  
49 =head1 DESCRIPTION
50  
51 An invocation is copy of a command sent to a specific instance. A
52 command can apply to one or more instances. A command invocation
53 applies to one instance. For example, if a user runs SendCommand
54 against three instances, then a command invocation is created for each
55 requested instance ID. A command invocation returns status and detail
56 information about a command you ran.
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 CloudWatchOutputConfig => L<Paws::SSM::CloudWatchOutputConfig>
62  
63 CloudWatch Logs information where you want Systems Manager to send the
64 command output.
65  
66  
67 =head2 CommandId => Str
68  
69 The command against which this invocation was requested.
70  
71  
72 =head2 CommandPlugins => ArrayRef[L<Paws::SSM::CommandPlugin>]
73  
74 Plugins processed by the command.
75  
76  
77 =head2 Comment => Str
78  
79 User-specified information about the command, such as a brief
80 description of what the command should do.
81  
82  
83 =head2 DocumentName => Str
84  
85 The document name that was requested for execution.
86  
87  
88 =head2 DocumentVersion => Str
89  
90 The SSM document version.
91  
92  
93 =head2 InstanceId => Str
94  
95 The instance ID in which this invocation was requested.
96  
97  
98 =head2 InstanceName => Str
99  
100 The name of the invocation target. For EC2 instances this is the value
101 for the aws:Name tag. For on-premises instances, this is the name of
102 the instance.
103  
104  
105 =head2 NotificationConfig => L<Paws::SSM::NotificationConfig>
106  
107 Configurations for sending notifications about command status changes
108 on a per instance basis.
109  
110  
111 =head2 RequestedDateTime => Str
112  
113 The time and date the request was sent to this instance.
114  
115  
116 =head2 ServiceRole => Str
117  
118 The IAM service role that Run Command uses to act on your behalf when
119 sending notifications about command status changes on a per instance
120 basis.
121  
122  
123 =head2 StandardErrorUrl => Str
124  
125 The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was
126 defined for the parent command. For an invocation, StandardErrorUrl is
127 populated if there is just one plugin defined for the command, and the
128 S3 bucket was defined for the command.
129  
130  
131 =head2 StandardOutputUrl => Str
132  
133 The URL to the plugin's StdOut file in Amazon S3, if the S3 bucket was
134 defined for the parent command. For an invocation, StandardOutputUrl is
135 populated if there is just one plugin defined for the command, and the
136 S3 bucket was defined for the command.
137  
138  
139 =head2 Status => Str
140  
141 Whether or not the invocation succeeded, failed, or is pending.
142  
143  
144 =head2 StatusDetails => Str
145  
146 A detailed status of the command execution for each invocation (each
147 instance targeted by the command). StatusDetails includes more
148 information than Status because it includes states resulting from error
149 and concurrency control parameters. StatusDetails can show different
150 results than Status. For more information about these statuses, see
151 Understanding command statuses
152 (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
153 in the I<AWS Systems Manager User Guide>. StatusDetails can be one of
154 the following values:
155  
156 =over
157  
158 =item *
159  
160 Pending: The command has not been sent to the instance.
161  
162 =item *
163  
164 In Progress: The command has been sent to the instance but has not
165 reached a terminal state.
166  
167 =item *
168  
169 Success: The execution of the command or plugin was successfully
170 completed. This is a terminal state.
171  
172 =item *
173  
174 Delivery Timed Out: The command was not delivered to the instance
175 before the delivery timeout expired. Delivery timeouts do not count
176 against the parent command's MaxErrors limit, but they do contribute to
177 whether the parent command status is Success or Incomplete. This is a
178 terminal state.
179  
180 =item *
181  
182 Execution Timed Out: Command execution started on the instance, but the
183 execution was not complete before the execution timeout expired.
184 Execution timeouts count against the MaxErrors limit of the parent
185 command. This is a terminal state.
186  
187 =item *
188  
189 Failed: The command was not successful on the instance. For a plugin,
190 this indicates that the result code was not zero. For a command
191 invocation, this indicates that the result code for one or more plugins
192 was not zero. Invocation failures count against the MaxErrors limit of
193 the parent command. This is a terminal state.
194  
195 =item *
196  
197 Canceled: The command was terminated before it was completed. This is a
198 terminal state.
199  
200 =item *
201  
202 Undeliverable: The command can't be delivered to the instance. The
203 instance might not exist or might not be responding. Undeliverable
204 invocations don't count against the parent command's MaxErrors limit
205 and don't contribute to whether the parent command status is Success or
206 Incomplete. This is a terminal state.
207  
208 =item *
209  
210 Terminated: The parent command exceeded its MaxErrors limit and
211 subsequent command invocations were canceled by the system. This is a
212 terminal state.
213  
214 =back
215  
216  
217  
218 =head2 TraceOutput => Str
219  
220 Gets the trace output sent by the agent.
221  
222  
223  
224 =head1 SEE ALSO
225  
226 This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
227  
228 =head1 BUGS and CONTRIBUTIONS
229  
230 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
231  
232 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
233  
234 =cut
235