« blib/lib/Paws/IoTEvents/UpdateInputResponse.pm
↑ Summary
blib/lib/Paws/IoTEventsData/AcknowledgeActionConfiguration.pm »
| 1 | package Paws::IoTEventsData; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'data.iotevents' } | ||
| 4 | sub signing_name { 'ioteventsdata' } | ||
| 5 | sub version { '2018-10-23' } | ||
| 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 BatchAcknowledgeAlarm { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchAcknowledgeAlarm', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub BatchDisableAlarm { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchDisableAlarm', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub BatchEnableAlarm { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchEnableAlarm', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub BatchPutMessage { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchPutMessage', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub BatchResetAlarm { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchResetAlarm', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | sub BatchSnoozeAlarm { | ||
| 43 | my $self = shift; | ||
| 44 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchSnoozeAlarm', @_); | ||
| 45 | return $self->caller->do_call($self, $call_object); | ||
| 46 | } | ||
| 47 | sub BatchUpdateDetector { | ||
| 48 | my $self = shift; | ||
| 49 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::BatchUpdateDetector', @_); | ||
| 50 | return $self->caller->do_call($self, $call_object); | ||
| 51 | } | ||
| 52 | sub DescribeAlarm { | ||
| 53 | my $self = shift; | ||
| 54 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::DescribeAlarm', @_); | ||
| 55 | return $self->caller->do_call($self, $call_object); | ||
| 56 | } | ||
| 57 | sub DescribeDetector { | ||
| 58 | my $self = shift; | ||
| 59 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::DescribeDetector', @_); | ||
| 60 | return $self->caller->do_call($self, $call_object); | ||
| 61 | } | ||
| 62 | sub ListAlarms { | ||
| 63 | my $self = shift; | ||
| 64 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::ListAlarms', @_); | ||
| 65 | return $self->caller->do_call($self, $call_object); | ||
| 66 | } | ||
| 67 | sub ListDetectors { | ||
| 68 | my $self = shift; | ||
| 69 | my $call_object = $self->new_with_coercions('Paws::IoTEventsData::ListDetectors', @_); | ||
| 70 | return $self->caller->do_call($self, $call_object); | ||
| 71 | } | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | sub operations { qw/BatchAcknowledgeAlarm BatchDisableAlarm BatchEnableAlarm BatchPutMessage BatchResetAlarm BatchSnoozeAlarm BatchUpdateDetector DescribeAlarm DescribeDetector ListAlarms ListDetectors / } | ||
| 76 | |||
| 77 | 1; | ||
| 78 | |||
| 79 | ### main pod documentation begin ### | ||
| 80 | |||
| 81 | =head1 NAME | ||
| 82 | |||
| 83 | Paws::IoTEventsData - Perl Interface to AWS AWS IoT Events Data | ||
| 84 | |||
| 85 | =head1 SYNOPSIS | ||
| 86 | |||
| 87 | use Paws; | ||
| 88 | |||
| 89 | my $obj = Paws->service('IoTEventsData'); | ||
| 90 | my $res = $obj->Method( | ||
| 91 | Arg1 => $val1, | ||
| 92 | Arg2 => [ 'V1', 'V2' ], | ||
| 93 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 94 | # of the arguments type | ||
| 95 | Arg3 => { Att1 => 'Val1' }, | ||
| 96 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 97 | # the constructor of the arguments type | ||
| 98 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 99 | ); | ||
| 100 | |||
| 101 | =head1 DESCRIPTION | ||
| 102 | |||
| 103 | AWS IoT Events monitors your equipment or device fleets for failures or | ||
| 104 | changes in operation, and triggers actions when such events occur. You | ||
| 105 | can use AWS IoT Events Data API commands to send inputs to detectors, | ||
| 106 | list detectors, and view or update a detector's status. | ||
| 107 | |||
| 108 | For more information, see What is AWS IoT Events? | ||
| 109 | (https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html) | ||
| 110 | in the I<AWS IoT Events Developer Guide>. | ||
| 111 | |||
| 112 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/data.iotevents-2018-10-23> | ||
| 113 | |||
| 114 | |||
| 115 | =head1 METHODS | ||
| 116 | |||
| 117 | =head2 BatchAcknowledgeAlarm | ||
| 118 | |||
| 119 | =over | ||
| 120 | |||
| 121 | =item AcknowledgeActionRequests => ArrayRef[L<Paws::IoTEventsData::AcknowledgeAlarmActionRequest>] | ||
| 122 | |||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchAcknowledgeAlarm> | ||
| 127 | |||
| 128 | Returns: a L<Paws::IoTEventsData::BatchAcknowledgeAlarmResponse> instance | ||
| 129 | |||
| 130 | Acknowledges one or more alarms. The alarms change to the | ||
| 131 | C<ACKNOWLEDGED> state after you acknowledge them. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 BatchDisableAlarm | ||
| 135 | |||
| 136 | =over | ||
| 137 | |||
| 138 | =item DisableActionRequests => ArrayRef[L<Paws::IoTEventsData::DisableAlarmActionRequest>] | ||
| 139 | |||
| 140 | |||
| 141 | =back | ||
| 142 | |||
| 143 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchDisableAlarm> | ||
| 144 | |||
| 145 | Returns: a L<Paws::IoTEventsData::BatchDisableAlarmResponse> instance | ||
| 146 | |||
| 147 | Disables one or more alarms. The alarms change to the C<DISABLED> state | ||
| 148 | after you disable them. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 BatchEnableAlarm | ||
| 152 | |||
| 153 | =over | ||
| 154 | |||
| 155 | =item EnableActionRequests => ArrayRef[L<Paws::IoTEventsData::EnableAlarmActionRequest>] | ||
| 156 | |||
| 157 | |||
| 158 | =back | ||
| 159 | |||
| 160 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchEnableAlarm> | ||
| 161 | |||
| 162 | Returns: a L<Paws::IoTEventsData::BatchEnableAlarmResponse> instance | ||
| 163 | |||
| 164 | Enables one or more alarms. The alarms change to the C<NORMAL> state | ||
| 165 | after you enable them. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 BatchPutMessage | ||
| 169 | |||
| 170 | =over | ||
| 171 | |||
| 172 | =item Messages => ArrayRef[L<Paws::IoTEventsData::Message>] | ||
| 173 | |||
| 174 | |||
| 175 | =back | ||
| 176 | |||
| 177 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchPutMessage> | ||
| 178 | |||
| 179 | Returns: a L<Paws::IoTEventsData::BatchPutMessageResponse> instance | ||
| 180 | |||
| 181 | Sends a set of messages to the AWS IoT Events system. Each message | ||
| 182 | payload is transformed into the input you specify (C<"inputName">) and | ||
| 183 | ingested into any detectors that monitor that input. If multiple | ||
| 184 | messages are sent, the order in which the messages are processed isn't | ||
| 185 | guaranteed. To guarantee ordering, you must send messages one at a time | ||
| 186 | and wait for a successful response. | ||
| 187 | |||
| 188 | |||
| 189 | =head2 BatchResetAlarm | ||
| 190 | |||
| 191 | =over | ||
| 192 | |||
| 193 | =item ResetActionRequests => ArrayRef[L<Paws::IoTEventsData::ResetAlarmActionRequest>] | ||
| 194 | |||
| 195 | |||
| 196 | =back | ||
| 197 | |||
| 198 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchResetAlarm> | ||
| 199 | |||
| 200 | Returns: a L<Paws::IoTEventsData::BatchResetAlarmResponse> instance | ||
| 201 | |||
| 202 | Resets one or more alarms. The alarms return to the C<NORMAL> state | ||
| 203 | after you reset them. | ||
| 204 | |||
| 205 | |||
| 206 | =head2 BatchSnoozeAlarm | ||
| 207 | |||
| 208 | =over | ||
| 209 | |||
| 210 | =item SnoozeActionRequests => ArrayRef[L<Paws::IoTEventsData::SnoozeAlarmActionRequest>] | ||
| 211 | |||
| 212 | |||
| 213 | =back | ||
| 214 | |||
| 215 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchSnoozeAlarm> | ||
| 216 | |||
| 217 | Returns: a L<Paws::IoTEventsData::BatchSnoozeAlarmResponse> instance | ||
| 218 | |||
| 219 | Changes one or more alarms to the snooze mode. The alarms change to the | ||
| 220 | C<SNOOZE_DISABLED> state after you set them to the snooze mode. | ||
| 221 | |||
| 222 | |||
| 223 | =head2 BatchUpdateDetector | ||
| 224 | |||
| 225 | =over | ||
| 226 | |||
| 227 | =item Detectors => ArrayRef[L<Paws::IoTEventsData::UpdateDetectorRequest>] | ||
| 228 | |||
| 229 | |||
| 230 | =back | ||
| 231 | |||
| 232 | Each argument is described in detail in: L<Paws::IoTEventsData::BatchUpdateDetector> | ||
| 233 | |||
| 234 | Returns: a L<Paws::IoTEventsData::BatchUpdateDetectorResponse> instance | ||
| 235 | |||
| 236 | Updates the state, variable values, and timer settings of one or more | ||
| 237 | detectors (instances) of a specified detector model. | ||
| 238 | |||
| 239 | |||
| 240 | =head2 DescribeAlarm | ||
| 241 | |||
| 242 | =over | ||
| 243 | |||
| 244 | =item AlarmModelName => Str | ||
| 245 | |||
| 246 | =item [KeyValue => Str] | ||
| 247 | |||
| 248 | |||
| 249 | =back | ||
| 250 | |||
| 251 | Each argument is described in detail in: L<Paws::IoTEventsData::DescribeAlarm> | ||
| 252 | |||
| 253 | Returns: a L<Paws::IoTEventsData::DescribeAlarmResponse> instance | ||
| 254 | |||
| 255 | Retrieves information about an alarm. | ||
| 256 | |||
| 257 | |||
| 258 | =head2 DescribeDetector | ||
| 259 | |||
| 260 | =over | ||
| 261 | |||
| 262 | =item DetectorModelName => Str | ||
| 263 | |||
| 264 | =item [KeyValue => Str] | ||
| 265 | |||
| 266 | |||
| 267 | =back | ||
| 268 | |||
| 269 | Each argument is described in detail in: L<Paws::IoTEventsData::DescribeDetector> | ||
| 270 | |||
| 271 | Returns: a L<Paws::IoTEventsData::DescribeDetectorResponse> instance | ||
| 272 | |||
| 273 | Returns information about the specified detector (instance). | ||
| 274 | |||
| 275 | |||
| 276 | =head2 ListAlarms | ||
| 277 | |||
| 278 | =over | ||
| 279 | |||
| 280 | =item AlarmModelName => Str | ||
| 281 | |||
| 282 | =item [MaxResults => Int] | ||
| 283 | |||
| 284 | =item [NextToken => Str] | ||
| 285 | |||
| 286 | |||
| 287 | =back | ||
| 288 | |||
| 289 | Each argument is described in detail in: L<Paws::IoTEventsData::ListAlarms> | ||
| 290 | |||
| 291 | Returns: a L<Paws::IoTEventsData::ListAlarmsResponse> instance | ||
| 292 | |||
| 293 | Lists one or more alarms. The operation returns only the metadata | ||
| 294 | associated with each alarm. | ||
| 295 | |||
| 296 | |||
| 297 | =head2 ListDetectors | ||
| 298 | |||
| 299 | =over | ||
| 300 | |||
| 301 | =item DetectorModelName => Str | ||
| 302 | |||
| 303 | =item [MaxResults => Int] | ||
| 304 | |||
| 305 | =item [NextToken => Str] | ||
| 306 | |||
| 307 | =item [StateName => Str] | ||
| 308 | |||
| 309 | |||
| 310 | =back | ||
| 311 | |||
| 312 | Each argument is described in detail in: L<Paws::IoTEventsData::ListDetectors> | ||
| 313 | |||
| 314 | Returns: a L<Paws::IoTEventsData::ListDetectorsResponse> instance | ||
| 315 | |||
| 316 | Lists detectors (the instances of a detector model). | ||
| 317 | |||
| 318 | |||
| 319 | |||
| 320 | |||
| 321 | =head1 PAGINATORS | ||
| 322 | |||
| 323 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 324 | |||
| 325 | |||
| 326 | |||
| 327 | |||
| 328 | =head1 SEE ALSO | ||
| 329 | |||
| 330 | This service class forms part of L<Paws> | ||
| 331 | |||
| 332 | =head1 BUGS and CONTRIBUTIONS | ||
| 333 | |||
| 334 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 335 | |||
| 336 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 337 | |||
| 338 | =cut | ||
| 339 |