File Coverage

blib/lib/Paws/SSM/GetCommandInvocationResult.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              
2             package Paws::SSM::GetCommandInvocationResult;
3 1     1   449 use Moose;
  1         3  
  1         6  
4             has CommandId => (is => 'ro', isa => 'Str');
5             has Comment => (is => 'ro', isa => 'Str');
6             has DocumentName => (is => 'ro', isa => 'Str');
7             has ExecutionElapsedTime => (is => 'ro', isa => 'Str');
8             has ExecutionEndDateTime => (is => 'ro', isa => 'Str');
9             has ExecutionStartDateTime => (is => 'ro', isa => 'Str');
10             has InstanceId => (is => 'ro', isa => 'Str');
11             has PluginName => (is => 'ro', isa => 'Str');
12             has ResponseCode => (is => 'ro', isa => 'Int');
13             has StandardErrorContent => (is => 'ro', isa => 'Str');
14             has StandardErrorUrl => (is => 'ro', isa => 'Str');
15             has StandardOutputContent => (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              
20             has _request_id => (is => 'ro', isa => 'Str');
21              
22             ### main pod documentation begin ###
23              
24             =head1 NAME
25              
26             Paws::SSM::GetCommandInvocationResult
27              
28             =head1 ATTRIBUTES
29              
30              
31             =head2 CommandId => Str
32              
33             The parent command ID of the invocation plugin.
34              
35              
36             =head2 Comment => Str
37              
38             The comment text for the command.
39              
40              
41             =head2 DocumentName => Str
42              
43             The name of the document that was executed. For example,
44             AWS-RunShellScript.
45              
46              
47             =head2 ExecutionElapsedTime => Str
48              
49             Duration since ExecutionStartDateTime.
50              
51              
52             =head2 ExecutionEndDateTime => Str
53              
54             The date and time the plugin was finished executing. Date and time are
55             written in ISO 8601 format. For example, June 7, 2017 is represented as
56             2017-06-7. The following sample AWS CLI command uses the
57             C<InvokedAfter> filter.
58              
59             C<aws ssm list-commands --filters
60             key=InvokedAfter,value=2017-06-07T00:00:00Z>
61              
62             If the plugin has not started to execute, the string is empty.
63              
64              
65             =head2 ExecutionStartDateTime => Str
66              
67             The date and time the plugin started executing. Date and time are
68             written in ISO 8601 format. For example, June 7, 2017 is represented as
69             2017-06-7. The following sample AWS CLI command uses the
70             C<InvokedBefore> filter.
71              
72             C<aws ssm list-commands --filters
73             key=InvokedBefore,value=2017-06-07T00:00:00Z>
74              
75             If the plugin has not started to execute, the string is empty.
76              
77              
78             =head2 InstanceId => Str
79              
80             The ID of the managed instance targeted by the command. A managed
81             instance can be an Amazon EC2 instance or an instance in your hybrid
82             environment that is configured for Systems Manager.
83              
84              
85             =head2 PluginName => Str
86              
87             The name of the plugin for which you want detailed results. For
88             example, aws:RunShellScript is a plugin.
89              
90              
91             =head2 ResponseCode => Int
92              
93             The error level response code for the plugin script. If the response
94             code is -1, then the command has not started executing on the instance,
95             or it was not received by the instance.
96              
97              
98             =head2 StandardErrorContent => Str
99              
100             The first 8,000 characters written by the plugin to stderr. If the
101             command has not finished executing, then this string is empty.
102              
103              
104             =head2 StandardErrorUrl => Str
105              
106             The URL for the complete text written by the plugin to stderr. If the
107             command has not finished executing, then this string is empty.
108              
109              
110             =head2 StandardOutputContent => Str
111              
112             The first 24,000 characters written by the plugin to stdout. If the
113             command has not finished executing, if ExecutionStatus is neither
114             Succeeded nor Failed, then this string is empty.
115              
116              
117             =head2 StandardOutputUrl => Str
118              
119             The URL for the complete text written by the plugin to stdout in Amazon
120             S3. If an Amazon S3 bucket was not specified, then this string is
121             empty.
122              
123              
124             =head2 Status => Str
125              
126             The status of the parent command for this invocation. This status can
127             be different than StatusDetails.
128              
129             Valid values are: C<"Pending">, C<"InProgress">, C<"Delayed">, C<"Success">, C<"Cancelled">, C<"TimedOut">, C<"Failed">, C<"Cancelling">
130             =head2 StatusDetails => Str
131              
132             A detailed status of the command execution for an invocation.
133             StatusDetails includes more information than Status because it includes
134             states resulting from error and concurrency control parameters.
135             StatusDetails can show different results than Status. For more
136             information about these statuses, see Run Command Status. StatusDetails
137             can be one of the following values:
138              
139             =over
140              
141             =item *
142              
143             Pending: The command has not been sent to the instance.
144              
145             =item *
146              
147             In Progress: The command has been sent to the instance but has not
148             reached a terminal state.
149              
150             =item *
151              
152             Delayed: The system attempted to send the command to the target, but
153             the target was not available. The instance might not be available
154             because of network issues, the instance was stopped, etc. The system
155             will try to deliver the command again.
156              
157             =item *
158              
159             Success: The command or plugin was executed successfully. This is a
160             terminal state.
161              
162             =item *
163              
164             Delivery Timed Out: The command was not delivered to the instance
165             before the delivery timeout expired. Delivery timeouts do not count
166             against the parent command's MaxErrors limit, but they do contribute to
167             whether the parent command status is Success or Incomplete. This is a
168             terminal state.
169              
170             =item *
171              
172             Execution Timed Out: The command started to execute on the instance,
173             but the execution was not complete before the timeout expired.
174             Execution timeouts count against the MaxErrors limit of the parent
175             command. This is a terminal state.
176              
177             =item *
178              
179             Failed: The command wasn't executed successfully on the instance. For a
180             plugin, this indicates that the result code was not zero. For a command
181             invocation, this indicates that the result code for one or more plugins
182             was not zero. Invocation failures count against the MaxErrors limit of
183             the parent command. This is a terminal state.
184              
185             =item *
186              
187             Canceled: The command was terminated before it was completed. This is a
188             terminal state.
189              
190             =item *
191              
192             Undeliverable: The command can't be delivered to the instance. The
193             instance might not exist or might not be responding. Undeliverable
194             invocations don't count against the parent command's MaxErrors limit
195             and don't contribute to whether the parent command status is Success or
196             Incomplete. This is a terminal state.
197              
198             =item *
199              
200             Terminated: The parent command exceeded its MaxErrors limit and
201             subsequent command invocations were canceled by the system. This is a
202             terminal state.
203              
204             =back
205              
206              
207              
208             =head2 _request_id => Str
209              
210              
211             =cut
212              
213             1;