« blib/lib/Paws/IoT/StartThingRegistrationTaskResponse.pm
↑ Summary
blib/lib/Paws/IoT/Statistics.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoT::StatisticalThreshold; | ||
| 3 | use Moose; | ||
| 4 | has Statistic => (is => 'ro', isa => 'Str', request_name => 'statistic', traits => ['NameInRequest']); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::IoT::StatisticalThreshold | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::IoT::StatisticalThreshold object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { Statistic => $value, ..., Statistic => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::StatisticalThreshold object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->Statistic | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | A statistical ranking (percentile) that indicates a threshold value by | ||
| 37 | which a behavior is determined to be in compliance or in violation of | ||
| 38 | the behavior. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Statistic => Str | ||
| 44 | |||
| 45 | The percentile that resolves to a threshold value by which compliance | ||
| 46 | with a behavior is determined. Metrics are collected over the specified | ||
| 47 | period (C<durationSeconds>) from all reporting devices in your account | ||
| 48 | and statistical ranks are calculated. Then, the measurements from a | ||
| 49 | device are collected over the same period. If the accumulated | ||
| 50 | measurements from the device fall above or below | ||
| 51 | (C<comparisonOperator>) the value associated with the percentile | ||
| 52 | specified, then the device is considered to be in compliance with the | ||
| 53 | behavior, otherwise a violation occurs. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head1 SEE ALSO | ||
| 58 | |||
| 59 | This class forms part of L<Paws>, describing an object used in L<Paws::IoT> | ||
| 60 | |||
| 61 | =head1 BUGS and CONTRIBUTIONS | ||
| 62 | |||
| 63 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 64 | |||
| 65 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 66 | |||
| 67 | =cut | ||
| 68 |