blib/lib/Paws/SageMaker/SecondaryStatusTransition.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::SageMaker::SecondaryStatusTransition;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str');
5 has StartTime => (is => 'ro', isa => 'Str', required => 1);
6 has Status => (is => 'ro', isa => 'Str', required => 1);
7 has StatusMessage => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::SageMaker::SecondaryStatusTransition
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::SageMaker::SecondaryStatusTransition object:
27  
28 $service_obj->Method(Att1 => { EndTime => $value, ..., StatusMessage => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::SecondaryStatusTransition object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->EndTime
36  
37 =head1 DESCRIPTION
38  
39 An array element of
40 DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides
41 additional details about a status that the training job has
42 transitioned through. A training job can be in one of several states,
43 for example, starting, downloading, training, or uploading. Within each
44 state, there are a number of intermediate states. For example, within
45 the starting state, Amazon SageMaker could be starting the training job
46 or launching the ML instances. These transitional states are referred
47 to as the job's secondary status.
48  
49 =head1 ATTRIBUTES
50  
51  
52 =head2 EndTime => Str
53  
54 A timestamp that shows when the training job transitioned out of this
55 secondary status state into another secondary status state or when the
56 training job has ended.
57  
58  
59 =head2 B<REQUIRED> StartTime => Str
60  
61 A timestamp that shows when the training job transitioned to the
62 current secondary status state.
63  
64  
65 =head2 B<REQUIRED> Status => Str
66  
67 Contains a secondary status information from a training job.
68  
69 Status might be one of the following secondary statuses:
70  
71 =over
72  
73 =item InProgress
74  
75 =over
76  
77 =item *
78  
79 C<Starting> - Starting the training job.
80  
81 =item *
82  
83 C<Downloading> - An optional stage for algorithms that support C<File>
84 training input mode. It indicates that data is being downloaded to the
85 ML storage volumes.
86  
87 =item *
88  
89 C<Training> - Training is in progress.
90  
91 =item *
92  
93 C<Uploading> - Training is complete and the model artifacts are being
94 uploaded to the S3 location.
95  
96 =back
97  
98 =item Completed
99  
100 =over
101  
102 =item *
103  
104 C<Completed> - The training job has completed.
105  
106 =back
107  
108 =item Failed
109  
110 =over
111  
112 =item *
113  
114 C<Failed> - The training job has failed. The reason for the failure is
115 returned in the C<FailureReason> field of
116 C<DescribeTrainingJobResponse>.
117  
118 =back
119  
120 =item Stopped
121  
122 =over
123  
124 =item *
125  
126 C<MaxRuntimeExceeded> - The job stopped because it exceeded the maximum
127 allowed runtime.
128  
129 =item *
130  
131 C<Stopped> - The training job has stopped.
132  
133 =back
134  
135 =item Stopping
136  
137 =over
138  
139 =item *
140  
141 C<Stopping> - Stopping the training job.
142  
143 =back
144  
145 =back
146  
147 We no longer support the following secondary statuses:
148  
149 =over
150  
151 =item *
152  
153 C<LaunchingMLInstances>
154  
155 =item *
156  
157 C<PreparingTrainingStack>
158  
159 =item *
160  
161 C<DownloadingTrainingImage>
162  
163 =back
164  
165  
166  
167 =head2 StatusMessage => Str
168  
169 A detailed description of the progress within a secondary status.
170  
171 Amazon SageMaker provides secondary statuses and status messages that
172 apply to each of them:
173  
174 =over
175  
176 =item Starting
177  
178 =over
179  
180 =item *
181  
182 Starting the training job.
183  
184 =item *
185  
186 Launching requested ML instances.
187  
188 =item *
189  
190 Insufficient capacity error from EC2 while launching instances,
191 retrying!
192  
193 =item *
194  
195 Launched instance was unhealthy, replacing it!
196  
197 =item *
198  
199 Preparing the instances for training.
200  
201 =back
202  
203 =item Training
204  
205 =over
206  
207 =item *
208  
209 Downloading the training image.
210  
211 =item *
212  
213 Training image download completed. Training in progress.
214  
215 =back
216  
217 =back
218  
219 Status messages are subject to change. Therefore, we recommend not
220 including them in code that programmatically initiates actions. For
221 examples, don't use status messages in if statements.
222  
223 To have an overview of your training job's progress, view
224 C<TrainingJobStatus> and C<SecondaryStatus> in DescribeTrainingJob, and
225 C<StatusMessage> together. For example, at the start of a training job,
226 you might see the following:
227  
228 =over
229  
230 =item *
231  
232 C<TrainingJobStatus> - InProgress
233  
234 =item *
235  
236 C<SecondaryStatus> - Training
237  
238 =item *
239  
240 C<StatusMessage> - Downloading the training image
241  
242 =back
243  
244  
245  
246  
247 =head1 SEE ALSO
248  
249 This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker>
250  
251 =head1 BUGS and CONTRIBUTIONS
252  
253 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
254  
255 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
256  
257 =cut
258