@aws-sdk/client-iot-events 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,6 +6,7 @@ import { IoTEventsServiceException as __BaseException } from "./IoTEventsService
6
6
  */
7
7
  export interface AcknowledgeFlow {
8
8
  /**
9
+ * @public
9
10
  * <p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>TRUE</code>, you
10
11
  * receive a notification when the alarm state changes. You must choose to acknowledge the
11
12
  * notification before the alarm state can return to <code>NORMAL</code>. If <code>FALSE</code>,
@@ -20,6 +21,7 @@ export interface AcknowledgeFlow {
20
21
  */
21
22
  export interface ClearTimerAction {
22
23
  /**
24
+ * @public
23
25
  * <p>The name of the timer to clear.</p>
24
26
  */
25
27
  timerName: string | undefined;
@@ -46,6 +48,7 @@ export type PayloadType = (typeof PayloadType)[keyof typeof PayloadType];
46
48
  */
47
49
  export interface Payload {
48
50
  /**
51
+ * @public
49
52
  * <p>The content of the payload. You can use a string expression that includes quoted strings
50
53
  * (<code>'<string>'</code>), variables (<code>$variable.<variable-name></code>),
51
54
  * input values (<code>$input.<input-name>.<path-to-datum></code>), string
@@ -54,6 +57,7 @@ export interface Payload {
54
57
  */
55
58
  contentExpression: string | undefined;
56
59
  /**
60
+ * @public
57
61
  * <p>The value of the payload type can be either <code>STRING</code> or
58
62
  * <code>JSON</code>.</p>
59
63
  */
@@ -111,6 +115,7 @@ export interface Payload {
111
115
  */
112
116
  export interface DynamoDBAction {
113
117
  /**
118
+ * @public
114
119
  * <p>The data type for the hash key (also called the partition key). You can specify the
115
120
  * following values:</p>
116
121
  * <ul>
@@ -128,15 +133,18 @@ export interface DynamoDBAction {
128
133
  */
129
134
  hashKeyType?: string;
130
135
  /**
136
+ * @public
131
137
  * <p>The name of the hash key (also called the partition key). The <code>hashKeyField</code>
132
138
  * value must match the partition key of the target DynamoDB table.</p>
133
139
  */
134
140
  hashKeyField: string | undefined;
135
141
  /**
142
+ * @public
136
143
  * <p>The value of the hash key (also called the partition key).</p>
137
144
  */
138
145
  hashKeyValue: string | undefined;
139
146
  /**
147
+ * @public
140
148
  * <p>The data type for the range key (also called the sort key), You can specify the following
141
149
  * values:</p>
142
150
  * <ul>
@@ -154,15 +162,18 @@ export interface DynamoDBAction {
154
162
  */
155
163
  rangeKeyType?: string;
156
164
  /**
165
+ * @public
157
166
  * <p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value
158
167
  * must match the sort key of the target DynamoDB table. </p>
159
168
  */
160
169
  rangeKeyField?: string;
161
170
  /**
171
+ * @public
162
172
  * <p>The value of the range key (also called the sort key).</p>
163
173
  */
164
174
  rangeKeyValue?: string;
165
175
  /**
176
+ * @public
166
177
  * <p>The type of operation to perform. You can specify the following values: </p>
167
178
  * <ul>
168
179
  * <li>
@@ -189,17 +200,20 @@ export interface DynamoDBAction {
189
200
  */
190
201
  operation?: string;
191
202
  /**
203
+ * @public
192
204
  * <p>The name of the DynamoDB column that receives the action payload.</p>
193
205
  * <p>If you don't specify this parameter, the name of the DynamoDB column is
194
206
  * <code>payload</code>.</p>
195
207
  */
196
208
  payloadField?: string;
197
209
  /**
210
+ * @public
198
211
  * <p>The name of the DynamoDB table. The <code>tableName</code> value must match the table name of
199
212
  * the target DynamoDB table. </p>
200
213
  */
201
214
  tableName: string | undefined;
202
215
  /**
216
+ * @public
203
217
  * <p>Information needed to configure the payload.</p>
204
218
  * <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
205
219
  * contains all attribute-value pairs that have the information about the detector model instance
@@ -260,10 +274,12 @@ export interface DynamoDBAction {
260
274
  */
261
275
  export interface DynamoDBv2Action {
262
276
  /**
277
+ * @public
263
278
  * <p>The name of the DynamoDB table.</p>
264
279
  */
265
280
  tableName: string | undefined;
266
281
  /**
282
+ * @public
267
283
  * <p>Information needed to configure the payload.</p>
268
284
  * <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
269
285
  * contains all attribute-value pairs that have the information about the detector model instance
@@ -279,16 +295,19 @@ export interface DynamoDBv2Action {
279
295
  */
280
296
  export interface FirehoseAction {
281
297
  /**
298
+ * @public
282
299
  * <p>The name of the Kinesis Data Firehose delivery stream where the data is written.</p>
283
300
  */
284
301
  deliveryStreamName: string | undefined;
285
302
  /**
303
+ * @public
286
304
  * <p>A character separator that is used to separate records written to the Kinesis Data
287
305
  * Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows
288
306
  * newline), ',' (comma).</p>
289
307
  */
290
308
  separator?: string;
291
309
  /**
310
+ * @public
292
311
  * <p>You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery
293
312
  * stream.</p>
294
313
  */
@@ -301,10 +320,12 @@ export interface FirehoseAction {
301
320
  */
302
321
  export interface IotEventsAction {
303
322
  /**
323
+ * @public
304
324
  * <p>The name of the AWS IoT Events input where the data is sent.</p>
305
325
  */
306
326
  inputName: string | undefined;
307
327
  /**
328
+ * @public
308
329
  * <p>You can configure the action payload when you send a message to an AWS IoT Events input.</p>
309
330
  */
310
331
  payload?: Payload;
@@ -345,11 +366,13 @@ export interface IotEventsAction {
345
366
  */
346
367
  export interface AssetPropertyTimestamp {
347
368
  /**
369
+ * @public
348
370
  * <p>The timestamp, in seconds, in the Unix epoch format. The valid range is between
349
371
  * 1-31556889864403199.</p>
350
372
  */
351
373
  timeInSeconds: string | undefined;
352
374
  /**
375
+ * @public
353
376
  * <p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is
354
377
  * between 0-999999999.</p>
355
378
  */
@@ -395,21 +418,25 @@ export interface AssetPropertyTimestamp {
395
418
  */
396
419
  export interface AssetPropertyVariant {
397
420
  /**
421
+ * @public
398
422
  * <p>The asset property value is a string. You must use an expression, and the evaluated result
399
423
  * should be a string.</p>
400
424
  */
401
425
  stringValue?: string;
402
426
  /**
427
+ * @public
403
428
  * <p>The asset property value is an integer. You must use an expression, and the evaluated
404
429
  * result should be an integer.</p>
405
430
  */
406
431
  integerValue?: string;
407
432
  /**
433
+ * @public
408
434
  * <p>The asset property value is a double. You must use an expression, and the evaluated result
409
435
  * should be a double.</p>
410
436
  */
411
437
  doubleValue?: string;
412
438
  /**
439
+ * @public
413
440
  * <p>The asset property value is a Boolean value that must be <code>'TRUE'</code> or
414
441
  * <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a
415
442
  * Boolean value.</p>
@@ -442,15 +469,18 @@ export interface AssetPropertyVariant {
442
469
  */
443
470
  export interface AssetPropertyValue {
444
471
  /**
472
+ * @public
445
473
  * <p>The value to send to an asset property.</p>
446
474
  */
447
475
  value?: AssetPropertyVariant;
448
476
  /**
477
+ * @public
449
478
  * <p>The timestamp associated with the asset property value. The default is the current event
450
479
  * time.</p>
451
480
  */
452
481
  timestamp?: AssetPropertyTimestamp;
453
482
  /**
483
+ * @public
454
484
  * <p>The quality of the asset property value. The value must be <code>'GOOD'</code>,
455
485
  * <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.</p>
456
486
  */
@@ -497,23 +527,28 @@ export interface AssetPropertyValue {
497
527
  */
498
528
  export interface IotSiteWiseAction {
499
529
  /**
530
+ * @public
500
531
  * <p>A unique identifier for this entry. You can use the entry ID to track which data entry
501
532
  * causes an error in case of failure. The default is a new unique identifier.</p>
502
533
  */
503
534
  entryId?: string;
504
535
  /**
536
+ * @public
505
537
  * <p>The ID of the asset that has the specified property.</p>
506
538
  */
507
539
  assetId?: string;
508
540
  /**
541
+ * @public
509
542
  * <p>The ID of the asset property.</p>
510
543
  */
511
544
  propertyId?: string;
512
545
  /**
546
+ * @public
513
547
  * <p>The alias of the asset property.</p>
514
548
  */
515
549
  propertyAlias?: string;
516
550
  /**
551
+ * @public
517
552
  * <p>The value to send to the asset property. This value contains timestamp, quality, and value
518
553
  * (TQV) information. </p>
519
554
  */
@@ -525,12 +560,14 @@ export interface IotSiteWiseAction {
525
560
  */
526
561
  export interface IotTopicPublishAction {
527
562
  /**
563
+ * @public
528
564
  * <p>The MQTT topic of the message. You can use a string expression that includes variables
529
565
  * (<code>$variable.<variable-name></code>) and input values
530
566
  * (<code>$input.<input-name>.<path-to-datum></code>) as the topic string.</p>
531
567
  */
532
568
  mqttTopic: string | undefined;
533
569
  /**
570
+ * @public
534
571
  * <p>You can configure the action payload when you publish a message to an AWS IoT Core
535
572
  * topic.</p>
536
573
  */
@@ -543,10 +580,12 @@ export interface IotTopicPublishAction {
543
580
  */
544
581
  export interface LambdaAction {
545
582
  /**
583
+ * @public
546
584
  * <p>The ARN of the Lambda function that is executed.</p>
547
585
  */
548
586
  functionArn: string | undefined;
549
587
  /**
588
+ * @public
550
589
  * <p>You can configure the action payload when you send a message to a Lambda function.</p>
551
590
  */
552
591
  payload?: Payload;
@@ -559,6 +598,7 @@ export interface LambdaAction {
559
598
  */
560
599
  export interface ResetTimerAction {
561
600
  /**
601
+ * @public
562
602
  * <p>The name of the timer to reset.</p>
563
603
  */
564
604
  timerName: string | undefined;
@@ -569,10 +609,12 @@ export interface ResetTimerAction {
569
609
  */
570
610
  export interface SetTimerAction {
571
611
  /**
612
+ * @public
572
613
  * <p>The name of the timer.</p>
573
614
  */
574
615
  timerName: string | undefined;
575
616
  /**
617
+ * @public
576
618
  * @deprecated
577
619
  *
578
620
  * <p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure
@@ -580,6 +622,7 @@ export interface SetTimerAction {
580
622
  */
581
623
  seconds?: number;
582
624
  /**
625
+ * @public
583
626
  * <p>The duration of the timer, in seconds. You can use a string expression that includes
584
627
  * numbers, variables (<code>$variable.<variable-name></code>), and input values
585
628
  * (<code>$input.<input-name>.<path-to-datum></code>) as the duration. The range of
@@ -594,10 +637,12 @@ export interface SetTimerAction {
594
637
  */
595
638
  export interface SetVariableAction {
596
639
  /**
640
+ * @public
597
641
  * <p>The name of the variable.</p>
598
642
  */
599
643
  variableName: string | undefined;
600
644
  /**
645
+ * @public
601
646
  * <p>The new value of the variable.</p>
602
647
  */
603
648
  value: string | undefined;
@@ -608,10 +653,12 @@ export interface SetVariableAction {
608
653
  */
609
654
  export interface SNSTopicPublishAction {
610
655
  /**
656
+ * @public
611
657
  * <p>The ARN of the Amazon SNS target where the message is sent.</p>
612
658
  */
613
659
  targetArn: string | undefined;
614
660
  /**
661
+ * @public
615
662
  * <p>You can configure the action payload when you send a message as an Amazon SNS push
616
663
  * notification.</p>
617
664
  */
@@ -624,15 +671,18 @@ export interface SNSTopicPublishAction {
624
671
  */
625
672
  export interface SqsAction {
626
673
  /**
674
+ * @public
627
675
  * <p>The URL of the SQS queue where the data is written.</p>
628
676
  */
629
677
  queueUrl: string | undefined;
630
678
  /**
679
+ * @public
631
680
  * <p>Set this to TRUE if you want the data to be base-64 encoded before it is written to the
632
681
  * queue. Otherwise, set this to FALSE.</p>
633
682
  */
634
683
  useBase64?: boolean;
635
684
  /**
685
+ * @public
636
686
  * <p>You can configure the action payload when you send a message to an Amazon SQS
637
687
  * queue.</p>
638
688
  */
@@ -644,50 +694,61 @@ export interface SqsAction {
644
694
  */
645
695
  export interface Action {
646
696
  /**
697
+ * @public
647
698
  * <p>Sets a variable to a specified value.</p>
648
699
  */
649
700
  setVariable?: SetVariableAction;
650
701
  /**
702
+ * @public
651
703
  * <p>Sends an Amazon SNS message.</p>
652
704
  */
653
705
  sns?: SNSTopicPublishAction;
654
706
  /**
707
+ * @public
655
708
  * <p>Publishes an MQTT message with the given topic to the AWS IoT message broker.</p>
656
709
  */
657
710
  iotTopicPublish?: IotTopicPublishAction;
658
711
  /**
712
+ * @public
659
713
  * <p>Information needed to set the timer.</p>
660
714
  */
661
715
  setTimer?: SetTimerAction;
662
716
  /**
717
+ * @public
663
718
  * <p>Information needed to clear the timer.</p>
664
719
  */
665
720
  clearTimer?: ClearTimerAction;
666
721
  /**
722
+ * @public
667
723
  * <p>Information needed to reset the timer.</p>
668
724
  */
669
725
  resetTimer?: ResetTimerAction;
670
726
  /**
727
+ * @public
671
728
  * <p>Calls a Lambda function, passing in information about the detector model instance and the
672
729
  * event that triggered the action.</p>
673
730
  */
674
731
  lambda?: LambdaAction;
675
732
  /**
733
+ * @public
676
734
  * <p>Sends AWS IoT Events input, which passes information about the detector model instance and the
677
735
  * event that triggered the action.</p>
678
736
  */
679
737
  iotEvents?: IotEventsAction;
680
738
  /**
739
+ * @public
681
740
  * <p>Sends information about the detector model instance and the event that triggered the
682
741
  * action to an Amazon SQS queue.</p>
683
742
  */
684
743
  sqs?: SqsAction;
685
744
  /**
745
+ * @public
686
746
  * <p>Sends information about the detector model instance and the event that triggered the
687
747
  * action to an Amazon Kinesis Data Firehose delivery stream.</p>
688
748
  */
689
749
  firehose?: FirehoseAction;
690
750
  /**
751
+ * @public
691
752
  * <p>Writes to the DynamoDB table that you created. The default action payload contains all
692
753
  * attribute-value pairs that have the information about the detector model instance and the
693
754
  * event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
@@ -697,6 +758,7 @@ export interface Action {
697
758
  */
698
759
  dynamoDB?: DynamoDBAction;
699
760
  /**
761
+ * @public
700
762
  * <p>Writes to the DynamoDB table that you created. The default action payload contains all
701
763
  * attribute-value pairs that have the information about the detector model instance and the
702
764
  * event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
@@ -706,6 +768,7 @@ export interface Action {
706
768
  */
707
769
  dynamoDBv2?: DynamoDBv2Action;
708
770
  /**
771
+ * @public
709
772
  * <p>Sends information about the detector model instance and the event that triggered the
710
773
  * action to an asset property in AWS IoT SiteWise .</p>
711
774
  */
@@ -718,34 +781,41 @@ export interface Action {
718
781
  */
719
782
  export interface AlarmAction {
720
783
  /**
784
+ * @public
721
785
  * <p>Information required to publish the Amazon SNS message.</p>
722
786
  */
723
787
  sns?: SNSTopicPublishAction;
724
788
  /**
789
+ * @public
725
790
  * <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
726
791
  */
727
792
  iotTopicPublish?: IotTopicPublishAction;
728
793
  /**
794
+ * @public
729
795
  * <p>Calls a Lambda function, passing in information about the detector model instance and the
730
796
  * event that triggered the action.</p>
731
797
  */
732
798
  lambda?: LambdaAction;
733
799
  /**
800
+ * @public
734
801
  * <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
735
802
  * event that triggered the action.</p>
736
803
  */
737
804
  iotEvents?: IotEventsAction;
738
805
  /**
806
+ * @public
739
807
  * <p>Sends information about the detector model instance and the event that triggered the
740
808
  * action to an Amazon SQS queue.</p>
741
809
  */
742
810
  sqs?: SqsAction;
743
811
  /**
812
+ * @public
744
813
  * <p>Sends information about the detector model instance and the event that triggered the
745
814
  * action to an Amazon Kinesis Data Firehose delivery stream.</p>
746
815
  */
747
816
  firehose?: FirehoseAction;
748
817
  /**
818
+ * @public
749
819
  * <p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action
750
820
  * payload contains all the information about the detector model instance and the event that
751
821
  * triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
@@ -796,6 +866,7 @@ export interface AlarmAction {
796
866
  */
797
867
  dynamoDB?: DynamoDBAction;
798
868
  /**
869
+ * @public
799
870
  * <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
800
871
  * payload contains all the information about the detector model instance and the event that
801
872
  * triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
@@ -846,6 +917,7 @@ export interface AlarmAction {
846
917
  */
847
918
  dynamoDBv2?: DynamoDBv2Action;
848
919
  /**
920
+ * @public
849
921
  * <p>Sends information about the detector model instance and the event that triggered the
850
922
  * action to a specified asset property in AWS IoT SiteWise.</p>
851
923
  * <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The
@@ -892,6 +964,7 @@ export interface AlarmAction {
892
964
  */
893
965
  export interface InitializationConfiguration {
894
966
  /**
967
+ * @public
895
968
  * <p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>FALSE</code>, all
896
969
  * alarm instances created based on the alarm model are activated. The default value is
897
970
  * <code>TRUE</code>.</p>
@@ -904,11 +977,13 @@ export interface InitializationConfiguration {
904
977
  */
905
978
  export interface AlarmCapabilities {
906
979
  /**
980
+ * @public
907
981
  * <p>Specifies the default alarm state.
908
982
  * The configuration applies to all alarms that were created based on this alarm model.</p>
909
983
  */
910
984
  initializationConfiguration?: InitializationConfiguration;
911
985
  /**
986
+ * @public
912
987
  * <p>Specifies whether to get notified for alarm state changes.</p>
913
988
  */
914
989
  acknowledgeFlow?: AcknowledgeFlow;
@@ -919,6 +994,7 @@ export interface AlarmCapabilities {
919
994
  */
920
995
  export interface AlarmEventActions {
921
996
  /**
997
+ * @public
922
998
  * <p>Specifies one or more supported actions to receive notifications when the alarm state
923
999
  * changes.</p>
924
1000
  */
@@ -930,14 +1006,17 @@ export interface AlarmEventActions {
930
1006
  */
931
1007
  export interface AlarmModelSummary {
932
1008
  /**
1009
+ * @public
933
1010
  * <p>The time the alarm model was created, in the Unix epoch format.</p>
934
1011
  */
935
1012
  creationTime?: Date;
936
1013
  /**
1014
+ * @public
937
1015
  * <p>The description of the alarm model.</p>
938
1016
  */
939
1017
  alarmModelDescription?: string;
940
1018
  /**
1019
+ * @public
941
1020
  * <p>The name of the alarm model.</p>
942
1021
  */
943
1022
  alarmModelName?: string;
@@ -962,30 +1041,37 @@ export type AlarmModelVersionStatus = (typeof AlarmModelVersionStatus)[keyof typ
962
1041
  */
963
1042
  export interface AlarmModelVersionSummary {
964
1043
  /**
1044
+ * @public
965
1045
  * <p>The name of the alarm model.</p>
966
1046
  */
967
1047
  alarmModelName?: string;
968
1048
  /**
1049
+ * @public
969
1050
  * <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
970
1051
  */
971
1052
  alarmModelArn?: string;
972
1053
  /**
1054
+ * @public
973
1055
  * <p>The version of the alarm model.</p>
974
1056
  */
975
1057
  alarmModelVersion?: string;
976
1058
  /**
1059
+ * @public
977
1060
  * <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
978
1061
  */
979
1062
  roleArn?: string;
980
1063
  /**
1064
+ * @public
981
1065
  * <p>The time the alarm model was created, in the Unix epoch format.</p>
982
1066
  */
983
1067
  creationTime?: Date;
984
1068
  /**
1069
+ * @public
985
1070
  * <p>The time the alarm model was last updated, in the Unix epoch format.</p>
986
1071
  */
987
1072
  lastUpdateTime?: Date;
988
1073
  /**
1074
+ * @public
989
1075
  * <p>The status of the alarm model. The status can be one of the following values:</p>
990
1076
  * <ul>
991
1077
  * <li>
@@ -1011,6 +1097,7 @@ export interface AlarmModelVersionSummary {
1011
1097
  */
1012
1098
  status?: AlarmModelVersionStatus | string;
1013
1099
  /**
1100
+ * @public
1014
1101
  * <p>
1015
1102
  * Contains information about the status of the alarm model version.
1016
1103
  * </p>
@@ -1024,6 +1111,7 @@ export interface AlarmModelVersionSummary {
1024
1111
  */
1025
1112
  export interface NotificationTargetActions {
1026
1113
  /**
1114
+ * @public
1027
1115
  * <p>Calls a Lambda function, passing in information about the detector model instance and the
1028
1116
  * event that triggered the action.</p>
1029
1117
  */
@@ -1035,10 +1123,12 @@ export interface NotificationTargetActions {
1035
1123
  */
1036
1124
  export interface EmailContent {
1037
1125
  /**
1126
+ * @public
1038
1127
  * <p>The subject of the email.</p>
1039
1128
  */
1040
1129
  subject?: string;
1041
1130
  /**
1131
+ * @public
1042
1132
  * <p>The message that you want to send. The message can be up to 200 characters.</p>
1043
1133
  */
1044
1134
  additionalMessage?: string;
@@ -1051,10 +1141,12 @@ export interface EmailContent {
1051
1141
  */
1052
1142
  export interface SSOIdentity {
1053
1143
  /**
1144
+ * @public
1054
1145
  * <p>The ID of the AWS SSO identity store.</p>
1055
1146
  */
1056
1147
  identityStoreId: string | undefined;
1057
1148
  /**
1149
+ * @public
1058
1150
  * <p>The user ID.</p>
1059
1151
  */
1060
1152
  userId?: string;
@@ -1065,6 +1157,7 @@ export interface SSOIdentity {
1065
1157
  */
1066
1158
  export interface RecipientDetail {
1067
1159
  /**
1160
+ * @public
1068
1161
  * <p>The AWS Single Sign-On (AWS SSO) authentication information.</p>
1069
1162
  */
1070
1163
  ssoIdentity?: SSOIdentity;
@@ -1078,6 +1171,7 @@ export interface RecipientDetail {
1078
1171
  */
1079
1172
  export interface EmailRecipients {
1080
1173
  /**
1174
+ * @public
1081
1175
  * <p>Specifies one or more recipients who receive the email.</p>
1082
1176
  */
1083
1177
  to?: RecipientDetail[];
@@ -1088,6 +1182,7 @@ export interface EmailRecipients {
1088
1182
  */
1089
1183
  export interface EmailConfiguration {
1090
1184
  /**
1185
+ * @public
1091
1186
  * <p>The email address that sends emails.</p>
1092
1187
  * <important>
1093
1188
  * <p>If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">verify
@@ -1096,10 +1191,12 @@ export interface EmailConfiguration {
1096
1191
  */
1097
1192
  from: string | undefined;
1098
1193
  /**
1194
+ * @public
1099
1195
  * <p>Contains the subject and message of an email.</p>
1100
1196
  */
1101
1197
  content?: EmailContent;
1102
1198
  /**
1199
+ * @public
1103
1200
  * <p>Contains the information of one or more recipients who receive the emails.</p>
1104
1201
  * <important>
1105
1202
  * <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive emails to your AWS SSO store</a>.</p>
@@ -1113,14 +1210,17 @@ export interface EmailConfiguration {
1113
1210
  */
1114
1211
  export interface SMSConfiguration {
1115
1212
  /**
1213
+ * @public
1116
1214
  * <p>The sender ID.</p>
1117
1215
  */
1118
1216
  senderId?: string;
1119
1217
  /**
1218
+ * @public
1120
1219
  * <p>The message that you want to send. The message can be up to 200 characters.</p>
1121
1220
  */
1122
1221
  additionalMessage?: string;
1123
1222
  /**
1223
+ * @public
1124
1224
  * <p>Specifies one or more recipients who receive the message.</p>
1125
1225
  * <important>
1126
1226
  * <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive SMS messages to your AWS SSO store</a>.</p>
@@ -1135,15 +1235,18 @@ export interface SMSConfiguration {
1135
1235
  */
1136
1236
  export interface NotificationAction {
1137
1237
  /**
1238
+ * @public
1138
1239
  * <p>Specifies an AWS Lambda function to manage alarm notifications.
1139
1240
  * You can create one or use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS Lambda function provided by AWS IoT Events</a>.</p>
1140
1241
  */
1141
1242
  action: NotificationTargetActions | undefined;
1142
1243
  /**
1244
+ * @public
1143
1245
  * <p>Contains the configuration information of SMS notifications.</p>
1144
1246
  */
1145
1247
  smsConfigurations?: SMSConfiguration[];
1146
1248
  /**
1249
+ * @public
1147
1250
  * <p>Contains the configuration information of email notifications.</p>
1148
1251
  */
1149
1252
  emailConfigurations?: EmailConfiguration[];
@@ -1154,6 +1257,7 @@ export interface NotificationAction {
1154
1257
  */
1155
1258
  export interface AlarmNotification {
1156
1259
  /**
1260
+ * @public
1157
1261
  * <p>Contains the notification settings of an alarm model.
1158
1262
  * The settings apply to all alarms that were created based on this alarm model.</p>
1159
1263
  */
@@ -1181,15 +1285,18 @@ export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof Compar
1181
1285
  */
1182
1286
  export interface SimpleRule {
1183
1287
  /**
1288
+ * @public
1184
1289
  * <p>The value on the left side of the comparison operator. You can specify an AWS IoT Events input
1185
1290
  * attribute as an input property.</p>
1186
1291
  */
1187
1292
  inputProperty: string | undefined;
1188
1293
  /**
1294
+ * @public
1189
1295
  * <p>The comparison operator.</p>
1190
1296
  */
1191
1297
  comparisonOperator: ComparisonOperator | string | undefined;
1192
1298
  /**
1299
+ * @public
1193
1300
  * <p>The value on the right side of the comparison operator. You can enter a number or specify
1194
1301
  * an AWS IoT Events input attribute.</p>
1195
1302
  */
@@ -1201,6 +1308,7 @@ export interface SimpleRule {
1201
1308
  */
1202
1309
  export interface AlarmRule {
1203
1310
  /**
1311
+ * @public
1204
1312
  * <p>A rule that compares an input property value to a threshold value with a comparison operator.</p>
1205
1313
  */
1206
1314
  simpleRule?: SimpleRule;
@@ -1225,6 +1333,7 @@ export type AnalysisResultLevel = (typeof AnalysisResultLevel)[keyof typeof Anal
1225
1333
  */
1226
1334
  export interface AnalysisResultLocation {
1227
1335
  /**
1336
+ * @public
1228
1337
  * <p>A <a href="https://github.com/json-path/JsonPath">JsonPath</a> expression that
1229
1338
  * identifies the error field in your detector model.</p>
1230
1339
  */
@@ -1236,6 +1345,7 @@ export interface AnalysisResultLocation {
1236
1345
  */
1237
1346
  export interface AnalysisResult {
1238
1347
  /**
1348
+ * @public
1239
1349
  * <p>The type of the analysis result. Analyses fall into the following types based on the
1240
1350
  * validators used to generate the analysis result:</p>
1241
1351
  * <ul>
@@ -1281,6 +1391,7 @@ export interface AnalysisResult {
1281
1391
  */
1282
1392
  type?: string;
1283
1393
  /**
1394
+ * @public
1284
1395
  * <p>The severity level of the analysis result. Based on the severity level, analysis results
1285
1396
  * fall into three general categories:</p>
1286
1397
  * <ul>
@@ -1305,10 +1416,12 @@ export interface AnalysisResult {
1305
1416
  */
1306
1417
  level?: AnalysisResultLevel | string;
1307
1418
  /**
1419
+ * @public
1308
1420
  * <p>Contains additional information about the analysis result.</p>
1309
1421
  */
1310
1422
  message?: string;
1311
1423
  /**
1424
+ * @public
1312
1425
  * <p>Contains one or more locations that you can use to locate the fields in your detector
1313
1426
  * model that the analysis result references.</p>
1314
1427
  */
@@ -1336,6 +1449,7 @@ export type AnalysisStatus = (typeof AnalysisStatus)[keyof typeof AnalysisStatus
1336
1449
  */
1337
1450
  export interface Attribute {
1338
1451
  /**
1452
+ * @public
1339
1453
  * <p>An expression that specifies an attribute-value pair in a JSON structure. Use this to
1340
1454
  * specify an attribute from the JSON payload that is made available by the input. Inputs are
1341
1455
  * derived from messages sent to AWS IoT Events (<code>BatchPutMessage</code>). Each such message contains
@@ -1352,10 +1466,12 @@ export interface Attribute {
1352
1466
  */
1353
1467
  export interface Tag {
1354
1468
  /**
1469
+ * @public
1355
1470
  * <p>The tag's key.</p>
1356
1471
  */
1357
1472
  key: string | undefined;
1358
1473
  /**
1474
+ * @public
1359
1475
  * <p>The tag's value.</p>
1360
1476
  */
1361
1477
  value: string | undefined;
@@ -1365,19 +1481,23 @@ export interface Tag {
1365
1481
  */
1366
1482
  export interface CreateAlarmModelRequest {
1367
1483
  /**
1484
+ * @public
1368
1485
  * <p>A unique name that helps you identify the alarm model. You can't change this name after
1369
1486
  * you create the alarm model.</p>
1370
1487
  */
1371
1488
  alarmModelName: string | undefined;
1372
1489
  /**
1490
+ * @public
1373
1491
  * <p>A description that tells you what the alarm model detects.</p>
1374
1492
  */
1375
1493
  alarmModelDescription?: string;
1376
1494
  /**
1495
+ * @public
1377
1496
  * <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
1378
1497
  */
1379
1498
  roleArn: string | undefined;
1380
1499
  /**
1500
+ * @public
1381
1501
  * <p>A list of key-value pairs that contain metadata for the alarm model. The tags help you
1382
1502
  * manage the alarm model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html">Tagging your AWS IoT Events
1383
1503
  * resources</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
@@ -1385,28 +1505,34 @@ export interface CreateAlarmModelRequest {
1385
1505
  */
1386
1506
  tags?: Tag[];
1387
1507
  /**
1508
+ * @public
1388
1509
  * <p>An input attribute used as a key to create an alarm.
1389
1510
  * AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
1390
1511
  * associated with this key to the alarm.</p>
1391
1512
  */
1392
1513
  key?: string;
1393
1514
  /**
1515
+ * @public
1394
1516
  * <p>A non-negative integer that reflects the severity level of the alarm.</p>
1395
1517
  */
1396
1518
  severity?: number;
1397
1519
  /**
1520
+ * @public
1398
1521
  * <p>Defines when your alarm is invoked.</p>
1399
1522
  */
1400
1523
  alarmRule: AlarmRule | undefined;
1401
1524
  /**
1525
+ * @public
1402
1526
  * <p>Contains information about one or more notification actions.</p>
1403
1527
  */
1404
1528
  alarmNotification?: AlarmNotification;
1405
1529
  /**
1530
+ * @public
1406
1531
  * <p>Contains information about one or more alarm actions.</p>
1407
1532
  */
1408
1533
  alarmEventActions?: AlarmEventActions;
1409
1534
  /**
1535
+ * @public
1410
1536
  * <p>Contains the configuration information of alarm state changes.</p>
1411
1537
  */
1412
1538
  alarmCapabilities?: AlarmCapabilities;
@@ -1416,22 +1542,27 @@ export interface CreateAlarmModelRequest {
1416
1542
  */
1417
1543
  export interface CreateAlarmModelResponse {
1418
1544
  /**
1545
+ * @public
1419
1546
  * <p>The time the alarm model was created, in the Unix epoch format.</p>
1420
1547
  */
1421
1548
  creationTime?: Date;
1422
1549
  /**
1550
+ * @public
1423
1551
  * <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
1424
1552
  */
1425
1553
  alarmModelArn?: string;
1426
1554
  /**
1555
+ * @public
1427
1556
  * <p>The version of the alarm model.</p>
1428
1557
  */
1429
1558
  alarmModelVersion?: string;
1430
1559
  /**
1560
+ * @public
1431
1561
  * <p>The time the alarm model was last updated, in the Unix epoch format.</p>
1432
1562
  */
1433
1563
  lastUpdateTime?: Date;
1434
1564
  /**
1565
+ * @public
1435
1566
  * <p>The status of the alarm model. The status can be one of the following values:</p>
1436
1567
  * <ul>
1437
1568
  * <li>
@@ -1501,10 +1632,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1501
1632
  readonly name: "ResourceAlreadyExistsException";
1502
1633
  readonly $fault: "client";
1503
1634
  /**
1635
+ * @public
1504
1636
  * <p>The ID of the resource.</p>
1505
1637
  */
1506
1638
  resourceId?: string;
1507
1639
  /**
1640
+ * @public
1508
1641
  * <p>The ARN of the resource.</p>
1509
1642
  */
1510
1643
  resourceArn?: string;
@@ -1556,16 +1689,19 @@ export declare class ThrottlingException extends __BaseException {
1556
1689
  */
1557
1690
  export interface Event {
1558
1691
  /**
1692
+ * @public
1559
1693
  * <p>The name of the event.</p>
1560
1694
  */
1561
1695
  eventName: string | undefined;
1562
1696
  /**
1697
+ * @public
1563
1698
  * <p>Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be
1564
1699
  * performed. If not present, the actions are performed (=TRUE). If the expression result is not
1565
1700
  * a Boolean value, the actions are not performed (=FALSE).</p>
1566
1701
  */
1567
1702
  condition?: string;
1568
1703
  /**
1704
+ * @public
1569
1705
  * <p>The actions to be performed.</p>
1570
1706
  */
1571
1707
  actions?: Action[];
@@ -1577,6 +1713,7 @@ export interface Event {
1577
1713
  */
1578
1714
  export interface OnEnterLifecycle {
1579
1715
  /**
1716
+ * @public
1580
1717
  * <p>Specifies the actions that are performed when the state is entered and the
1581
1718
  * <code>condition</code> is <code>TRUE</code>.</p>
1582
1719
  */
@@ -1589,6 +1726,7 @@ export interface OnEnterLifecycle {
1589
1726
  */
1590
1727
  export interface OnExitLifecycle {
1591
1728
  /**
1729
+ * @public
1592
1730
  * <p>Specifies the <code>actions</code> that are performed when the state is exited and the
1593
1731
  * <code>condition</code> is <code>TRUE</code>.</p>
1594
1732
  */
@@ -1601,19 +1739,23 @@ export interface OnExitLifecycle {
1601
1739
  */
1602
1740
  export interface TransitionEvent {
1603
1741
  /**
1742
+ * @public
1604
1743
  * <p>The name of the transition event.</p>
1605
1744
  */
1606
1745
  eventName: string | undefined;
1607
1746
  /**
1747
+ * @public
1608
1748
  * <p>Required. A Boolean expression that when TRUE causes the actions to be performed and the
1609
1749
  * <code>nextState</code> to be entered.</p>
1610
1750
  */
1611
1751
  condition: string | undefined;
1612
1752
  /**
1753
+ * @public
1613
1754
  * <p>The actions to be performed.</p>
1614
1755
  */
1615
1756
  actions?: Action[];
1616
1757
  /**
1758
+ * @public
1617
1759
  * <p>The next state to enter.</p>
1618
1760
  */
1619
1761
  nextState: string | undefined;
@@ -1624,10 +1766,12 @@ export interface TransitionEvent {
1624
1766
  */
1625
1767
  export interface OnInputLifecycle {
1626
1768
  /**
1769
+ * @public
1627
1770
  * <p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>
1628
1771
  */
1629
1772
  events?: Event[];
1630
1773
  /**
1774
+ * @public
1631
1775
  * <p>Specifies the actions performed, and the next state entered, when a <code>condition</code>
1632
1776
  * evaluates to TRUE.</p>
1633
1777
  */
@@ -1639,20 +1783,24 @@ export interface OnInputLifecycle {
1639
1783
  */
1640
1784
  export interface State {
1641
1785
  /**
1786
+ * @public
1642
1787
  * <p>The name of the state.</p>
1643
1788
  */
1644
1789
  stateName: string | undefined;
1645
1790
  /**
1791
+ * @public
1646
1792
  * <p>When an input is received and the <code>condition</code> is TRUE, perform the specified
1647
1793
  * <code>actions</code>.</p>
1648
1794
  */
1649
1795
  onInput?: OnInputLifecycle;
1650
1796
  /**
1797
+ * @public
1651
1798
  * <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
1652
1799
  * is TRUE.</p>
1653
1800
  */
1654
1801
  onEnter?: OnEnterLifecycle;
1655
1802
  /**
1803
+ * @public
1656
1804
  * <p>When exiting this state, perform these <code>actions</code> if the specified
1657
1805
  * <code>condition</code> is <code>TRUE</code>.</p>
1658
1806
  */
@@ -1664,10 +1812,12 @@ export interface State {
1664
1812
  */
1665
1813
  export interface DetectorModelDefinition {
1666
1814
  /**
1815
+ * @public
1667
1816
  * <p>Information about the states of the detector.</p>
1668
1817
  */
1669
1818
  states: State[] | undefined;
1670
1819
  /**
1820
+ * @public
1671
1821
  * <p>The state that is entered at the creation of each detector (instance).</p>
1672
1822
  */
1673
1823
  initialStateName: string | undefined;
@@ -1689,18 +1839,22 @@ export type EvaluationMethod = (typeof EvaluationMethod)[keyof typeof Evaluation
1689
1839
  */
1690
1840
  export interface CreateDetectorModelRequest {
1691
1841
  /**
1842
+ * @public
1692
1843
  * <p>The name of the detector model.</p>
1693
1844
  */
1694
1845
  detectorModelName: string | undefined;
1695
1846
  /**
1847
+ * @public
1696
1848
  * <p>Information that defines how the detectors operate.</p>
1697
1849
  */
1698
1850
  detectorModelDefinition: DetectorModelDefinition | undefined;
1699
1851
  /**
1852
+ * @public
1700
1853
  * <p>A brief description of the detector model.</p>
1701
1854
  */
1702
1855
  detectorModelDescription?: string;
1703
1856
  /**
1857
+ * @public
1704
1858
  * <p>The input attribute key used to identify a device or system to create a detector (an
1705
1859
  * instance of the detector model) and then to route each input received to the appropriate
1706
1860
  * detector (instance). This parameter uses a JSON-path expression in the message payload of each
@@ -1709,14 +1863,17 @@ export interface CreateDetectorModelRequest {
1709
1863
  */
1710
1864
  key?: string;
1711
1865
  /**
1866
+ * @public
1712
1867
  * <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
1713
1868
  */
1714
1869
  roleArn: string | undefined;
1715
1870
  /**
1871
+ * @public
1716
1872
  * <p>Metadata that can be used to manage the detector model.</p>
1717
1873
  */
1718
1874
  tags?: Tag[];
1719
1875
  /**
1876
+ * @public
1720
1877
  * <p>Information about the order in which events are evaluated and how actions are executed.
1721
1878
  * </p>
1722
1879
  */
@@ -1745,38 +1902,47 @@ export type DetectorModelVersionStatus = (typeof DetectorModelVersionStatus)[key
1745
1902
  */
1746
1903
  export interface DetectorModelConfiguration {
1747
1904
  /**
1905
+ * @public
1748
1906
  * <p>The name of the detector model.</p>
1749
1907
  */
1750
1908
  detectorModelName?: string;
1751
1909
  /**
1910
+ * @public
1752
1911
  * <p>The version of the detector model.</p>
1753
1912
  */
1754
1913
  detectorModelVersion?: string;
1755
1914
  /**
1915
+ * @public
1756
1916
  * <p>A brief description of the detector model.</p>
1757
1917
  */
1758
1918
  detectorModelDescription?: string;
1759
1919
  /**
1920
+ * @public
1760
1921
  * <p>The ARN of the detector model.</p>
1761
1922
  */
1762
1923
  detectorModelArn?: string;
1763
1924
  /**
1925
+ * @public
1764
1926
  * <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
1765
1927
  */
1766
1928
  roleArn?: string;
1767
1929
  /**
1930
+ * @public
1768
1931
  * <p>The time the detector model was created.</p>
1769
1932
  */
1770
1933
  creationTime?: Date;
1771
1934
  /**
1935
+ * @public
1772
1936
  * <p>The time the detector model was last updated.</p>
1773
1937
  */
1774
1938
  lastUpdateTime?: Date;
1775
1939
  /**
1940
+ * @public
1776
1941
  * <p>The status of the detector model.</p>
1777
1942
  */
1778
1943
  status?: DetectorModelVersionStatus | string;
1779
1944
  /**
1945
+ * @public
1780
1946
  * <p>The value used to identify a detector instance. When a device or system sends input, a new
1781
1947
  * detector instance with a unique key value is created. AWS IoT Events can continue to route input to its
1782
1948
  * corresponding detector instance based on this identifying information. </p>
@@ -1787,6 +1953,7 @@ export interface DetectorModelConfiguration {
1787
1953
  */
1788
1954
  key?: string;
1789
1955
  /**
1956
+ * @public
1790
1957
  * <p>Information about the order in which events are evaluated and how actions are executed.
1791
1958
  * </p>
1792
1959
  */
@@ -1797,6 +1964,7 @@ export interface DetectorModelConfiguration {
1797
1964
  */
1798
1965
  export interface CreateDetectorModelResponse {
1799
1966
  /**
1967
+ * @public
1800
1968
  * <p>Information about how the detector model is configured.</p>
1801
1969
  */
1802
1970
  detectorModelConfiguration?: DetectorModelConfiguration;
@@ -1807,6 +1975,7 @@ export interface CreateDetectorModelResponse {
1807
1975
  */
1808
1976
  export interface InputDefinition {
1809
1977
  /**
1978
+ * @public
1810
1979
  * <p>The attributes from the JSON payload that are made available by the input. Inputs are
1811
1980
  * derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such
1812
1981
  * message contains a JSON payload, and those attributes (and their paired values) specified here
@@ -1820,18 +1989,22 @@ export interface InputDefinition {
1820
1989
  */
1821
1990
  export interface CreateInputRequest {
1822
1991
  /**
1992
+ * @public
1823
1993
  * <p>The name you want to give to the input.</p>
1824
1994
  */
1825
1995
  inputName: string | undefined;
1826
1996
  /**
1997
+ * @public
1827
1998
  * <p>A brief description of the input.</p>
1828
1999
  */
1829
2000
  inputDescription?: string;
1830
2001
  /**
2002
+ * @public
1831
2003
  * <p>The definition of the input.</p>
1832
2004
  */
1833
2005
  inputDefinition: InputDefinition | undefined;
1834
2006
  /**
2007
+ * @public
1835
2008
  * <p>Metadata that can be used to manage the input.</p>
1836
2009
  */
1837
2010
  tags?: Tag[];
@@ -1856,26 +2029,32 @@ export type InputStatus = (typeof InputStatus)[keyof typeof InputStatus];
1856
2029
  */
1857
2030
  export interface InputConfiguration {
1858
2031
  /**
2032
+ * @public
1859
2033
  * <p>The name of the input.</p>
1860
2034
  */
1861
2035
  inputName: string | undefined;
1862
2036
  /**
2037
+ * @public
1863
2038
  * <p>A brief description of the input.</p>
1864
2039
  */
1865
2040
  inputDescription?: string;
1866
2041
  /**
2042
+ * @public
1867
2043
  * <p>The ARN of the input.</p>
1868
2044
  */
1869
2045
  inputArn: string | undefined;
1870
2046
  /**
2047
+ * @public
1871
2048
  * <p>The time the input was created.</p>
1872
2049
  */
1873
2050
  creationTime: Date | undefined;
1874
2051
  /**
2052
+ * @public
1875
2053
  * <p>The last time the input was updated.</p>
1876
2054
  */
1877
2055
  lastUpdateTime: Date | undefined;
1878
2056
  /**
2057
+ * @public
1879
2058
  * <p>The status of the input.</p>
1880
2059
  */
1881
2060
  status: InputStatus | string | undefined;
@@ -1885,6 +2064,7 @@ export interface InputConfiguration {
1885
2064
  */
1886
2065
  export interface CreateInputResponse {
1887
2066
  /**
2067
+ * @public
1888
2068
  * <p>Information about the configuration of the input.</p>
1889
2069
  */
1890
2070
  inputConfiguration?: InputConfiguration;
@@ -1894,6 +2074,7 @@ export interface CreateInputResponse {
1894
2074
  */
1895
2075
  export interface DeleteAlarmModelRequest {
1896
2076
  /**
2077
+ * @public
1897
2078
  * <p>The name of the alarm model.</p>
1898
2079
  */
1899
2080
  alarmModelName: string | undefined;
@@ -1920,6 +2101,7 @@ export declare class ResourceNotFoundException extends __BaseException {
1920
2101
  */
1921
2102
  export interface DeleteDetectorModelRequest {
1922
2103
  /**
2104
+ * @public
1923
2105
  * <p>The name of the detector model to be deleted.</p>
1924
2106
  */
1925
2107
  detectorModelName: string | undefined;
@@ -1934,6 +2116,7 @@ export interface DeleteDetectorModelResponse {
1934
2116
  */
1935
2117
  export interface DeleteInputRequest {
1936
2118
  /**
2119
+ * @public
1937
2120
  * <p>The name of the input to delete.</p>
1938
2121
  */
1939
2122
  inputName: string | undefined;
@@ -1948,10 +2131,12 @@ export interface DeleteInputResponse {
1948
2131
  */
1949
2132
  export interface DescribeAlarmModelRequest {
1950
2133
  /**
2134
+ * @public
1951
2135
  * <p>The name of the alarm model.</p>
1952
2136
  */
1953
2137
  alarmModelName: string | undefined;
1954
2138
  /**
2139
+ * @public
1955
2140
  * <p>The version of the alarm model.</p>
1956
2141
  */
1957
2142
  alarmModelVersion?: string;
@@ -1961,22 +2146,27 @@ export interface DescribeAlarmModelRequest {
1961
2146
  */
1962
2147
  export interface DescribeAlarmModelResponse {
1963
2148
  /**
2149
+ * @public
1964
2150
  * <p>The time the alarm model was created, in the Unix epoch format.</p>
1965
2151
  */
1966
2152
  creationTime?: Date;
1967
2153
  /**
2154
+ * @public
1968
2155
  * <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
1969
2156
  */
1970
2157
  alarmModelArn?: string;
1971
2158
  /**
2159
+ * @public
1972
2160
  * <p>The version of the alarm model.</p>
1973
2161
  */
1974
2162
  alarmModelVersion?: string;
1975
2163
  /**
2164
+ * @public
1976
2165
  * <p>The time the alarm model was last updated, in the Unix epoch format.</p>
1977
2166
  */
1978
2167
  lastUpdateTime?: Date;
1979
2168
  /**
2169
+ * @public
1980
2170
  * <p>The status of the alarm model. The status can be one of the following values:</p>
1981
2171
  * <ul>
1982
2172
  * <li>
@@ -2002,46 +2192,56 @@ export interface DescribeAlarmModelResponse {
2002
2192
  */
2003
2193
  status?: AlarmModelVersionStatus | string;
2004
2194
  /**
2195
+ * @public
2005
2196
  * <p>
2006
2197
  * Contains information about the status of the alarm model.
2007
2198
  * </p>
2008
2199
  */
2009
2200
  statusMessage?: string;
2010
2201
  /**
2202
+ * @public
2011
2203
  * <p>The name of the alarm model.</p>
2012
2204
  */
2013
2205
  alarmModelName?: string;
2014
2206
  /**
2207
+ * @public
2015
2208
  * <p>The description of the alarm model.</p>
2016
2209
  */
2017
2210
  alarmModelDescription?: string;
2018
2211
  /**
2212
+ * @public
2019
2213
  * <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
2020
2214
  */
2021
2215
  roleArn?: string;
2022
2216
  /**
2217
+ * @public
2023
2218
  * <p>An input attribute used as a key to create an alarm.
2024
2219
  * AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
2025
2220
  * associated with this key to the alarm.</p>
2026
2221
  */
2027
2222
  key?: string;
2028
2223
  /**
2224
+ * @public
2029
2225
  * <p>A non-negative integer that reflects the severity level of the alarm.</p>
2030
2226
  */
2031
2227
  severity?: number;
2032
2228
  /**
2229
+ * @public
2033
2230
  * <p>Defines when your alarm is invoked.</p>
2034
2231
  */
2035
2232
  alarmRule?: AlarmRule;
2036
2233
  /**
2234
+ * @public
2037
2235
  * <p>Contains information about one or more notification actions.</p>
2038
2236
  */
2039
2237
  alarmNotification?: AlarmNotification;
2040
2238
  /**
2239
+ * @public
2041
2240
  * <p>Contains information about one or more alarm actions.</p>
2042
2241
  */
2043
2242
  alarmEventActions?: AlarmEventActions;
2044
2243
  /**
2244
+ * @public
2045
2245
  * <p>Contains the configuration information of alarm state changes.</p>
2046
2246
  */
2047
2247
  alarmCapabilities?: AlarmCapabilities;
@@ -2051,10 +2251,12 @@ export interface DescribeAlarmModelResponse {
2051
2251
  */
2052
2252
  export interface DescribeDetectorModelRequest {
2053
2253
  /**
2254
+ * @public
2054
2255
  * <p>The name of the detector model.</p>
2055
2256
  */
2056
2257
  detectorModelName: string | undefined;
2057
2258
  /**
2259
+ * @public
2058
2260
  * <p>The version of the detector model.</p>
2059
2261
  */
2060
2262
  detectorModelVersion?: string;
@@ -2065,10 +2267,12 @@ export interface DescribeDetectorModelRequest {
2065
2267
  */
2066
2268
  export interface DetectorModel {
2067
2269
  /**
2270
+ * @public
2068
2271
  * <p>Information that defines how a detector operates.</p>
2069
2272
  */
2070
2273
  detectorModelDefinition?: DetectorModelDefinition;
2071
2274
  /**
2275
+ * @public
2072
2276
  * <p>Information about how the detector is configured.</p>
2073
2277
  */
2074
2278
  detectorModelConfiguration?: DetectorModelConfiguration;
@@ -2078,6 +2282,7 @@ export interface DetectorModel {
2078
2282
  */
2079
2283
  export interface DescribeDetectorModelResponse {
2080
2284
  /**
2285
+ * @public
2081
2286
  * <p>Information about the detector model.</p>
2082
2287
  */
2083
2288
  detectorModel?: DetectorModel;
@@ -2087,6 +2292,7 @@ export interface DescribeDetectorModelResponse {
2087
2292
  */
2088
2293
  export interface DescribeDetectorModelAnalysisRequest {
2089
2294
  /**
2295
+ * @public
2090
2296
  * <p>The ID of the analysis result that you want to retrieve.</p>
2091
2297
  */
2092
2298
  analysisId: string | undefined;
@@ -2096,6 +2302,7 @@ export interface DescribeDetectorModelAnalysisRequest {
2096
2302
  */
2097
2303
  export interface DescribeDetectorModelAnalysisResponse {
2098
2304
  /**
2305
+ * @public
2099
2306
  * <p>The status of the analysis activity. The status can be one of the following values:</p>
2100
2307
  * <ul>
2101
2308
  * <li>
@@ -2121,6 +2328,7 @@ export interface DescribeDetectorModelAnalysisResponse {
2121
2328
  */
2122
2329
  export interface DescribeInputRequest {
2123
2330
  /**
2331
+ * @public
2124
2332
  * <p>The name of the input.</p>
2125
2333
  */
2126
2334
  inputName: string | undefined;
@@ -2131,10 +2339,12 @@ export interface DescribeInputRequest {
2131
2339
  */
2132
2340
  export interface Input {
2133
2341
  /**
2342
+ * @public
2134
2343
  * <p>Information about the configuration of an input.</p>
2135
2344
  */
2136
2345
  inputConfiguration?: InputConfiguration;
2137
2346
  /**
2347
+ * @public
2138
2348
  * <p>The definition of the input.</p>
2139
2349
  */
2140
2350
  inputDefinition?: InputDefinition;
@@ -2144,6 +2354,7 @@ export interface Input {
2144
2354
  */
2145
2355
  export interface DescribeInputResponse {
2146
2356
  /**
2357
+ * @public
2147
2358
  * <p>Information about the input.</p>
2148
2359
  */
2149
2360
  input?: Input;
@@ -2160,10 +2371,12 @@ export interface DescribeLoggingOptionsRequest {
2160
2371
  */
2161
2372
  export interface DetectorDebugOption {
2162
2373
  /**
2374
+ * @public
2163
2375
  * <p>The name of the detector model.</p>
2164
2376
  */
2165
2377
  detectorModelName: string | undefined;
2166
2378
  /**
2379
+ * @public
2167
2380
  * <p>The value of the input attribute key used to create the detector (the instance of the
2168
2381
  * detector model).</p>
2169
2382
  */
@@ -2188,18 +2401,22 @@ export type LoggingLevel = (typeof LoggingLevel)[keyof typeof LoggingLevel];
2188
2401
  */
2189
2402
  export interface LoggingOptions {
2190
2403
  /**
2404
+ * @public
2191
2405
  * <p>The ARN of the role that grants permission to AWS IoT Events to perform logging.</p>
2192
2406
  */
2193
2407
  roleArn: string | undefined;
2194
2408
  /**
2409
+ * @public
2195
2410
  * <p>The logging level.</p>
2196
2411
  */
2197
2412
  level: LoggingLevel | string | undefined;
2198
2413
  /**
2414
+ * @public
2199
2415
  * <p>If TRUE, logging is enabled for AWS IoT Events.</p>
2200
2416
  */
2201
2417
  enabled: boolean | undefined;
2202
2418
  /**
2419
+ * @public
2203
2420
  * <p>Information that identifies those detector models and their detectors (instances) for
2204
2421
  * which the logging level is given.</p>
2205
2422
  */
@@ -2210,6 +2427,7 @@ export interface LoggingOptions {
2210
2427
  */
2211
2428
  export interface DescribeLoggingOptionsResponse {
2212
2429
  /**
2430
+ * @public
2213
2431
  * <p>The current settings of the AWS IoT Events logging options.</p>
2214
2432
  */
2215
2433
  loggingOptions?: LoggingOptions;
@@ -2232,14 +2450,17 @@ export declare class UnsupportedOperationException extends __BaseException {
2232
2450
  */
2233
2451
  export interface DetectorModelSummary {
2234
2452
  /**
2453
+ * @public
2235
2454
  * <p>The name of the detector model.</p>
2236
2455
  */
2237
2456
  detectorModelName?: string;
2238
2457
  /**
2458
+ * @public
2239
2459
  * <p>A brief description of the detector model.</p>
2240
2460
  */
2241
2461
  detectorModelDescription?: string;
2242
2462
  /**
2463
+ * @public
2243
2464
  * <p>The time the detector model was created.</p>
2244
2465
  */
2245
2466
  creationTime?: Date;
@@ -2250,34 +2471,42 @@ export interface DetectorModelSummary {
2250
2471
  */
2251
2472
  export interface DetectorModelVersionSummary {
2252
2473
  /**
2474
+ * @public
2253
2475
  * <p>The name of the detector model.</p>
2254
2476
  */
2255
2477
  detectorModelName?: string;
2256
2478
  /**
2479
+ * @public
2257
2480
  * <p>The ID of the detector model version.</p>
2258
2481
  */
2259
2482
  detectorModelVersion?: string;
2260
2483
  /**
2484
+ * @public
2261
2485
  * <p>The ARN of the detector model version.</p>
2262
2486
  */
2263
2487
  detectorModelArn?: string;
2264
2488
  /**
2489
+ * @public
2265
2490
  * <p>The ARN of the role that grants the detector model permission to perform its tasks.</p>
2266
2491
  */
2267
2492
  roleArn?: string;
2268
2493
  /**
2494
+ * @public
2269
2495
  * <p>The time the detector model version was created.</p>
2270
2496
  */
2271
2497
  creationTime?: Date;
2272
2498
  /**
2499
+ * @public
2273
2500
  * <p>The last time the detector model version was updated.</p>
2274
2501
  */
2275
2502
  lastUpdateTime?: Date;
2276
2503
  /**
2504
+ * @public
2277
2505
  * <p>The status of the detector model version.</p>
2278
2506
  */
2279
2507
  status?: DetectorModelVersionStatus | string;
2280
2508
  /**
2509
+ * @public
2281
2510
  * <p>Information about the order in which events are evaluated and how actions are executed.
2282
2511
  * </p>
2283
2512
  */
@@ -2288,14 +2517,17 @@ export interface DetectorModelVersionSummary {
2288
2517
  */
2289
2518
  export interface GetDetectorModelAnalysisResultsRequest {
2290
2519
  /**
2520
+ * @public
2291
2521
  * <p>The ID of the analysis result that you want to retrieve.</p>
2292
2522
  */
2293
2523
  analysisId: string | undefined;
2294
2524
  /**
2525
+ * @public
2295
2526
  * <p>The token that you can use to return the next set of results.</p>
2296
2527
  */
2297
2528
  nextToken?: string;
2298
2529
  /**
2530
+ * @public
2299
2531
  * <p>The maximum number of results to be returned per request.</p>
2300
2532
  */
2301
2533
  maxResults?: number;
@@ -2305,10 +2537,12 @@ export interface GetDetectorModelAnalysisResultsRequest {
2305
2537
  */
2306
2538
  export interface GetDetectorModelAnalysisResultsResponse {
2307
2539
  /**
2540
+ * @public
2308
2541
  * <p>Contains information about one or more analysis results.</p>
2309
2542
  */
2310
2543
  analysisResults?: AnalysisResult[];
2311
2544
  /**
2545
+ * @public
2312
2546
  * <p>The token that you can use to return the next set of results,
2313
2547
  * or <code>null</code> if there are no more results.</p>
2314
2548
  */
@@ -2322,6 +2556,7 @@ export interface GetDetectorModelAnalysisResultsResponse {
2322
2556
  */
2323
2557
  export interface IotEventsInputIdentifier {
2324
2558
  /**
2559
+ * @public
2325
2560
  * <p>
2326
2561
  * The name of the input routed to AWS IoT Events.
2327
2562
  * </p>
@@ -2336,12 +2571,14 @@ export interface IotEventsInputIdentifier {
2336
2571
  */
2337
2572
  export interface IotSiteWiseAssetModelPropertyIdentifier {
2338
2573
  /**
2574
+ * @public
2339
2575
  * <p>
2340
2576
  * The ID of the AWS IoT SiteWise asset model.
2341
2577
  * </p>
2342
2578
  */
2343
2579
  assetModelId: string | undefined;
2344
2580
  /**
2581
+ * @public
2345
2582
  * <p>
2346
2583
  * The ID of the AWS IoT SiteWise asset property.
2347
2584
  * </p>
@@ -2356,6 +2593,7 @@ export interface IotSiteWiseAssetModelPropertyIdentifier {
2356
2593
  */
2357
2594
  export interface IotSiteWiseInputIdentifier {
2358
2595
  /**
2596
+ * @public
2359
2597
  * <p>
2360
2598
  * The identifier of the AWS IoT SiteWise asset model property.
2361
2599
  * </p>
@@ -2370,12 +2608,14 @@ export interface IotSiteWiseInputIdentifier {
2370
2608
  */
2371
2609
  export interface InputIdentifier {
2372
2610
  /**
2611
+ * @public
2373
2612
  * <p>
2374
2613
  * The identifier of the input routed to AWS IoT Events.
2375
2614
  * </p>
2376
2615
  */
2377
2616
  iotEventsInputIdentifier?: IotEventsInputIdentifier;
2378
2617
  /**
2618
+ * @public
2379
2619
  * <p>
2380
2620
  * The identifer of the input routed from AWS IoT SiteWise.
2381
2621
  * </p>
@@ -2388,26 +2628,32 @@ export interface InputIdentifier {
2388
2628
  */
2389
2629
  export interface InputSummary {
2390
2630
  /**
2631
+ * @public
2391
2632
  * <p>The name of the input.</p>
2392
2633
  */
2393
2634
  inputName?: string;
2394
2635
  /**
2636
+ * @public
2395
2637
  * <p>A brief description of the input.</p>
2396
2638
  */
2397
2639
  inputDescription?: string;
2398
2640
  /**
2641
+ * @public
2399
2642
  * <p>The ARN of the input.</p>
2400
2643
  */
2401
2644
  inputArn?: string;
2402
2645
  /**
2646
+ * @public
2403
2647
  * <p>The time the input was created.</p>
2404
2648
  */
2405
2649
  creationTime?: Date;
2406
2650
  /**
2651
+ * @public
2407
2652
  * <p>The last time the input was updated.</p>
2408
2653
  */
2409
2654
  lastUpdateTime?: Date;
2410
2655
  /**
2656
+ * @public
2411
2657
  * <p>The status of the input.</p>
2412
2658
  */
2413
2659
  status?: InputStatus | string;
@@ -2417,10 +2663,12 @@ export interface InputSummary {
2417
2663
  */
2418
2664
  export interface ListAlarmModelsRequest {
2419
2665
  /**
2666
+ * @public
2420
2667
  * <p>The token that you can use to return the next set of results.</p>
2421
2668
  */
2422
2669
  nextToken?: string;
2423
2670
  /**
2671
+ * @public
2424
2672
  * <p>The maximum number of results to be returned per request.</p>
2425
2673
  */
2426
2674
  maxResults?: number;
@@ -2430,10 +2678,12 @@ export interface ListAlarmModelsRequest {
2430
2678
  */
2431
2679
  export interface ListAlarmModelsResponse {
2432
2680
  /**
2681
+ * @public
2433
2682
  * <p>A list that summarizes each alarm model.</p>
2434
2683
  */
2435
2684
  alarmModelSummaries?: AlarmModelSummary[];
2436
2685
  /**
2686
+ * @public
2437
2687
  * <p>The token that you can use to return the next set of results,
2438
2688
  * or <code>null</code> if there are no more results.</p>
2439
2689
  */
@@ -2444,14 +2694,17 @@ export interface ListAlarmModelsResponse {
2444
2694
  */
2445
2695
  export interface ListAlarmModelVersionsRequest {
2446
2696
  /**
2697
+ * @public
2447
2698
  * <p>The name of the alarm model.</p>
2448
2699
  */
2449
2700
  alarmModelName: string | undefined;
2450
2701
  /**
2702
+ * @public
2451
2703
  * <p>The token that you can use to return the next set of results.</p>
2452
2704
  */
2453
2705
  nextToken?: string;
2454
2706
  /**
2707
+ * @public
2455
2708
  * <p>The maximum number of results to be returned per request.</p>
2456
2709
  */
2457
2710
  maxResults?: number;
@@ -2461,10 +2714,12 @@ export interface ListAlarmModelVersionsRequest {
2461
2714
  */
2462
2715
  export interface ListAlarmModelVersionsResponse {
2463
2716
  /**
2717
+ * @public
2464
2718
  * <p>A list that summarizes each alarm model version.</p>
2465
2719
  */
2466
2720
  alarmModelVersionSummaries?: AlarmModelVersionSummary[];
2467
2721
  /**
2722
+ * @public
2468
2723
  * <p>The token that you can use to return the next set of results,
2469
2724
  * or <code>null</code> if there are no more results.</p>
2470
2725
  */
@@ -2475,10 +2730,12 @@ export interface ListAlarmModelVersionsResponse {
2475
2730
  */
2476
2731
  export interface ListDetectorModelsRequest {
2477
2732
  /**
2733
+ * @public
2478
2734
  * <p>The token that you can use to return the next set of results.</p>
2479
2735
  */
2480
2736
  nextToken?: string;
2481
2737
  /**
2738
+ * @public
2482
2739
  * <p>The maximum number of results to be returned per request.</p>
2483
2740
  */
2484
2741
  maxResults?: number;
@@ -2488,10 +2745,12 @@ export interface ListDetectorModelsRequest {
2488
2745
  */
2489
2746
  export interface ListDetectorModelsResponse {
2490
2747
  /**
2748
+ * @public
2491
2749
  * <p>Summary information about the detector models.</p>
2492
2750
  */
2493
2751
  detectorModelSummaries?: DetectorModelSummary[];
2494
2752
  /**
2753
+ * @public
2495
2754
  * <p>The token that you can use to return the next set of results,
2496
2755
  * or <code>null</code> if there are no more results.</p>
2497
2756
  */
@@ -2502,14 +2761,17 @@ export interface ListDetectorModelsResponse {
2502
2761
  */
2503
2762
  export interface ListDetectorModelVersionsRequest {
2504
2763
  /**
2764
+ * @public
2505
2765
  * <p>The name of the detector model whose versions are returned.</p>
2506
2766
  */
2507
2767
  detectorModelName: string | undefined;
2508
2768
  /**
2769
+ * @public
2509
2770
  * <p>The token that you can use to return the next set of results.</p>
2510
2771
  */
2511
2772
  nextToken?: string;
2512
2773
  /**
2774
+ * @public
2513
2775
  * <p>The maximum number of results to be returned per request.</p>
2514
2776
  */
2515
2777
  maxResults?: number;
@@ -2519,10 +2781,12 @@ export interface ListDetectorModelVersionsRequest {
2519
2781
  */
2520
2782
  export interface ListDetectorModelVersionsResponse {
2521
2783
  /**
2784
+ * @public
2522
2785
  * <p>Summary information about the detector model versions.</p>
2523
2786
  */
2524
2787
  detectorModelVersionSummaries?: DetectorModelVersionSummary[];
2525
2788
  /**
2789
+ * @public
2526
2790
  * <p>The token that you can use to return the next set of results,
2527
2791
  * or <code>null</code> if there are no more results.</p>
2528
2792
  */
@@ -2533,18 +2797,21 @@ export interface ListDetectorModelVersionsResponse {
2533
2797
  */
2534
2798
  export interface ListInputRoutingsRequest {
2535
2799
  /**
2800
+ * @public
2536
2801
  * <p>
2537
2802
  * The identifer of the routed input.
2538
2803
  * </p>
2539
2804
  */
2540
2805
  inputIdentifier: InputIdentifier | undefined;
2541
2806
  /**
2807
+ * @public
2542
2808
  * <p>
2543
2809
  * The maximum number of results to be returned per request.
2544
2810
  * </p>
2545
2811
  */
2546
2812
  maxResults?: number;
2547
2813
  /**
2814
+ * @public
2548
2815
  * <p>
2549
2816
  * The token that you can use to return the next set of results.
2550
2817
  * </p>
@@ -2559,12 +2826,14 @@ export interface ListInputRoutingsRequest {
2559
2826
  */
2560
2827
  export interface RoutedResource {
2561
2828
  /**
2829
+ * @public
2562
2830
  * <p>
2563
2831
  * The name of the routed resource.
2564
2832
  * </p>
2565
2833
  */
2566
2834
  name?: string;
2567
2835
  /**
2836
+ * @public
2568
2837
  * <p>
2569
2838
  * The ARN of the routed resource. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.
2570
2839
  * </p>
@@ -2576,12 +2845,14 @@ export interface RoutedResource {
2576
2845
  */
2577
2846
  export interface ListInputRoutingsResponse {
2578
2847
  /**
2848
+ * @public
2579
2849
  * <p>
2580
2850
  * Summary information about the routed resources.
2581
2851
  * </p>
2582
2852
  */
2583
2853
  routedResources?: RoutedResource[];
2584
2854
  /**
2855
+ * @public
2585
2856
  * <p>
2586
2857
  * The token that you can use to return the next set of results,
2587
2858
  * or <code>null</code> if there are no more results.
@@ -2594,10 +2865,12 @@ export interface ListInputRoutingsResponse {
2594
2865
  */
2595
2866
  export interface ListInputsRequest {
2596
2867
  /**
2868
+ * @public
2597
2869
  * <p>The token that you can use to return the next set of results.</p>
2598
2870
  */
2599
2871
  nextToken?: string;
2600
2872
  /**
2873
+ * @public
2601
2874
  * <p>The maximum number of results to be returned per request.</p>
2602
2875
  */
2603
2876
  maxResults?: number;
@@ -2607,10 +2880,12 @@ export interface ListInputsRequest {
2607
2880
  */
2608
2881
  export interface ListInputsResponse {
2609
2882
  /**
2883
+ * @public
2610
2884
  * <p>Summary information about the inputs.</p>
2611
2885
  */
2612
2886
  inputSummaries?: InputSummary[];
2613
2887
  /**
2888
+ * @public
2614
2889
  * <p>The token that you can use to return the next set of results,
2615
2890
  * or <code>null</code> if there are no more results.</p>
2616
2891
  */
@@ -2621,6 +2896,7 @@ export interface ListInputsResponse {
2621
2896
  */
2622
2897
  export interface ListTagsForResourceRequest {
2623
2898
  /**
2899
+ * @public
2624
2900
  * <p>The ARN of the resource.</p>
2625
2901
  */
2626
2902
  resourceArn: string | undefined;
@@ -2630,6 +2906,7 @@ export interface ListTagsForResourceRequest {
2630
2906
  */
2631
2907
  export interface ListTagsForResourceResponse {
2632
2908
  /**
2909
+ * @public
2633
2910
  * <p>The list of tags assigned to the resource.</p>
2634
2911
  */
2635
2912
  tags?: Tag[];
@@ -2639,6 +2916,7 @@ export interface ListTagsForResourceResponse {
2639
2916
  */
2640
2917
  export interface PutLoggingOptionsRequest {
2641
2918
  /**
2919
+ * @public
2642
2920
  * <p>The new values of the AWS IoT Events logging options.</p>
2643
2921
  */
2644
2922
  loggingOptions: LoggingOptions | undefined;
@@ -2648,6 +2926,7 @@ export interface PutLoggingOptionsRequest {
2648
2926
  */
2649
2927
  export interface StartDetectorModelAnalysisRequest {
2650
2928
  /**
2929
+ * @public
2651
2930
  * <p>Information that defines how a detector operates.</p>
2652
2931
  */
2653
2932
  detectorModelDefinition: DetectorModelDefinition | undefined;
@@ -2657,6 +2936,7 @@ export interface StartDetectorModelAnalysisRequest {
2657
2936
  */
2658
2937
  export interface StartDetectorModelAnalysisResponse {
2659
2938
  /**
2939
+ * @public
2660
2940
  * <p>The ID that you can use to retrieve the analysis result.</p>
2661
2941
  */
2662
2942
  analysisId?: string;
@@ -2666,10 +2946,12 @@ export interface StartDetectorModelAnalysisResponse {
2666
2946
  */
2667
2947
  export interface TagResourceRequest {
2668
2948
  /**
2949
+ * @public
2669
2950
  * <p>The ARN of the resource.</p>
2670
2951
  */
2671
2952
  resourceArn: string | undefined;
2672
2953
  /**
2954
+ * @public
2673
2955
  * <p>The new or modified tags for the resource.</p>
2674
2956
  */
2675
2957
  tags: Tag[] | undefined;
@@ -2684,10 +2966,12 @@ export interface TagResourceResponse {
2684
2966
  */
2685
2967
  export interface UntagResourceRequest {
2686
2968
  /**
2969
+ * @public
2687
2970
  * <p>The ARN of the resource.</p>
2688
2971
  */
2689
2972
  resourceArn: string | undefined;
2690
2973
  /**
2974
+ * @public
2691
2975
  * <p>A list of the keys of the tags to be removed from the resource.</p>
2692
2976
  */
2693
2977
  tagKeys: string[] | undefined;
@@ -2702,34 +2986,42 @@ export interface UntagResourceResponse {
2702
2986
  */
2703
2987
  export interface UpdateAlarmModelRequest {
2704
2988
  /**
2989
+ * @public
2705
2990
  * <p>The name of the alarm model.</p>
2706
2991
  */
2707
2992
  alarmModelName: string | undefined;
2708
2993
  /**
2994
+ * @public
2709
2995
  * <p>The description of the alarm model.</p>
2710
2996
  */
2711
2997
  alarmModelDescription?: string;
2712
2998
  /**
2999
+ * @public
2713
3000
  * <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
2714
3001
  */
2715
3002
  roleArn: string | undefined;
2716
3003
  /**
3004
+ * @public
2717
3005
  * <p>A non-negative integer that reflects the severity level of the alarm.</p>
2718
3006
  */
2719
3007
  severity?: number;
2720
3008
  /**
3009
+ * @public
2721
3010
  * <p>Defines when your alarm is invoked.</p>
2722
3011
  */
2723
3012
  alarmRule: AlarmRule | undefined;
2724
3013
  /**
3014
+ * @public
2725
3015
  * <p>Contains information about one or more notification actions.</p>
2726
3016
  */
2727
3017
  alarmNotification?: AlarmNotification;
2728
3018
  /**
3019
+ * @public
2729
3020
  * <p>Contains information about one or more alarm actions.</p>
2730
3021
  */
2731
3022
  alarmEventActions?: AlarmEventActions;
2732
3023
  /**
3024
+ * @public
2733
3025
  * <p>Contains the configuration information of alarm state changes.</p>
2734
3026
  */
2735
3027
  alarmCapabilities?: AlarmCapabilities;
@@ -2739,22 +3031,27 @@ export interface UpdateAlarmModelRequest {
2739
3031
  */
2740
3032
  export interface UpdateAlarmModelResponse {
2741
3033
  /**
3034
+ * @public
2742
3035
  * <p>The time the alarm model was created, in the Unix epoch format.</p>
2743
3036
  */
2744
3037
  creationTime?: Date;
2745
3038
  /**
3039
+ * @public
2746
3040
  * <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
2747
3041
  */
2748
3042
  alarmModelArn?: string;
2749
3043
  /**
3044
+ * @public
2750
3045
  * <p>The version of the alarm model.</p>
2751
3046
  */
2752
3047
  alarmModelVersion?: string;
2753
3048
  /**
3049
+ * @public
2754
3050
  * <p>The time the alarm model was last updated, in the Unix epoch format.</p>
2755
3051
  */
2756
3052
  lastUpdateTime?: Date;
2757
3053
  /**
3054
+ * @public
2758
3055
  * <p>The status of the alarm model. The status can be one of the following values:</p>
2759
3056
  * <ul>
2760
3057
  * <li>
@@ -2785,22 +3082,27 @@ export interface UpdateAlarmModelResponse {
2785
3082
  */
2786
3083
  export interface UpdateDetectorModelRequest {
2787
3084
  /**
3085
+ * @public
2788
3086
  * <p>The name of the detector model that is updated.</p>
2789
3087
  */
2790
3088
  detectorModelName: string | undefined;
2791
3089
  /**
3090
+ * @public
2792
3091
  * <p>Information that defines how a detector operates.</p>
2793
3092
  */
2794
3093
  detectorModelDefinition: DetectorModelDefinition | undefined;
2795
3094
  /**
3095
+ * @public
2796
3096
  * <p>A brief description of the detector model.</p>
2797
3097
  */
2798
3098
  detectorModelDescription?: string;
2799
3099
  /**
3100
+ * @public
2800
3101
  * <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
2801
3102
  */
2802
3103
  roleArn: string | undefined;
2803
3104
  /**
3105
+ * @public
2804
3106
  * <p>Information about the order in which events are evaluated and how actions are executed.
2805
3107
  * </p>
2806
3108
  */
@@ -2811,6 +3113,7 @@ export interface UpdateDetectorModelRequest {
2811
3113
  */
2812
3114
  export interface UpdateDetectorModelResponse {
2813
3115
  /**
3116
+ * @public
2814
3117
  * <p>Information about how the detector model is configured.</p>
2815
3118
  */
2816
3119
  detectorModelConfiguration?: DetectorModelConfiguration;
@@ -2820,14 +3123,17 @@ export interface UpdateDetectorModelResponse {
2820
3123
  */
2821
3124
  export interface UpdateInputRequest {
2822
3125
  /**
3126
+ * @public
2823
3127
  * <p>The name of the input you want to update.</p>
2824
3128
  */
2825
3129
  inputName: string | undefined;
2826
3130
  /**
3131
+ * @public
2827
3132
  * <p>A brief description of the input.</p>
2828
3133
  */
2829
3134
  inputDescription?: string;
2830
3135
  /**
3136
+ * @public
2831
3137
  * <p>The definition of the input.</p>
2832
3138
  */
2833
3139
  inputDefinition: InputDefinition | undefined;
@@ -2837,6 +3143,7 @@ export interface UpdateInputRequest {
2837
3143
  */
2838
3144
  export interface UpdateInputResponse {
2839
3145
  /**
3146
+ * @public
2840
3147
  * <p>Information about the configuration of the input.</p>
2841
3148
  */
2842
3149
  inputConfiguration?: InputConfiguration;