blib/lib/Paws/LookoutEquipment.pm untested

filter: Statementstmt 0.0% 0 / 81 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 29 Podpod 0.0% 0 / 28 totaltotal 0.0% 0 / 138 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::LookoutEquipment;
2 use Moose;
3 sub service { 'lookoutequipment' }
4 sub signing_name { 'lookoutequipment' }
5 sub version { '2020-12-15' }
6 sub target_prefix { 'AWSLookoutEquipmentFrontendService' }
7 sub json_version { "1.0" }
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 CreateDataset {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::CreateDataset', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CreateInferenceScheduler {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::CreateInferenceScheduler', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CreateModel {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::CreateModel', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub DeleteDataset {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DeleteDataset', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub DeleteInferenceScheduler {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DeleteInferenceScheduler', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub DeleteModel {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DeleteModel', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub DescribeDataIngestionJob {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DescribeDataIngestionJob', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub DescribeDataset {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DescribeDataset', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub DescribeInferenceScheduler {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DescribeInferenceScheduler', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub DescribeModel {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::DescribeModel', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub ListDataIngestionJobs {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListDataIngestionJobs', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub ListDatasets {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListDatasets', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub ListInferenceExecutions {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListInferenceExecutions', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub ListInferenceSchedulers {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListInferenceSchedulers', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub ListModels {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListModels', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub ListTagsForResource {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::ListTagsForResource', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub StartDataIngestionJob {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::StartDataIngestionJob', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub StartInferenceScheduler {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::StartInferenceScheduler', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub StopInferenceScheduler {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::StopInferenceScheduler', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub TagResource {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::TagResource', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub UntagResource {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::UntagResource', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub UpdateInferenceScheduler {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::LookoutEquipment::UpdateInferenceScheduler', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128
129  
130  
131 sub operations { qw/CreateDataset CreateInferenceScheduler CreateModel DeleteDataset DeleteInferenceScheduler DeleteModel DescribeDataIngestionJob DescribeDataset DescribeInferenceScheduler DescribeModel ListDataIngestionJobs ListDatasets ListInferenceExecutions ListInferenceSchedulers ListModels ListTagsForResource StartDataIngestionJob StartInferenceScheduler StopInferenceScheduler TagResource UntagResource UpdateInferenceScheduler / }
132  
133 1;
134  
135 ### main pod documentation begin ###
136  
137 =head1 NAME
138  
139 Paws::LookoutEquipment - Perl Interface to AWS Amazon Lookout for Equipment
140  
141 =head1 SYNOPSIS
142  
143 use Paws;
144  
145 my $obj = Paws->service('LookoutEquipment');
146 my $res = $obj->Method(
147 Arg1 => $val1,
148 Arg2 => [ 'V1', 'V2' ],
149 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
150 # of the arguments type
151 Arg3 => { Att1 => 'Val1' },
152 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
153 # the constructor of the arguments type
154 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
155 );
156  
157 =head1 DESCRIPTION
158  
159 Amazon Lookout for Equipment is a machine learning service that uses
160 advanced analytics to identify anomalies in machines from sensor data
161 for use in predictive maintenance.
162  
163 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15>
164  
165  
166 =head1 METHODS
167  
168 =head2 CreateDataset
169  
170 =over
171  
172 =item ClientToken => Str
173  
174 =item DatasetName => Str
175  
176 =item DatasetSchema => L<Paws::LookoutEquipment::DatasetSchema>
177  
178 =item [ServerSideKmsKeyId => Str]
179  
180 =item [Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>]]
181  
182  
183 =back
184  
185 Each argument is described in detail in: L<Paws::LookoutEquipment::CreateDataset>
186  
187 Returns: a L<Paws::LookoutEquipment::CreateDatasetResponse> instance
188  
189 Creates a container for a collection of data being ingested for
190 analysis. The dataset contains the metadata describing where the data
191 is and what the data actually looks like. In other words, it contains
192 the location of the data source, the data schema, and other
193 information. A dataset also contains any tags associated with the
194 ingested data.
195  
196  
197 =head2 CreateInferenceScheduler
198  
199 =over
200  
201 =item ClientToken => Str
202  
203 =item DataInputConfiguration => L<Paws::LookoutEquipment::InferenceInputConfiguration>
204  
205 =item DataOutputConfiguration => L<Paws::LookoutEquipment::InferenceOutputConfiguration>
206  
207 =item DataUploadFrequency => Str
208  
209 =item InferenceSchedulerName => Str
210  
211 =item ModelName => Str
212  
213 =item RoleArn => Str
214  
215 =item [DataDelayOffsetInMinutes => Int]
216  
217 =item [ServerSideKmsKeyId => Str]
218  
219 =item [Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>]]
220  
221  
222 =back
223  
224 Each argument is described in detail in: L<Paws::LookoutEquipment::CreateInferenceScheduler>
225  
226 Returns: a L<Paws::LookoutEquipment::CreateInferenceSchedulerResponse> instance
227  
228 Creates a scheduled inference. Scheduling an inference is setting up a
229 continuous real-time inference plan to analyze new measurement data.
230 When setting up the schedule, you provide an S3 bucket location for the
231 input data, assign it a delimiter between separate entries in the data,
232 set an offset delay if desired, and set the frequency of inferencing.
233 You must also provide an S3 bucket location for the output data.
234  
235  
236 =head2 CreateModel
237  
238 =over
239  
240 =item ClientToken => Str
241  
242 =item DatasetName => Str
243  
244 =item ModelName => Str
245  
246 =item [DataPreProcessingConfiguration => L<Paws::LookoutEquipment::DataPreProcessingConfiguration>]
247  
248 =item [DatasetSchema => L<Paws::LookoutEquipment::DatasetSchema>]
249  
250 =item [EvaluationDataEndTime => Str]
251  
252 =item [EvaluationDataStartTime => Str]
253  
254 =item [LabelsInputConfiguration => L<Paws::LookoutEquipment::LabelsInputConfiguration>]
255  
256 =item [RoleArn => Str]
257  
258 =item [ServerSideKmsKeyId => Str]
259  
260 =item [Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>]]
261  
262 =item [TrainingDataEndTime => Str]
263  
264 =item [TrainingDataStartTime => Str]
265  
266  
267 =back
268  
269 Each argument is described in detail in: L<Paws::LookoutEquipment::CreateModel>
270  
271 Returns: a L<Paws::LookoutEquipment::CreateModelResponse> instance
272  
273 Creates an ML model for data inference.
274  
275 A machine-learning (ML) model is a mathematical model that finds
276 patterns in your data. In Amazon Lookout for Equipment, the model
277 learns the patterns of normal behavior and detects abnormal behavior
278 that could be potential equipment failure (or maintenance events). The
279 models are made by analyzing normal data and abnormalities in machine
280 behavior that have already occurred.
281  
282 Your model is trained using a portion of the data from your dataset and
283 uses that data to learn patterns of normal behavior and abnormal
284 patterns that lead to equipment failure. Another portion of the data is
285 used to evaluate the model's accuracy.
286  
287  
288 =head2 DeleteDataset
289  
290 =over
291  
292 =item DatasetName => Str
293  
294  
295 =back
296  
297 Each argument is described in detail in: L<Paws::LookoutEquipment::DeleteDataset>
298  
299 Returns: nothing
300  
301 Deletes a dataset and associated artifacts. The operation will check to
302 see if any inference scheduler or data ingestion job is currently using
303 the dataset, and if there isn't, the dataset, its metadata, and any
304 associated data stored in S3 will be deleted. This does not affect any
305 models that used this dataset for training and evaluation, but does
306 prevent it from being used in the future.
307  
308  
309 =head2 DeleteInferenceScheduler
310  
311 =over
312  
313 =item InferenceSchedulerName => Str
314  
315  
316 =back
317  
318 Each argument is described in detail in: L<Paws::LookoutEquipment::DeleteInferenceScheduler>
319  
320 Returns: nothing
321  
322 Deletes an inference scheduler that has been set up. Already processed
323 output results are not affected.
324  
325  
326 =head2 DeleteModel
327  
328 =over
329  
330 =item ModelName => Str
331  
332  
333 =back
334  
335 Each argument is described in detail in: L<Paws::LookoutEquipment::DeleteModel>
336  
337 Returns: nothing
338  
339 Deletes an ML model currently available for Amazon Lookout for
340 Equipment. This will prevent it from being used with an inference
341 scheduler, even one that is already set up.
342  
343  
344 =head2 DescribeDataIngestionJob
345  
346 =over
347  
348 =item JobId => Str
349  
350  
351 =back
352  
353 Each argument is described in detail in: L<Paws::LookoutEquipment::DescribeDataIngestionJob>
354  
355 Returns: a L<Paws::LookoutEquipment::DescribeDataIngestionJobResponse> instance
356  
357 Provides information on a specific data ingestion job such as creation
358 time, dataset ARN, status, and so on.
359  
360  
361 =head2 DescribeDataset
362  
363 =over
364  
365 =item DatasetName => Str
366  
367  
368 =back
369  
370 Each argument is described in detail in: L<Paws::LookoutEquipment::DescribeDataset>
371  
372 Returns: a L<Paws::LookoutEquipment::DescribeDatasetResponse> instance
373  
374 Provides information on a specified dataset such as the schema
375 location, status, and so on.
376  
377  
378 =head2 DescribeInferenceScheduler
379  
380 =over
381  
382 =item InferenceSchedulerName => Str
383  
384  
385 =back
386  
387 Each argument is described in detail in: L<Paws::LookoutEquipment::DescribeInferenceScheduler>
388  
389 Returns: a L<Paws::LookoutEquipment::DescribeInferenceSchedulerResponse> instance
390  
391 Specifies information about the inference scheduler being used,
392 including name, model, status, and associated metadata
393  
394  
395 =head2 DescribeModel
396  
397 =over
398  
399 =item ModelName => Str
400  
401  
402 =back
403  
404 Each argument is described in detail in: L<Paws::LookoutEquipment::DescribeModel>
405  
406 Returns: a L<Paws::LookoutEquipment::DescribeModelResponse> instance
407  
408 Provides overall information about a specific ML model, including model
409 name and ARN, dataset, training and evaluation information, status, and
410 so on.
411  
412  
413 =head2 ListDataIngestionJobs
414  
415 =over
416  
417 =item [DatasetName => Str]
418  
419 =item [MaxResults => Int]
420  
421 =item [NextToken => Str]
422  
423 =item [Status => Str]
424  
425  
426 =back
427  
428 Each argument is described in detail in: L<Paws::LookoutEquipment::ListDataIngestionJobs>
429  
430 Returns: a L<Paws::LookoutEquipment::ListDataIngestionJobsResponse> instance
431  
432 Provides a list of all data ingestion jobs, including dataset name and
433 ARN, S3 location of the input data, status, and so on.
434  
435  
436 =head2 ListDatasets
437  
438 =over
439  
440 =item [DatasetNameBeginsWith => Str]
441  
442 =item [MaxResults => Int]
443  
444 =item [NextToken => Str]
445  
446  
447 =back
448  
449 Each argument is described in detail in: L<Paws::LookoutEquipment::ListDatasets>
450  
451 Returns: a L<Paws::LookoutEquipment::ListDatasetsResponse> instance
452  
453 Lists all datasets currently available in your account, filtering on
454 the dataset name.
455  
456  
457 =head2 ListInferenceExecutions
458  
459 =over
460  
461 =item InferenceSchedulerName => Str
462  
463 =item [DataEndTimeBefore => Str]
464  
465 =item [DataStartTimeAfter => Str]
466  
467 =item [MaxResults => Int]
468  
469 =item [NextToken => Str]
470  
471 =item [Status => Str]
472  
473  
474 =back
475  
476 Each argument is described in detail in: L<Paws::LookoutEquipment::ListInferenceExecutions>
477  
478 Returns: a L<Paws::LookoutEquipment::ListInferenceExecutionsResponse> instance
479  
480 Lists all inference executions that have been performed by the
481 specified inference scheduler.
482  
483  
484 =head2 ListInferenceSchedulers
485  
486 =over
487  
488 =item [InferenceSchedulerNameBeginsWith => Str]
489  
490 =item [MaxResults => Int]
491  
492 =item [ModelName => Str]
493  
494 =item [NextToken => Str]
495  
496  
497 =back
498  
499 Each argument is described in detail in: L<Paws::LookoutEquipment::ListInferenceSchedulers>
500  
501 Returns: a L<Paws::LookoutEquipment::ListInferenceSchedulersResponse> instance
502  
503 Retrieves a list of all inference schedulers currently available for
504 your account.
505  
506  
507 =head2 ListModels
508  
509 =over
510  
511 =item [DatasetNameBeginsWith => Str]
512  
513 =item [MaxResults => Int]
514  
515 =item [ModelNameBeginsWith => Str]
516  
517 =item [NextToken => Str]
518  
519 =item [Status => Str]
520  
521  
522 =back
523  
524 Each argument is described in detail in: L<Paws::LookoutEquipment::ListModels>
525  
526 Returns: a L<Paws::LookoutEquipment::ListModelsResponse> instance
527  
528 Generates a list of all models in the account, including model name and
529 ARN, dataset, and status.
530  
531  
532 =head2 ListTagsForResource
533  
534 =over
535  
536 =item ResourceArn => Str
537  
538  
539 =back
540  
541 Each argument is described in detail in: L<Paws::LookoutEquipment::ListTagsForResource>
542  
543 Returns: a L<Paws::LookoutEquipment::ListTagsForResourceResponse> instance
544  
545 Lists all the tags for a specified resource, including key and value.
546  
547  
548 =head2 StartDataIngestionJob
549  
550 =over
551  
552 =item ClientToken => Str
553  
554 =item DatasetName => Str
555  
556 =item IngestionInputConfiguration => L<Paws::LookoutEquipment::IngestionInputConfiguration>
557  
558 =item RoleArn => Str
559  
560  
561 =back
562  
563 Each argument is described in detail in: L<Paws::LookoutEquipment::StartDataIngestionJob>
564  
565 Returns: a L<Paws::LookoutEquipment::StartDataIngestionJobResponse> instance
566  
567 Starts a data ingestion job. Amazon Lookout for Equipment returns the
568 job status.
569  
570  
571 =head2 StartInferenceScheduler
572  
573 =over
574  
575 =item InferenceSchedulerName => Str
576  
577  
578 =back
579  
580 Each argument is described in detail in: L<Paws::LookoutEquipment::StartInferenceScheduler>
581  
582 Returns: a L<Paws::LookoutEquipment::StartInferenceSchedulerResponse> instance
583  
584 Starts an inference scheduler.
585  
586  
587 =head2 StopInferenceScheduler
588  
589 =over
590  
591 =item InferenceSchedulerName => Str
592  
593  
594 =back
595  
596 Each argument is described in detail in: L<Paws::LookoutEquipment::StopInferenceScheduler>
597  
598 Returns: a L<Paws::LookoutEquipment::StopInferenceSchedulerResponse> instance
599  
600 Stops an inference scheduler.
601  
602  
603 =head2 TagResource
604  
605 =over
606  
607 =item ResourceArn => Str
608  
609 =item Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>]
610  
611  
612 =back
613  
614 Each argument is described in detail in: L<Paws::LookoutEquipment::TagResource>
615  
616 Returns: a L<Paws::LookoutEquipment::TagResourceResponse> instance
617  
618 Associates a given tag to a resource in your account. A tag is a
619 key-value pair which can be added to an Amazon Lookout for Equipment
620 resource as metadata. Tags can be used for organizing your resources as
621 well as helping you to search and filter by tag. Multiple tags can be
622 added to a resource, either when you create it, or later. Up to 50 tags
623 can be associated with each resource.
624  
625  
626 =head2 UntagResource
627  
628 =over
629  
630 =item ResourceArn => Str
631  
632 =item TagKeys => ArrayRef[Str|Undef]
633  
634  
635 =back
636  
637 Each argument is described in detail in: L<Paws::LookoutEquipment::UntagResource>
638  
639 Returns: a L<Paws::LookoutEquipment::UntagResourceResponse> instance
640  
641 Removes a specific tag from a given resource. The tag is specified by
642 its key.
643  
644  
645 =head2 UpdateInferenceScheduler
646  
647 =over
648  
649 =item InferenceSchedulerName => Str
650  
651 =item [DataDelayOffsetInMinutes => Int]
652  
653 =item [DataInputConfiguration => L<Paws::LookoutEquipment::InferenceInputConfiguration>]
654  
655 =item [DataOutputConfiguration => L<Paws::LookoutEquipment::InferenceOutputConfiguration>]
656  
657 =item [DataUploadFrequency => Str]
658  
659 =item [RoleArn => Str]
660  
661  
662 =back
663  
664 Each argument is described in detail in: L<Paws::LookoutEquipment::UpdateInferenceScheduler>
665  
666 Returns: nothing
667  
668 Updates an inference scheduler.
669  
670  
671  
672  
673 =head1 PAGINATORS
674  
675 Paginator methods are helpers that repetively call methods that return partial results
676  
677  
678  
679  
680 =head1 SEE ALSO
681  
682 This service class forms part of L<Paws>
683  
684 =head1 BUGS and CONTRIBUTIONS
685  
686 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
687  
688 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
689  
690 =cut
691