blib/lib/Paws/IoTEvents.pm untested

filter: Statementstmt 0.0% 0 / 91 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 32 Podpod 0.0% 0 / 31 totaltotal 0.0% 0 / 154 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::IoTEvents;
2 use Moose;
3 sub service { 'iotevents' }
4 sub signing_name { 'iotevents' }
5 sub version { '2018-07-27' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub CreateAlarmModel {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::IoTEvents::CreateAlarmModel', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub CreateDetectorModel {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::IoTEvents::CreateDetectorModel', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub CreateInput {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::IoTEvents::CreateInput', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub DeleteAlarmModel {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DeleteAlarmModel', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub DeleteDetectorModel {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DeleteDetectorModel', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub DeleteInput {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DeleteInput', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub DescribeAlarmModel {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DescribeAlarmModel', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub DescribeDetectorModel {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DescribeDetectorModel', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub DescribeDetectorModelAnalysis {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DescribeDetectorModelAnalysis', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub DescribeInput {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DescribeInput', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub DescribeLoggingOptions {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::IoTEvents::DescribeLoggingOptions', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub GetDetectorModelAnalysisResults {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::IoTEvents::GetDetectorModelAnalysisResults', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub ListAlarmModels {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListAlarmModels', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub ListAlarmModelVersions {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListAlarmModelVersions', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub ListDetectorModels {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListDetectorModels', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub ListDetectorModelVersions {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListDetectorModelVersions', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub ListInputRoutings {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListInputRoutings', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102 sub ListInputs {
103 my $self = shift;
104 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListInputs', @_);
105 return $self->caller->do_call($self, $call_object);
106 }
107 sub ListTagsForResource {
108 my $self = shift;
109 my $call_object = $self->new_with_coercions('Paws::IoTEvents::ListTagsForResource', @_);
110 return $self->caller->do_call($self, $call_object);
111 }
112 sub PutLoggingOptions {
113 my $self = shift;
114 my $call_object = $self->new_with_coercions('Paws::IoTEvents::PutLoggingOptions', @_);
115 return $self->caller->do_call($self, $call_object);
116 }
117 sub StartDetectorModelAnalysis {
118 my $self = shift;
119 my $call_object = $self->new_with_coercions('Paws::IoTEvents::StartDetectorModelAnalysis', @_);
120 return $self->caller->do_call($self, $call_object);
121 }
122 sub TagResource {
123 my $self = shift;
124 my $call_object = $self->new_with_coercions('Paws::IoTEvents::TagResource', @_);
125 return $self->caller->do_call($self, $call_object);
126 }
127 sub UntagResource {
128 my $self = shift;
129 my $call_object = $self->new_with_coercions('Paws::IoTEvents::UntagResource', @_);
130 return $self->caller->do_call($self, $call_object);
131 }
132 sub UpdateAlarmModel {
133 my $self = shift;
134 my $call_object = $self->new_with_coercions('Paws::IoTEvents::UpdateAlarmModel', @_);
135 return $self->caller->do_call($self, $call_object);
136 }
137 sub UpdateDetectorModel {
138 my $self = shift;
139 my $call_object = $self->new_with_coercions('Paws::IoTEvents::UpdateDetectorModel', @_);
140 return $self->caller->do_call($self, $call_object);
141 }
142 sub UpdateInput {
143 my $self = shift;
144 my $call_object = $self->new_with_coercions('Paws::IoTEvents::UpdateInput', @_);
145 return $self->caller->do_call($self, $call_object);
146 }
147
148  
149  
150 sub operations { qw/CreateAlarmModel CreateDetectorModel CreateInput DeleteAlarmModel DeleteDetectorModel DeleteInput DescribeAlarmModel DescribeDetectorModel DescribeDetectorModelAnalysis DescribeInput DescribeLoggingOptions GetDetectorModelAnalysisResults ListAlarmModels ListAlarmModelVersions ListDetectorModels ListDetectorModelVersions ListInputRoutings ListInputs ListTagsForResource PutLoggingOptions StartDetectorModelAnalysis TagResource UntagResource UpdateAlarmModel UpdateDetectorModel UpdateInput / }
151  
152 1;
153  
154 ### main pod documentation begin ###
155  
156 =head1 NAME
157  
158 Paws::IoTEvents - Perl Interface to AWS AWS IoT Events
159  
160 =head1 SYNOPSIS
161  
162 use Paws;
163  
164 my $obj = Paws->service('IoTEvents');
165 my $res = $obj->Method(
166 Arg1 => $val1,
167 Arg2 => [ 'V1', 'V2' ],
168 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
169 # of the arguments type
170 Arg3 => { Att1 => 'Val1' },
171 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
172 # the constructor of the arguments type
173 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
174 );
175  
176 =head1 DESCRIPTION
177  
178 AWS IoT Events monitors your equipment or device fleets for failures or
179 changes in operation, and triggers actions when such events occur. You
180 can use AWS IoT Events API operations to create, read, update, and
181 delete inputs and detector models, and to list their versions.
182  
183 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27>
184  
185  
186 =head1 METHODS
187  
188 =head2 CreateAlarmModel
189  
190 =over
191  
192 =item AlarmModelName => Str
193  
194 =item AlarmRule => L<Paws::IoTEvents::AlarmRule>
195  
196 =item RoleArn => Str
197  
198 =item [AlarmCapabilities => L<Paws::IoTEvents::AlarmCapabilities>]
199  
200 =item [AlarmEventActions => L<Paws::IoTEvents::AlarmEventActions>]
201  
202 =item [AlarmModelDescription => Str]
203  
204 =item [AlarmNotification => L<Paws::IoTEvents::AlarmNotification>]
205  
206 =item [Key => Str]
207  
208 =item [Severity => Int]
209  
210 =item [Tags => ArrayRef[L<Paws::IoTEvents::Tag>]]
211  
212  
213 =back
214  
215 Each argument is described in detail in: L<Paws::IoTEvents::CreateAlarmModel>
216  
217 Returns: a L<Paws::IoTEvents::CreateAlarmModelResponse> instance
218  
219 Creates an alarm model to monitor an AWS IoT Events input attribute.
220 You can use the alarm to get notified when the value is outside a
221 specified range. For more information, see Create an alarm model
222 (https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html)
223 in the I<AWS IoT Events Developer Guide>.
224  
225  
226 =head2 CreateDetectorModel
227  
228 =over
229  
230 =item DetectorModelDefinition => L<Paws::IoTEvents::DetectorModelDefinition>
231  
232 =item DetectorModelName => Str
233  
234 =item RoleArn => Str
235  
236 =item [DetectorModelDescription => Str]
237  
238 =item [EvaluationMethod => Str]
239  
240 =item [Key => Str]
241  
242 =item [Tags => ArrayRef[L<Paws::IoTEvents::Tag>]]
243  
244  
245 =back
246  
247 Each argument is described in detail in: L<Paws::IoTEvents::CreateDetectorModel>
248  
249 Returns: a L<Paws::IoTEvents::CreateDetectorModelResponse> instance
250  
251 Creates a detector model.
252  
253  
254 =head2 CreateInput
255  
256 =over
257  
258 =item InputDefinition => L<Paws::IoTEvents::InputDefinition>
259  
260 =item InputName => Str
261  
262 =item [InputDescription => Str]
263  
264 =item [Tags => ArrayRef[L<Paws::IoTEvents::Tag>]]
265  
266  
267 =back
268  
269 Each argument is described in detail in: L<Paws::IoTEvents::CreateInput>
270  
271 Returns: a L<Paws::IoTEvents::CreateInputResponse> instance
272  
273 Creates an input.
274  
275  
276 =head2 DeleteAlarmModel
277  
278 =over
279  
280 =item AlarmModelName => Str
281  
282  
283 =back
284  
285 Each argument is described in detail in: L<Paws::IoTEvents::DeleteAlarmModel>
286  
287 Returns: a L<Paws::IoTEvents::DeleteAlarmModelResponse> instance
288  
289 Deletes an alarm model. Any alarm instances that were created based on
290 this alarm model are also deleted. This action can't be undone.
291  
292  
293 =head2 DeleteDetectorModel
294  
295 =over
296  
297 =item DetectorModelName => Str
298  
299  
300 =back
301  
302 Each argument is described in detail in: L<Paws::IoTEvents::DeleteDetectorModel>
303  
304 Returns: a L<Paws::IoTEvents::DeleteDetectorModelResponse> instance
305  
306 Deletes a detector model. Any active instances of the detector model
307 are also deleted.
308  
309  
310 =head2 DeleteInput
311  
312 =over
313  
314 =item InputName => Str
315  
316  
317 =back
318  
319 Each argument is described in detail in: L<Paws::IoTEvents::DeleteInput>
320  
321 Returns: a L<Paws::IoTEvents::DeleteInputResponse> instance
322  
323 Deletes an input.
324  
325  
326 =head2 DescribeAlarmModel
327  
328 =over
329  
330 =item AlarmModelName => Str
331  
332 =item [AlarmModelVersion => Str]
333  
334  
335 =back
336  
337 Each argument is described in detail in: L<Paws::IoTEvents::DescribeAlarmModel>
338  
339 Returns: a L<Paws::IoTEvents::DescribeAlarmModelResponse> instance
340  
341 Retrieves information about an alarm model. If you don't specify a
342 value for the C<alarmModelVersion> parameter, the latest version is
343 returned.
344  
345  
346 =head2 DescribeDetectorModel
347  
348 =over
349  
350 =item DetectorModelName => Str
351  
352 =item [DetectorModelVersion => Str]
353  
354  
355 =back
356  
357 Each argument is described in detail in: L<Paws::IoTEvents::DescribeDetectorModel>
358  
359 Returns: a L<Paws::IoTEvents::DescribeDetectorModelResponse> instance
360  
361 Describes a detector model. If the C<version> parameter is not
362 specified, information about the latest version is returned.
363  
364  
365 =head2 DescribeDetectorModelAnalysis
366  
367 =over
368  
369 =item AnalysisId => Str
370  
371  
372 =back
373  
374 Each argument is described in detail in: L<Paws::IoTEvents::DescribeDetectorModelAnalysis>
375  
376 Returns: a L<Paws::IoTEvents::DescribeDetectorModelAnalysisResponse> instance
377  
378 Retrieves runtime information about a detector model analysis.
379  
380 After AWS IoT Events starts analyzing your detector model, you have up
381 to 24 hours to retrieve the analysis results.
382  
383  
384 =head2 DescribeInput
385  
386 =over
387  
388 =item InputName => Str
389  
390  
391 =back
392  
393 Each argument is described in detail in: L<Paws::IoTEvents::DescribeInput>
394  
395 Returns: a L<Paws::IoTEvents::DescribeInputResponse> instance
396  
397 Describes an input.
398  
399  
400 =head2 DescribeLoggingOptions
401  
402  
403  
404  
405  
406  
407 Each argument is described in detail in: L<Paws::IoTEvents::DescribeLoggingOptions>
408  
409 Returns: a L<Paws::IoTEvents::DescribeLoggingOptionsResponse> instance
410  
411 Retrieves the current settings of the AWS IoT Events logging options.
412  
413  
414 =head2 GetDetectorModelAnalysisResults
415  
416 =over
417  
418 =item AnalysisId => Str
419  
420 =item [MaxResults => Int]
421  
422 =item [NextToken => Str]
423  
424  
425 =back
426  
427 Each argument is described in detail in: L<Paws::IoTEvents::GetDetectorModelAnalysisResults>
428  
429 Returns: a L<Paws::IoTEvents::GetDetectorModelAnalysisResultsResponse> instance
430  
431 Retrieves one or more analysis results of the detector model.
432  
433 After AWS IoT Events starts analyzing your detector model, you have up
434 to 24 hours to retrieve the analysis results.
435  
436  
437 =head2 ListAlarmModels
438  
439 =over
440  
441 =item [MaxResults => Int]
442  
443 =item [NextToken => Str]
444  
445  
446 =back
447  
448 Each argument is described in detail in: L<Paws::IoTEvents::ListAlarmModels>
449  
450 Returns: a L<Paws::IoTEvents::ListAlarmModelsResponse> instance
451  
452 Lists the alarm models that you created. The operation returns only the
453 metadata associated with each alarm model.
454  
455  
456 =head2 ListAlarmModelVersions
457  
458 =over
459  
460 =item AlarmModelName => Str
461  
462 =item [MaxResults => Int]
463  
464 =item [NextToken => Str]
465  
466  
467 =back
468  
469 Each argument is described in detail in: L<Paws::IoTEvents::ListAlarmModelVersions>
470  
471 Returns: a L<Paws::IoTEvents::ListAlarmModelVersionsResponse> instance
472  
473 Lists all the versions of an alarm model. The operation returns only
474 the metadata associated with each alarm model version.
475  
476  
477 =head2 ListDetectorModels
478  
479 =over
480  
481 =item [MaxResults => Int]
482  
483 =item [NextToken => Str]
484  
485  
486 =back
487  
488 Each argument is described in detail in: L<Paws::IoTEvents::ListDetectorModels>
489  
490 Returns: a L<Paws::IoTEvents::ListDetectorModelsResponse> instance
491  
492 Lists the detector models you have created. Only the metadata
493 associated with each detector model is returned.
494  
495  
496 =head2 ListDetectorModelVersions
497  
498 =over
499  
500 =item DetectorModelName => Str
501  
502 =item [MaxResults => Int]
503  
504 =item [NextToken => Str]
505  
506  
507 =back
508  
509 Each argument is described in detail in: L<Paws::IoTEvents::ListDetectorModelVersions>
510  
511 Returns: a L<Paws::IoTEvents::ListDetectorModelVersionsResponse> instance
512  
513 Lists all the versions of a detector model. Only the metadata
514 associated with each detector model version is returned.
515  
516  
517 =head2 ListInputRoutings
518  
519 =over
520  
521 =item InputIdentifier => L<Paws::IoTEvents::InputIdentifier>
522  
523 =item [MaxResults => Int]
524  
525 =item [NextToken => Str]
526  
527  
528 =back
529  
530 Each argument is described in detail in: L<Paws::IoTEvents::ListInputRoutings>
531  
532 Returns: a L<Paws::IoTEvents::ListInputRoutingsResponse> instance
533  
534 Lists one or more input routings.
535  
536  
537 =head2 ListInputs
538  
539 =over
540  
541 =item [MaxResults => Int]
542  
543 =item [NextToken => Str]
544  
545  
546 =back
547  
548 Each argument is described in detail in: L<Paws::IoTEvents::ListInputs>
549  
550 Returns: a L<Paws::IoTEvents::ListInputsResponse> instance
551  
552 Lists the inputs you have created.
553  
554  
555 =head2 ListTagsForResource
556  
557 =over
558  
559 =item ResourceArn => Str
560  
561  
562 =back
563  
564 Each argument is described in detail in: L<Paws::IoTEvents::ListTagsForResource>
565  
566 Returns: a L<Paws::IoTEvents::ListTagsForResourceResponse> instance
567  
568 Lists the tags (metadata) you have assigned to the resource.
569  
570  
571 =head2 PutLoggingOptions
572  
573 =over
574  
575 =item LoggingOptions => L<Paws::IoTEvents::LoggingOptions>
576  
577  
578 =back
579  
580 Each argument is described in detail in: L<Paws::IoTEvents::PutLoggingOptions>
581  
582 Returns: nothing
583  
584 Sets or updates the AWS IoT Events logging options.
585  
586 If you update the value of any C<loggingOptions> field, it takes up to
587 one minute for the change to take effect. If you change the policy
588 attached to the role you specified in the C<roleArn> field (for
589 example, to correct an invalid policy), it takes up to five minutes for
590 that change to take effect.
591  
592  
593 =head2 StartDetectorModelAnalysis
594  
595 =over
596  
597 =item DetectorModelDefinition => L<Paws::IoTEvents::DetectorModelDefinition>
598  
599  
600 =back
601  
602 Each argument is described in detail in: L<Paws::IoTEvents::StartDetectorModelAnalysis>
603  
604 Returns: a L<Paws::IoTEvents::StartDetectorModelAnalysisResponse> instance
605  
606 Performs an analysis of your detector model. For more information, see
607 Troubleshooting a detector model
608 (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html)
609 in the I<AWS IoT Events Developer Guide>.
610  
611  
612 =head2 TagResource
613  
614 =over
615  
616 =item ResourceArn => Str
617  
618 =item Tags => ArrayRef[L<Paws::IoTEvents::Tag>]
619  
620  
621 =back
622  
623 Each argument is described in detail in: L<Paws::IoTEvents::TagResource>
624  
625 Returns: a L<Paws::IoTEvents::TagResourceResponse> instance
626  
627 Adds to or modifies the tags of the given resource. Tags are metadata
628 that can be used to manage a resource.
629  
630  
631 =head2 UntagResource
632  
633 =over
634  
635 =item ResourceArn => Str
636  
637 =item TagKeys => ArrayRef[Str|Undef]
638  
639  
640 =back
641  
642 Each argument is described in detail in: L<Paws::IoTEvents::UntagResource>
643  
644 Returns: a L<Paws::IoTEvents::UntagResourceResponse> instance
645  
646 Removes the given tags (metadata) from the resource.
647  
648  
649 =head2 UpdateAlarmModel
650  
651 =over
652  
653 =item AlarmModelName => Str
654  
655 =item AlarmRule => L<Paws::IoTEvents::AlarmRule>
656  
657 =item RoleArn => Str
658  
659 =item [AlarmCapabilities => L<Paws::IoTEvents::AlarmCapabilities>]
660  
661 =item [AlarmEventActions => L<Paws::IoTEvents::AlarmEventActions>]
662  
663 =item [AlarmModelDescription => Str]
664  
665 =item [AlarmNotification => L<Paws::IoTEvents::AlarmNotification>]
666  
667 =item [Severity => Int]
668  
669  
670 =back
671  
672 Each argument is described in detail in: L<Paws::IoTEvents::UpdateAlarmModel>
673  
674 Returns: a L<Paws::IoTEvents::UpdateAlarmModelResponse> instance
675  
676 Updates an alarm model. Any alarms that were created based on the
677 previous version are deleted and then created again as new data
678 arrives.
679  
680  
681 =head2 UpdateDetectorModel
682  
683 =over
684  
685 =item DetectorModelDefinition => L<Paws::IoTEvents::DetectorModelDefinition>
686  
687 =item DetectorModelName => Str
688  
689 =item RoleArn => Str
690  
691 =item [DetectorModelDescription => Str]
692  
693 =item [EvaluationMethod => Str]
694  
695  
696 =back
697  
698 Each argument is described in detail in: L<Paws::IoTEvents::UpdateDetectorModel>
699  
700 Returns: a L<Paws::IoTEvents::UpdateDetectorModelResponse> instance
701  
702 Updates a detector model. Detectors (instances) spawned by the previous
703 version are deleted and then re-created as new inputs arrive.
704  
705  
706 =head2 UpdateInput
707  
708 =over
709  
710 =item InputDefinition => L<Paws::IoTEvents::InputDefinition>
711  
712 =item InputName => Str
713  
714 =item [InputDescription => Str]
715  
716  
717 =back
718  
719 Each argument is described in detail in: L<Paws::IoTEvents::UpdateInput>
720  
721 Returns: a L<Paws::IoTEvents::UpdateInputResponse> instance
722  
723 Updates an input.
724  
725  
726  
727  
728 =head1 PAGINATORS
729  
730 Paginator methods are helpers that repetively call methods that return partial results
731  
732  
733  
734  
735 =head1 SEE ALSO
736  
737 This service class forms part of L<Paws>
738  
739 =head1 BUGS and CONTRIBUTIONS
740  
741 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
742  
743 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
744  
745 =cut
746