-
Notifications
You must be signed in to change notification settings - Fork 36
/
swagger.yml
1067 lines (997 loc) · 32.4 KB
/
swagger.yml
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
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
#-----------------------------------------------------------------------------------------------------------------------
# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
# with the License. A copy of the License is located at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
# and limitations under the License.
#-----------------------------------------------------------------------------------------------------------------------
openapi: '3.0.0'
info:
title: 'AWS Connected Device Framework: Notifications'
description: |
The CDF Notifications umbrella of services receives input from a number of different sources (e.g. IoT Core, DynamoDB Streams, API Gateway), and filters based on a subscriber's notification settings. Any filtered messages are then sent on to a number of pre-configured targets (e.g. AppSync, SNS, or republished to IoT Core).
The CDF Notifications is comprised of 2 micro-services: the CDF Events Processor, and the CDF Notification Dispatcher.
**Releases**
- Version 1 (`application/vnd.aws-cdf-v1.0+json`) supported a single target per target type per subscription, e.g. a single email and/or single mobile push device per subscription.
- Version 2 (`application/vnd.aws-cdf-v2.0+json`) was enhanced to allow multiple targets per target type per subscription, e.g. multiple emails and/or multiple mobile push devices per subscription. A new set of endpoints to allow for adding and deleting of individual targets was added too.
version: 2.0.0
tags:
- name: EventSources
description: |
An `EventSource` must be congifured per source of events to allow the event processor to consume events. The following types of event sources are supported:
- DynamoDB
- IoT Core
All incoming events must contain an `id` that can be used to match against a configured `EventSource` `eventSourceId`. If a matching `EventSource` configuration cannot be found, the event is dropped.
Events that are sourced via API Gateway or IoT Core are to be provided in the common message format, whereas events sourced from DynamoDB are converted to the common message format by the Event Processor.
- name: Events
description: |
An `Event` represents a message consumed from an event source that has had a rule evaluated against it (its `conditions`). Each event also specifies the available subscription targets (its `supportedTargets`) such as email and/or sms, as well as custom message `templates` to notify of the alert.
- name: Subscriptions
description: A 'Subscription' allows a user to subscribe to an event, optionally configuring which supported targets to retrieve the alert by.
paths:
/eventsources:
post:
tags:
- EventSources
summary: Creates a new EventSource
operationId: 'createEventSource'
requestBody:
required: true
content:
application/vnd.aws-cdf-v2.0+json:
schema:
$ref: '#/components/schemas/EventSourceDetail'
examples:
dynamoDb:
$ref: '#/components/examples/NewDynamoDBEventSource'
iotCore:
$ref: '#/components/examples/NewIoTCoreEventSource'
application/vnd.aws-cdf-v1.0+json:
schema:
$ref: '#/components/schemas/EventSourceDetail'
examples:
dynamoDb:
$ref: '#/components/examples/NewDynamoDBEventSource'
iotCore:
$ref: '#/components/examples/NewIoTCoreEventSource'
responses:
'201':
$ref: '#/components/responses/Created'
'400':
$ref: '#/components/responses/BadRequest'
get:
tags:
- EventSources
summary: Returns all configured event sources
operationId: 'listEventSources'
responses:
'200':
$ref: '#/components/schemas/EventSourceList'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
/eventsources/{eventSourceId}:
parameters:
- $ref: '#/components/parameters/eventSourceId'
get:
tags:
- EventSources
summary: Returns a single event source
operationId: getEventSource
responses:
'200':
$ref: '#/components/schemas/EventSourceDetail'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- EventSources
summary: Deletes an event source
operationId: deleteEventSource
responses:
'204':
$ref: '#/components/responses/Deleted'
'404':
$ref: '#/components/responses/NotFound'
/eventsources/{eventSourceId}/events:
parameters:
- $ref: '#/components/parameters/eventSourceId'
post:
tags:
- Events
summary: Creates a new Event
operationId: createEvent
requestBody:
required: true
content:
application/vnd.aws-cdf-v2.0+json:
schema:
$ref: '#/components/schemas/Event'
examples:
lowBatteryAlert1:
$ref: '#/components/examples/NewEvent1'
lowBatteryAlert2:
$ref: '#/components/examples/NewEvent2'
lowBatteryAlert3:
$ref: '#/components/examples/NewEvent3'
application/vnd.aws-cdf-v1.0+json:
schema:
$ref: '#/components/schemas/Event'
examples:
lowBatteryAlert1:
$ref: '#/components/examples/NewEvent1'
lowBatteryAlert2:
$ref: '#/components/examples/NewEvent2'
lowBatteryAlert3:
$ref: '#/components/examples/NewEvent3'
responses:
'201':
$ref: '#/components/responses/Created'
'400':
$ref: '#/components/responses/BadRequest'
get:
tags:
- Events
summary: Lists all events for a specific event source
operationId: listEventsForEventSource
responses:
'200':
$ref: '#/components/schemas/EventList'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
/events/{eventId}:
parameters:
- $ref: '#/components/parameters/eventId'
get:
tags:
- Events
summary: Returns a single event
operationId: getEvent
responses:
'200':
$ref: '#/components/schemas/Event'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Events
summary: Updates an existing event.
operationId: updateEvent
responses:
'201':
$ref: '#/components/responses/Created'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Events
summary: Deletes an event
operationId: deleteEvent
responses:
'204':
$ref: '#/components/responses/NoBody'
'404':
$ref: '#/components/responses/NotFound'
/events/{eventId}/subscriptions:
parameters:
- $ref: '#/components/parameters/eventId'
post:
tags:
- Subscriptions
summary: Creates a new subscription of an event
operationId: createSubscription
requestBody:
required: true
content:
application/vnd.aws-cdf-v2.0+json:
schema:
$ref: '#/components/schemas/SubscriptionV2'
examples:
lowBatteryAlert:
$ref: '#/components/examples/NewSubscriptionV2'
application/vnd.aws-cdf-v1.0+json:
schema:
$ref: '#/components/schemas/SubscriptionV1'
examples:
lowBatteryAlert:
$ref: '#/components/examples/NewSubscriptionV1'
responses:
'201':
$ref: '#/components/responses/Created'
'400':
$ref: '#/components/responses/BadRequest'
get:
parameters:
- $ref: '#/components/parameters/fromSubscriptionId'
tags:
- Subscriptions
summary: Lists all subscriptions for the provided event
operationId: listSubscriptionsForEvent
responses:
'200':
$ref: '#/components/schemas/SubscriptionList'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
/subscriptions/{subscriptionId}:
parameters:
- $ref: '#/components/parameters/subscriptionId'
get:
tags:
- Subscriptions
summary: Returns a single subscription
operationId: getSubscription
responses:
'200':
description: Requested subscription.
content:
application/vnd.aws-cdf-v2.0+json:
schema:
$ref: '#/components/schemas/SubscriptionV2'
application/vnd.aws-cdf-v1.0+json:
schema:
$ref: '#/components/schemas/SubscriptionV1'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Subscriptions
summary: Modify existing subscription
operationId: updateSubscription
requestBody:
required: true
content:
application/vnd.aws-cdf-v2.0+json:
schema:
$ref: '#/components/schemas/UpdateSubscription'
examples:
disableSubscription:
$ref: '#/components/examples/DisableSubscription'
responses:
'204':
$ref: '#/components/responses/Modified'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Subscriptions
summary: Deletes a subscription
operationId: deleteSubscription
responses:
'204':
$ref: '#/components/responses/Deleted'
'404':
$ref: '#/components/responses/NotFound'
/user/{userId}/subscriptions:
parameters:
- $ref: '#/components/parameters/userId'
- $ref: '#/components/parameters/principalFilter'
- $ref: '#/components/parameters/principalValueFilter'
get:
tags:
- Subscriptions
summary: Lists all subscriptions for the provided user
operationId: listSubscriptionsForUser
responses:
'200':
$ref: '#/components/schemas/SubscriptionList'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Subscriptions
summary: Delete subscriptions for a given user
operationId: deleteSubscriptionsForUser
responses:
'204':
$ref: '#/components/responses/Deleted'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
/subscriptions/{subscriptionId}/targets/{targetType}:
parameters:
- $ref: '#/components/parameters/subscriptionId'
- $ref: '#/components/parameters/targetType'
post:
tags:
- Targets
summary: Adds a new target to an existing subscription
operationId: createTarget
requestBody:
required: true
content:
application/vnd.aws-cdf-v2.0+json:
schema:
oneOf:
- $ref: '#/components/schemas/EmailTargetV2'
- $ref: '#/components/schemas/SMSTargetV2'
- $ref: '#/components/schemas/PushTargetV2'
- $ref: '#/components/schemas/DynamoDbTargetV2'
examples:
email:
$ref: '#/components/examples/NewEmailTarget'
sms:
$ref: '#/components/examples/NewSMSTarget'
push_gcm:
$ref: '#/components/examples/NewPushTarget'
dynamoDb:
$ref: '#/components/examples/NewDynamoDbTarget'
responses:
'201':
$ref: '#/components/responses/Created'
'400':
$ref: '#/components/responses/BadRequest'
/subscriptions/{subscriptionId}/targets/{targetType}/{targetId}:
parameters:
- $ref: '#/components/parameters/subscriptionId'
- $ref: '#/components/parameters/targetType'
- $ref: '#/components/parameters/targetId'
delete:
tags:
- Targets
summary: Delete a specific target from an existing subscription
operationId: deleteTarget
responses:
'204':
$ref: '#/components/responses/Deleted'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
EventSourceSummary:
properties:
id:
description: |
For DynamoDB event sources, this must be provided and represents the DynamoDB table Arn.
For IoTCore event sources, this is a automatically generated unique id, and will be added to all messages originating from this event source.
type: string
name:
description: Name of the event source.
type: string
required:
- name
EventSourceDetail:
allOf:
- $ref: '#/components/schemas/EventSourceSummary'
- type: object
properties:
sourceType:
description: Event source type
type: string
enum: [DynamoDB, IoTCore]
principal:
description: |
The attribute within the event message that represents the principal (e.g. deviceId, thingName, or username).
type: string
dynamoDb:
description: DynamoDB event source specific configuration.
type: object
properties:
tableName:
description: Name of the DynamoDB table
type: string
required:
- tableName
iotCore:
description: IoTCore event source configuration.
type: object
properties:
mqttTopic:
description: The MQTT topic that this event source subscribes to. Supports wildcards.
type: string
attributes:
description: A map of source message attributes that will be transferred to the common message format for processing,
type: object
additionalProperties:
type: string
required:
- mqttTopic
- attributes
required:
- sourceType
- principal
EventSourceList:
properties:
results:
description: A list of event sources.
type: array
items:
$ref: '#/components/schemas/EventSourceSummary'
Event:
properties:
name:
description: Name of event
type: string
conditions:
$ref: '#/components/schemas/EventConditions'
ruleParameters:
description: List of parameters that require values providing along with a subscription in order to evaluate the event conditions
type: array
items:
oneOf:
- type: string
- type: number
- type: boolean
enabled:
description: Enabled state of the event
type: boolean
default: true
templates:
description: A map of message templates (in VTL format) to be compiled for the different supported targets
type: object
additionalProperties:
type: string
supportedTargets:
description: A map of supported targets, along with the messaging template to use
type: object
properties:
email:
type: string
sms:
type: string
push_gcm:
type: string
eventId:
description: Event ID
type: string
readOnly: true
eventSourceId:
description: Event source ID
type: string
readOnly: true
principal:
description: The name of the attribute that represents the principal in incoming messages from the event source
type: string
readOnly: true
disableAlertThreshold:
description: If set to true, alerts will be sent every time rather than just the first time after a threshold being passed.
type: boolean
default: false
required:
- name
- conditions
- templates
EventConditions:
properties:
all:
description: All of these conditions must evalute to true for the alert to be triggered
oneOf:
- $ref: '#/components/schemas/EventConditions'
- type: array
items:
$ref: '#/components/schemas/EventCondition'
any:
description: Any of these conditions must evalute to true for the alert to be triggered
oneOf:
- $ref: '#/components/schemas/EventConditions'
- type: array
items:
$ref: '#/components/schemas/EventCondition'
EventCondition:
properties:
fact:
description: The name of the attribute (in the common message format) to be evaluated
type: string
operator:
description: The type of operator to evaluate the fact with
type: string
enum:
[
equal,
notEqual,
lessThan,
lessThanExclusive,
greaterThan,
greaterThanExclusive,
in,
notIn,
contains,
doesNotContain,
]
value:
description: The value of the fact to evaluate
oneOf:
- type: string
- type: number
- type: boolean
EventList:
properties:
results:
description: A list of events.
type: array
items:
$ref: '#/components/schemas/Event'
pagination:
type: object
description: Pagination details
properties:
offset:
type: object
properties:
eventSourceId:
description: The event source ID to paginate from
type: string
eventId:
description: The event ID to paginate from
type: string
count:
type: number
UpdateSubscription:
properties:
ruleParameterValues:
description: The values of any required rule parameters of the event
type: object
additionalProperties:
oneOf:
- type: string
- type: number
- type: boolean
enabled:
description: Enabled status (This is a placeholder to enable/disable notifications. Currently, not validated)
type: boolean
required:
- id
SubscriptionBase:
properties:
id:
description: Subscription ID
type: string
readOnly: true
user:
type: object
properties:
id:
description: User ID
type: string
required:
- id
principalValue:
description: Value of the principal attribute of the event to susbcribe to
type: string
ruleParameterValues:
description: The values of any required rule parameters of the event
type: object
additionalProperties:
oneOf:
- type: string
- type: number
- type: boolean
event:
type: object
properties:
id:
description: Event ID
type: string
name:
description: Event name
type: string
conditions:
$ref: '#/components/schemas/EventConditions'
disableAlertThreshold:
description: If set to true, alerts will be sent every time rather than just the first time after a threshold being passed.
type: boolean
readOnly: true
enabled:
description: Enabled status (This is a placeholder to enable/disable notifications. Currently, not validated)
type: boolean
default: true
alerted:
description: Alerted status (This is a placeholder to enable/disable notifications. Currently, not validated)
type: boolean
readOnly: true
required:
- user
- principalValue
EmailTargetV1:
type: object
properties:
address:
description: Email address
type: string
required:
- address
EmailTargetV2:
allOf:
- $ref: '#/components/schemas/EmailTargetV1'
- type: object
properties:
subscriptionArn:
description: SNS subscription ARN
type: string
SMSTargetV1:
type: object
properties:
phoneNumber:
description: SMS phone number
type: string
required:
- phoneNumber
SMSTargetV2:
allOf:
- $ref: '#/components/schemas/SMSTargetV1'
- type: object
properties:
subscriptionArn:
description: SNS subscription ARN
type: string
PushTargetV1:
type: object
properties:
platformApplicationArn:
description: Platform Application Arn
type: string
token:
description: Application Token
type: string
required:
- platformApplicationArn
- token
PushTargetV2:
allOf:
- $ref: '#/components/schemas/PushTargetV1'
- type: object
properties:
platformEndpointArn:
description: ARN representing a specific app of a specific mobile device. Created after subscribing using the `platformApplicationArn` and `token`.
subscriptionArn:
description: SNS subscription ARN
type: string
DynamoDbTargetV1:
type: object
properties:
tableName:
description: Name of an existing DynamoDB table
type: string
attributeMapping:
description: Mapping of source to destination attributes of the DynamoDB table to copy from/to
type: object
additionalProperties:
type: string
required:
- tableName
- attributeMapping
DynamoDbTargetV2:
allOf:
- $ref: '#/components/schemas/DynamoDbTargetV1'
SubscriptionV1:
allOf:
- $ref: '#/components/schemas/SubscriptionBase'
- type: object
properties:
targets:
type: object
properties:
email:
$ref: '#/components/schemas/EmailTargetV1'
sms:
$ref: '#/components/schemas/SMSTargetV1'
push_gcm:
$ref: '#/components/schemas/PushTargetV1'
dynamoDb:
$ref: '#/components/schemas/DynamoDbTargetV1'
SubscriptionV2:
allOf:
- $ref: '#/components/schemas/SubscriptionBase'
- type: object
properties:
targets:
type: object
properties:
email:
type: array
items:
$ref: '#/components/schemas/EmailTargetV1'
sms:
type: array
items:
$ref: '#/components/schemas/SMSTargetV1'
push_gcm:
type: array
items:
$ref: '#/components/schemas/PushTargetV1'
dynamoDb:
type: array
items:
$ref: '#/components/schemas/DynamoDbTargetV1'
SubscriptionList:
type: object
properties:
results:
type: array
description: A list of subscriptions.
items:
oneOf:
- $ref: '#/components/schemas/SubscriptionV1'
- $ref: '#/components/schemas/SubscriptionV2'
pagination:
type: object
properties:
offset:
type: object
properties:
eventId:
description: The event ID to paginate from
type: string
subscriptionId:
description: The subscription ID to paginate from
type: string
count:
type: number
Error:
type: object
properties:
message:
description: Error message
type: string
parameters:
eventSourceId:
name: eventSourceId
in: path
description: Event source ID
required: true
schema:
type: string
eventId:
name: eventId
in: path
description: Event ID
required: true
schema:
type: string
subscriptionId:
name: subscriptionId
in: path
description: Subscription ID
required: true
schema:
type: string
userId:
name: userId
in: path
description: User ID
required: true
schema:
type: string
fromSubscriptionId:
name: fromSubscriptionId
in: query
description: Subscription ID to use as the start of paginated results
schema:
type: string
targetType:
name: targetType
in: path
description: Target type
required: true
schema:
type: string
enum:
- email
- sms
- dynamodb
- push_gcm
targetId:
name: targetId
in: path
description: Unique ID of the target, which depends on the `targetType`. May be `email.address`, `sms.phoneNumber`, `dynamodb.tablename` or `push_gcm.appplicationEndpointArn`.
required: true
schema:
type: string
principalFilter:
name: principal
in: query
description: A principal to filter by.
schema:
type: string
principalValueFilter:
name: principalValue
in: query
description: The value of the principal to filter by.
schema:
type: string
examples:
NewDynamoDBEventSource:
summary: Creating a new DynamoDB event source
value:
id: 'arn:aws:dynamodb:us-west-2:xxxxxxxxxxxx:table/myTable"'
name: Processed Events
sourceType: DynamoDB
principal: thingName
dynamoDb:
tableName: myTable
NewIoTCoreEventSource:
summary: Creating a new IoT Core event source
value:
name: Raw Events
sourceType: IoTCore
principal: thingName
iotCore:
mqttTopic: 'telemetry/+'
attribtues:
- batteryLevel: bl
NewEvent1:
summary: Creating an event to represent a low battery alert
value:
name: Low Battery Alert
conditions:
all:
- fact: batteryLevel
operator: lessThanInclusive
value: 20
supportedTargets:
email: default
sms: small
push_gcm: small
templates:
default: 'The battery for bowl {{=it.principalValue}} is low.'
small: '{{=it.principalValue}} battery low'
NewEvent2:
summary: Creating an event to represent a low battery alert based on a parameter value to be provided at the time of creating a subscription
value:
name: Low Battery Alert
conditions:
all:
- fact: batteryLevel
operator: lessThanInclusive
value: $batteryLevelThreshold
supportedTargets:
email: default
sms: small
push_gcm: small
templates:
default: 'The battery for bowl {{=it.principalValue}} is low.'
small: '{{=it.principalValue}} battery low'
NewEvent3:
summary: Creating an event to represent a low battery alert based on a threshold value present in the same event
value:
name: Low Battery Alert
conditions:
all:
- fact: batteryLevel
operator: lessThanInclusive
value: { fact: batteryLevelThreshold }
supportedTargets:
email: default
sms: small
push_gcm: small
templates:
default: 'The battery for bowl {{=it.principalValue}} is low.'
small: '{{=it.principalValue}} battery low'
ExistingEvent:
summary: An existing event
value:
eventId: 'af6b6890-6dde-11e9-addb-23bea6189627'
eventSourceId: 'a2f05ee0-6dde-11e9-addb-23bea6189627'
name: Low Battery Alert
conditions:
all:
- fact: batteryLevel
operator: lessThanInclusive
value: 20
supportedTargets:
email: default
sms: small
push_gcm: small
templates:
default: 'The battery for bowl {{=it.principalValue}} is low.'
small: '{{=it.principalValue}} battery low'
enabled: true
principal: thingName
NewSubscriptionV1:
summary: A new subscription
value:
user:
id: user123
principalValue: device001
targets:
email:
address: xxxxxxxxxxxx
sms:
phoneNumber: 15551231234
push_gcm:
platformApplicationArn: arn:aws:sns:us-west-2:xxxxxxxxxxxx:app/GCM/MyApplication
token: EXAMPLE12345
NewSubscriptionV2:
summary: A new subscription
value:
user:
id: user123
principalValue: device001
targets:
email:
- address: someone@somewhere.com
- address: someone@somewhereelse.com
sms:
- phoneNumber: 15551231234
push_gcm:
- platformApplicationArn: arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication
token: EXAMPLE12345
DisableSubscription:
summary: Disable existing subscription to prevent alert being sent
value:
enabled:
id: false
NewEmailTarget:
summary: A new email target
value:
address: someone@somewhere.com