blib/lib/Paws/MachineLearning.pm

filter: Statementstmt 8.1% 14 / 172 Branchbran 0.0% 0 / 32 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 12.2% 5 / 41 Podpod 84.2% 32 / 38 totaltotal 18.0% 51 / 283 CC 25 SCAR 32.3
CC
25
Cov
7%
DescribeAllBatchPredictions
56.0
DescribeAllDataSources
56.0
DescribeAllEvaluations
56.0
CRAP 25.2
« lib/Paws/StorageGateway.pm ↑ Summary lib/Paws/DataPipeline.pm »
1 package Paws::MachineLearning;
2 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 1 ▶ sub service { 'machinelearning' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
4 0 ▶ sub signing_name { 'machinelearning' }
Subroutine signing_name: not called CC=1 SCAR=6.9
Pod undocumented
5 0 ▶ sub version { '2014-12-12' }
Subroutine version: not called CC=1 SCAR=6.9
Pod undocumented
6 0 ▶ sub target_prefix { 'AmazonML_20141212' }
Subroutine target_prefix: not called CC=1 SCAR=6.9
Pod undocumented
7 0 ▶ sub json_version { "1.1" }
Subroutine json_version: not called CC=1 SCAR=6.9
Pod undocumented
8 1 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 1 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
10 1 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 1 });
12 1 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
13 1 ] });
14  
15 1 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 0 ▶ sub AddTags {
Subroutine AddTags: not called CC=1 SCAR=6.9
Pod documented
19 0 my $self = shift;
20 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::AddTags', @_);
21 0 return $self->caller->do_call($self, $call_object);
22 }
23 0 ▶ sub CreateBatchPrediction {
Subroutine CreateBatchPrediction: not called CC=1 SCAR=6.9
Pod documented
24 0 my $self = shift;
25 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateBatchPrediction', @_);
26 0 return $self->caller->do_call($self, $call_object);
27 }
28 0 ▶ sub CreateDataSourceFromRDS {
Subroutine CreateDataSourceFromRDS: not called CC=1 SCAR=6.9
Pod documented
29 0 my $self = shift;
30 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateDataSourceFromRDS', @_);
31 0 return $self->caller->do_call($self, $call_object);
32 }
33 0 ▶ sub CreateDataSourceFromRedshift {
Subroutine CreateDataSourceFromRedshift: not called CC=1 SCAR=6.9
Pod documented
34 0 my $self = shift;
35 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateDataSourceFromRedshift', @_);
36 0 return $self->caller->do_call($self, $call_object);
37 }
38 0 ▶ sub CreateDataSourceFromS3 {
Subroutine CreateDataSourceFromS3: not called CC=1 SCAR=6.9
Pod documented
39 0 my $self = shift;
40 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateDataSourceFromS3', @_);
41 0 return $self->caller->do_call($self, $call_object);
42 }
43 0 ▶ sub CreateEvaluation {
Subroutine CreateEvaluation: not called CC=1 SCAR=6.9
Pod documented
44 0 my $self = shift;
45 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateEvaluation', @_);
46 0 return $self->caller->do_call($self, $call_object);
47 }
48 0 ▶ sub CreateMLModel {
Subroutine CreateMLModel: not called CC=1 SCAR=6.9
Pod documented
49 0 my $self = shift;
50 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateMLModel', @_);
51 0 return $self->caller->do_call($self, $call_object);
52 }
53 0 ▶ sub CreateRealtimeEndpoint {
Subroutine CreateRealtimeEndpoint: not called CC=1 SCAR=6.9
Pod documented
54 0 my $self = shift;
55 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::CreateRealtimeEndpoint', @_);
56 0 return $self->caller->do_call($self, $call_object);
57 }
58 0 ▶ sub DeleteBatchPrediction {
Subroutine DeleteBatchPrediction: not called CC=1 SCAR=6.9
Pod documented
59 0 my $self = shift;
60 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteBatchPrediction', @_);
61 0 return $self->caller->do_call($self, $call_object);
62 }
63 0 ▶ sub DeleteDataSource {
Subroutine DeleteDataSource: not called CC=1 SCAR=6.9
Pod documented
64 0 my $self = shift;
65 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteDataSource', @_);
66 0 return $self->caller->do_call($self, $call_object);
67 }
68 0 ▶ sub DeleteEvaluation {
Subroutine DeleteEvaluation: not called CC=1 SCAR=6.9
Pod documented
69 0 my $self = shift;
70 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteEvaluation', @_);
71 0 return $self->caller->do_call($self, $call_object);
72 }
73 0 ▶ sub DeleteMLModel {
Subroutine DeleteMLModel: not called CC=1 SCAR=6.9
Pod documented
74 0 my $self = shift;
75 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteMLModel', @_);
76 0 return $self->caller->do_call($self, $call_object);
77 }
78 0 ▶ sub DeleteRealtimeEndpoint {
Subroutine DeleteRealtimeEndpoint: not called CC=1 SCAR=6.9
Pod documented
79 0 my $self = shift;
80 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteRealtimeEndpoint', @_);
81 0 return $self->caller->do_call($self, $call_object);
82 }
83 0 ▶ sub DeleteTags {
Subroutine DeleteTags: not called CC=1 SCAR=6.9
Pod documented
84 0 my $self = shift;
85 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DeleteTags', @_);
86 0 return $self->caller->do_call($self, $call_object);
87 }
88 0 ▶ sub DescribeBatchPredictions {
Subroutine DescribeBatchPredictions: not called CC=1 SCAR=6.9
Pod documented
89 0 my $self = shift;
90 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DescribeBatchPredictions', @_);
91 0 return $self->caller->do_call($self, $call_object);
92 }
93 0 ▶ sub DescribeDataSources {
Subroutine DescribeDataSources: not called CC=1 SCAR=6.9
Pod documented
94 0 my $self = shift;
95 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DescribeDataSources', @_);
96 0 return $self->caller->do_call($self, $call_object);
97 }
98 0 ▶ sub DescribeEvaluations {
Subroutine DescribeEvaluations: not called CC=1 SCAR=6.9
Pod documented
99 0 my $self = shift;
100 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DescribeEvaluations', @_);
101 0 return $self->caller->do_call($self, $call_object);
102 }
103 1 ▶ sub DescribeMLModels {
Subroutine DescribeMLModels: called CC=1 SCAR=0.0
Pod documented
104 1 my $self = shift;
105 1 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DescribeMLModels', @_);
106 1 return $self->caller->do_call($self, $call_object);
107 }
108 0 ▶ sub DescribeTags {
Subroutine DescribeTags: not called CC=1 SCAR=6.9
Pod documented
109 0 my $self = shift;
110 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::DescribeTags', @_);
111 0 return $self->caller->do_call($self, $call_object);
112 }
113 0 ▶ sub GetBatchPrediction {
Subroutine GetBatchPrediction: not called CC=1 SCAR=6.9
Pod documented
114 0 my $self = shift;
115 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::GetBatchPrediction', @_);
116 0 return $self->caller->do_call($self, $call_object);
117 }
118 0 ▶ sub GetDataSource {
Subroutine GetDataSource: not called CC=1 SCAR=6.9
Pod documented
119 0 my $self = shift;
120 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::GetDataSource', @_);
121 0 return $self->caller->do_call($self, $call_object);
122 }
123 0 ▶ sub GetEvaluation {
Subroutine GetEvaluation: not called CC=1 SCAR=6.9
Pod documented
124 0 my $self = shift;
125 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::GetEvaluation', @_);
126 0 return $self->caller->do_call($self, $call_object);
127 }
128 0 ▶ sub GetMLModel {
Subroutine GetMLModel: not called CC=1 SCAR=6.9
Pod documented
129 0 my $self = shift;
130 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::GetMLModel', @_);
131 0 return $self->caller->do_call($self, $call_object);
132 }
133 0 ▶ sub Predict {
Subroutine Predict: not called CC=1 SCAR=6.9
Pod documented
134 0 my $self = shift;
135 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::Predict', @_);
136 0 return $self->caller->do_call($self, $call_object);
137 }
138 0 ▶ sub UpdateBatchPrediction {
Subroutine UpdateBatchPrediction: not called CC=1 SCAR=6.9
Pod documented
139 0 my $self = shift;
140 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::UpdateBatchPrediction', @_);
141 0 return $self->caller->do_call($self, $call_object);
142 }
143 0 ▶ sub UpdateDataSource {
Subroutine UpdateDataSource: not called CC=1 SCAR=6.9
Pod documented
144 0 my $self = shift;
145 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::UpdateDataSource', @_);
146 0 return $self->caller->do_call($self, $call_object);
147 }
148 0 ▶ sub UpdateEvaluation {
Subroutine UpdateEvaluation: not called CC=1 SCAR=6.9
Pod documented
149 0 my $self = shift;
150 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::UpdateEvaluation', @_);
151 0 return $self->caller->do_call($self, $call_object);
152 }
153 0 ▶ sub UpdateMLModel {
Subroutine UpdateMLModel: not called CC=1 SCAR=6.9
Pod documented
154 0 my $self = shift;
155 0 my $call_object = $self->new_with_coercions('Paws::MachineLearning::UpdateMLModel', @_);
156 0 return $self->caller->do_call($self, $call_object);
157 }
158
159 0 ▶ sub DescribeAllBatchPredictions {
Subroutine DescribeAllBatchPredictions: not called CC=7 SCAR=40.3
Pod documented
160 0 my $self = shift;
161  
162 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
163 0 my $result = $self->DescribeBatchPredictions(@_);
164 0 my $next_result = $result;
165  
166 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
167 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
168 0 $next_result = $self->DescribeBatchPredictions(@_, NextToken => $next_result->NextToken);
169 0 push @{ $result->Results }, @{ $next_result->Results };
170 }
171 0 return $result;
172 } else {
173 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
174 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
175 0 $result = $self->DescribeBatchPredictions(@_, NextToken => $result->NextToken);
176 }
177 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
178 }
179  
180 return undef
181 0 }
182 0 ▶ sub DescribeAllDataSources {
Subroutine DescribeAllDataSources: not called CC=7 SCAR=40.3
Pod documented
183 0 my $self = shift;
184  
185 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
186 0 my $result = $self->DescribeDataSources(@_);
187 0 my $next_result = $result;
188  
189 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
190 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
191 0 $next_result = $self->DescribeDataSources(@_, NextToken => $next_result->NextToken);
192 0 push @{ $result->Results }, @{ $next_result->Results };
193 }
194 0 return $result;
195 } else {
196 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
197 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
198 0 $result = $self->DescribeDataSources(@_, NextToken => $result->NextToken);
199 }
200 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
201 }
202  
203 return undef
204 0 }
205 0 ▶ sub DescribeAllEvaluations {
Subroutine DescribeAllEvaluations: not called CC=7 SCAR=40.3
Pod documented
206 0 my $self = shift;
207  
208 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
209 0 my $result = $self->DescribeEvaluations(@_);
210 0 my $next_result = $result;
211  
212 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
213 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
214 0 $next_result = $self->DescribeEvaluations(@_, NextToken => $next_result->NextToken);
215 0 push @{ $result->Results }, @{ $next_result->Results };
216 }
217 0 return $result;
218 } else {
219 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
220 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
221 0 $result = $self->DescribeEvaluations(@_, NextToken => $result->NextToken);
222 }
223 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
224 }
225  
226 return undef
227 0 }
228 0 ▶ sub DescribeAllMLModels {
Subroutine DescribeAllMLModels: not called CC=7 SCAR=40.3
Pod documented
229 0 my $self = shift;
230  
231 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
232 0 my $result = $self->DescribeMLModels(@_);
233 0 my $next_result = $result;
234  
235 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
236 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
237 0 $next_result = $self->DescribeMLModels(@_, NextToken => $next_result->NextToken);
238 0 push @{ $result->Results }, @{ $next_result->Results };
239 }
240 0 return $result;
241 } else {
242 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
243 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
244 0 $result = $self->DescribeMLModels(@_, NextToken => $result->NextToken);
245 }
246 0 $callback->($_ => 'Results') foreach (@{ $result->Results });
247 }
248  
249 return undef
250 0 }
251  
252  
253 0 ▶ sub operations { qw/AddTags CreateBatchPrediction CreateDataSourceFromRDS CreateDataSourceFromRedshift CreateDataSourceFromS3 CreateEvaluation CreateMLModel CreateRealtimeEndpoint DeleteBatchPrediction DeleteDataSource DeleteEvaluation DeleteMLModel DeleteRealtimeEndpoint DeleteTags DescribeBatchPredictions DescribeDataSources DescribeEvaluations DescribeMLModels DescribeTags GetBatchPrediction GetDataSource GetEvaluation GetMLModel Predict UpdateBatchPrediction UpdateDataSource UpdateEvaluation UpdateMLModel / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
254  
255 1 1;
256  
257 ### main pod documentation begin ###
258  
259 =head1 NAME
260  
261 Paws::MachineLearning - Perl Interface to AWS Amazon Machine Learning
262  
263 =head1 SYNOPSIS
264  
265 use Paws;
266  
267 my $obj = Paws->service('MachineLearning');
268 my $res = $obj->Method(
269 Arg1 => $val1,
270 Arg2 => [ 'V1', 'V2' ],
271 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
272 # of the arguments type
273 Arg3 => { Att1 => 'Val1' },
274 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
275 # the constructor of the arguments type
276 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
277 );
278  
279 =head1 DESCRIPTION
280  
281 Definition of the public APIs exposed by Amazon Machine Learning
282  
283 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning-2014-12-12>
284  
285  
286 =head1 METHODS
287  
288 =head2 AddTags
289  
290 =over
291  
292 =item ResourceId => Str
293  
294 =item ResourceType => Str
295  
296 =item Tags => ArrayRef[L<Paws::MachineLearning::Tag>]
297  
298  
299 =back
300  
301 Each argument is described in detail in: L<Paws::MachineLearning::AddTags>
302  
303 Returns: a L<Paws::MachineLearning::AddTagsOutput> instance
304  
305 Adds one or more tags to an object, up to a limit of 10. Each tag
306 consists of a key and an optional value. If you add a tag using a key
307 that is already associated with the ML object, C<AddTags> updates the
308 tag's value.
309  
310  
311 =head2 CreateBatchPrediction
312  
313 =over
314  
315 =item BatchPredictionDataSourceId => Str
316  
317 =item BatchPredictionId => Str
318  
319 =item MLModelId => Str
320  
321 =item OutputUri => Str
322  
323 =item [BatchPredictionName => Str]
324  
325  
326 =back
327  
328 Each argument is described in detail in: L<Paws::MachineLearning::CreateBatchPrediction>
329  
330 Returns: a L<Paws::MachineLearning::CreateBatchPredictionOutput> instance
331  
332 Generates predictions for a group of observations. The observations to
333 process exist in one or more data files referenced by a C<DataSource>.
334 This operation creates a new C<BatchPrediction>, and uses an C<MLModel>
335 and the data files referenced by the C<DataSource> as information
336 sources.
337  
338 C<CreateBatchPrediction> is an asynchronous operation. In response to
339 C<CreateBatchPrediction>, Amazon Machine Learning (Amazon ML)
340 immediately returns and sets the C<BatchPrediction> status to
341 C<PENDING>. After the C<BatchPrediction> completes, Amazon ML sets the
342 status to C<COMPLETED>.
343  
344 You can poll for status updates by using the GetBatchPrediction
345 operation and checking the C<Status> parameter of the result. After the
346 C<COMPLETED> status appears, the results are available in the location
347 specified by the C<OutputUri> parameter.
348  
349  
350 =head2 CreateDataSourceFromRDS
351  
352 =over
353  
354 =item DataSourceId => Str
355  
356 =item RDSData => L<Paws::MachineLearning::RDSDataSpec>
357  
358 =item RoleARN => Str
359  
360 =item [ComputeStatistics => Bool]
361  
362 =item [DataSourceName => Str]
363  
364  
365 =back
366  
367 Each argument is described in detail in: L<Paws::MachineLearning::CreateDataSourceFromRDS>
368  
369 Returns: a L<Paws::MachineLearning::CreateDataSourceFromRDSOutput> instance
370  
371 Creates a C<DataSource> object from an Amazon Relational Database
372 Service (http://aws.amazon.com/rds/) (Amazon RDS). A C<DataSource>
373 references data that can be used to perform C<CreateMLModel>,
374 C<CreateEvaluation>, or C<CreateBatchPrediction> operations.
375  
376 C<CreateDataSourceFromRDS> is an asynchronous operation. In response to
377 C<CreateDataSourceFromRDS>, Amazon Machine Learning (Amazon ML)
378 immediately returns and sets the C<DataSource> status to C<PENDING>.
379 After the C<DataSource> is created and ready for use, Amazon ML sets
380 the C<Status> parameter to C<COMPLETED>. C<DataSource> in the
381 C<COMPLETED> or C<PENDING> state can be used only to perform
382 C<E<gt>CreateMLModel>E<gt>, C<CreateEvaluation>, or
383 C<CreateBatchPrediction> operations.
384  
385 If Amazon ML cannot accept the input source, it sets the C<Status>
386 parameter to C<FAILED> and includes an error message in the C<Message>
387 attribute of the C<GetDataSource> operation response.
388  
389  
390 =head2 CreateDataSourceFromRedshift
391  
392 =over
393  
394 =item DataSourceId => Str
395  
396 =item DataSpec => L<Paws::MachineLearning::RedshiftDataSpec>
397  
398 =item RoleARN => Str
399  
400 =item [ComputeStatistics => Bool]
401  
402 =item [DataSourceName => Str]
403  
404  
405 =back
406  
407 Each argument is described in detail in: L<Paws::MachineLearning::CreateDataSourceFromRedshift>
408  
409 Returns: a L<Paws::MachineLearning::CreateDataSourceFromRedshiftOutput> instance
410  
411 Creates a C<DataSource> from a database hosted on an Amazon Redshift
412 cluster. A C<DataSource> references data that can be used to perform
413 either C<CreateMLModel>, C<CreateEvaluation>, or
414 C<CreateBatchPrediction> operations.
415  
416 C<CreateDataSourceFromRedshift> is an asynchronous operation. In
417 response to C<CreateDataSourceFromRedshift>, Amazon Machine Learning
418 (Amazon ML) immediately returns and sets the C<DataSource> status to
419 C<PENDING>. After the C<DataSource> is created and ready for use,
420 Amazon ML sets the C<Status> parameter to C<COMPLETED>. C<DataSource>
421 in C<COMPLETED> or C<PENDING> states can be used to perform only
422 C<CreateMLModel>, C<CreateEvaluation>, or C<CreateBatchPrediction>
423 operations.
424  
425 If Amazon ML can't accept the input source, it sets the C<Status>
426 parameter to C<FAILED> and includes an error message in the C<Message>
427 attribute of the C<GetDataSource> operation response.
428  
429 The observations should be contained in the database hosted on an
430 Amazon Redshift cluster and should be specified by a C<SelectSqlQuery>
431 query. Amazon ML executes an C<Unload> command in Amazon Redshift to
432 transfer the result set of the C<SelectSqlQuery> query to
433 C<S3StagingLocation>.
434  
435 After the C<DataSource> has been created, it's ready for use in
436 evaluations and batch predictions. If you plan to use the C<DataSource>
437 to train an C<MLModel>, the C<DataSource> also requires a recipe. A
438 recipe describes how each input variable will be used in training an
439 C<MLModel>. Will the variable be included or excluded from training?
440 Will the variable be manipulated; for example, will it be combined with
441 another variable or will it be split apart into word combinations? The
442 recipe provides answers to these questions.
443  
444 You can't change an existing datasource, but you can copy and modify
445 the settings from an existing Amazon Redshift datasource to create a
446 new datasource. To do so, call C<GetDataSource> for an existing
447 datasource and copy the values to a C<CreateDataSource> call. Change
448 the settings that you want to change and make sure that all required
449 fields have the appropriate values.
450  
451  
452 =head2 CreateDataSourceFromS3
453  
454 =over
455  
456 =item DataSourceId => Str
457  
458 =item DataSpec => L<Paws::MachineLearning::S3DataSpec>
459  
460 =item [ComputeStatistics => Bool]
461  
462 =item [DataSourceName => Str]
463  
464  
465 =back
466  
467 Each argument is described in detail in: L<Paws::MachineLearning::CreateDataSourceFromS3>
468  
469 Returns: a L<Paws::MachineLearning::CreateDataSourceFromS3Output> instance
470  
471 Creates a C<DataSource> object. A C<DataSource> references data that
472 can be used to perform C<CreateMLModel>, C<CreateEvaluation>, or
473 C<CreateBatchPrediction> operations.
474  
475 C<CreateDataSourceFromS3> is an asynchronous operation. In response to
476 C<CreateDataSourceFromS3>, Amazon Machine Learning (Amazon ML)
477 immediately returns and sets the C<DataSource> status to C<PENDING>.
478 After the C<DataSource> has been created and is ready for use, Amazon
479 ML sets the C<Status> parameter to C<COMPLETED>. C<DataSource> in the
480 C<COMPLETED> or C<PENDING> state can be used to perform only
481 C<CreateMLModel>, C<CreateEvaluation> or C<CreateBatchPrediction>
482 operations.
483  
484 If Amazon ML can't accept the input source, it sets the C<Status>
485 parameter to C<FAILED> and includes an error message in the C<Message>
486 attribute of the C<GetDataSource> operation response.
487  
488 The observation data used in a C<DataSource> should be ready to use;
489 that is, it should have a consistent structure, and missing data values
490 should be kept to a minimum. The observation data must reside in one or
491 more .csv files in an Amazon Simple Storage Service (Amazon S3)
492 location, along with a schema that describes the data items by name and
493 type. The same schema must be used for all of the data files referenced
494 by the C<DataSource>.
495  
496 After the C<DataSource> has been created, it's ready to use in
497 evaluations and batch predictions. If you plan to use the C<DataSource>
498 to train an C<MLModel>, the C<DataSource> also needs a recipe. A recipe
499 describes how each input variable will be used in training an
500 C<MLModel>. Will the variable be included or excluded from training?
501 Will the variable be manipulated; for example, will it be combined with
502 another variable or will it be split apart into word combinations? The
503 recipe provides answers to these questions.
504  
505  
506 =head2 CreateEvaluation
507  
508 =over
509  
510 =item EvaluationDataSourceId => Str
511  
512 =item EvaluationId => Str
513  
514 =item MLModelId => Str
515  
516 =item [EvaluationName => Str]
517  
518  
519 =back
520  
521 Each argument is described in detail in: L<Paws::MachineLearning::CreateEvaluation>
522  
523 Returns: a L<Paws::MachineLearning::CreateEvaluationOutput> instance
524  
525 Creates a new C<Evaluation> of an C<MLModel>. An C<MLModel> is
526 evaluated on a set of observations associated to a C<DataSource>. Like
527 a C<DataSource> for an C<MLModel>, the C<DataSource> for an
528 C<Evaluation> contains values for the C<Target Variable>. The
529 C<Evaluation> compares the predicted result for each observation to the
530 actual outcome and provides a summary so that you know how effective
531 the C<MLModel> functions on the test data. Evaluation generates a
532 relevant performance metric, such as BinaryAUC, RegressionRMSE or
533 MulticlassAvgFScore based on the corresponding C<MLModelType>:
534 C<BINARY>, C<REGRESSION> or C<MULTICLASS>.
535  
536 C<CreateEvaluation> is an asynchronous operation. In response to
537 C<CreateEvaluation>, Amazon Machine Learning (Amazon ML) immediately
538 returns and sets the evaluation status to C<PENDING>. After the
539 C<Evaluation> is created and ready for use, Amazon ML sets the status
540 to C<COMPLETED>.
541  
542 You can use the C<GetEvaluation> operation to check progress of the
543 evaluation during the creation operation.
544  
545  
546 =head2 CreateMLModel
547  
548 =over
549  
550 =item MLModelId => Str
551  
552 =item MLModelType => Str
553  
554 =item TrainingDataSourceId => Str
555  
556 =item [MLModelName => Str]
557  
558 =item [Parameters => L<Paws::MachineLearning::TrainingParameters>]
559  
560 =item [Recipe => Str]
561  
562 =item [RecipeUri => Str]
563  
564  
565 =back
566  
567 Each argument is described in detail in: L<Paws::MachineLearning::CreateMLModel>
568  
569 Returns: a L<Paws::MachineLearning::CreateMLModelOutput> instance
570  
571 Creates a new C<MLModel> using the C<DataSource> and the recipe as
572 information sources.
573  
574 An C<MLModel> is nearly immutable. Users can update only the
575 C<MLModelName> and the C<ScoreThreshold> in an C<MLModel> without
576 creating a new C<MLModel>.
577  
578 C<CreateMLModel> is an asynchronous operation. In response to
579 C<CreateMLModel>, Amazon Machine Learning (Amazon ML) immediately
580 returns and sets the C<MLModel> status to C<PENDING>. After the
581 C<MLModel> has been created and ready is for use, Amazon ML sets the
582 status to C<COMPLETED>.
583  
584 You can use the C<GetMLModel> operation to check the progress of the
585 C<MLModel> during the creation operation.
586  
587 C<CreateMLModel> requires a C<DataSource> with computed statistics,
588 which can be created by setting C<ComputeStatistics> to C<true> in
589 C<CreateDataSourceFromRDS>, C<CreateDataSourceFromS3>, or
590 C<CreateDataSourceFromRedshift> operations.
591  
592  
593 =head2 CreateRealtimeEndpoint
594  
595 =over
596  
597 =item MLModelId => Str
598  
599  
600 =back
601  
602 Each argument is described in detail in: L<Paws::MachineLearning::CreateRealtimeEndpoint>
603  
604 Returns: a L<Paws::MachineLearning::CreateRealtimeEndpointOutput> instance
605  
606 Creates a real-time endpoint for the C<MLModel>. The endpoint contains
607 the URI of the C<MLModel>; that is, the location to send real-time
608 prediction requests for the specified C<MLModel>.
609  
610  
611 =head2 DeleteBatchPrediction
612  
613 =over
614  
615 =item BatchPredictionId => Str
616  
617  
618 =back
619  
620 Each argument is described in detail in: L<Paws::MachineLearning::DeleteBatchPrediction>
621  
622 Returns: a L<Paws::MachineLearning::DeleteBatchPredictionOutput> instance
623  
624 Assigns the DELETED status to a C<BatchPrediction>, rendering it
625 unusable.
626  
627 After using the C<DeleteBatchPrediction> operation, you can use the
628 GetBatchPrediction operation to verify that the status of the
629 C<BatchPrediction> changed to DELETED.
630  
631 B<Caution:> The result of the C<DeleteBatchPrediction> operation is
632 irreversible.
633  
634  
635 =head2 DeleteDataSource
636  
637 =over
638  
639 =item DataSourceId => Str
640  
641  
642 =back
643  
644 Each argument is described in detail in: L<Paws::MachineLearning::DeleteDataSource>
645  
646 Returns: a L<Paws::MachineLearning::DeleteDataSourceOutput> instance
647  
648 Assigns the DELETED status to a C<DataSource>, rendering it unusable.
649  
650 After using the C<DeleteDataSource> operation, you can use the
651 GetDataSource operation to verify that the status of the C<DataSource>
652 changed to DELETED.
653  
654 B<Caution:> The results of the C<DeleteDataSource> operation are
655 irreversible.
656  
657  
658 =head2 DeleteEvaluation
659  
660 =over
661  
662 =item EvaluationId => Str
663  
664  
665 =back
666  
667 Each argument is described in detail in: L<Paws::MachineLearning::DeleteEvaluation>
668  
669 Returns: a L<Paws::MachineLearning::DeleteEvaluationOutput> instance
670  
671 Assigns the C<DELETED> status to an C<Evaluation>, rendering it
672 unusable.
673  
674 After invoking the C<DeleteEvaluation> operation, you can use the
675 C<GetEvaluation> operation to verify that the status of the
676 C<Evaluation> changed to C<DELETED>.
677  
678 B<Caution:> The results of the C<DeleteEvaluation> operation are
679 irreversible.
680  
681  
682 =head2 DeleteMLModel
683  
684 =over
685  
686 =item MLModelId => Str
687  
688  
689 =back
690  
691 Each argument is described in detail in: L<Paws::MachineLearning::DeleteMLModel>
692  
693 Returns: a L<Paws::MachineLearning::DeleteMLModelOutput> instance
694  
695 Assigns the C<DELETED> status to an C<MLModel>, rendering it unusable.
696  
697 After using the C<DeleteMLModel> operation, you can use the
698 C<GetMLModel> operation to verify that the status of the C<MLModel>
699 changed to DELETED.
700  
701 B<Caution:> The result of the C<DeleteMLModel> operation is
702 irreversible.
703  
704  
705 =head2 DeleteRealtimeEndpoint
706  
707 =over
708  
709 =item MLModelId => Str
710  
711  
712 =back
713  
714 Each argument is described in detail in: L<Paws::MachineLearning::DeleteRealtimeEndpoint>
715  
716 Returns: a L<Paws::MachineLearning::DeleteRealtimeEndpointOutput> instance
717  
718 Deletes a real time endpoint of an C<MLModel>.
719  
720  
721 =head2 DeleteTags
722  
723 =over
724  
725 =item ResourceId => Str
726  
727 =item ResourceType => Str
728  
729 =item TagKeys => ArrayRef[Str|Undef]
730  
731  
732 =back
733  
734 Each argument is described in detail in: L<Paws::MachineLearning::DeleteTags>
735  
736 Returns: a L<Paws::MachineLearning::DeleteTagsOutput> instance
737  
738 Deletes the specified tags associated with an ML object. After this
739 operation is complete, you can't recover deleted tags.
740  
741 If you specify a tag that doesn't exist, Amazon ML ignores it.
742  
743  
744 =head2 DescribeBatchPredictions
745  
746 =over
747  
748 =item [EQ => Str]
749  
750 =item [FilterVariable => Str]
751  
752 =item [GE => Str]
753  
754 =item [GT => Str]
755  
756 =item [LE => Str]
757  
758 =item [Limit => Int]
759  
760 =item [LT => Str]
761  
762 =item [NE => Str]
763  
764 =item [NextToken => Str]
765  
766 =item [Prefix => Str]
767  
768 =item [SortOrder => Str]
769  
770  
771 =back
772  
773 Each argument is described in detail in: L<Paws::MachineLearning::DescribeBatchPredictions>
774  
775 Returns: a L<Paws::MachineLearning::DescribeBatchPredictionsOutput> instance
776  
777 Returns a list of C<BatchPrediction> operations that match the search
778 criteria in the request.
779  
780  
781 =head2 DescribeDataSources
782  
783 =over
784  
785 =item [EQ => Str]
786  
787 =item [FilterVariable => Str]
788  
789 =item [GE => Str]
790  
791 =item [GT => Str]
792  
793 =item [LE => Str]
794  
795 =item [Limit => Int]
796  
797 =item [LT => Str]
798  
799 =item [NE => Str]
800  
801 =item [NextToken => Str]
802  
803 =item [Prefix => Str]
804  
805 =item [SortOrder => Str]
806  
807  
808 =back
809  
810 Each argument is described in detail in: L<Paws::MachineLearning::DescribeDataSources>
811  
812 Returns: a L<Paws::MachineLearning::DescribeDataSourcesOutput> instance
813  
814 Returns a list of C<DataSource> that match the search criteria in the
815 request.
816  
817  
818 =head2 DescribeEvaluations
819  
820 =over
821  
822 =item [EQ => Str]
823  
824 =item [FilterVariable => Str]
825  
826 =item [GE => Str]
827  
828 =item [GT => Str]
829  
830 =item [LE => Str]
831  
832 =item [Limit => Int]
833  
834 =item [LT => Str]
835  
836 =item [NE => Str]
837  
838 =item [NextToken => Str]
839  
840 =item [Prefix => Str]
841  
842 =item [SortOrder => Str]
843  
844  
845 =back
846  
847 Each argument is described in detail in: L<Paws::MachineLearning::DescribeEvaluations>
848  
849 Returns: a L<Paws::MachineLearning::DescribeEvaluationsOutput> instance
850  
851 Returns a list of C<DescribeEvaluations> that match the search criteria
852 in the request.
853  
854  
855 =head2 DescribeMLModels
856  
857 =over
858  
859 =item [EQ => Str]
860  
861 =item [FilterVariable => Str]
862  
863 =item [GE => Str]
864  
865 =item [GT => Str]
866  
867 =item [LE => Str]
868  
869 =item [Limit => Int]
870  
871 =item [LT => Str]
872  
873 =item [NE => Str]
874  
875 =item [NextToken => Str]
876  
877 =item [Prefix => Str]
878  
879 =item [SortOrder => Str]
880  
881  
882 =back
883  
884 Each argument is described in detail in: L<Paws::MachineLearning::DescribeMLModels>
885  
886 Returns: a L<Paws::MachineLearning::DescribeMLModelsOutput> instance
887  
888 Returns a list of C<MLModel> that match the search criteria in the
889 request.
890  
891  
892 =head2 DescribeTags
893  
894 =over
895  
896 =item ResourceId => Str
897  
898 =item ResourceType => Str
899  
900  
901 =back
902  
903 Each argument is described in detail in: L<Paws::MachineLearning::DescribeTags>
904  
905 Returns: a L<Paws::MachineLearning::DescribeTagsOutput> instance
906  
907 Describes one or more of the tags for your Amazon ML object.
908  
909  
910 =head2 GetBatchPrediction
911  
912 =over
913  
914 =item BatchPredictionId => Str
915  
916  
917 =back
918  
919 Each argument is described in detail in: L<Paws::MachineLearning::GetBatchPrediction>
920  
921 Returns: a L<Paws::MachineLearning::GetBatchPredictionOutput> instance
922  
923 Returns a C<BatchPrediction> that includes detailed metadata, status,
924 and data file information for a C<Batch Prediction> request.
925  
926  
927 =head2 GetDataSource
928  
929 =over
930  
931 =item DataSourceId => Str
932  
933 =item [Verbose => Bool]
934  
935  
936 =back
937  
938 Each argument is described in detail in: L<Paws::MachineLearning::GetDataSource>
939  
940 Returns: a L<Paws::MachineLearning::GetDataSourceOutput> instance
941  
942 Returns a C<DataSource> that includes metadata and data file
943 information, as well as the current status of the C<DataSource>.
944  
945 C<GetDataSource> provides results in normal or verbose format. The
946 verbose format adds the schema description and the list of files
947 pointed to by the DataSource to the normal format.
948  
949  
950 =head2 GetEvaluation
951  
952 =over
953  
954 =item EvaluationId => Str
955  
956  
957 =back
958  
959 Each argument is described in detail in: L<Paws::MachineLearning::GetEvaluation>
960  
961 Returns: a L<Paws::MachineLearning::GetEvaluationOutput> instance
962  
963 Returns an C<Evaluation> that includes metadata as well as the current
964 status of the C<Evaluation>.
965  
966  
967 =head2 GetMLModel
968  
969 =over
970  
971 =item MLModelId => Str
972  
973 =item [Verbose => Bool]
974  
975  
976 =back
977  
978 Each argument is described in detail in: L<Paws::MachineLearning::GetMLModel>
979  
980 Returns: a L<Paws::MachineLearning::GetMLModelOutput> instance
981  
982 Returns an C<MLModel> that includes detailed metadata, data source
983 information, and the current status of the C<MLModel>.
984  
985 C<GetMLModel> provides results in normal or verbose format.
986  
987  
988 =head2 Predict
989  
990 =over
991  
992 =item MLModelId => Str
993  
994 =item PredictEndpoint => Str
995  
996 =item Record => L<Paws::MachineLearning::Record>
997  
998  
999 =back
1000  
1001 Each argument is described in detail in: L<Paws::MachineLearning::Predict>
1002  
1003 Returns: a L<Paws::MachineLearning::PredictOutput> instance
1004  
1005 Generates a prediction for the observation using the specified C<ML
1006 Model>.
1007  
1008 B<Note:> Not all response parameters will be populated. Whether a
1009 response parameter is populated depends on the type of model requested.
1010  
1011  
1012 =head2 UpdateBatchPrediction
1013  
1014 =over
1015  
1016 =item BatchPredictionId => Str
1017  
1018 =item BatchPredictionName => Str
1019  
1020  
1021 =back
1022  
1023 Each argument is described in detail in: L<Paws::MachineLearning::UpdateBatchPrediction>
1024  
1025 Returns: a L<Paws::MachineLearning::UpdateBatchPredictionOutput> instance
1026  
1027 Updates the C<BatchPredictionName> of a C<BatchPrediction>.
1028  
1029 You can use the C<GetBatchPrediction> operation to view the contents of
1030 the updated data element.
1031  
1032  
1033 =head2 UpdateDataSource
1034  
1035 =over
1036  
1037 =item DataSourceId => Str
1038  
1039 =item DataSourceName => Str
1040  
1041  
1042 =back
1043  
1044 Each argument is described in detail in: L<Paws::MachineLearning::UpdateDataSource>
1045  
1046 Returns: a L<Paws::MachineLearning::UpdateDataSourceOutput> instance
1047  
1048 Updates the C<DataSourceName> of a C<DataSource>.
1049  
1050 You can use the C<GetDataSource> operation to view the contents of the
1051 updated data element.
1052  
1053  
1054 =head2 UpdateEvaluation
1055  
1056 =over
1057  
1058 =item EvaluationId => Str
1059  
1060 =item EvaluationName => Str
1061  
1062  
1063 =back
1064  
1065 Each argument is described in detail in: L<Paws::MachineLearning::UpdateEvaluation>
1066  
1067 Returns: a L<Paws::MachineLearning::UpdateEvaluationOutput> instance
1068  
1069 Updates the C<EvaluationName> of an C<Evaluation>.
1070  
1071 You can use the C<GetEvaluation> operation to view the contents of the
1072 updated data element.
1073  
1074  
1075 =head2 UpdateMLModel
1076  
1077 =over
1078  
1079 =item MLModelId => Str
1080  
1081 =item [MLModelName => Str]
1082  
1083 =item [ScoreThreshold => Num]
1084  
1085  
1086 =back
1087  
1088 Each argument is described in detail in: L<Paws::MachineLearning::UpdateMLModel>
1089  
1090 Returns: a L<Paws::MachineLearning::UpdateMLModelOutput> instance
1091  
1092 Updates the C<MLModelName> and the C<ScoreThreshold> of an C<MLModel>.
1093  
1094 You can use the C<GetMLModel> operation to view the contents of the
1095 updated data element.
1096  
1097  
1098  
1099  
1100 =head1 PAGINATORS
1101  
1102 Paginator methods are helpers that repetively call methods that return partial results
1103  
1104 =head2 DescribeAllBatchPredictions(sub { },[EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1105  
1106 =head2 DescribeAllBatchPredictions([EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1107  
1108  
1109 If passed a sub as first parameter, it will call the sub for each element found in :
1110  
1111 - Results, passing the object as the first parameter, and the string 'Results' as the second parameter
1112  
1113 If not, it will return a a L<Paws::MachineLearning::DescribeBatchPredictionsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1114  
1115  
1116 =head2 DescribeAllDataSources(sub { },[EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1117  
1118 =head2 DescribeAllDataSources([EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1119  
1120  
1121 If passed a sub as first parameter, it will call the sub for each element found in :
1122  
1123 - Results, passing the object as the first parameter, and the string 'Results' as the second parameter
1124  
1125 If not, it will return a a L<Paws::MachineLearning::DescribeDataSourcesOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1126  
1127  
1128 =head2 DescribeAllEvaluations(sub { },[EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1129  
1130 =head2 DescribeAllEvaluations([EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1131  
1132  
1133 If passed a sub as first parameter, it will call the sub for each element found in :
1134  
1135 - Results, passing the object as the first parameter, and the string 'Results' as the second parameter
1136  
1137 If not, it will return a a L<Paws::MachineLearning::DescribeEvaluationsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1138  
1139  
1140 =head2 DescribeAllMLModels(sub { },[EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1141  
1142 =head2 DescribeAllMLModels([EQ => Str, FilterVariable => Str, GE => Str, GT => Str, LE => Str, Limit => Int, LT => Str, NE => Str, NextToken => Str, Prefix => Str, SortOrder => Str])
1143  
1144  
1145 If passed a sub as first parameter, it will call the sub for each element found in :
1146  
1147 - Results, passing the object as the first parameter, and the string 'Results' as the second parameter
1148  
1149 If not, it will return a a L<Paws::MachineLearning::DescribeMLModelsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1150  
1151  
1152  
1153  
1154  
1155 =head1 SEE ALSO
1156  
1157 This service class forms part of L<Paws>
1158  
1159 =head1 BUGS and CONTRIBUTIONS
1160  
1161 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1162  
1163 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1164  
1165 =cut
1166  
« lib/Paws/StorageGateway.pm ↑ Summary lib/Paws/DataPipeline.pm »