blib/lib/Paws/Personalize.pm untested

filter: Statementstmt 0.0% 0 / 396 Branchbran 0.0% 0 / 48 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 66 Podpod 0.0% 0 / 65 totaltotal 0.0% 0 / 575 CC 25 SCAR 17.9
CC
25
Cov
0%
ListAllBatchInferenceJobs
12.0
ListAllCampaigns
12.0
ListAllDatasetExportJobs
12.0
CRAP 6.0
1 package Paws::Personalize;
2 use Moose;
3 sub service { 'personalize' }
4 sub signing_name { 'personalize' }
5 sub version { '2018-05-22' }
6 sub target_prefix { 'AmazonPersonalize' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub CreateBatchInferenceJob {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateBatchInferenceJob', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CreateCampaign {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateCampaign', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CreateDataset {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateDataset', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub CreateDatasetExportJob {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateDatasetExportJob', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub CreateDatasetGroup {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateDatasetGroup', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub CreateDatasetImportJob {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateDatasetImportJob', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub CreateEventTracker {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateEventTracker', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub CreateFilter {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateFilter', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub CreateSchema {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateSchema', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub CreateSolution {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateSolution', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub CreateSolutionVersion {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::Personalize::CreateSolutionVersion', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub DeleteCampaign {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteCampaign', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub DeleteDataset {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteDataset', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub DeleteDatasetGroup {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteDatasetGroup', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub DeleteEventTracker {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteEventTracker', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub DeleteFilter {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteFilter', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub DeleteSchema {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteSchema', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub DeleteSolution {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::Personalize::DeleteSolution', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub DescribeAlgorithm {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeAlgorithm', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub DescribeBatchInferenceJob {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeBatchInferenceJob', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub DescribeCampaign {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeCampaign', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub DescribeDataset {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeDataset', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128 sub DescribeDatasetExportJob {
129 my $self = shift;
130 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeDatasetExportJob', @_);
131 return $self->caller->do_call($self, $call_object);
132 }
133 sub DescribeDatasetGroup {
134 my $self = shift;
135 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeDatasetGroup', @_);
136 return $self->caller->do_call($self, $call_object);
137 }
138 sub DescribeDatasetImportJob {
139 my $self = shift;
140 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeDatasetImportJob', @_);
141 return $self->caller->do_call($self, $call_object);
142 }
143 sub DescribeEventTracker {
144 my $self = shift;
145 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeEventTracker', @_);
146 return $self->caller->do_call($self, $call_object);
147 }
148 sub DescribeFeatureTransformation {
149 my $self = shift;
150 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeFeatureTransformation', @_);
151 return $self->caller->do_call($self, $call_object);
152 }
153 sub DescribeFilter {
154 my $self = shift;
155 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeFilter', @_);
156 return $self->caller->do_call($self, $call_object);
157 }
158 sub DescribeRecipe {
159 my $self = shift;
160 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeRecipe', @_);
161 return $self->caller->do_call($self, $call_object);
162 }
163 sub DescribeSchema {
164 my $self = shift;
165 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeSchema', @_);
166 return $self->caller->do_call($self, $call_object);
167 }
168 sub DescribeSolution {
169 my $self = shift;
170 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeSolution', @_);
171 return $self->caller->do_call($self, $call_object);
172 }
173 sub DescribeSolutionVersion {
174 my $self = shift;
175 my $call_object = $self->new_with_coercions('Paws::Personalize::DescribeSolutionVersion', @_);
176 return $self->caller->do_call($self, $call_object);
177 }
178 sub GetSolutionMetrics {
179 my $self = shift;
180 my $call_object = $self->new_with_coercions('Paws::Personalize::GetSolutionMetrics', @_);
181 return $self->caller->do_call($self, $call_object);
182 }
183 sub ListBatchInferenceJobs {
184 my $self = shift;
185 my $call_object = $self->new_with_coercions('Paws::Personalize::ListBatchInferenceJobs', @_);
186 return $self->caller->do_call($self, $call_object);
187 }
188 sub ListCampaigns {
189 my $self = shift;
190 my $call_object = $self->new_with_coercions('Paws::Personalize::ListCampaigns', @_);
191 return $self->caller->do_call($self, $call_object);
192 }
193 sub ListDatasetExportJobs {
194 my $self = shift;
195 my $call_object = $self->new_with_coercions('Paws::Personalize::ListDatasetExportJobs', @_);
196 return $self->caller->do_call($self, $call_object);
197 }
198 sub ListDatasetGroups {
199 my $self = shift;
200 my $call_object = $self->new_with_coercions('Paws::Personalize::ListDatasetGroups', @_);
201 return $self->caller->do_call($self, $call_object);
202 }
203 sub ListDatasetImportJobs {
204 my $self = shift;
205 my $call_object = $self->new_with_coercions('Paws::Personalize::ListDatasetImportJobs', @_);
206 return $self->caller->do_call($self, $call_object);
207 }
208 sub ListDatasets {
209 my $self = shift;
210 my $call_object = $self->new_with_coercions('Paws::Personalize::ListDatasets', @_);
211 return $self->caller->do_call($self, $call_object);
212 }
213 sub ListEventTrackers {
214 my $self = shift;
215 my $call_object = $self->new_with_coercions('Paws::Personalize::ListEventTrackers', @_);
216 return $self->caller->do_call($self, $call_object);
217 }
218 sub ListFilters {
219 my $self = shift;
220 my $call_object = $self->new_with_coercions('Paws::Personalize::ListFilters', @_);
221 return $self->caller->do_call($self, $call_object);
222 }
223 sub ListRecipes {
224 my $self = shift;
225 my $call_object = $self->new_with_coercions('Paws::Personalize::ListRecipes', @_);
226 return $self->caller->do_call($self, $call_object);
227 }
228 sub ListSchemas {
229 my $self = shift;
230 my $call_object = $self->new_with_coercions('Paws::Personalize::ListSchemas', @_);
231 return $self->caller->do_call($self, $call_object);
232 }
233 sub ListSolutions {
234 my $self = shift;
235 my $call_object = $self->new_with_coercions('Paws::Personalize::ListSolutions', @_);
236 return $self->caller->do_call($self, $call_object);
237 }
238 sub ListSolutionVersions {
239 my $self = shift;
240 my $call_object = $self->new_with_coercions('Paws::Personalize::ListSolutionVersions', @_);
241 return $self->caller->do_call($self, $call_object);
242 }
243 sub StopSolutionVersionCreation {
244 my $self = shift;
245 my $call_object = $self->new_with_coercions('Paws::Personalize::StopSolutionVersionCreation', @_);
246 return $self->caller->do_call($self, $call_object);
247 }
248 sub UpdateCampaign {
249 my $self = shift;
250 my $call_object = $self->new_with_coercions('Paws::Personalize::UpdateCampaign', @_);
251 return $self->caller->do_call($self, $call_object);
252 }
253
254 sub ListAllBatchInferenceJobs {
255 my $self = shift;
256  
257 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
258 my $result = $self->ListBatchInferenceJobs(@_);
259 my $next_result = $result;
260  
261 if (not defined $callback) {
262 while ($next_result->nextToken) {
263 $next_result = $self->ListBatchInferenceJobs(@_, nextToken => $next_result->nextToken);
264 push @{ $result->batchInferenceJobs }, @{ $next_result->batchInferenceJobs };
265 }
266 return $result;
267 } else {
268 while ($result->nextToken) {
269 $callback->($_ => 'batchInferenceJobs') foreach (@{ $result->batchInferenceJobs });
270 $result = $self->ListBatchInferenceJobs(@_, nextToken => $result->nextToken);
271 }
272 $callback->($_ => 'batchInferenceJobs') foreach (@{ $result->batchInferenceJobs });
273 }
274  
275 return undef
276 }
277 sub ListAllCampaigns {
278 my $self = shift;
279  
280 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
281 my $result = $self->ListCampaigns(@_);
282 my $next_result = $result;
283  
284 if (not defined $callback) {
285 while ($next_result->nextToken) {
286 $next_result = $self->ListCampaigns(@_, nextToken => $next_result->nextToken);
287 push @{ $result->campaigns }, @{ $next_result->campaigns };
288 }
289 return $result;
290 } else {
291 while ($result->nextToken) {
292 $callback->($_ => 'campaigns') foreach (@{ $result->campaigns });
293 $result = $self->ListCampaigns(@_, nextToken => $result->nextToken);
294 }
295 $callback->($_ => 'campaigns') foreach (@{ $result->campaigns });
296 }
297  
298 return undef
299 }
300 sub ListAllDatasetExportJobs {
301 my $self = shift;
302  
303 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
304 my $result = $self->ListDatasetExportJobs(@_);
305 my $next_result = $result;
306  
307 if (not defined $callback) {
308 while ($next_result->nextToken) {
309 $next_result = $self->ListDatasetExportJobs(@_, nextToken => $next_result->nextToken);
310 push @{ $result->datasetExportJobs }, @{ $next_result->datasetExportJobs };
311 }
312 return $result;
313 } else {
314 while ($result->nextToken) {
315 $callback->($_ => 'datasetExportJobs') foreach (@{ $result->datasetExportJobs });
316 $result = $self->ListDatasetExportJobs(@_, nextToken => $result->nextToken);
317 }
318 $callback->($_ => 'datasetExportJobs') foreach (@{ $result->datasetExportJobs });
319 }
320  
321 return undef
322 }
323 sub ListAllDatasetGroups {
324 my $self = shift;
325  
326 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
327 my $result = $self->ListDatasetGroups(@_);
328 my $next_result = $result;
329  
330 if (not defined $callback) {
331 while ($next_result->nextToken) {
332 $next_result = $self->ListDatasetGroups(@_, nextToken => $next_result->nextToken);
333 push @{ $result->datasetGroups }, @{ $next_result->datasetGroups };
334 }
335 return $result;
336 } else {
337 while ($result->nextToken) {
338 $callback->($_ => 'datasetGroups') foreach (@{ $result->datasetGroups });
339 $result = $self->ListDatasetGroups(@_, nextToken => $result->nextToken);
340 }
341 $callback->($_ => 'datasetGroups') foreach (@{ $result->datasetGroups });
342 }
343  
344 return undef
345 }
346 sub ListAllDatasetImportJobs {
347 my $self = shift;
348  
349 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
350 my $result = $self->ListDatasetImportJobs(@_);
351 my $next_result = $result;
352  
353 if (not defined $callback) {
354 while ($next_result->nextToken) {
355 $next_result = $self->ListDatasetImportJobs(@_, nextToken => $next_result->nextToken);
356 push @{ $result->datasetImportJobs }, @{ $next_result->datasetImportJobs };
357 }
358 return $result;
359 } else {
360 while ($result->nextToken) {
361 $callback->($_ => 'datasetImportJobs') foreach (@{ $result->datasetImportJobs });
362 $result = $self->ListDatasetImportJobs(@_, nextToken => $result->nextToken);
363 }
364 $callback->($_ => 'datasetImportJobs') foreach (@{ $result->datasetImportJobs });
365 }
366  
367 return undef
368 }
369 sub ListAllDatasets {
370 my $self = shift;
371  
372 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
373 my $result = $self->ListDatasets(@_);
374 my $next_result = $result;
375  
376 if (not defined $callback) {
377 while ($next_result->nextToken) {
378 $next_result = $self->ListDatasets(@_, nextToken => $next_result->nextToken);
379 push @{ $result->datasets }, @{ $next_result->datasets };
380 }
381 return $result;
382 } else {
383 while ($result->nextToken) {
384 $callback->($_ => 'datasets') foreach (@{ $result->datasets });
385 $result = $self->ListDatasets(@_, nextToken => $result->nextToken);
386 }
387 $callback->($_ => 'datasets') foreach (@{ $result->datasets });
388 }
389  
390 return undef
391 }
392 sub ListAllEventTrackers {
393 my $self = shift;
394  
395 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
396 my $result = $self->ListEventTrackers(@_);
397 my $next_result = $result;
398  
399 if (not defined $callback) {
400 while ($next_result->nextToken) {
401 $next_result = $self->ListEventTrackers(@_, nextToken => $next_result->nextToken);
402 push @{ $result->eventTrackers }, @{ $next_result->eventTrackers };
403 }
404 return $result;
405 } else {
406 while ($result->nextToken) {
407 $callback->($_ => 'eventTrackers') foreach (@{ $result->eventTrackers });
408 $result = $self->ListEventTrackers(@_, nextToken => $result->nextToken);
409 }
410 $callback->($_ => 'eventTrackers') foreach (@{ $result->eventTrackers });
411 }
412  
413 return undef
414 }
415 sub ListAllFilters {
416 my $self = shift;
417  
418 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
419 my $result = $self->ListFilters(@_);
420 my $next_result = $result;
421  
422 if (not defined $callback) {
423 while ($next_result->nextToken) {
424 $next_result = $self->ListFilters(@_, nextToken => $next_result->nextToken);
425 push @{ $result->Filters }, @{ $next_result->Filters };
426 }
427 return $result;
428 } else {
429 while ($result->nextToken) {
430 $callback->($_ => 'Filters') foreach (@{ $result->Filters });
431 $result = $self->ListFilters(@_, nextToken => $result->nextToken);
432 }
433 $callback->($_ => 'Filters') foreach (@{ $result->Filters });
434 }
435  
436 return undef
437 }
438 sub ListAllRecipes {
439 my $self = shift;
440  
441 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
442 my $result = $self->ListRecipes(@_);
443 my $next_result = $result;
444  
445 if (not defined $callback) {
446 while ($next_result->nextToken) {
447 $next_result = $self->ListRecipes(@_, nextToken => $next_result->nextToken);
448 push @{ $result->recipes }, @{ $next_result->recipes };
449 }
450 return $result;
451 } else {
452 while ($result->nextToken) {
453 $callback->($_ => 'recipes') foreach (@{ $result->recipes });
454 $result = $self->ListRecipes(@_, nextToken => $result->nextToken);
455 }
456 $callback->($_ => 'recipes') foreach (@{ $result->recipes });
457 }
458  
459 return undef
460 }
461 sub ListAllSchemas {
462 my $self = shift;
463  
464 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
465 my $result = $self->ListSchemas(@_);
466 my $next_result = $result;
467  
468 if (not defined $callback) {
469 while ($next_result->nextToken) {
470 $next_result = $self->ListSchemas(@_, nextToken => $next_result->nextToken);
471 push @{ $result->schemas }, @{ $next_result->schemas };
472 }
473 return $result;
474 } else {
475 while ($result->nextToken) {
476 $callback->($_ => 'schemas') foreach (@{ $result->schemas });
477 $result = $self->ListSchemas(@_, nextToken => $result->nextToken);
478 }
479 $callback->($_ => 'schemas') foreach (@{ $result->schemas });
480 }
481  
482 return undef
483 }
484 sub ListAllSolutions {
485 my $self = shift;
486  
487 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
488 my $result = $self->ListSolutions(@_);
489 my $next_result = $result;
490  
491 if (not defined $callback) {
492 while ($next_result->nextToken) {
493 $next_result = $self->ListSolutions(@_, nextToken => $next_result->nextToken);
494 push @{ $result->solutions }, @{ $next_result->solutions };
495 }
496 return $result;
497 } else {
498 while ($result->nextToken) {
499 $callback->($_ => 'solutions') foreach (@{ $result->solutions });
500 $result = $self->ListSolutions(@_, nextToken => $result->nextToken);
501 }
502 $callback->($_ => 'solutions') foreach (@{ $result->solutions });
503 }
504  
505 return undef
506 }
507 sub ListAllSolutionVersions {
508 my $self = shift;
509  
510 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
511 my $result = $self->ListSolutionVersions(@_);
512 my $next_result = $result;
513  
514 if (not defined $callback) {
515 while ($next_result->nextToken) {
516 $next_result = $self->ListSolutionVersions(@_, nextToken => $next_result->nextToken);
517 push @{ $result->solutionVersions }, @{ $next_result->solutionVersions };
518 }
519 return $result;
520 } else {
521 while ($result->nextToken) {
522 $callback->($_ => 'solutionVersions') foreach (@{ $result->solutionVersions });
523 $result = $self->ListSolutionVersions(@_, nextToken => $result->nextToken);
524 }
525 $callback->($_ => 'solutionVersions') foreach (@{ $result->solutionVersions });
526 }
527  
528 return undef
529 }
530  
531  
532 sub operations { qw/CreateBatchInferenceJob CreateCampaign CreateDataset CreateDatasetExportJob CreateDatasetGroup CreateDatasetImportJob CreateEventTracker CreateFilter CreateSchema CreateSolution CreateSolutionVersion DeleteCampaign DeleteDataset DeleteDatasetGroup DeleteEventTracker DeleteFilter DeleteSchema DeleteSolution DescribeAlgorithm DescribeBatchInferenceJob DescribeCampaign DescribeDataset DescribeDatasetExportJob DescribeDatasetGroup DescribeDatasetImportJob DescribeEventTracker DescribeFeatureTransformation DescribeFilter DescribeRecipe DescribeSchema DescribeSolution DescribeSolutionVersion GetSolutionMetrics ListBatchInferenceJobs ListCampaigns ListDatasetExportJobs ListDatasetGroups ListDatasetImportJobs ListDatasets ListEventTrackers ListFilters ListRecipes ListSchemas ListSolutions ListSolutionVersions StopSolutionVersionCreation UpdateCampaign / }
533  
534 1;
535  
536 ### main pod documentation begin ###
537  
538 =head1 NAME
539  
540 Paws::Personalize - Perl Interface to AWS Amazon Personalize
541  
542 =head1 SYNOPSIS
543  
544 use Paws;
545  
546 my $obj = Paws->service('Personalize');
547 my $res = $obj->Method(
548 Arg1 => $val1,
549 Arg2 => [ 'V1', 'V2' ],
550 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
551 # of the arguments type
552 Arg3 => { Att1 => 'Val1' },
553 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
554 # the constructor of the arguments type
555 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
556 );
557  
558 =head1 DESCRIPTION
559  
560 Amazon Personalize is a machine learning service that makes it easy to
561 add individualized recommendations to customers.
562  
563 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22>
564  
565  
566 =head1 METHODS
567  
568 =head2 CreateBatchInferenceJob
569  
570 =over
571  
572 =item JobInput => L<Paws::Personalize::BatchInferenceJobInput>
573  
574 =item JobName => Str
575  
576 =item JobOutput => L<Paws::Personalize::BatchInferenceJobOutput>
577  
578 =item RoleArn => Str
579  
580 =item SolutionVersionArn => Str
581  
582 =item [BatchInferenceJobConfig => L<Paws::Personalize::BatchInferenceJobConfig>]
583  
584 =item [FilterArn => Str]
585  
586 =item [NumResults => Int]
587  
588  
589 =back
590  
591 Each argument is described in detail in: L<Paws::Personalize::CreateBatchInferenceJob>
592  
593 Returns: a L<Paws::Personalize::CreateBatchInferenceJobResponse> instance
594  
595 Creates a batch inference job. The operation can handle up to 50
596 million records and the input file must be in JSON format. For more
597 information, see recommendations-batch.
598  
599  
600 =head2 CreateCampaign
601  
602 =over
603  
604 =item MinProvisionedTPS => Int
605  
606 =item Name => Str
607  
608 =item SolutionVersionArn => Str
609  
610 =item [CampaignConfig => L<Paws::Personalize::CampaignConfig>]
611  
612  
613 =back
614  
615 Each argument is described in detail in: L<Paws::Personalize::CreateCampaign>
616  
617 Returns: a L<Paws::Personalize::CreateCampaignResponse> instance
618  
619 Creates a campaign by deploying a solution version. When a client calls
620 the GetRecommendations
621 (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)
622 and GetPersonalizedRanking
623 (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html)
624 APIs, a campaign is specified in the request.
625  
626 B<Minimum Provisioned TPS and Auto-Scaling>
627  
628 A transaction is a single C<GetRecommendations> or
629 C<GetPersonalizedRanking> call. Transactions per second (TPS) is the
630 throughput and unit of billing for Amazon Personalize. The minimum
631 provisioned TPS (C<minProvisionedTPS>) specifies the baseline
632 throughput provisioned by Amazon Personalize, and thus, the minimum
633 billing charge.
634  
635 If your TPS increases beyond C<minProvisionedTPS>, Amazon Personalize
636 auto-scales the provisioned capacity up and down, but never below
637 C<minProvisionedTPS>. There's a short time delay while the capacity is
638 increased that might cause loss of transactions.
639  
640 The actual TPS used is calculated as the average requests/second within
641 a 5-minute window. You pay for maximum of either the minimum
642 provisioned TPS or the actual TPS. We recommend starting with a low
643 C<minProvisionedTPS>, track your usage using Amazon CloudWatch metrics,
644 and then increase the C<minProvisionedTPS> as necessary.
645  
646 B<Status>
647  
648 A campaign can be in one of the following states:
649  
650 =over
651  
652 =item *
653  
654 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
655  
656 =item *
657  
658 DELETE PENDING E<gt> DELETE IN_PROGRESS
659  
660 =back
661  
662 To get the campaign status, call DescribeCampaign.
663  
664 Wait until the C<status> of the campaign is C<ACTIVE> before asking the
665 campaign for recommendations.
666  
667 B<Related APIs>
668  
669 =over
670  
671 =item *
672  
673 ListCampaigns
674  
675 =item *
676  
677 DescribeCampaign
678  
679 =item *
680  
681 UpdateCampaign
682  
683 =item *
684  
685 DeleteCampaign
686  
687 =back
688  
689  
690  
691 =head2 CreateDataset
692  
693 =over
694  
695 =item DatasetGroupArn => Str
696  
697 =item DatasetType => Str
698  
699 =item Name => Str
700  
701 =item SchemaArn => Str
702  
703  
704 =back
705  
706 Each argument is described in detail in: L<Paws::Personalize::CreateDataset>
707  
708 Returns: a L<Paws::Personalize::CreateDatasetResponse> instance
709  
710 Creates an empty dataset and adds it to the specified dataset group.
711 Use CreateDatasetImportJob to import your training data to a dataset.
712  
713 There are three types of datasets:
714  
715 =over
716  
717 =item *
718  
719 Interactions
720  
721 =item *
722  
723 Items
724  
725 =item *
726  
727 Users
728  
729 =back
730  
731 Each dataset type has an associated schema with required field types.
732 Only the C<Interactions> dataset is required in order to train a model
733 (also referred to as creating a solution).
734  
735 A dataset can be in one of the following states:
736  
737 =over
738  
739 =item *
740  
741 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
742  
743 =item *
744  
745 DELETE PENDING E<gt> DELETE IN_PROGRESS
746  
747 =back
748  
749 To get the status of the dataset, call DescribeDataset.
750  
751 B<Related APIs>
752  
753 =over
754  
755 =item *
756  
757 CreateDatasetGroup
758  
759 =item *
760  
761 ListDatasets
762  
763 =item *
764  
765 DescribeDataset
766  
767 =item *
768  
769 DeleteDataset
770  
771 =back
772  
773  
774  
775 =head2 CreateDatasetExportJob
776  
777 =over
778  
779 =item DatasetArn => Str
780  
781 =item JobName => Str
782  
783 =item JobOutput => L<Paws::Personalize::DatasetExportJobOutput>
784  
785 =item RoleArn => Str
786  
787 =item [IngestionMode => Str]
788  
789  
790 =back
791  
792 Each argument is described in detail in: L<Paws::Personalize::CreateDatasetExportJob>
793  
794 Returns: a L<Paws::Personalize::CreateDatasetExportJobResponse> instance
795  
796 Creates a job that exports data from your dataset to an Amazon S3
797 bucket. To allow Amazon Personalize to export the training data, you
798 must specify an service-linked AWS Identity and Access Management (IAM)
799 role that gives Amazon Personalize C<PutObject> permissions for your
800 Amazon S3 bucket. For information, see Exporting a dataset
801 (https://docs.aws.amazon.com/personalize/latest/dg/export-data.html) in
802 the Amazon Personalize developer guide.
803  
804 B<Status>
805  
806 A dataset export job can be in one of the following states:
807  
808 =over
809  
810 =item *
811  
812 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
813  
814 =back
815  
816 To get the status of the export job, call DescribeDatasetExportJob, and
817 specify the Amazon Resource Name (ARN) of the dataset export job. The
818 dataset export is complete when the status shows as ACTIVE. If the
819 status shows as CREATE FAILED, the response includes a C<failureReason>
820 key, which describes why the job failed.
821  
822  
823 =head2 CreateDatasetGroup
824  
825 =over
826  
827 =item Name => Str
828  
829 =item [KmsKeyArn => Str]
830  
831 =item [RoleArn => Str]
832  
833  
834 =back
835  
836 Each argument is described in detail in: L<Paws::Personalize::CreateDatasetGroup>
837  
838 Returns: a L<Paws::Personalize::CreateDatasetGroupResponse> instance
839  
840 Creates an empty dataset group. A dataset group contains related
841 datasets that supply data for training a model. A dataset group can
842 contain at most three datasets, one for each type of dataset:
843  
844 =over
845  
846 =item *
847  
848 Interactions
849  
850 =item *
851  
852 Items
853  
854 =item *
855  
856 Users
857  
858 =back
859  
860 To train a model (create a solution), a dataset group that contains an
861 C<Interactions> dataset is required. Call CreateDataset to add a
862 dataset to the group.
863  
864 A dataset group can be in one of the following states:
865  
866 =over
867  
868 =item *
869  
870 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
871  
872 =item *
873  
874 DELETE PENDING
875  
876 =back
877  
878 To get the status of the dataset group, call DescribeDatasetGroup. If
879 the status shows as CREATE FAILED, the response includes a
880 C<failureReason> key, which describes why the creation failed.
881  
882 You must wait until the C<status> of the dataset group is C<ACTIVE>
883 before adding a dataset to the group.
884  
885 You can specify an AWS Key Management Service (KMS) key to encrypt the
886 datasets in the group. If you specify a KMS key, you must also include
887 an AWS Identity and Access Management (IAM) role that has permission to
888 access the key.
889  
890 B<APIs that require a dataset group ARN in the request>
891  
892 =over
893  
894 =item *
895  
896 CreateDataset
897  
898 =item *
899  
900 CreateEventTracker
901  
902 =item *
903  
904 CreateSolution
905  
906 =back
907  
908 B<Related APIs>
909  
910 =over
911  
912 =item *
913  
914 ListDatasetGroups
915  
916 =item *
917  
918 DescribeDatasetGroup
919  
920 =item *
921  
922 DeleteDatasetGroup
923  
924 =back
925  
926  
927  
928 =head2 CreateDatasetImportJob
929  
930 =over
931  
932 =item DatasetArn => Str
933  
934 =item DataSource => L<Paws::Personalize::DataSource>
935  
936 =item JobName => Str
937  
938 =item RoleArn => Str
939  
940  
941 =back
942  
943 Each argument is described in detail in: L<Paws::Personalize::CreateDatasetImportJob>
944  
945 Returns: a L<Paws::Personalize::CreateDatasetImportJobResponse> instance
946  
947 Creates a job that imports training data from your data source (an
948 Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
949 Personalize to import the training data, you must specify an AWS
950 Identity and Access Management (IAM) service role that has permission
951 to read from the data source, as Amazon Personalize makes a copy of
952 your data and processes it in an internal AWS system. For information
953 on granting access to your Amazon S3 bucket, see Giving Amazon
954 Personalize Access to Amazon S3 Resources
955 (https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html).
956  
957 The dataset import job replaces any existing data in the dataset that
958 you imported in bulk.
959  
960 B<Status>
961  
962 A dataset import job can be in one of the following states:
963  
964 =over
965  
966 =item *
967  
968 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
969  
970 =back
971  
972 To get the status of the import job, call DescribeDatasetImportJob,
973 providing the Amazon Resource Name (ARN) of the dataset import job. The
974 dataset import is complete when the status shows as ACTIVE. If the
975 status shows as CREATE FAILED, the response includes a C<failureReason>
976 key, which describes why the job failed.
977  
978 Importing takes time. You must wait until the status shows as ACTIVE
979 before training a model using the dataset.
980  
981 B<Related APIs>
982  
983 =over
984  
985 =item *
986  
987 ListDatasetImportJobs
988  
989 =item *
990  
991 DescribeDatasetImportJob
992  
993 =back
994  
995  
996  
997 =head2 CreateEventTracker
998  
999 =over
1000  
1001 =item DatasetGroupArn => Str
1002  
1003 =item Name => Str
1004  
1005  
1006 =back
1007  
1008 Each argument is described in detail in: L<Paws::Personalize::CreateEventTracker>
1009  
1010 Returns: a L<Paws::Personalize::CreateEventTrackerResponse> instance
1011  
1012 Creates an event tracker that you use when adding event data to a
1013 specified dataset group using the PutEvents
1014 (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)
1015 API.
1016  
1017 Only one event tracker can be associated with a dataset group. You will
1018 get an error if you call C<CreateEventTracker> using the same dataset
1019 group as an existing event tracker.
1020  
1021 When you create an event tracker, the response includes a tracking ID,
1022 which you pass as a parameter when you use the PutEvents
1023 (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)
1024 operation. Amazon Personalize then appends the event data to the
1025 Interactions dataset of the dataset group you specify in your event
1026 tracker.
1027  
1028 The event tracker can be in one of the following states:
1029  
1030 =over
1031  
1032 =item *
1033  
1034 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
1035  
1036 =item *
1037  
1038 DELETE PENDING E<gt> DELETE IN_PROGRESS
1039  
1040 =back
1041  
1042 To get the status of the event tracker, call DescribeEventTracker.
1043  
1044 The event tracker must be in the ACTIVE state before using the tracking
1045 ID.
1046  
1047 B<Related APIs>
1048  
1049 =over
1050  
1051 =item *
1052  
1053 ListEventTrackers
1054  
1055 =item *
1056  
1057 DescribeEventTracker
1058  
1059 =item *
1060  
1061 DeleteEventTracker
1062  
1063 =back
1064  
1065  
1066  
1067 =head2 CreateFilter
1068  
1069 =over
1070  
1071 =item DatasetGroupArn => Str
1072  
1073 =item FilterExpression => Str
1074  
1075 =item Name => Str
1076  
1077  
1078 =back
1079  
1080 Each argument is described in detail in: L<Paws::Personalize::CreateFilter>
1081  
1082 Returns: a L<Paws::Personalize::CreateFilterResponse> instance
1083  
1084 Creates a recommendation filter. For more information, see filter.
1085  
1086  
1087 =head2 CreateSchema
1088  
1089 =over
1090  
1091 =item Name => Str
1092  
1093 =item Schema => Str
1094  
1095  
1096 =back
1097  
1098 Each argument is described in detail in: L<Paws::Personalize::CreateSchema>
1099  
1100 Returns: a L<Paws::Personalize::CreateSchemaResponse> instance
1101  
1102 Creates an Amazon Personalize schema from the specified schema string.
1103 The schema you create must be in Avro JSON format.
1104  
1105 Amazon Personalize recognizes three schema variants. Each schema is
1106 associated with a dataset type and has a set of required field and
1107 keywords. You specify a schema when you call CreateDataset.
1108  
1109 B<Related APIs>
1110  
1111 =over
1112  
1113 =item *
1114  
1115 ListSchemas
1116  
1117 =item *
1118  
1119 DescribeSchema
1120  
1121 =item *
1122  
1123 DeleteSchema
1124  
1125 =back
1126  
1127  
1128  
1129 =head2 CreateSolution
1130  
1131 =over
1132  
1133 =item DatasetGroupArn => Str
1134  
1135 =item Name => Str
1136  
1137 =item [EventType => Str]
1138  
1139 =item [PerformAutoML => Bool]
1140  
1141 =item [PerformHPO => Bool]
1142  
1143 =item [RecipeArn => Str]
1144  
1145 =item [SolutionConfig => L<Paws::Personalize::SolutionConfig>]
1146  
1147  
1148 =back
1149  
1150 Each argument is described in detail in: L<Paws::Personalize::CreateSolution>
1151  
1152 Returns: a L<Paws::Personalize::CreateSolutionResponse> instance
1153  
1154 Creates the configuration for training a model. A trained model is
1155 known as a solution. After the configuration is created, you train the
1156 model (create a solution) by calling the CreateSolutionVersion
1157 operation. Every time you call C<CreateSolutionVersion>, a new version
1158 of the solution is created.
1159  
1160 After creating a solution version, you check its accuracy by calling
1161 GetSolutionMetrics. When you are satisfied with the version, you deploy
1162 it using CreateCampaign. The campaign provides recommendations to a
1163 client through the GetRecommendations
1164 (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)
1165 API.
1166  
1167 To train a model, Amazon Personalize requires training data and a
1168 recipe. The training data comes from the dataset group that you provide
1169 in the request. A recipe specifies the training algorithm and a feature
1170 transformation. You can specify one of the predefined recipes provided
1171 by Amazon Personalize. Alternatively, you can specify C<performAutoML>
1172 and Amazon Personalize will analyze your data and select the optimum
1173 USER_PERSONALIZATION recipe for you.
1174  
1175 Amazon Personalize doesn't support configuring the C<hpoObjective> for
1176 solution hyperparameter optimization at this time.
1177  
1178 B<Status>
1179  
1180 A solution can be in one of the following states:
1181  
1182 =over
1183  
1184 =item *
1185  
1186 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
1187  
1188 =item *
1189  
1190 DELETE PENDING E<gt> DELETE IN_PROGRESS
1191  
1192 =back
1193  
1194 To get the status of the solution, call DescribeSolution. Wait until
1195 the status shows as ACTIVE before calling C<CreateSolutionVersion>.
1196  
1197 B<Related APIs>
1198  
1199 =over
1200  
1201 =item *
1202  
1203 ListSolutions
1204  
1205 =item *
1206  
1207 CreateSolutionVersion
1208  
1209 =item *
1210  
1211 DescribeSolution
1212  
1213 =item *
1214  
1215 DeleteSolution
1216  
1217 =back
1218  
1219 =over
1220  
1221 =item *
1222  
1223 ListSolutionVersions
1224  
1225 =item *
1226  
1227 DescribeSolutionVersion
1228  
1229 =back
1230  
1231  
1232  
1233 =head2 CreateSolutionVersion
1234  
1235 =over
1236  
1237 =item SolutionArn => Str
1238  
1239 =item [TrainingMode => Str]
1240  
1241  
1242 =back
1243  
1244 Each argument is described in detail in: L<Paws::Personalize::CreateSolutionVersion>
1245  
1246 Returns: a L<Paws::Personalize::CreateSolutionVersionResponse> instance
1247  
1248 Trains or retrains an active solution. A solution is created using the
1249 CreateSolution operation and must be in the ACTIVE state before calling
1250 C<CreateSolutionVersion>. A new version of the solution is created
1251 every time you call this operation.
1252  
1253 B<Status>
1254  
1255 A solution version can be in one of the following states:
1256  
1257 =over
1258  
1259 =item *
1260  
1261 CREATE PENDING
1262  
1263 =item *
1264  
1265 CREATE IN_PROGRESS
1266  
1267 =item *
1268  
1269 ACTIVE
1270  
1271 =item *
1272  
1273 CREATE FAILED
1274  
1275 =item *
1276  
1277 CREATE STOPPING
1278  
1279 =item *
1280  
1281 CREATE STOPPED
1282  
1283 =back
1284  
1285 To get the status of the version, call DescribeSolutionVersion. Wait
1286 until the status shows as ACTIVE before calling C<CreateCampaign>.
1287  
1288 If the status shows as CREATE FAILED, the response includes a
1289 C<failureReason> key, which describes why the job failed.
1290  
1291 B<Related APIs>
1292  
1293 =over
1294  
1295 =item *
1296  
1297 ListSolutionVersions
1298  
1299 =item *
1300  
1301 DescribeSolutionVersion
1302  
1303 =back
1304  
1305 =over
1306  
1307 =item *
1308  
1309 ListSolutions
1310  
1311 =item *
1312  
1313 CreateSolution
1314  
1315 =item *
1316  
1317 DescribeSolution
1318  
1319 =item *
1320  
1321 DeleteSolution
1322  
1323 =back
1324  
1325  
1326  
1327 =head2 DeleteCampaign
1328  
1329 =over
1330  
1331 =item CampaignArn => Str
1332  
1333  
1334 =back
1335  
1336 Each argument is described in detail in: L<Paws::Personalize::DeleteCampaign>
1337  
1338 Returns: nothing
1339  
1340 Removes a campaign by deleting the solution deployment. The solution
1341 that the campaign is based on is not deleted and can be redeployed when
1342 needed. A deleted campaign can no longer be specified in a
1343 GetRecommendations
1344 (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)
1345 request. For more information on campaigns, see CreateCampaign.
1346  
1347  
1348 =head2 DeleteDataset
1349  
1350 =over
1351  
1352 =item DatasetArn => Str
1353  
1354  
1355 =back
1356  
1357 Each argument is described in detail in: L<Paws::Personalize::DeleteDataset>
1358  
1359 Returns: nothing
1360  
1361 Deletes a dataset. You can't delete a dataset if an associated
1362 C<DatasetImportJob> or C<SolutionVersion> is in the CREATE PENDING or
1363 IN PROGRESS state. For more information on datasets, see CreateDataset.
1364  
1365  
1366 =head2 DeleteDatasetGroup
1367  
1368 =over
1369  
1370 =item DatasetGroupArn => Str
1371  
1372  
1373 =back
1374  
1375 Each argument is described in detail in: L<Paws::Personalize::DeleteDatasetGroup>
1376  
1377 Returns: nothing
1378  
1379 Deletes a dataset group. Before you delete a dataset group, you must
1380 delete the following:
1381  
1382 =over
1383  
1384 =item *
1385  
1386 All associated event trackers.
1387  
1388 =item *
1389  
1390 All associated solutions.
1391  
1392 =item *
1393  
1394 All datasets in the dataset group.
1395  
1396 =back
1397  
1398  
1399  
1400 =head2 DeleteEventTracker
1401  
1402 =over
1403  
1404 =item EventTrackerArn => Str
1405  
1406  
1407 =back
1408  
1409 Each argument is described in detail in: L<Paws::Personalize::DeleteEventTracker>
1410  
1411 Returns: nothing
1412  
1413 Deletes the event tracker. Does not delete the event-interactions
1414 dataset from the associated dataset group. For more information on
1415 event trackers, see CreateEventTracker.
1416  
1417  
1418 =head2 DeleteFilter
1419  
1420 =over
1421  
1422 =item FilterArn => Str
1423  
1424  
1425 =back
1426  
1427 Each argument is described in detail in: L<Paws::Personalize::DeleteFilter>
1428  
1429 Returns: nothing
1430  
1431 Deletes a filter.
1432  
1433  
1434 =head2 DeleteSchema
1435  
1436 =over
1437  
1438 =item SchemaArn => Str
1439  
1440  
1441 =back
1442  
1443 Each argument is described in detail in: L<Paws::Personalize::DeleteSchema>
1444  
1445 Returns: nothing
1446  
1447 Deletes a schema. Before deleting a schema, you must delete all
1448 datasets referencing the schema. For more information on schemas, see
1449 CreateSchema.
1450  
1451  
1452 =head2 DeleteSolution
1453  
1454 =over
1455  
1456 =item SolutionArn => Str
1457  
1458  
1459 =back
1460  
1461 Each argument is described in detail in: L<Paws::Personalize::DeleteSolution>
1462  
1463 Returns: nothing
1464  
1465 Deletes all versions of a solution and the C<Solution> object itself.
1466 Before deleting a solution, you must delete all campaigns based on the
1467 solution. To determine what campaigns are using the solution, call
1468 ListCampaigns and supply the Amazon Resource Name (ARN) of the
1469 solution. You can't delete a solution if an associated
1470 C<SolutionVersion> is in the CREATE PENDING or IN PROGRESS state. For
1471 more information on solutions, see CreateSolution.
1472  
1473  
1474 =head2 DescribeAlgorithm
1475  
1476 =over
1477  
1478 =item AlgorithmArn => Str
1479  
1480  
1481 =back
1482  
1483 Each argument is described in detail in: L<Paws::Personalize::DescribeAlgorithm>
1484  
1485 Returns: a L<Paws::Personalize::DescribeAlgorithmResponse> instance
1486  
1487 Describes the given algorithm.
1488  
1489  
1490 =head2 DescribeBatchInferenceJob
1491  
1492 =over
1493  
1494 =item BatchInferenceJobArn => Str
1495  
1496  
1497 =back
1498  
1499 Each argument is described in detail in: L<Paws::Personalize::DescribeBatchInferenceJob>
1500  
1501 Returns: a L<Paws::Personalize::DescribeBatchInferenceJobResponse> instance
1502  
1503 Gets the properties of a batch inference job including name, Amazon
1504 Resource Name (ARN), status, input and output configurations, and the
1505 ARN of the solution version used to generate the recommendations.
1506  
1507  
1508 =head2 DescribeCampaign
1509  
1510 =over
1511  
1512 =item CampaignArn => Str
1513  
1514  
1515 =back
1516  
1517 Each argument is described in detail in: L<Paws::Personalize::DescribeCampaign>
1518  
1519 Returns: a L<Paws::Personalize::DescribeCampaignResponse> instance
1520  
1521 Describes the given campaign, including its status.
1522  
1523 A campaign can be in one of the following states:
1524  
1525 =over
1526  
1527 =item *
1528  
1529 CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED
1530  
1531 =item *
1532  
1533 DELETE PENDING E<gt> DELETE IN_PROGRESS
1534  
1535 =back
1536  
1537 When the C<status> is C<CREATE FAILED>, the response includes the
1538 C<failureReason> key, which describes why.
1539  
1540 For more information on campaigns, see CreateCampaign.
1541  
1542  
1543 =head2 DescribeDataset
1544  
1545 =over
1546  
1547 =item DatasetArn => Str
1548  
1549  
1550 =back
1551  
1552 Each argument is described in detail in: L<Paws::Personalize::DescribeDataset>
1553  
1554 Returns: a L<Paws::Personalize::DescribeDatasetResponse> instance
1555  
1556 Describes the given dataset. For more information on datasets, see
1557 CreateDataset.
1558  
1559  
1560 =head2 DescribeDatasetExportJob
1561  
1562 =over
1563  
1564 =item DatasetExportJobArn => Str
1565  
1566  
1567 =back
1568  
1569 Each argument is described in detail in: L<Paws::Personalize::DescribeDatasetExportJob>
1570  
1571 Returns: a L<Paws::Personalize::DescribeDatasetExportJobResponse> instance
1572  
1573 Describes the dataset export job created by CreateDatasetExportJob,
1574 including the export job status.
1575  
1576  
1577 =head2 DescribeDatasetGroup
1578  
1579 =over
1580  
1581 =item DatasetGroupArn => Str
1582  
1583  
1584 =back
1585  
1586 Each argument is described in detail in: L<Paws::Personalize::DescribeDatasetGroup>
1587  
1588 Returns: a L<Paws::Personalize::DescribeDatasetGroupResponse> instance
1589  
1590 Describes the given dataset group. For more information on dataset
1591 groups, see CreateDatasetGroup.
1592  
1593  
1594 =head2 DescribeDatasetImportJob
1595  
1596 =over
1597  
1598 =item DatasetImportJobArn => Str
1599  
1600  
1601 =back
1602  
1603 Each argument is described in detail in: L<Paws::Personalize::DescribeDatasetImportJob>
1604  
1605 Returns: a L<Paws::Personalize::DescribeDatasetImportJobResponse> instance
1606  
1607 Describes the dataset import job created by CreateDatasetImportJob,
1608 including the import job status.
1609  
1610  
1611 =head2 DescribeEventTracker
1612  
1613 =over
1614  
1615 =item EventTrackerArn => Str
1616  
1617  
1618 =back
1619  
1620 Each argument is described in detail in: L<Paws::Personalize::DescribeEventTracker>
1621  
1622 Returns: a L<Paws::Personalize::DescribeEventTrackerResponse> instance
1623  
1624 Describes an event tracker. The response includes the C<trackingId> and
1625 C<status> of the event tracker. For more information on event trackers,
1626 see CreateEventTracker.
1627  
1628  
1629 =head2 DescribeFeatureTransformation
1630  
1631 =over
1632  
1633 =item FeatureTransformationArn => Str
1634  
1635  
1636 =back
1637  
1638 Each argument is described in detail in: L<Paws::Personalize::DescribeFeatureTransformation>
1639  
1640 Returns: a L<Paws::Personalize::DescribeFeatureTransformationResponse> instance
1641  
1642 Describes the given feature transformation.
1643  
1644  
1645 =head2 DescribeFilter
1646  
1647 =over
1648  
1649 =item FilterArn => Str
1650  
1651  
1652 =back
1653  
1654 Each argument is described in detail in: L<Paws::Personalize::DescribeFilter>
1655  
1656 Returns: a L<Paws::Personalize::DescribeFilterResponse> instance
1657  
1658 Describes a filter's properties.
1659  
1660  
1661 =head2 DescribeRecipe
1662  
1663 =over
1664  
1665 =item RecipeArn => Str
1666  
1667  
1668 =back
1669  
1670 Each argument is described in detail in: L<Paws::Personalize::DescribeRecipe>
1671  
1672 Returns: a L<Paws::Personalize::DescribeRecipeResponse> instance
1673  
1674 Describes a recipe.
1675  
1676 A recipe contains three items:
1677  
1678 =over
1679  
1680 =item *
1681  
1682 An algorithm that trains a model.
1683  
1684 =item *
1685  
1686 Hyperparameters that govern the training.
1687  
1688 =item *
1689  
1690 Feature transformation information for modifying the input data before
1691 training.
1692  
1693 =back
1694  
1695 Amazon Personalize provides a set of predefined recipes. You specify a
1696 recipe when you create a solution with the CreateSolution API.
1697 C<CreateSolution> trains a model by using the algorithm in the
1698 specified recipe and a training dataset. The solution, when deployed as
1699 a campaign, can provide recommendations using the GetRecommendations
1700 (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)
1701 API.
1702  
1703  
1704 =head2 DescribeSchema
1705  
1706 =over
1707  
1708 =item SchemaArn => Str
1709  
1710  
1711 =back
1712  
1713 Each argument is described in detail in: L<Paws::Personalize::DescribeSchema>
1714  
1715 Returns: a L<Paws::Personalize::DescribeSchemaResponse> instance
1716  
1717 Describes a schema. For more information on schemas, see CreateSchema.
1718  
1719  
1720 =head2 DescribeSolution
1721  
1722 =over
1723  
1724 =item SolutionArn => Str
1725  
1726  
1727 =back
1728  
1729 Each argument is described in detail in: L<Paws::Personalize::DescribeSolution>
1730  
1731 Returns: a L<Paws::Personalize::DescribeSolutionResponse> instance
1732  
1733 Describes a solution. For more information on solutions, see
1734 CreateSolution.
1735  
1736  
1737 =head2 DescribeSolutionVersion
1738  
1739 =over
1740  
1741 =item SolutionVersionArn => Str
1742  
1743  
1744 =back
1745  
1746 Each argument is described in detail in: L<Paws::Personalize::DescribeSolutionVersion>
1747  
1748 Returns: a L<Paws::Personalize::DescribeSolutionVersionResponse> instance
1749  
1750 Describes a specific version of a solution. For more information on
1751 solutions, see CreateSolution.
1752  
1753  
1754 =head2 GetSolutionMetrics
1755  
1756 =over
1757  
1758 =item SolutionVersionArn => Str
1759  
1760  
1761 =back
1762  
1763 Each argument is described in detail in: L<Paws::Personalize::GetSolutionMetrics>
1764  
1765 Returns: a L<Paws::Personalize::GetSolutionMetricsResponse> instance
1766  
1767 Gets the metrics for the specified solution version.
1768  
1769  
1770 =head2 ListBatchInferenceJobs
1771  
1772 =over
1773  
1774 =item [MaxResults => Int]
1775  
1776 =item [NextToken => Str]
1777  
1778 =item [SolutionVersionArn => Str]
1779  
1780  
1781 =back
1782  
1783 Each argument is described in detail in: L<Paws::Personalize::ListBatchInferenceJobs>
1784  
1785 Returns: a L<Paws::Personalize::ListBatchInferenceJobsResponse> instance
1786  
1787 Gets a list of the batch inference jobs that have been performed off of
1788 a solution version.
1789  
1790  
1791 =head2 ListCampaigns
1792  
1793 =over
1794  
1795 =item [MaxResults => Int]
1796  
1797 =item [NextToken => Str]
1798  
1799 =item [SolutionArn => Str]
1800  
1801  
1802 =back
1803  
1804 Each argument is described in detail in: L<Paws::Personalize::ListCampaigns>
1805  
1806 Returns: a L<Paws::Personalize::ListCampaignsResponse> instance
1807  
1808 Returns a list of campaigns that use the given solution. When a
1809 solution is not specified, all the campaigns associated with the
1810 account are listed. The response provides the properties for each
1811 campaign, including the Amazon Resource Name (ARN). For more
1812 information on campaigns, see CreateCampaign.
1813  
1814  
1815 =head2 ListDatasetExportJobs
1816  
1817 =over
1818  
1819 =item [DatasetArn => Str]
1820  
1821 =item [MaxResults => Int]
1822  
1823 =item [NextToken => Str]
1824  
1825  
1826 =back
1827  
1828 Each argument is described in detail in: L<Paws::Personalize::ListDatasetExportJobs>
1829  
1830 Returns: a L<Paws::Personalize::ListDatasetExportJobsResponse> instance
1831  
1832 Returns a list of dataset export jobs that use the given dataset. When
1833 a dataset is not specified, all the dataset export jobs associated with
1834 the account are listed. The response provides the properties for each
1835 dataset export job, including the Amazon Resource Name (ARN). For more
1836 information on dataset export jobs, see CreateDatasetExportJob. For
1837 more information on datasets, see CreateDataset.
1838  
1839  
1840 =head2 ListDatasetGroups
1841  
1842 =over
1843  
1844 =item [MaxResults => Int]
1845  
1846 =item [NextToken => Str]
1847  
1848  
1849 =back
1850  
1851 Each argument is described in detail in: L<Paws::Personalize::ListDatasetGroups>
1852  
1853 Returns: a L<Paws::Personalize::ListDatasetGroupsResponse> instance
1854  
1855 Returns a list of dataset groups. The response provides the properties
1856 for each dataset group, including the Amazon Resource Name (ARN). For
1857 more information on dataset groups, see CreateDatasetGroup.
1858  
1859  
1860 =head2 ListDatasetImportJobs
1861  
1862 =over
1863  
1864 =item [DatasetArn => Str]
1865  
1866 =item [MaxResults => Int]
1867  
1868 =item [NextToken => Str]
1869  
1870  
1871 =back
1872  
1873 Each argument is described in detail in: L<Paws::Personalize::ListDatasetImportJobs>
1874  
1875 Returns: a L<Paws::Personalize::ListDatasetImportJobsResponse> instance
1876  
1877 Returns a list of dataset import jobs that use the given dataset. When
1878 a dataset is not specified, all the dataset import jobs associated with
1879 the account are listed. The response provides the properties for each
1880 dataset import job, including the Amazon Resource Name (ARN). For more
1881 information on dataset import jobs, see CreateDatasetImportJob. For
1882 more information on datasets, see CreateDataset.
1883  
1884  
1885 =head2 ListDatasets
1886  
1887 =over
1888  
1889 =item [DatasetGroupArn => Str]
1890  
1891 =item [MaxResults => Int]
1892  
1893 =item [NextToken => Str]
1894  
1895  
1896 =back
1897  
1898 Each argument is described in detail in: L<Paws::Personalize::ListDatasets>
1899  
1900 Returns: a L<Paws::Personalize::ListDatasetsResponse> instance
1901  
1902 Returns the list of datasets contained in the given dataset group. The
1903 response provides the properties for each dataset, including the Amazon
1904 Resource Name (ARN). For more information on datasets, see
1905 CreateDataset.
1906  
1907  
1908 =head2 ListEventTrackers
1909  
1910 =over
1911  
1912 =item [DatasetGroupArn => Str]
1913  
1914 =item [MaxResults => Int]
1915  
1916 =item [NextToken => Str]
1917  
1918  
1919 =back
1920  
1921 Each argument is described in detail in: L<Paws::Personalize::ListEventTrackers>
1922  
1923 Returns: a L<Paws::Personalize::ListEventTrackersResponse> instance
1924  
1925 Returns the list of event trackers associated with the account. The
1926 response provides the properties for each event tracker, including the
1927 Amazon Resource Name (ARN) and tracking ID. For more information on
1928 event trackers, see CreateEventTracker.
1929  
1930  
1931 =head2 ListFilters
1932  
1933 =over
1934  
1935 =item [DatasetGroupArn => Str]
1936  
1937 =item [MaxResults => Int]
1938  
1939 =item [NextToken => Str]
1940  
1941  
1942 =back
1943  
1944 Each argument is described in detail in: L<Paws::Personalize::ListFilters>
1945  
1946 Returns: a L<Paws::Personalize::ListFiltersResponse> instance
1947  
1948 Lists all filters that belong to a given dataset group.
1949  
1950  
1951 =head2 ListRecipes
1952  
1953 =over
1954  
1955 =item [MaxResults => Int]
1956  
1957 =item [NextToken => Str]
1958  
1959 =item [RecipeProvider => Str]
1960  
1961  
1962 =back
1963  
1964 Each argument is described in detail in: L<Paws::Personalize::ListRecipes>
1965  
1966 Returns: a L<Paws::Personalize::ListRecipesResponse> instance
1967  
1968 Returns a list of available recipes. The response provides the
1969 properties for each recipe, including the recipe's Amazon Resource Name
1970 (ARN).
1971  
1972  
1973 =head2 ListSchemas
1974  
1975 =over
1976  
1977 =item [MaxResults => Int]
1978  
1979 =item [NextToken => Str]
1980  
1981  
1982 =back
1983  
1984 Each argument is described in detail in: L<Paws::Personalize::ListSchemas>
1985  
1986 Returns: a L<Paws::Personalize::ListSchemasResponse> instance
1987  
1988 Returns the list of schemas associated with the account. The response
1989 provides the properties for each schema, including the Amazon Resource
1990 Name (ARN). For more information on schemas, see CreateSchema.
1991  
1992  
1993 =head2 ListSolutions
1994  
1995 =over
1996  
1997 =item [DatasetGroupArn => Str]
1998  
1999 =item [MaxResults => Int]
2000  
2001 =item [NextToken => Str]
2002  
2003  
2004 =back
2005  
2006 Each argument is described in detail in: L<Paws::Personalize::ListSolutions>
2007  
2008 Returns: a L<Paws::Personalize::ListSolutionsResponse> instance
2009  
2010 Returns a list of solutions that use the given dataset group. When a
2011 dataset group is not specified, all the solutions associated with the
2012 account are listed. The response provides the properties for each
2013 solution, including the Amazon Resource Name (ARN). For more
2014 information on solutions, see CreateSolution.
2015  
2016  
2017 =head2 ListSolutionVersions
2018  
2019 =over
2020  
2021 =item [MaxResults => Int]
2022  
2023 =item [NextToken => Str]
2024  
2025 =item [SolutionArn => Str]
2026  
2027  
2028 =back
2029  
2030 Each argument is described in detail in: L<Paws::Personalize::ListSolutionVersions>
2031  
2032 Returns: a L<Paws::Personalize::ListSolutionVersionsResponse> instance
2033  
2034 Returns a list of solution versions for the given solution. When a
2035 solution is not specified, all the solution versions associated with
2036 the account are listed. The response provides the properties for each
2037 solution version, including the Amazon Resource Name (ARN). For more
2038 information on solutions, see CreateSolution.
2039  
2040  
2041 =head2 StopSolutionVersionCreation
2042  
2043 =over
2044  
2045 =item SolutionVersionArn => Str
2046  
2047  
2048 =back
2049  
2050 Each argument is described in detail in: L<Paws::Personalize::StopSolutionVersionCreation>
2051  
2052 Returns: nothing
2053  
2054 Stops creating a solution version that is in a state of CREATE_PENDING
2055 or CREATE IN_PROGRESS.
2056  
2057 Depending on the current state of the solution version, the solution
2058 version state changes as follows:
2059  
2060 =over
2061  
2062 =item *
2063  
2064 CREATE_PENDING E<gt> CREATE_STOPPED
2065  
2066 or
2067  
2068 =item *
2069  
2070 CREATE_IN_PROGRESS E<gt> CREATE_STOPPING E<gt> CREATE_STOPPED
2071  
2072 =back
2073  
2074 You are billed for all of the training completed up until you stop the
2075 solution version creation. You cannot resume creating a solution
2076 version once it has been stopped.
2077  
2078  
2079 =head2 UpdateCampaign
2080  
2081 =over
2082  
2083 =item CampaignArn => Str
2084  
2085 =item [CampaignConfig => L<Paws::Personalize::CampaignConfig>]
2086  
2087 =item [MinProvisionedTPS => Int]
2088  
2089 =item [SolutionVersionArn => Str]
2090  
2091  
2092 =back
2093  
2094 Each argument is described in detail in: L<Paws::Personalize::UpdateCampaign>
2095  
2096 Returns: a L<Paws::Personalize::UpdateCampaignResponse> instance
2097  
2098 Updates a campaign by either deploying a new solution or changing the
2099 value of the campaign's C<minProvisionedTPS> parameter.
2100  
2101 To update a campaign, the campaign status must be ACTIVE or CREATE
2102 FAILED. Check the campaign status using the DescribeCampaign API.
2103  
2104 You must wait until the C<status> of the updated campaign is C<ACTIVE>
2105 before asking the campaign for recommendations.
2106  
2107 For more information on campaigns, see CreateCampaign.
2108  
2109  
2110  
2111  
2112 =head1 PAGINATORS
2113  
2114 Paginator methods are helpers that repetively call methods that return partial results
2115  
2116 =head2 ListAllBatchInferenceJobs(sub { },[MaxResults => Int, NextToken => Str, SolutionVersionArn => Str])
2117  
2118 =head2 ListAllBatchInferenceJobs([MaxResults => Int, NextToken => Str, SolutionVersionArn => Str])
2119  
2120  
2121 If passed a sub as first parameter, it will call the sub for each element found in :
2122  
2123 - batchInferenceJobs, passing the object as the first parameter, and the string 'batchInferenceJobs' as the second parameter
2124  
2125 If not, it will return a a L<Paws::Personalize::ListBatchInferenceJobsResponse> 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.
2126  
2127  
2128 =head2 ListAllCampaigns(sub { },[MaxResults => Int, NextToken => Str, SolutionArn => Str])
2129  
2130 =head2 ListAllCampaigns([MaxResults => Int, NextToken => Str, SolutionArn => Str])
2131  
2132  
2133 If passed a sub as first parameter, it will call the sub for each element found in :
2134  
2135 - campaigns, passing the object as the first parameter, and the string 'campaigns' as the second parameter
2136  
2137 If not, it will return a a L<Paws::Personalize::ListCampaignsResponse> 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.
2138  
2139  
2140 =head2 ListAllDatasetExportJobs(sub { },[DatasetArn => Str, MaxResults => Int, NextToken => Str])
2141  
2142 =head2 ListAllDatasetExportJobs([DatasetArn => Str, MaxResults => Int, NextToken => Str])
2143  
2144  
2145 If passed a sub as first parameter, it will call the sub for each element found in :
2146  
2147 - datasetExportJobs, passing the object as the first parameter, and the string 'datasetExportJobs' as the second parameter
2148  
2149 If not, it will return a a L<Paws::Personalize::ListDatasetExportJobsResponse> 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.
2150  
2151  
2152 =head2 ListAllDatasetGroups(sub { },[MaxResults => Int, NextToken => Str])
2153  
2154 =head2 ListAllDatasetGroups([MaxResults => Int, NextToken => Str])
2155  
2156  
2157 If passed a sub as first parameter, it will call the sub for each element found in :
2158  
2159 - datasetGroups, passing the object as the first parameter, and the string 'datasetGroups' as the second parameter
2160  
2161 If not, it will return a a L<Paws::Personalize::ListDatasetGroupsResponse> 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.
2162  
2163  
2164 =head2 ListAllDatasetImportJobs(sub { },[DatasetArn => Str, MaxResults => Int, NextToken => Str])
2165  
2166 =head2 ListAllDatasetImportJobs([DatasetArn => Str, MaxResults => Int, NextToken => Str])
2167  
2168  
2169 If passed a sub as first parameter, it will call the sub for each element found in :
2170  
2171 - datasetImportJobs, passing the object as the first parameter, and the string 'datasetImportJobs' as the second parameter
2172  
2173 If not, it will return a a L<Paws::Personalize::ListDatasetImportJobsResponse> 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.
2174  
2175  
2176 =head2 ListAllDatasets(sub { },[DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2177  
2178 =head2 ListAllDatasets([DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2179  
2180  
2181 If passed a sub as first parameter, it will call the sub for each element found in :
2182  
2183 - datasets, passing the object as the first parameter, and the string 'datasets' as the second parameter
2184  
2185 If not, it will return a a L<Paws::Personalize::ListDatasetsResponse> 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.
2186  
2187  
2188 =head2 ListAllEventTrackers(sub { },[DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2189  
2190 =head2 ListAllEventTrackers([DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2191  
2192  
2193 If passed a sub as first parameter, it will call the sub for each element found in :
2194  
2195 - eventTrackers, passing the object as the first parameter, and the string 'eventTrackers' as the second parameter
2196  
2197 If not, it will return a a L<Paws::Personalize::ListEventTrackersResponse> 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.
2198  
2199  
2200 =head2 ListAllFilters(sub { },[DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2201  
2202 =head2 ListAllFilters([DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2203  
2204  
2205 If passed a sub as first parameter, it will call the sub for each element found in :
2206  
2207 - Filters, passing the object as the first parameter, and the string 'Filters' as the second parameter
2208  
2209 If not, it will return a a L<Paws::Personalize::ListFiltersResponse> 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.
2210  
2211  
2212 =head2 ListAllRecipes(sub { },[MaxResults => Int, NextToken => Str, RecipeProvider => Str])
2213  
2214 =head2 ListAllRecipes([MaxResults => Int, NextToken => Str, RecipeProvider => Str])
2215  
2216  
2217 If passed a sub as first parameter, it will call the sub for each element found in :
2218  
2219 - recipes, passing the object as the first parameter, and the string 'recipes' as the second parameter
2220  
2221 If not, it will return a a L<Paws::Personalize::ListRecipesResponse> 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.
2222  
2223  
2224 =head2 ListAllSchemas(sub { },[MaxResults => Int, NextToken => Str])
2225  
2226 =head2 ListAllSchemas([MaxResults => Int, NextToken => Str])
2227  
2228  
2229 If passed a sub as first parameter, it will call the sub for each element found in :
2230  
2231 - schemas, passing the object as the first parameter, and the string 'schemas' as the second parameter
2232  
2233 If not, it will return a a L<Paws::Personalize::ListSchemasResponse> 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.
2234  
2235  
2236 =head2 ListAllSolutions(sub { },[DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2237  
2238 =head2 ListAllSolutions([DatasetGroupArn => Str, MaxResults => Int, NextToken => Str])
2239  
2240  
2241 If passed a sub as first parameter, it will call the sub for each element found in :
2242  
2243 - solutions, passing the object as the first parameter, and the string 'solutions' as the second parameter
2244  
2245 If not, it will return a a L<Paws::Personalize::ListSolutionsResponse> 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.
2246  
2247  
2248 =head2 ListAllSolutionVersions(sub { },[MaxResults => Int, NextToken => Str, SolutionArn => Str])
2249  
2250 =head2 ListAllSolutionVersions([MaxResults => Int, NextToken => Str, SolutionArn => Str])
2251  
2252  
2253 If passed a sub as first parameter, it will call the sub for each element found in :
2254  
2255 - solutionVersions, passing the object as the first parameter, and the string 'solutionVersions' as the second parameter
2256  
2257 If not, it will return a a L<Paws::Personalize::ListSolutionVersionsResponse> 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.
2258  
2259  
2260  
2261  
2262  
2263 =head1 SEE ALSO
2264  
2265 This service class forms part of L<Paws>
2266  
2267 =head1 BUGS and CONTRIBUTIONS
2268  
2269 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
2270  
2271 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
2272  
2273 =cut
2274