/
docs-2.json
765 lines (765 loc) · 32 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
{
"version": "2.0",
"service": "<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events API commands enable you to create, read, update and delete inputs and detector models, and to list their versions.</p>",
"operations": {
"CreateDetectorModel": "<p>Creates a detector model.</p>",
"CreateInput": "<p>Creates an input.</p>",
"DeleteDetectorModel": "<p>Deletes a detector model. Any active instances of the detector model are also deleted.</p>",
"DeleteInput": "<p>Deletes an input.</p>",
"DescribeDetectorModel": "<p>Describes a detector model. If the <code>\"version\"</code> parameter is not specified, information about the latest version is returned.</p>",
"DescribeInput": "<p>Describes an input.</p>",
"DescribeLoggingOptions": "<p>Retrieves the current settings of the AWS IoT Events logging options.</p>",
"ListDetectorModelVersions": "<p>Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.</p>",
"ListDetectorModels": "<p>Lists the detector models you have created. Only the metadata associated with each detector model is returned.</p>",
"ListInputs": "<p>Lists the inputs you have created.</p>",
"ListTagsForResource": "<p>Lists the tags (metadata) you have assigned to the resource.</p>",
"PutLoggingOptions": "<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>\"loggingOptions\"</code> field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the <code>\"roleArn\"</code> field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect.</p>",
"TagResource": "<p>Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.</p>",
"UntagResource": "<p>Removes the given tags (metadata) from the resource.</p>",
"UpdateDetectorModel": "<p>Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.</p>",
"UpdateInput": "<p>Updates an input.</p>"
},
"shapes": {
"Action": {
"base": "<p>An action to be performed when the <code>\"condition\"</code> is TRUE.</p>",
"refs": {
"Actions$member": null
}
},
"Actions": {
"base": null,
"refs": {
"Event$actions": "<p>The actions to be performed.</p>",
"TransitionEvent$actions": "<p>The actions to be performed.</p>"
}
},
"AmazonResourceName": {
"base": null,
"refs": {
"CreateDetectorModelRequest$roleArn": "<p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>",
"DetectorModelConfiguration$roleArn": "<p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>",
"DetectorModelVersionSummary$roleArn": "<p>The ARN of the role that grants the detector model permission to perform its tasks.</p>",
"LambdaAction$functionArn": "<p>The ARN of the AWS Lambda function which is executed.</p>",
"ListTagsForResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
"LoggingOptions$roleArn": "<p>The ARN of the role that grants permission to AWS IoT Events to perform logging.</p>",
"SNSTopicPublishAction$targetArn": "<p>The ARN of the Amazon SNS target where the message is sent.</p>",
"TagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
"UntagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
"UpdateDetectorModelRequest$roleArn": "<p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>"
}
},
"Attribute": {
"base": "<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors. </p>",
"refs": {
"Attributes$member": null
}
},
"AttributeJsonPath": {
"base": null,
"refs": {
"Attribute$jsonPath": "<p>An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system (<code>BatchPutMessage</code>). Each such message contains a JSON payload, and the attribute (and its paired value) specified here are available for use in the <code>\"condition\"</code> expressions used by detectors. </p> <p>Syntax: <code><field-name>.<field-name>...</code> </p>",
"CreateDetectorModelRequest$key": "<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.</p>",
"DetectorModelConfiguration$key": "<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.</p>"
}
},
"Attributes": {
"base": null,
"refs": {
"InputDefinition$attributes": "<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>\"condition\"</code> expressions used by detectors that monitor this input. </p>"
}
},
"ClearTimerAction": {
"base": "<p>Information needed to clear the timer.</p>",
"refs": {
"Action$clearTimer": "<p>Information needed to clear the timer.</p>"
}
},
"Condition": {
"base": null,
"refs": {
"Event$condition": "<p>[Optional] The Boolean expression that when TRUE causes the <code>\"actions\"</code> to be performed. If not present, the actions are performed (=TRUE); if the expression result is not a Boolean value, the actions are NOT performed (=FALSE).</p>",
"TransitionEvent$condition": "<p>[Required] A Boolean expression that when TRUE causes the actions to be performed and the <code>\"nextState\"</code> to be entered.</p>"
}
},
"CreateDetectorModelRequest": {
"base": null,
"refs": {
}
},
"CreateDetectorModelResponse": {
"base": null,
"refs": {
}
},
"CreateInputRequest": {
"base": null,
"refs": {
}
},
"CreateInputResponse": {
"base": null,
"refs": {
}
},
"DeleteDetectorModelRequest": {
"base": null,
"refs": {
}
},
"DeleteDetectorModelResponse": {
"base": null,
"refs": {
}
},
"DeleteInputRequest": {
"base": null,
"refs": {
}
},
"DeleteInputResponse": {
"base": null,
"refs": {
}
},
"DeliveryStreamName": {
"base": null,
"refs": {
"FirehoseAction$deliveryStreamName": "<p>The name of the Kinesis Data Firehose delivery stream where the data is written.</p>"
}
},
"DescribeDetectorModelRequest": {
"base": null,
"refs": {
}
},
"DescribeDetectorModelResponse": {
"base": null,
"refs": {
}
},
"DescribeInputRequest": {
"base": null,
"refs": {
}
},
"DescribeInputResponse": {
"base": null,
"refs": {
}
},
"DescribeLoggingOptionsRequest": {
"base": null,
"refs": {
}
},
"DescribeLoggingOptionsResponse": {
"base": null,
"refs": {
}
},
"DetectorDebugOption": {
"base": "<p>The detector model and the specific detectors (instances) for which the logging level is given.</p>",
"refs": {
"DetectorDebugOptions$member": null
}
},
"DetectorDebugOptions": {
"base": null,
"refs": {
"LoggingOptions$detectorDebugOptions": "<p>Information that identifies those detector models and their detectors (instances) for which the logging level is given.</p>"
}
},
"DetectorModel": {
"base": "<p>Information about the detector model.</p>",
"refs": {
"DescribeDetectorModelResponse$detectorModel": "<p>Information about the detector model.</p>"
}
},
"DetectorModelArn": {
"base": null,
"refs": {
"DetectorModelConfiguration$detectorModelArn": "<p>The ARN of the detector model.</p>",
"DetectorModelVersionSummary$detectorModelArn": "<p>The ARN of the detector model version.</p>"
}
},
"DetectorModelConfiguration": {
"base": "<p>Information about how the detector model is configured.</p>",
"refs": {
"CreateDetectorModelResponse$detectorModelConfiguration": "<p>Information about how the detector model is configured.</p>",
"DetectorModel$detectorModelConfiguration": "<p>Information about how the detector is configured.</p>",
"UpdateDetectorModelResponse$detectorModelConfiguration": "<p>Information about how the detector model is configured.</p>"
}
},
"DetectorModelDefinition": {
"base": "<p>Information that defines how a detector operates.</p>",
"refs": {
"CreateDetectorModelRequest$detectorModelDefinition": "<p>Information that defines how the detectors operate.</p>",
"DetectorModel$detectorModelDefinition": "<p>Information that defines how a detector operates.</p>",
"UpdateDetectorModelRequest$detectorModelDefinition": "<p>Information that defines how a detector operates.</p>"
}
},
"DetectorModelDescription": {
"base": null,
"refs": {
"CreateDetectorModelRequest$detectorModelDescription": "<p>A brief description of the detector model.</p>",
"DetectorModelConfiguration$detectorModelDescription": "<p>A brief description of the detector model.</p>",
"DetectorModelSummary$detectorModelDescription": "<p>A brief description of the detector model.</p>",
"UpdateDetectorModelRequest$detectorModelDescription": "<p>A brief description of the detector model.</p>"
}
},
"DetectorModelName": {
"base": null,
"refs": {
"CreateDetectorModelRequest$detectorModelName": "<p>The name of the detector model.</p>",
"DeleteDetectorModelRequest$detectorModelName": "<p>The name of the detector model to be deleted.</p>",
"DescribeDetectorModelRequest$detectorModelName": "<p>The name of the detector model.</p>",
"DetectorDebugOption$detectorModelName": "<p>The name of the detector model.</p>",
"DetectorModelConfiguration$detectorModelName": "<p>The name of the detector model.</p>",
"DetectorModelSummary$detectorModelName": "<p>The name of the detector model.</p>",
"DetectorModelVersionSummary$detectorModelName": "<p>The name of the detector model.</p>",
"ListDetectorModelVersionsRequest$detectorModelName": "<p>The name of the detector model whose versions are returned.</p>",
"UpdateDetectorModelRequest$detectorModelName": "<p>The name of the detector model that is updated.</p>"
}
},
"DetectorModelSummaries": {
"base": null,
"refs": {
"ListDetectorModelsResponse$detectorModelSummaries": "<p>Summary information about the detector models.</p>"
}
},
"DetectorModelSummary": {
"base": "<p>Information about the detector model.</p>",
"refs": {
"DetectorModelSummaries$member": null
}
},
"DetectorModelVersion": {
"base": null,
"refs": {
"DescribeDetectorModelRequest$detectorModelVersion": "<p>The version of the detector model.</p>",
"DetectorModelConfiguration$detectorModelVersion": "<p>The version of the detector model.</p>",
"DetectorModelVersionSummary$detectorModelVersion": "<p>The ID of the detector model version.</p>"
}
},
"DetectorModelVersionStatus": {
"base": null,
"refs": {
"DetectorModelConfiguration$status": "<p>The status of the detector model.</p>",
"DetectorModelVersionSummary$status": "<p>The status of the detector model version.</p>"
}
},
"DetectorModelVersionSummaries": {
"base": null,
"refs": {
"ListDetectorModelVersionsResponse$detectorModelVersionSummaries": "<p>Summary information about the detector model versions.</p>"
}
},
"DetectorModelVersionSummary": {
"base": "<p>Information about the detector model version.</p>",
"refs": {
"DetectorModelVersionSummaries$member": null
}
},
"EvaluationMethod": {
"base": null,
"refs": {
"CreateDetectorModelRequest$evaluationMethod": "<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>",
"DetectorModelConfiguration$evaluationMethod": "<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>",
"DetectorModelVersionSummary$evaluationMethod": "<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>",
"UpdateDetectorModelRequest$evaluationMethod": "<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>"
}
},
"Event": {
"base": "<p>Specifies the <code>\"actions\"</code> to be performed when the <code>\"condition\"</code> evaluates to TRUE.</p>",
"refs": {
"Events$member": null
}
},
"EventName": {
"base": null,
"refs": {
"Event$eventName": "<p>The name of the event.</p>",
"TransitionEvent$eventName": "<p>The name of the transition event.</p>"
}
},
"Events": {
"base": null,
"refs": {
"OnEnterLifecycle$events": "<p>Specifies the actions that are performed when the state is entered and the <code>\"condition\"</code> is TRUE.</p>",
"OnExitLifecycle$events": "<p>Specifies the <code>\"actions\"</code> that are performed when the state is exited and the <code>\"condition\"</code> is TRUE.</p>",
"OnInputLifecycle$events": "<p>Specifies the actions performed when the <code>\"condition\"</code> evaluates to TRUE.</p>"
}
},
"FirehoseAction": {
"base": "<p>Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream.</p>",
"refs": {
"Action$firehose": "<p>Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream.</p>"
}
},
"FirehoseSeparator": {
"base": null,
"refs": {
"FirehoseAction$separator": "<p>A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).</p>"
}
},
"Input": {
"base": "<p>Information about the input.</p>",
"refs": {
"DescribeInputResponse$input": "<p>Information about the input.</p>"
}
},
"InputArn": {
"base": null,
"refs": {
"InputConfiguration$inputArn": "<p>The ARN of the input.</p>",
"InputSummary$inputArn": "<p>The ARN of the input.</p>"
}
},
"InputConfiguration": {
"base": "<p>Information about the configuration of an input.</p>",
"refs": {
"CreateInputResponse$inputConfiguration": "<p>Information about the configuration of the input.</p>",
"Input$inputConfiguration": "<p>Information about the configuration of an input.</p>",
"UpdateInputResponse$inputConfiguration": "<p>Information about the configuration of the input.</p>"
}
},
"InputDefinition": {
"base": "<p>The definition of the input.</p>",
"refs": {
"CreateInputRequest$inputDefinition": "<p>The definition of the input.</p>",
"Input$inputDefinition": "<p>The definition of the input.</p>",
"UpdateInputRequest$inputDefinition": "<p>The definition of the input.</p>"
}
},
"InputDescription": {
"base": null,
"refs": {
"CreateInputRequest$inputDescription": "<p>A brief description of the input.</p>",
"InputConfiguration$inputDescription": "<p>A brief description of the input.</p>",
"InputSummary$inputDescription": "<p>A brief description of the input.</p>",
"UpdateInputRequest$inputDescription": "<p>A brief description of the input.</p>"
}
},
"InputName": {
"base": null,
"refs": {
"CreateInputRequest$inputName": "<p>The name you want to give to the input.</p>",
"DeleteInputRequest$inputName": "<p>The name of the input to delete.</p>",
"DescribeInputRequest$inputName": "<p>The name of the input.</p>",
"InputConfiguration$inputName": "<p>The name of the input.</p>",
"InputSummary$inputName": "<p>The name of the input.</p>",
"IotEventsAction$inputName": "<p>The name of the AWS IoT Events input where the data is sent.</p>",
"UpdateInputRequest$inputName": "<p>The name of the input you want to update.</p>"
}
},
"InputStatus": {
"base": null,
"refs": {
"InputConfiguration$status": "<p>The status of the input.</p>",
"InputSummary$status": "<p>The status of the input.</p>"
}
},
"InputSummaries": {
"base": null,
"refs": {
"ListInputsResponse$inputSummaries": "<p>Summary information about the inputs.</p>"
}
},
"InputSummary": {
"base": "<p>Information about the input.</p>",
"refs": {
"InputSummaries$member": null
}
},
"InternalFailureException": {
"base": "<p>An internal failure occurred.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>The request was invalid.</p>",
"refs": {
}
},
"IotEventsAction": {
"base": "<p>Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action.</p>",
"refs": {
"Action$iotEvents": "<p>Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action.</p>"
}
},
"IotTopicPublishAction": {
"base": "<p>Information required to publish the MQTT message via the AWS IoT message broker.</p>",
"refs": {
"Action$iotTopicPublish": "<p>Publishes an MQTT message with the given topic to the AWS IoT message broker.</p>"
}
},
"KeyValue": {
"base": null,
"refs": {
"DetectorDebugOption$keyValue": "<p>The value of the input attribute key used to create the detector (the instance of the detector model).</p>"
}
},
"LambdaAction": {
"base": "<p>Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.</p>",
"refs": {
"Action$lambda": "<p>Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.</p>"
}
},
"LimitExceededException": {
"base": "<p>A limit was exceeded.</p>",
"refs": {
}
},
"ListDetectorModelVersionsRequest": {
"base": null,
"refs": {
}
},
"ListDetectorModelVersionsResponse": {
"base": null,
"refs": {
}
},
"ListDetectorModelsRequest": {
"base": null,
"refs": {
}
},
"ListDetectorModelsResponse": {
"base": null,
"refs": {
}
},
"ListInputsRequest": {
"base": null,
"refs": {
}
},
"ListInputsResponse": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"LoggingEnabled": {
"base": null,
"refs": {
"LoggingOptions$enabled": "<p>If TRUE, logging is enabled for AWS IoT Events.</p>"
}
},
"LoggingLevel": {
"base": null,
"refs": {
"LoggingOptions$level": "<p>The logging level.</p>"
}
},
"LoggingOptions": {
"base": "<p>The values of the AWS IoT Events logging options.</p>",
"refs": {
"DescribeLoggingOptionsResponse$loggingOptions": "<p>The current settings of the AWS IoT Events logging options.</p>",
"PutLoggingOptionsRequest$loggingOptions": "<p>The new values of the AWS IoT Events logging options.</p>"
}
},
"MQTTTopic": {
"base": null,
"refs": {
"IotTopicPublishAction$mqttTopic": "<p>The MQTT topic of the message.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListDetectorModelVersionsRequest$maxResults": "<p>The maximum number of results to return at one time.</p>",
"ListDetectorModelsRequest$maxResults": "<p>The maximum number of results to return at one time.</p>",
"ListInputsRequest$maxResults": "<p>The maximum number of results to return at one time.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"ListDetectorModelVersionsRequest$nextToken": "<p>The token for the next set of results.</p>",
"ListDetectorModelVersionsResponse$nextToken": "<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>",
"ListDetectorModelsRequest$nextToken": "<p>The token for the next set of results.</p>",
"ListDetectorModelsResponse$nextToken": "<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>",
"ListInputsRequest$nextToken": "<p>The token for the next set of results.</p>",
"ListInputsResponse$nextToken": "<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
},
"OnEnterLifecycle": {
"base": "<p>When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.</p>",
"refs": {
"State$onEnter": "<p>When entering this state, perform these <code>\"actions\"</code> if the <code>\"condition\"</code> is TRUE.</p>"
}
},
"OnExitLifecycle": {
"base": "<p>When exiting this state, perform these <code>\"actions\"</code> if the specified <code>\"condition\"</code> is TRUE.</p>",
"refs": {
"State$onExit": "<p>When exiting this state, perform these <code>\"actions\"</code> if the specified <code>\"condition\"</code> is TRUE.</p>"
}
},
"OnInputLifecycle": {
"base": "<p>Specifies the actions performed when the <code>\"condition\"</code> evaluates to TRUE.</p>",
"refs": {
"State$onInput": "<p>When an input is received and the <code>\"condition\"</code> is TRUE, perform the specified <code>\"actions\"</code>.</p>"
}
},
"PutLoggingOptionsRequest": {
"base": null,
"refs": {
}
},
"QueueUrl": {
"base": null,
"refs": {
"SqsAction$queueUrl": "<p>The URL of the Amazon SQS queue where the data is written.</p>"
}
},
"ResetTimerAction": {
"base": "<p>Information needed to reset the timer.</p>",
"refs": {
"Action$resetTimer": "<p>Information needed to reset the timer.</p>"
}
},
"ResourceAlreadyExistsException": {
"base": "<p>The resource already exists.</p>",
"refs": {
}
},
"ResourceInUseException": {
"base": "<p>The resource is in use.</p>",
"refs": {
}
},
"ResourceNotFoundException": {
"base": "<p>The resource was not found.</p>",
"refs": {
}
},
"SNSTopicPublishAction": {
"base": "<p>Information required to publish the Amazon SNS message.</p>",
"refs": {
"Action$sns": "<p>Sends an Amazon SNS message.</p>"
}
},
"Seconds": {
"base": null,
"refs": {
"SetTimerAction$seconds": "<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.</p>"
}
},
"ServiceUnavailableException": {
"base": "<p>The service is currently unavailable.</p>",
"refs": {
}
},
"SetTimerAction": {
"base": "<p>Information needed to set the timer.</p>",
"refs": {
"Action$setTimer": "<p>Information needed to set the timer.</p>"
}
},
"SetVariableAction": {
"base": "<p>Information about the variable and its new value.</p>",
"refs": {
"Action$setVariable": "<p>Sets a variable to a specified value.</p>"
}
},
"SqsAction": {
"base": "<p>Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.</p>",
"refs": {
"Action$sqs": "<p>Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.</p>"
}
},
"State": {
"base": "<p>Information that defines a state of a detector.</p>",
"refs": {
"States$member": null
}
},
"StateName": {
"base": null,
"refs": {
"DetectorModelDefinition$initialStateName": "<p>The state that is entered at the creation of each detector (instance).</p>",
"State$stateName": "<p>The name of the state.</p>",
"TransitionEvent$nextState": "<p>The next state to enter.</p>"
}
},
"States": {
"base": null,
"refs": {
"DetectorModelDefinition$states": "<p>Information about the states of the detector.</p>"
}
},
"Tag": {
"base": "<p>Metadata that can be used to manage the resource.</p>",
"refs": {
"Tags$member": null
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$key": "<p>The tag's key.</p>",
"TagKeys$member": null
}
},
"TagKeys": {
"base": null,
"refs": {
"UntagResourceRequest$tagKeys": "<p>A list of the keys of the tags to be removed from the resource.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$value": "<p>The tag's value.</p>"
}
},
"Tags": {
"base": null,
"refs": {
"CreateDetectorModelRequest$tags": "<p>Metadata that can be used to manage the detector model.</p>",
"CreateInputRequest$tags": "<p>Metadata that can be used to manage the input.</p>",
"ListTagsForResourceResponse$tags": "<p>The list of tags assigned to the resource.</p>",
"TagResourceRequest$tags": "<p>The new or modified tags for the resource.</p>"
}
},
"ThrottlingException": {
"base": "<p>The request could not be completed due to throttling.</p>",
"refs": {
}
},
"TimerName": {
"base": null,
"refs": {
"ClearTimerAction$timerName": "<p>The name of the timer to clear.</p>",
"ResetTimerAction$timerName": "<p>The name of the timer to reset.</p>",
"SetTimerAction$timerName": "<p>The name of the timer.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"DetectorModelConfiguration$creationTime": "<p>The time the detector model was created.</p>",
"DetectorModelConfiguration$lastUpdateTime": "<p>The time the detector model was last updated.</p>",
"DetectorModelSummary$creationTime": "<p>The time the detector model was created.</p>",
"DetectorModelVersionSummary$creationTime": "<p>The time the detector model version was created.</p>",
"DetectorModelVersionSummary$lastUpdateTime": "<p>The last time the detector model version was updated.</p>",
"InputConfiguration$creationTime": "<p>The time the input was created.</p>",
"InputConfiguration$lastUpdateTime": "<p>The last time the input was updated.</p>",
"InputSummary$creationTime": "<p>The time the input was created.</p>",
"InputSummary$lastUpdateTime": "<p>The last time the input was updated.</p>"
}
},
"TransitionEvent": {
"base": "<p>Specifies the actions performed and the next state entered when a <code>\"condition\"</code> evaluates to TRUE.</p>",
"refs": {
"TransitionEvents$member": null
}
},
"TransitionEvents": {
"base": null,
"refs": {
"OnInputLifecycle$transitionEvents": "<p>Specifies the actions performed, and the next state entered, when a <code>\"condition\"</code> evaluates to TRUE.</p>"
}
},
"UnsupportedOperationException": {
"base": "<p>The requested operation is not supported.</p>",
"refs": {
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,
"refs": {
}
},
"UpdateDetectorModelRequest": {
"base": null,
"refs": {
}
},
"UpdateDetectorModelResponse": {
"base": null,
"refs": {
}
},
"UpdateInputRequest": {
"base": null,
"refs": {
}
},
"UpdateInputResponse": {
"base": null,
"refs": {
}
},
"UseBase64": {
"base": null,
"refs": {
"SqsAction$useBase64": "<p>Set this to TRUE if you want the data to be Base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.</p>"
}
},
"VariableName": {
"base": null,
"refs": {
"SetVariableAction$variableName": "<p>The name of the variable.</p>"
}
},
"VariableValue": {
"base": null,
"refs": {
"SetVariableAction$value": "<p>The new value of the variable.</p>"
}
},
"errorMessage": {
"base": null,
"refs": {
"InternalFailureException$message": "<p>The message for the exception.</p>",
"InvalidRequestException$message": "<p>The message for the exception.</p>",
"LimitExceededException$message": "<p>The message for the exception.</p>",
"ResourceAlreadyExistsException$message": "<p>The message for the exception.</p>",
"ResourceInUseException$message": "<p>The message for the exception.</p>",
"ResourceNotFoundException$message": "<p>The message for the exception.</p>",
"ServiceUnavailableException$message": "<p>The message for the exception.</p>",
"ThrottlingException$message": "<p>The message for the exception.</p>",
"UnsupportedOperationException$message": "<p>The message for the exception.</p>"
}
},
"resourceArn": {
"base": null,
"refs": {
"ResourceAlreadyExistsException$resourceArn": "<p>The ARN of the resource.</p>"
}
},
"resourceId": {
"base": null,
"refs": {
"ResourceAlreadyExistsException$resourceId": "<p>The ID of the resource.</p>"
}
}
}
}