« blib/lib/Paws/IoTEventsData/BatchUpdateDetectorResponse.pm
↑ Summary
blib/lib/Paws/IoTEventsData/DescribeAlarm.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEventsData::CustomerAction; | ||
| 3 | use Moose; | ||
| 4 | has AcknowledgeActionConfiguration => (is => 'ro', isa => 'Paws::IoTEventsData::AcknowledgeActionConfiguration', request_name => 'acknowledgeActionConfiguration', traits => ['NameInRequest']); | ||
| 5 | has ActionName => (is => 'ro', isa => 'Str', request_name => 'actionName', traits => ['NameInRequest']); | ||
| 6 | has DisableActionConfiguration => (is => 'ro', isa => 'Paws::IoTEventsData::DisableActionConfiguration', request_name => 'disableActionConfiguration', traits => ['NameInRequest']); | ||
| 7 | has EnableActionConfiguration => (is => 'ro', isa => 'Paws::IoTEventsData::EnableActionConfiguration', request_name => 'enableActionConfiguration', traits => ['NameInRequest']); | ||
| 8 | has ResetActionConfiguration => (is => 'ro', isa => 'Paws::IoTEventsData::ResetActionConfiguration', request_name => 'resetActionConfiguration', traits => ['NameInRequest']); | ||
| 9 | has SnoozeActionConfiguration => (is => 'ro', isa => 'Paws::IoTEventsData::SnoozeActionConfiguration', request_name => 'snoozeActionConfiguration', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::IoTEventsData::CustomerAction | ||
| 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::CustomerAction object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { AcknowledgeActionConfiguration => $value, ..., SnoozeActionConfiguration => $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::CustomerAction object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->AcknowledgeActionConfiguration | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Contains information about the action that you can take to respond to | ||
| 42 | the alarm. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AcknowledgeActionConfiguration => L<Paws::IoTEventsData::AcknowledgeActionConfiguration> | ||
| 48 | |||
| 49 | Contains the configuration information of an acknowledge action. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 ActionName => Str | ||
| 53 | |||
| 54 | The name of the action. The action name can be one of the following | ||
| 55 | values: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | C<SNOOZE> - When you snooze the alarm, the alarm state changes to | ||
| 62 | C<SNOOZE_DISABLED>. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<ENABLE> - When you enable the alarm, the alarm state changes to | ||
| 67 | C<NORMAL>. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<DISABLE> - When you disable the alarm, the alarm state changes to | ||
| 72 | C<DISABLED>. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<ACKNOWLEDGE> - When you acknowledge the alarm, the alarm state | ||
| 77 | changes to C<ACKNOWLEDGED>. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<RESET> - When you reset the alarm, the alarm state changes to | ||
| 82 | C<NORMAL>. | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | For more information, see the AlarmState | ||
| 87 | (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html) | ||
| 88 | API. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DisableActionConfiguration => L<Paws::IoTEventsData::DisableActionConfiguration> | ||
| 92 | |||
| 93 | Contains the configuration information of a disable action. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 EnableActionConfiguration => L<Paws::IoTEventsData::EnableActionConfiguration> | ||
| 97 | |||
| 98 | Contains the configuration information of an enable action. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 ResetActionConfiguration => L<Paws::IoTEventsData::ResetActionConfiguration> | ||
| 102 | |||
| 103 | Contains the configuration information of a reset action. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 SnoozeActionConfiguration => L<Paws::IoTEventsData::SnoozeActionConfiguration> | ||
| 107 | |||
| 108 | Contains the configuration information of a snooze action. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEventsData> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |