« blib/lib/Paws/IoTEventsData/AlarmState.pm
↑ Summary
blib/lib/Paws/IoTEventsData/BatchAcknowledgeAlarm.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEventsData::AlarmSummary; | ||
| 3 | use Moose; | ||
| 4 | has AlarmModelName => (is => 'ro', isa => 'Str', request_name => 'alarmModelName', traits => ['NameInRequest']); | ||
| 5 | has AlarmModelVersion => (is => 'ro', isa => 'Str', request_name => 'alarmModelVersion', traits => ['NameInRequest']); | ||
| 6 | has CreationTime => (is => 'ro', isa => 'Str', request_name => 'creationTime', traits => ['NameInRequest']); | ||
| 7 | has KeyValue => (is => 'ro', isa => 'Str', request_name => 'keyValue', traits => ['NameInRequest']); | ||
| 8 | has LastUpdateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdateTime', traits => ['NameInRequest']); | ||
| 9 | has StateName => (is => 'ro', isa => 'Str', request_name => 'stateName', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::IoTEventsData::AlarmSummary | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::IoTEventsData::AlarmSummary object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { AlarmModelName => $value, ..., StateName => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEventsData::AlarmSummary object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->AlarmModelName | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Contains a summary of an alarm. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 AlarmModelName => Str | ||
| 47 | |||
| 48 | The name of the alarm model. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AlarmModelVersion => Str | ||
| 52 | |||
| 53 | The version of the alarm model. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CreationTime => Str | ||
| 57 | |||
| 58 | The time the alarm was created, in the Unix epoch format. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 KeyValue => Str | ||
| 62 | |||
| 63 | The value of the key used as a filter to select only the alarms | ||
| 64 | associated with the key | ||
| 65 | (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). | ||
| 66 | |||
| 67 | |||
| 68 | =head2 LastUpdateTime => Str | ||
| 69 | |||
| 70 | The time the alarm was last updated, in the Unix epoch format. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 StateName => Str | ||
| 74 | |||
| 75 | The name of the alarm state. The state name can be one of the following | ||
| 76 | values: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<DISABLED> - When the alarm is in the C<DISABLED> state, it isn't | ||
| 83 | ready to evaluate data. To enable the alarm, you must change the alarm | ||
| 84 | to the C<NORMAL> state. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<NORMAL> - When the alarm is in the C<NORMAL> state, it's ready to | ||
| 89 | evaluate data. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<ACTIVE> - If the alarm is in the C<ACTIVE> state, the alarm is | ||
| 94 | invoked. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<ACKNOWLEDGED> - When the alarm is in the C<ACKNOWLEDGED> state, the | ||
| 99 | alarm was invoked and you acknowledged the alarm. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<SNOOZE_DISABLED> - When the alarm is in the C<SNOOZE_DISABLED> state, | ||
| 104 | the alarm is disabled for a specified period of time. After the snooze | ||
| 105 | time, the alarm automatically changes to the C<NORMAL> state. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<LATCHED> - When the alarm is in the C<LATCHED> state, the alarm was | ||
| 110 | invoked. However, the data that the alarm is currently evaluating is | ||
| 111 | within the specified range. To change the alarm to the C<NORMAL> state, | ||
| 112 | you must acknowledge the alarm. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEventsData> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |