File Coverage

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