« blib/lib/Paws/IoTEventsData/SnoozeActionConfiguration.pm
↑ Summary
blib/lib/Paws/IoTEventsData/StateChangeConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEventsData::SnoozeAlarmActionRequest; | ||
| 3 | use Moose; | ||
| 4 | has AlarmModelName => (is => 'ro', isa => 'Str', request_name => 'alarmModelName', traits => ['NameInRequest'], required => 1); | ||
| 5 | has KeyValue => (is => 'ro', isa => 'Str', request_name => 'keyValue', traits => ['NameInRequest']); | ||
| 6 | has Note => (is => 'ro', isa => 'Str', request_name => 'note', traits => ['NameInRequest']); | ||
| 7 | has RequestId => (is => 'ro', isa => 'Str', request_name => 'requestId', traits => ['NameInRequest'], required => 1); | ||
| 8 | has SnoozeDuration => (is => 'ro', isa => 'Int', request_name => 'snoozeDuration', traits => ['NameInRequest'], required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::IoTEventsData::SnoozeAlarmActionRequest | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::IoTEventsData::SnoozeAlarmActionRequest object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AlarmModelName => $value, ..., SnoozeDuration => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEventsData::SnoozeAlarmActionRequest object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AlarmModelName | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Information needed to snooze the alarm. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> AlarmModelName => Str | ||
| 46 | |||
| 47 | The name of the alarm model. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 KeyValue => Str | ||
| 51 | |||
| 52 | The value of the key used as a filter to select only the alarms | ||
| 53 | associated with the key | ||
| 54 | (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Note => Str | ||
| 58 | |||
| 59 | The note that you can leave when you snooze the alarm. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> RequestId => Str | ||
| 63 | |||
| 64 | The request ID. Each ID must be unique within each batch. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> SnoozeDuration => Int | ||
| 68 | |||
| 69 | The snooze time in seconds. The alarm automatically changes to the | ||
| 70 | C<NORMAL> state after this duration. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEventsData> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |