@aws-sdk/client-iot-events 3.687.0 → 3.692.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.
- package/dist-types/models/models_0.d.ts +222 -222
- package/dist-types/ts3.4/models/models_0.d.ts +224 -222
- package/package.json +35 -35
|
@@ -131,7 +131,7 @@ export interface DynamoDBAction {
|
|
|
131
131
|
* <code>'STRING'</code>.</p>
|
|
132
132
|
* @public
|
|
133
133
|
*/
|
|
134
|
-
hashKeyType?: string;
|
|
134
|
+
hashKeyType?: string | undefined;
|
|
135
135
|
/**
|
|
136
136
|
* <p>The name of the hash key (also called the partition key). The <code>hashKeyField</code>
|
|
137
137
|
* value must match the partition key of the target DynamoDB table.</p>
|
|
@@ -160,18 +160,18 @@ export interface DynamoDBAction {
|
|
|
160
160
|
* <code>'STRING'</code>.</p>
|
|
161
161
|
* @public
|
|
162
162
|
*/
|
|
163
|
-
rangeKeyType?: string;
|
|
163
|
+
rangeKeyType?: string | undefined;
|
|
164
164
|
/**
|
|
165
165
|
* <p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value
|
|
166
166
|
* must match the sort key of the target DynamoDB table. </p>
|
|
167
167
|
* @public
|
|
168
168
|
*/
|
|
169
|
-
rangeKeyField?: string;
|
|
169
|
+
rangeKeyField?: string | undefined;
|
|
170
170
|
/**
|
|
171
171
|
* <p>The value of the range key (also called the sort key).</p>
|
|
172
172
|
* @public
|
|
173
173
|
*/
|
|
174
|
-
rangeKeyValue?: string;
|
|
174
|
+
rangeKeyValue?: string | undefined;
|
|
175
175
|
/**
|
|
176
176
|
* <p>The type of operation to perform. You can specify the following values: </p>
|
|
177
177
|
* <ul>
|
|
@@ -198,14 +198,14 @@ export interface DynamoDBAction {
|
|
|
198
198
|
* operation.</p>
|
|
199
199
|
* @public
|
|
200
200
|
*/
|
|
201
|
-
operation?: string;
|
|
201
|
+
operation?: string | undefined;
|
|
202
202
|
/**
|
|
203
203
|
* <p>The name of the DynamoDB column that receives the action payload.</p>
|
|
204
204
|
* <p>If you don't specify this parameter, the name of the DynamoDB column is
|
|
205
205
|
* <code>payload</code>.</p>
|
|
206
206
|
* @public
|
|
207
207
|
*/
|
|
208
|
-
payloadField?: string;
|
|
208
|
+
payloadField?: string | undefined;
|
|
209
209
|
/**
|
|
210
210
|
* <p>The name of the DynamoDB table. The <code>tableName</code> value must match the table name of
|
|
211
211
|
* the target DynamoDB table. </p>
|
|
@@ -220,7 +220,7 @@ export interface DynamoDBAction {
|
|
|
220
220
|
* <code>contentExpression</code>.</p>
|
|
221
221
|
* @public
|
|
222
222
|
*/
|
|
223
|
-
payload?: Payload;
|
|
223
|
+
payload?: Payload | undefined;
|
|
224
224
|
}
|
|
225
225
|
/**
|
|
226
226
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
|
|
@@ -286,7 +286,7 @@ export interface DynamoDBv2Action {
|
|
|
286
286
|
* <code>contentExpression</code>.</p>
|
|
287
287
|
* @public
|
|
288
288
|
*/
|
|
289
|
-
payload?: Payload;
|
|
289
|
+
payload?: Payload | undefined;
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
292
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
@@ -305,13 +305,13 @@ export interface FirehoseAction {
|
|
|
305
305
|
* newline), ',' (comma).</p>
|
|
306
306
|
* @public
|
|
307
307
|
*/
|
|
308
|
-
separator?: string;
|
|
308
|
+
separator?: string | undefined;
|
|
309
309
|
/**
|
|
310
310
|
* <p>You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery
|
|
311
311
|
* stream.</p>
|
|
312
312
|
* @public
|
|
313
313
|
*/
|
|
314
|
-
payload?: Payload;
|
|
314
|
+
payload?: Payload | undefined;
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
317
|
* <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
|
|
@@ -328,7 +328,7 @@ export interface IotEventsAction {
|
|
|
328
328
|
* <p>You can configure the action payload when you send a message to an AWS IoT Events input.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
|
-
payload?: Payload;
|
|
331
|
+
payload?: Payload | undefined;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
334
|
* <p>A structure that contains timestamp information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
@@ -376,7 +376,7 @@ export interface AssetPropertyTimestamp {
|
|
|
376
376
|
* between 0-999999999.</p>
|
|
377
377
|
* @public
|
|
378
378
|
*/
|
|
379
|
-
offsetInNanos?: string;
|
|
379
|
+
offsetInNanos?: string | undefined;
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
382
382
|
* <p>A structure that contains an asset property value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html">Variant</a>
|
|
@@ -422,26 +422,26 @@ export interface AssetPropertyVariant {
|
|
|
422
422
|
* should be a string.</p>
|
|
423
423
|
* @public
|
|
424
424
|
*/
|
|
425
|
-
stringValue?: string;
|
|
425
|
+
stringValue?: string | undefined;
|
|
426
426
|
/**
|
|
427
427
|
* <p>The asset property value is an integer. You must use an expression, and the evaluated
|
|
428
428
|
* result should be an integer.</p>
|
|
429
429
|
* @public
|
|
430
430
|
*/
|
|
431
|
-
integerValue?: string;
|
|
431
|
+
integerValue?: string | undefined;
|
|
432
432
|
/**
|
|
433
433
|
* <p>The asset property value is a double. You must use an expression, and the evaluated result
|
|
434
434
|
* should be a double.</p>
|
|
435
435
|
* @public
|
|
436
436
|
*/
|
|
437
|
-
doubleValue?: string;
|
|
437
|
+
doubleValue?: string | undefined;
|
|
438
438
|
/**
|
|
439
439
|
* <p>The asset property value is a Boolean value that must be <code>'TRUE'</code> or
|
|
440
440
|
* <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a
|
|
441
441
|
* Boolean value.</p>
|
|
442
442
|
* @public
|
|
443
443
|
*/
|
|
444
|
-
booleanValue?: string;
|
|
444
|
+
booleanValue?: string | undefined;
|
|
445
445
|
}
|
|
446
446
|
/**
|
|
447
447
|
* <p>A structure that contains value information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
@@ -472,19 +472,19 @@ export interface AssetPropertyValue {
|
|
|
472
472
|
* <p>The value to send to an asset property.</p>
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
|
-
value?: AssetPropertyVariant;
|
|
475
|
+
value?: AssetPropertyVariant | undefined;
|
|
476
476
|
/**
|
|
477
477
|
* <p>The timestamp associated with the asset property value. The default is the current event
|
|
478
478
|
* time.</p>
|
|
479
479
|
* @public
|
|
480
480
|
*/
|
|
481
|
-
timestamp?: AssetPropertyTimestamp;
|
|
481
|
+
timestamp?: AssetPropertyTimestamp | undefined;
|
|
482
482
|
/**
|
|
483
483
|
* <p>The quality of the asset property value. The value must be <code>'GOOD'</code>,
|
|
484
484
|
* <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.</p>
|
|
485
485
|
* @public
|
|
486
486
|
*/
|
|
487
|
-
quality?: string;
|
|
487
|
+
quality?: string | undefined;
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
490
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
@@ -531,28 +531,28 @@ export interface IotSiteWiseAction {
|
|
|
531
531
|
* causes an error in case of failure. The default is a new unique identifier.</p>
|
|
532
532
|
* @public
|
|
533
533
|
*/
|
|
534
|
-
entryId?: string;
|
|
534
|
+
entryId?: string | undefined;
|
|
535
535
|
/**
|
|
536
536
|
* <p>The ID of the asset that has the specified property.</p>
|
|
537
537
|
* @public
|
|
538
538
|
*/
|
|
539
|
-
assetId?: string;
|
|
539
|
+
assetId?: string | undefined;
|
|
540
540
|
/**
|
|
541
541
|
* <p>The ID of the asset property.</p>
|
|
542
542
|
* @public
|
|
543
543
|
*/
|
|
544
|
-
propertyId?: string;
|
|
544
|
+
propertyId?: string | undefined;
|
|
545
545
|
/**
|
|
546
546
|
* <p>The alias of the asset property.</p>
|
|
547
547
|
* @public
|
|
548
548
|
*/
|
|
549
|
-
propertyAlias?: string;
|
|
549
|
+
propertyAlias?: string | undefined;
|
|
550
550
|
/**
|
|
551
551
|
* <p>The value to send to the asset property. This value contains timestamp, quality, and value
|
|
552
552
|
* (TQV) information. </p>
|
|
553
553
|
* @public
|
|
554
554
|
*/
|
|
555
|
-
propertyValue?: AssetPropertyValue;
|
|
555
|
+
propertyValue?: AssetPropertyValue | undefined;
|
|
556
556
|
}
|
|
557
557
|
/**
|
|
558
558
|
* <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
|
|
@@ -571,7 +571,7 @@ export interface IotTopicPublishAction {
|
|
|
571
571
|
* topic.</p>
|
|
572
572
|
* @public
|
|
573
573
|
*/
|
|
574
|
-
payload?: Payload;
|
|
574
|
+
payload?: Payload | undefined;
|
|
575
575
|
}
|
|
576
576
|
/**
|
|
577
577
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
@@ -588,7 +588,7 @@ export interface LambdaAction {
|
|
|
588
588
|
* <p>You can configure the action payload when you send a message to a Lambda function.</p>
|
|
589
589
|
* @public
|
|
590
590
|
*/
|
|
591
|
-
payload?: Payload;
|
|
591
|
+
payload?: Payload | undefined;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
594
|
* <p>Information required to reset the timer. The timer is reset to the previously evaluated
|
|
@@ -620,7 +620,7 @@ export interface SetTimerAction {
|
|
|
620
620
|
* accuracy. The maximum value is 31622400 seconds. </p>
|
|
621
621
|
* @public
|
|
622
622
|
*/
|
|
623
|
-
seconds?: number;
|
|
623
|
+
seconds?: number | undefined;
|
|
624
624
|
/**
|
|
625
625
|
* <p>The duration of the timer, in seconds. You can use a string expression that includes
|
|
626
626
|
* numbers, variables (<code>$variable.<variable-name></code>), and input values
|
|
@@ -629,7 +629,7 @@ export interface SetTimerAction {
|
|
|
629
629
|
* The evaluated result of the duration is rounded down to the nearest whole number. </p>
|
|
630
630
|
* @public
|
|
631
631
|
*/
|
|
632
|
-
durationExpression?: string;
|
|
632
|
+
durationExpression?: string | undefined;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
635
|
* <p>Information about the variable and its new value.</p>
|
|
@@ -662,7 +662,7 @@ export interface SNSTopicPublishAction {
|
|
|
662
662
|
* notification.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
payload?: Payload;
|
|
665
|
+
payload?: Payload | undefined;
|
|
666
666
|
}
|
|
667
667
|
/**
|
|
668
668
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
@@ -680,13 +680,13 @@ export interface SqsAction {
|
|
|
680
680
|
* queue. Otherwise, set this to FALSE.</p>
|
|
681
681
|
* @public
|
|
682
682
|
*/
|
|
683
|
-
useBase64?: boolean;
|
|
683
|
+
useBase64?: boolean | undefined;
|
|
684
684
|
/**
|
|
685
685
|
* <p>You can configure the action payload when you send a message to an Amazon SQS
|
|
686
686
|
* queue.</p>
|
|
687
687
|
* @public
|
|
688
688
|
*/
|
|
689
|
-
payload?: Payload;
|
|
689
|
+
payload?: Payload | undefined;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
692
|
* <p>An action to be performed when the <code>condition</code> is TRUE.</p>
|
|
@@ -697,56 +697,56 @@ export interface Action {
|
|
|
697
697
|
* <p>Sets a variable to a specified value.</p>
|
|
698
698
|
* @public
|
|
699
699
|
*/
|
|
700
|
-
setVariable?: SetVariableAction;
|
|
700
|
+
setVariable?: SetVariableAction | undefined;
|
|
701
701
|
/**
|
|
702
702
|
* <p>Sends an Amazon SNS message.</p>
|
|
703
703
|
* @public
|
|
704
704
|
*/
|
|
705
|
-
sns?: SNSTopicPublishAction;
|
|
705
|
+
sns?: SNSTopicPublishAction | undefined;
|
|
706
706
|
/**
|
|
707
707
|
* <p>Publishes an MQTT message with the given topic to the AWS IoT message broker.</p>
|
|
708
708
|
* @public
|
|
709
709
|
*/
|
|
710
|
-
iotTopicPublish?: IotTopicPublishAction;
|
|
710
|
+
iotTopicPublish?: IotTopicPublishAction | undefined;
|
|
711
711
|
/**
|
|
712
712
|
* <p>Information needed to set the timer.</p>
|
|
713
713
|
* @public
|
|
714
714
|
*/
|
|
715
|
-
setTimer?: SetTimerAction;
|
|
715
|
+
setTimer?: SetTimerAction | undefined;
|
|
716
716
|
/**
|
|
717
717
|
* <p>Information needed to clear the timer.</p>
|
|
718
718
|
* @public
|
|
719
719
|
*/
|
|
720
|
-
clearTimer?: ClearTimerAction;
|
|
720
|
+
clearTimer?: ClearTimerAction | undefined;
|
|
721
721
|
/**
|
|
722
722
|
* <p>Information needed to reset the timer.</p>
|
|
723
723
|
* @public
|
|
724
724
|
*/
|
|
725
|
-
resetTimer?: ResetTimerAction;
|
|
725
|
+
resetTimer?: ResetTimerAction | undefined;
|
|
726
726
|
/**
|
|
727
727
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
728
728
|
* event that triggered the action.</p>
|
|
729
729
|
* @public
|
|
730
730
|
*/
|
|
731
|
-
lambda?: LambdaAction;
|
|
731
|
+
lambda?: LambdaAction | undefined;
|
|
732
732
|
/**
|
|
733
733
|
* <p>Sends AWS IoT Events input, which passes information about the detector model instance and the
|
|
734
734
|
* event that triggered the action.</p>
|
|
735
735
|
* @public
|
|
736
736
|
*/
|
|
737
|
-
iotEvents?: IotEventsAction;
|
|
737
|
+
iotEvents?: IotEventsAction | undefined;
|
|
738
738
|
/**
|
|
739
739
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
740
740
|
* action to an Amazon SQS queue.</p>
|
|
741
741
|
* @public
|
|
742
742
|
*/
|
|
743
|
-
sqs?: SqsAction;
|
|
743
|
+
sqs?: SqsAction | undefined;
|
|
744
744
|
/**
|
|
745
745
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
746
746
|
* action to an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
747
747
|
* @public
|
|
748
748
|
*/
|
|
749
|
-
firehose?: FirehoseAction;
|
|
749
|
+
firehose?: FirehoseAction | undefined;
|
|
750
750
|
/**
|
|
751
751
|
* <p>Writes to the DynamoDB table that you created. The default action payload contains all
|
|
752
752
|
* attribute-value pairs that have the information about the detector model instance and the
|
|
@@ -756,7 +756,7 @@ export interface Action {
|
|
|
756
756
|
* <i>AWS IoT Events Developer Guide</i>.</p>
|
|
757
757
|
* @public
|
|
758
758
|
*/
|
|
759
|
-
dynamoDB?: DynamoDBAction;
|
|
759
|
+
dynamoDB?: DynamoDBAction | undefined;
|
|
760
760
|
/**
|
|
761
761
|
* <p>Writes to the DynamoDB table that you created. The default action payload contains all
|
|
762
762
|
* attribute-value pairs that have the information about the detector model instance and the
|
|
@@ -766,13 +766,13 @@ export interface Action {
|
|
|
766
766
|
* <i>AWS IoT Events Developer Guide</i>.</p>
|
|
767
767
|
* @public
|
|
768
768
|
*/
|
|
769
|
-
dynamoDBv2?: DynamoDBv2Action;
|
|
769
|
+
dynamoDBv2?: DynamoDBv2Action | undefined;
|
|
770
770
|
/**
|
|
771
771
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
772
772
|
* action to an asset property in AWS IoT SiteWise .</p>
|
|
773
773
|
* @public
|
|
774
774
|
*/
|
|
775
|
-
iotSiteWise?: IotSiteWiseAction;
|
|
775
|
+
iotSiteWise?: IotSiteWiseAction | undefined;
|
|
776
776
|
}
|
|
777
777
|
/**
|
|
778
778
|
* <p>Specifies one of the following actions to receive notifications when the alarm state
|
|
@@ -784,36 +784,36 @@ export interface AlarmAction {
|
|
|
784
784
|
* <p>Information required to publish the Amazon SNS message.</p>
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
|
-
sns?: SNSTopicPublishAction;
|
|
787
|
+
sns?: SNSTopicPublishAction | undefined;
|
|
788
788
|
/**
|
|
789
789
|
* <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
|
|
790
790
|
* @public
|
|
791
791
|
*/
|
|
792
|
-
iotTopicPublish?: IotTopicPublishAction;
|
|
792
|
+
iotTopicPublish?: IotTopicPublishAction | undefined;
|
|
793
793
|
/**
|
|
794
794
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
795
795
|
* event that triggered the action.</p>
|
|
796
796
|
* @public
|
|
797
797
|
*/
|
|
798
|
-
lambda?: LambdaAction;
|
|
798
|
+
lambda?: LambdaAction | undefined;
|
|
799
799
|
/**
|
|
800
800
|
* <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
|
|
801
801
|
* event that triggered the action.</p>
|
|
802
802
|
* @public
|
|
803
803
|
*/
|
|
804
|
-
iotEvents?: IotEventsAction;
|
|
804
|
+
iotEvents?: IotEventsAction | undefined;
|
|
805
805
|
/**
|
|
806
806
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
807
807
|
* action to an Amazon SQS queue.</p>
|
|
808
808
|
* @public
|
|
809
809
|
*/
|
|
810
|
-
sqs?: SqsAction;
|
|
810
|
+
sqs?: SqsAction | undefined;
|
|
811
811
|
/**
|
|
812
812
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
813
813
|
* action to an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
814
814
|
* @public
|
|
815
815
|
*/
|
|
816
|
-
firehose?: FirehoseAction;
|
|
816
|
+
firehose?: FirehoseAction | undefined;
|
|
817
817
|
/**
|
|
818
818
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action
|
|
819
819
|
* payload contains all the information about the detector model instance and the event that
|
|
@@ -864,7 +864,7 @@ export interface AlarmAction {
|
|
|
864
864
|
* <code><payload-field>_raw</code>.</p>
|
|
865
865
|
* @public
|
|
866
866
|
*/
|
|
867
|
-
dynamoDB?: DynamoDBAction;
|
|
867
|
+
dynamoDB?: DynamoDBAction | undefined;
|
|
868
868
|
/**
|
|
869
869
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
|
|
870
870
|
* payload contains all the information about the detector model instance and the event that
|
|
@@ -915,7 +915,7 @@ export interface AlarmAction {
|
|
|
915
915
|
* <code>JSON</code>.</p>
|
|
916
916
|
* @public
|
|
917
917
|
*/
|
|
918
|
-
dynamoDBv2?: DynamoDBv2Action;
|
|
918
|
+
dynamoDBv2?: DynamoDBv2Action | undefined;
|
|
919
919
|
/**
|
|
920
920
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
921
921
|
* action to a specified asset property in AWS IoT SiteWise.</p>
|
|
@@ -955,7 +955,7 @@ export interface AlarmAction {
|
|
|
955
955
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
iotSiteWise?: IotSiteWiseAction;
|
|
958
|
+
iotSiteWise?: IotSiteWiseAction | undefined;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
961
|
* <p>Specifies the default alarm state.
|
|
@@ -981,12 +981,12 @@ export interface AlarmCapabilities {
|
|
|
981
981
|
* The configuration applies to all alarms that were created based on this alarm model.</p>
|
|
982
982
|
* @public
|
|
983
983
|
*/
|
|
984
|
-
initializationConfiguration?: InitializationConfiguration;
|
|
984
|
+
initializationConfiguration?: InitializationConfiguration | undefined;
|
|
985
985
|
/**
|
|
986
986
|
* <p>Specifies whether to get notified for alarm state changes.</p>
|
|
987
987
|
* @public
|
|
988
988
|
*/
|
|
989
|
-
acknowledgeFlow?: AcknowledgeFlow;
|
|
989
|
+
acknowledgeFlow?: AcknowledgeFlow | undefined;
|
|
990
990
|
}
|
|
991
991
|
/**
|
|
992
992
|
* <p>Contains information about one or more alarm actions.</p>
|
|
@@ -998,7 +998,7 @@ export interface AlarmEventActions {
|
|
|
998
998
|
* changes.</p>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
alarmActions?: AlarmAction[];
|
|
1001
|
+
alarmActions?: AlarmAction[] | undefined;
|
|
1002
1002
|
}
|
|
1003
1003
|
/**
|
|
1004
1004
|
* <p>Contains a summary of an alarm model.</p>
|
|
@@ -1009,17 +1009,17 @@ export interface AlarmModelSummary {
|
|
|
1009
1009
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1010
1010
|
* @public
|
|
1011
1011
|
*/
|
|
1012
|
-
creationTime?: Date;
|
|
1012
|
+
creationTime?: Date | undefined;
|
|
1013
1013
|
/**
|
|
1014
1014
|
* <p>The description of the alarm model.</p>
|
|
1015
1015
|
* @public
|
|
1016
1016
|
*/
|
|
1017
|
-
alarmModelDescription?: string;
|
|
1017
|
+
alarmModelDescription?: string | undefined;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* <p>The name of the alarm model.</p>
|
|
1020
1020
|
* @public
|
|
1021
1021
|
*/
|
|
1022
|
-
alarmModelName?: string;
|
|
1022
|
+
alarmModelName?: string | undefined;
|
|
1023
1023
|
}
|
|
1024
1024
|
/**
|
|
1025
1025
|
* @public
|
|
@@ -1044,32 +1044,32 @@ export interface AlarmModelVersionSummary {
|
|
|
1044
1044
|
* <p>The name of the alarm model.</p>
|
|
1045
1045
|
* @public
|
|
1046
1046
|
*/
|
|
1047
|
-
alarmModelName?: string;
|
|
1047
|
+
alarmModelName?: string | undefined;
|
|
1048
1048
|
/**
|
|
1049
1049
|
* <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>
|
|
1050
1050
|
* @public
|
|
1051
1051
|
*/
|
|
1052
|
-
alarmModelArn?: string;
|
|
1052
|
+
alarmModelArn?: string | undefined;
|
|
1053
1053
|
/**
|
|
1054
1054
|
* <p>The version of the alarm model.</p>
|
|
1055
1055
|
* @public
|
|
1056
1056
|
*/
|
|
1057
|
-
alarmModelVersion?: string;
|
|
1057
|
+
alarmModelVersion?: string | undefined;
|
|
1058
1058
|
/**
|
|
1059
1059
|
* <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>
|
|
1060
1060
|
* @public
|
|
1061
1061
|
*/
|
|
1062
|
-
roleArn?: string;
|
|
1062
|
+
roleArn?: string | undefined;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1065
1065
|
* @public
|
|
1066
1066
|
*/
|
|
1067
|
-
creationTime?: Date;
|
|
1067
|
+
creationTime?: Date | undefined;
|
|
1068
1068
|
/**
|
|
1069
1069
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
1070
1070
|
* @public
|
|
1071
1071
|
*/
|
|
1072
|
-
lastUpdateTime?: Date;
|
|
1072
|
+
lastUpdateTime?: Date | undefined;
|
|
1073
1073
|
/**
|
|
1074
1074
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
1075
1075
|
* <ul>
|
|
@@ -1095,14 +1095,14 @@ export interface AlarmModelVersionSummary {
|
|
|
1095
1095
|
* </ul>
|
|
1096
1096
|
* @public
|
|
1097
1097
|
*/
|
|
1098
|
-
status?: AlarmModelVersionStatus;
|
|
1098
|
+
status?: AlarmModelVersionStatus | undefined;
|
|
1099
1099
|
/**
|
|
1100
1100
|
* <p>
|
|
1101
1101
|
* Contains information about the status of the alarm model version.
|
|
1102
1102
|
* </p>
|
|
1103
1103
|
* @public
|
|
1104
1104
|
*/
|
|
1105
|
-
statusMessage?: string;
|
|
1105
|
+
statusMessage?: string | undefined;
|
|
1106
1106
|
}
|
|
1107
1107
|
/**
|
|
1108
1108
|
* <p>Specifies an AWS Lambda function to manage alarm notifications.
|
|
@@ -1115,7 +1115,7 @@ export interface NotificationTargetActions {
|
|
|
1115
1115
|
* event that triggered the action.</p>
|
|
1116
1116
|
* @public
|
|
1117
1117
|
*/
|
|
1118
|
-
lambdaAction?: LambdaAction;
|
|
1118
|
+
lambdaAction?: LambdaAction | undefined;
|
|
1119
1119
|
}
|
|
1120
1120
|
/**
|
|
1121
1121
|
* <p>Contains the subject and message of an email.</p>
|
|
@@ -1126,12 +1126,12 @@ export interface EmailContent {
|
|
|
1126
1126
|
* <p>The subject of the email.</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
subject?: string;
|
|
1129
|
+
subject?: string | undefined;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* <p>The message that you want to send. The message can be up to 200 characters.</p>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
additionalMessage?: string;
|
|
1134
|
+
additionalMessage?: string | undefined;
|
|
1135
1135
|
}
|
|
1136
1136
|
/**
|
|
1137
1137
|
* <p>Contains information about your identity source in AWS Single Sign-On. For more information, see
|
|
@@ -1149,7 +1149,7 @@ export interface SSOIdentity {
|
|
|
1149
1149
|
* <p>The user ID.</p>
|
|
1150
1150
|
* @public
|
|
1151
1151
|
*/
|
|
1152
|
-
userId?: string;
|
|
1152
|
+
userId?: string | undefined;
|
|
1153
1153
|
}
|
|
1154
1154
|
/**
|
|
1155
1155
|
* <p>The information that identifies the recipient.</p>
|
|
@@ -1160,7 +1160,7 @@ export interface RecipientDetail {
|
|
|
1160
1160
|
* <p>The AWS Single Sign-On (AWS SSO) authentication information.</p>
|
|
1161
1161
|
* @public
|
|
1162
1162
|
*/
|
|
1163
|
-
ssoIdentity?: SSOIdentity;
|
|
1163
|
+
ssoIdentity?: SSOIdentity | undefined;
|
|
1164
1164
|
}
|
|
1165
1165
|
/**
|
|
1166
1166
|
* <p>Contains the information of one or more recipients who receive the emails.</p>
|
|
@@ -1174,7 +1174,7 @@ export interface EmailRecipients {
|
|
|
1174
1174
|
* <p>Specifies one or more recipients who receive the email.</p>
|
|
1175
1175
|
* @public
|
|
1176
1176
|
*/
|
|
1177
|
-
to?: RecipientDetail[];
|
|
1177
|
+
to?: RecipientDetail[] | undefined;
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
1180
|
* <p>Contains the configuration information of email notifications.</p>
|
|
@@ -1194,7 +1194,7 @@ export interface EmailConfiguration {
|
|
|
1194
1194
|
* <p>Contains the subject and message of an email.</p>
|
|
1195
1195
|
* @public
|
|
1196
1196
|
*/
|
|
1197
|
-
content?: EmailContent;
|
|
1197
|
+
content?: EmailContent | undefined;
|
|
1198
1198
|
/**
|
|
1199
1199
|
* <p>Contains the information of one or more recipients who receive the emails.</p>
|
|
1200
1200
|
* <important>
|
|
@@ -1213,12 +1213,12 @@ export interface SMSConfiguration {
|
|
|
1213
1213
|
* <p>The sender ID.</p>
|
|
1214
1214
|
* @public
|
|
1215
1215
|
*/
|
|
1216
|
-
senderId?: string;
|
|
1216
|
+
senderId?: string | undefined;
|
|
1217
1217
|
/**
|
|
1218
1218
|
* <p>The message that you want to send. The message can be up to 200 characters.</p>
|
|
1219
1219
|
* @public
|
|
1220
1220
|
*/
|
|
1221
|
-
additionalMessage?: string;
|
|
1221
|
+
additionalMessage?: string | undefined;
|
|
1222
1222
|
/**
|
|
1223
1223
|
* <p>Specifies one or more recipients who receive the message.</p>
|
|
1224
1224
|
* <important>
|
|
@@ -1244,12 +1244,12 @@ export interface NotificationAction {
|
|
|
1244
1244
|
* <p>Contains the configuration information of SMS notifications.</p>
|
|
1245
1245
|
* @public
|
|
1246
1246
|
*/
|
|
1247
|
-
smsConfigurations?: SMSConfiguration[];
|
|
1247
|
+
smsConfigurations?: SMSConfiguration[] | undefined;
|
|
1248
1248
|
/**
|
|
1249
1249
|
* <p>Contains the configuration information of email notifications.</p>
|
|
1250
1250
|
* @public
|
|
1251
1251
|
*/
|
|
1252
|
-
emailConfigurations?: EmailConfiguration[];
|
|
1252
|
+
emailConfigurations?: EmailConfiguration[] | undefined;
|
|
1253
1253
|
}
|
|
1254
1254
|
/**
|
|
1255
1255
|
* <p>Contains information about one or more notification actions.</p>
|
|
@@ -1261,7 +1261,7 @@ export interface AlarmNotification {
|
|
|
1261
1261
|
* The settings apply to all alarms that were created based on this alarm model.</p>
|
|
1262
1262
|
* @public
|
|
1263
1263
|
*/
|
|
1264
|
-
notificationActions?: NotificationAction[];
|
|
1264
|
+
notificationActions?: NotificationAction[] | undefined;
|
|
1265
1265
|
}
|
|
1266
1266
|
/**
|
|
1267
1267
|
* @public
|
|
@@ -1311,7 +1311,7 @@ export interface AlarmRule {
|
|
|
1311
1311
|
* <p>A rule that compares an input property value to a threshold value with a comparison operator.</p>
|
|
1312
1312
|
* @public
|
|
1313
1313
|
*/
|
|
1314
|
-
simpleRule?: SimpleRule;
|
|
1314
|
+
simpleRule?: SimpleRule | undefined;
|
|
1315
1315
|
}
|
|
1316
1316
|
/**
|
|
1317
1317
|
* @public
|
|
@@ -1337,7 +1337,7 @@ export interface AnalysisResultLocation {
|
|
|
1337
1337
|
* identifies the error field in your detector model.</p>
|
|
1338
1338
|
* @public
|
|
1339
1339
|
*/
|
|
1340
|
-
path?: string;
|
|
1340
|
+
path?: string | undefined;
|
|
1341
1341
|
}
|
|
1342
1342
|
/**
|
|
1343
1343
|
* <p>Contains the result of the analysis.</p>
|
|
@@ -1389,7 +1389,7 @@ export interface AnalysisResult {
|
|
|
1389
1389
|
* analyses</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
1390
1390
|
* @public
|
|
1391
1391
|
*/
|
|
1392
|
-
type?: string;
|
|
1392
|
+
type?: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* <p>The severity level of the analysis result. Based on the severity level, analysis results
|
|
1395
1395
|
* fall into three general categories:</p>
|
|
@@ -1414,18 +1414,18 @@ export interface AnalysisResult {
|
|
|
1414
1414
|
* </ul>
|
|
1415
1415
|
* @public
|
|
1416
1416
|
*/
|
|
1417
|
-
level?: AnalysisResultLevel;
|
|
1417
|
+
level?: AnalysisResultLevel | undefined;
|
|
1418
1418
|
/**
|
|
1419
1419
|
* <p>Contains additional information about the analysis result.</p>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
|
-
message?: string;
|
|
1422
|
+
message?: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
1424
|
* <p>Contains one or more locations that you can use to locate the fields in your detector
|
|
1425
1425
|
* model that the analysis result references.</p>
|
|
1426
1426
|
* @public
|
|
1427
1427
|
*/
|
|
1428
|
-
locations?: AnalysisResultLocation[];
|
|
1428
|
+
locations?: AnalysisResultLocation[] | undefined;
|
|
1429
1429
|
}
|
|
1430
1430
|
/**
|
|
1431
1431
|
* @public
|
|
@@ -1490,7 +1490,7 @@ export interface CreateAlarmModelRequest {
|
|
|
1490
1490
|
* <p>A description that tells you what the alarm model detects.</p>
|
|
1491
1491
|
* @public
|
|
1492
1492
|
*/
|
|
1493
|
-
alarmModelDescription?: string;
|
|
1493
|
+
alarmModelDescription?: string | undefined;
|
|
1494
1494
|
/**
|
|
1495
1495
|
* <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>
|
|
1496
1496
|
* @public
|
|
@@ -1503,19 +1503,19 @@ export interface CreateAlarmModelRequest {
|
|
|
1503
1503
|
* <p>You can create up to 50 tags for one alarm model.</p>
|
|
1504
1504
|
* @public
|
|
1505
1505
|
*/
|
|
1506
|
-
tags?: Tag[];
|
|
1506
|
+
tags?: Tag[] | undefined;
|
|
1507
1507
|
/**
|
|
1508
1508
|
* <p>An input attribute used as a key to create an alarm.
|
|
1509
1509
|
* AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
|
|
1510
1510
|
* associated with this key to the alarm.</p>
|
|
1511
1511
|
* @public
|
|
1512
1512
|
*/
|
|
1513
|
-
key?: string;
|
|
1513
|
+
key?: string | undefined;
|
|
1514
1514
|
/**
|
|
1515
1515
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
1516
1516
|
* @public
|
|
1517
1517
|
*/
|
|
1518
|
-
severity?: number;
|
|
1518
|
+
severity?: number | undefined;
|
|
1519
1519
|
/**
|
|
1520
1520
|
* <p>Defines when your alarm is invoked.</p>
|
|
1521
1521
|
* @public
|
|
@@ -1525,17 +1525,17 @@ export interface CreateAlarmModelRequest {
|
|
|
1525
1525
|
* <p>Contains information about one or more notification actions.</p>
|
|
1526
1526
|
* @public
|
|
1527
1527
|
*/
|
|
1528
|
-
alarmNotification?: AlarmNotification;
|
|
1528
|
+
alarmNotification?: AlarmNotification | undefined;
|
|
1529
1529
|
/**
|
|
1530
1530
|
* <p>Contains information about one or more alarm actions.</p>
|
|
1531
1531
|
* @public
|
|
1532
1532
|
*/
|
|
1533
|
-
alarmEventActions?: AlarmEventActions;
|
|
1533
|
+
alarmEventActions?: AlarmEventActions | undefined;
|
|
1534
1534
|
/**
|
|
1535
1535
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
1536
1536
|
* @public
|
|
1537
1537
|
*/
|
|
1538
|
-
alarmCapabilities?: AlarmCapabilities;
|
|
1538
|
+
alarmCapabilities?: AlarmCapabilities | undefined;
|
|
1539
1539
|
}
|
|
1540
1540
|
/**
|
|
1541
1541
|
* @public
|
|
@@ -1545,22 +1545,22 @@ export interface CreateAlarmModelResponse {
|
|
|
1545
1545
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1546
1546
|
* @public
|
|
1547
1547
|
*/
|
|
1548
|
-
creationTime?: Date;
|
|
1548
|
+
creationTime?: Date | undefined;
|
|
1549
1549
|
/**
|
|
1550
1550
|
* <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>
|
|
1551
1551
|
* @public
|
|
1552
1552
|
*/
|
|
1553
|
-
alarmModelArn?: string;
|
|
1553
|
+
alarmModelArn?: string | undefined;
|
|
1554
1554
|
/**
|
|
1555
1555
|
* <p>The version of the alarm model.</p>
|
|
1556
1556
|
* @public
|
|
1557
1557
|
*/
|
|
1558
|
-
alarmModelVersion?: string;
|
|
1558
|
+
alarmModelVersion?: string | undefined;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
1561
1561
|
* @public
|
|
1562
1562
|
*/
|
|
1563
|
-
lastUpdateTime?: Date;
|
|
1563
|
+
lastUpdateTime?: Date | undefined;
|
|
1564
1564
|
/**
|
|
1565
1565
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
1566
1566
|
* <ul>
|
|
@@ -1586,7 +1586,7 @@ export interface CreateAlarmModelResponse {
|
|
|
1586
1586
|
* </ul>
|
|
1587
1587
|
* @public
|
|
1588
1588
|
*/
|
|
1589
|
-
status?: AlarmModelVersionStatus;
|
|
1589
|
+
status?: AlarmModelVersionStatus | undefined;
|
|
1590
1590
|
}
|
|
1591
1591
|
/**
|
|
1592
1592
|
* <p>An internal failure occurred.</p>
|
|
@@ -1635,12 +1635,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1635
1635
|
* <p>The ID of the resource.</p>
|
|
1636
1636
|
* @public
|
|
1637
1637
|
*/
|
|
1638
|
-
resourceId?: string;
|
|
1638
|
+
resourceId?: string | undefined;
|
|
1639
1639
|
/**
|
|
1640
1640
|
* <p>The ARN of the resource.</p>
|
|
1641
1641
|
* @public
|
|
1642
1642
|
*/
|
|
1643
|
-
resourceArn?: string;
|
|
1643
|
+
resourceArn?: string | undefined;
|
|
1644
1644
|
/**
|
|
1645
1645
|
* @internal
|
|
1646
1646
|
*/
|
|
@@ -1699,12 +1699,12 @@ export interface Event {
|
|
|
1699
1699
|
* a Boolean value, the actions are not performed (=FALSE).</p>
|
|
1700
1700
|
* @public
|
|
1701
1701
|
*/
|
|
1702
|
-
condition?: string;
|
|
1702
|
+
condition?: string | undefined;
|
|
1703
1703
|
/**
|
|
1704
1704
|
* <p>The actions to be performed.</p>
|
|
1705
1705
|
* @public
|
|
1706
1706
|
*/
|
|
1707
|
-
actions?: Action[];
|
|
1707
|
+
actions?: Action[] | undefined;
|
|
1708
1708
|
}
|
|
1709
1709
|
/**
|
|
1710
1710
|
* <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
|
|
@@ -1717,7 +1717,7 @@ export interface OnEnterLifecycle {
|
|
|
1717
1717
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1718
1718
|
* @public
|
|
1719
1719
|
*/
|
|
1720
|
-
events?: Event[];
|
|
1720
|
+
events?: Event[] | undefined;
|
|
1721
1721
|
}
|
|
1722
1722
|
/**
|
|
1723
1723
|
* <p>When exiting this state, perform these <code>actions</code> if the specified
|
|
@@ -1730,7 +1730,7 @@ export interface OnExitLifecycle {
|
|
|
1730
1730
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1731
1731
|
* @public
|
|
1732
1732
|
*/
|
|
1733
|
-
events?: Event[];
|
|
1733
|
+
events?: Event[] | undefined;
|
|
1734
1734
|
}
|
|
1735
1735
|
/**
|
|
1736
1736
|
* <p>Specifies the actions performed and the next state entered when a <code>condition</code>
|
|
@@ -1753,7 +1753,7 @@ export interface TransitionEvent {
|
|
|
1753
1753
|
* <p>The actions to be performed.</p>
|
|
1754
1754
|
* @public
|
|
1755
1755
|
*/
|
|
1756
|
-
actions?: Action[];
|
|
1756
|
+
actions?: Action[] | undefined;
|
|
1757
1757
|
/**
|
|
1758
1758
|
* <p>The next state to enter.</p>
|
|
1759
1759
|
* @public
|
|
@@ -1769,13 +1769,13 @@ export interface OnInputLifecycle {
|
|
|
1769
1769
|
* <p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>
|
|
1770
1770
|
* @public
|
|
1771
1771
|
*/
|
|
1772
|
-
events?: Event[];
|
|
1772
|
+
events?: Event[] | undefined;
|
|
1773
1773
|
/**
|
|
1774
1774
|
* <p>Specifies the actions performed, and the next state entered, when a <code>condition</code>
|
|
1775
1775
|
* evaluates to TRUE.</p>
|
|
1776
1776
|
* @public
|
|
1777
1777
|
*/
|
|
1778
|
-
transitionEvents?: TransitionEvent[];
|
|
1778
|
+
transitionEvents?: TransitionEvent[] | undefined;
|
|
1779
1779
|
}
|
|
1780
1780
|
/**
|
|
1781
1781
|
* <p>Information that defines a state of a detector.</p>
|
|
@@ -1792,19 +1792,19 @@ export interface State {
|
|
|
1792
1792
|
* <code>actions</code>.</p>
|
|
1793
1793
|
* @public
|
|
1794
1794
|
*/
|
|
1795
|
-
onInput?: OnInputLifecycle;
|
|
1795
|
+
onInput?: OnInputLifecycle | undefined;
|
|
1796
1796
|
/**
|
|
1797
1797
|
* <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
|
|
1798
1798
|
* is TRUE.</p>
|
|
1799
1799
|
* @public
|
|
1800
1800
|
*/
|
|
1801
|
-
onEnter?: OnEnterLifecycle;
|
|
1801
|
+
onEnter?: OnEnterLifecycle | undefined;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* <p>When exiting this state, perform these <code>actions</code> if the specified
|
|
1804
1804
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1805
1805
|
* @public
|
|
1806
1806
|
*/
|
|
1807
|
-
onExit?: OnExitLifecycle;
|
|
1807
|
+
onExit?: OnExitLifecycle | undefined;
|
|
1808
1808
|
}
|
|
1809
1809
|
/**
|
|
1810
1810
|
* <p>Information that defines how a detector operates.</p>
|
|
@@ -1852,7 +1852,7 @@ export interface CreateDetectorModelRequest {
|
|
|
1852
1852
|
* <p>A brief description of the detector model.</p>
|
|
1853
1853
|
* @public
|
|
1854
1854
|
*/
|
|
1855
|
-
detectorModelDescription?: string;
|
|
1855
|
+
detectorModelDescription?: string | undefined;
|
|
1856
1856
|
/**
|
|
1857
1857
|
* <p>The input attribute key used to identify a device or system to create a detector (an
|
|
1858
1858
|
* instance of the detector model) and then to route each input received to the appropriate
|
|
@@ -1861,7 +1861,7 @@ export interface CreateDetectorModelRequest {
|
|
|
1861
1861
|
* the input.</p>
|
|
1862
1862
|
* @public
|
|
1863
1863
|
*/
|
|
1864
|
-
key?: string;
|
|
1864
|
+
key?: string | undefined;
|
|
1865
1865
|
/**
|
|
1866
1866
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
1867
1867
|
* @public
|
|
@@ -1871,13 +1871,13 @@ export interface CreateDetectorModelRequest {
|
|
|
1871
1871
|
* <p>Metadata that can be used to manage the detector model.</p>
|
|
1872
1872
|
* @public
|
|
1873
1873
|
*/
|
|
1874
|
-
tags?: Tag[];
|
|
1874
|
+
tags?: Tag[] | undefined;
|
|
1875
1875
|
/**
|
|
1876
1876
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
1877
1877
|
* </p>
|
|
1878
1878
|
* @public
|
|
1879
1879
|
*/
|
|
1880
|
-
evaluationMethod?: EvaluationMethod;
|
|
1880
|
+
evaluationMethod?: EvaluationMethod | undefined;
|
|
1881
1881
|
}
|
|
1882
1882
|
/**
|
|
1883
1883
|
* @public
|
|
@@ -1905,42 +1905,42 @@ export interface DetectorModelConfiguration {
|
|
|
1905
1905
|
* <p>The name of the detector model.</p>
|
|
1906
1906
|
* @public
|
|
1907
1907
|
*/
|
|
1908
|
-
detectorModelName?: string;
|
|
1908
|
+
detectorModelName?: string | undefined;
|
|
1909
1909
|
/**
|
|
1910
1910
|
* <p>The version of the detector model.</p>
|
|
1911
1911
|
* @public
|
|
1912
1912
|
*/
|
|
1913
|
-
detectorModelVersion?: string;
|
|
1913
|
+
detectorModelVersion?: string | undefined;
|
|
1914
1914
|
/**
|
|
1915
1915
|
* <p>A brief description of the detector model.</p>
|
|
1916
1916
|
* @public
|
|
1917
1917
|
*/
|
|
1918
|
-
detectorModelDescription?: string;
|
|
1918
|
+
detectorModelDescription?: string | undefined;
|
|
1919
1919
|
/**
|
|
1920
1920
|
* <p>The ARN of the detector model.</p>
|
|
1921
1921
|
* @public
|
|
1922
1922
|
*/
|
|
1923
|
-
detectorModelArn?: string;
|
|
1923
|
+
detectorModelArn?: string | undefined;
|
|
1924
1924
|
/**
|
|
1925
1925
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
1926
1926
|
* @public
|
|
1927
1927
|
*/
|
|
1928
|
-
roleArn?: string;
|
|
1928
|
+
roleArn?: string | undefined;
|
|
1929
1929
|
/**
|
|
1930
1930
|
* <p>The time the detector model was created.</p>
|
|
1931
1931
|
* @public
|
|
1932
1932
|
*/
|
|
1933
|
-
creationTime?: Date;
|
|
1933
|
+
creationTime?: Date | undefined;
|
|
1934
1934
|
/**
|
|
1935
1935
|
* <p>The time the detector model was last updated.</p>
|
|
1936
1936
|
* @public
|
|
1937
1937
|
*/
|
|
1938
|
-
lastUpdateTime?: Date;
|
|
1938
|
+
lastUpdateTime?: Date | undefined;
|
|
1939
1939
|
/**
|
|
1940
1940
|
* <p>The status of the detector model.</p>
|
|
1941
1941
|
* @public
|
|
1942
1942
|
*/
|
|
1943
|
-
status?: DetectorModelVersionStatus;
|
|
1943
|
+
status?: DetectorModelVersionStatus | undefined;
|
|
1944
1944
|
/**
|
|
1945
1945
|
* <p>The value used to identify a detector instance. When a device or system sends input, a new
|
|
1946
1946
|
* detector instance with a unique key value is created. AWS IoT Events can continue to route input to its
|
|
@@ -1951,13 +1951,13 @@ export interface DetectorModelConfiguration {
|
|
|
1951
1951
|
* attribute-value.</p>
|
|
1952
1952
|
* @public
|
|
1953
1953
|
*/
|
|
1954
|
-
key?: string;
|
|
1954
|
+
key?: string | undefined;
|
|
1955
1955
|
/**
|
|
1956
1956
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
1957
1957
|
* </p>
|
|
1958
1958
|
* @public
|
|
1959
1959
|
*/
|
|
1960
|
-
evaluationMethod?: EvaluationMethod;
|
|
1960
|
+
evaluationMethod?: EvaluationMethod | undefined;
|
|
1961
1961
|
}
|
|
1962
1962
|
/**
|
|
1963
1963
|
* @public
|
|
@@ -1967,7 +1967,7 @@ export interface CreateDetectorModelResponse {
|
|
|
1967
1967
|
* <p>Information about how the detector model is configured.</p>
|
|
1968
1968
|
* @public
|
|
1969
1969
|
*/
|
|
1970
|
-
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
1970
|
+
detectorModelConfiguration?: DetectorModelConfiguration | undefined;
|
|
1971
1971
|
}
|
|
1972
1972
|
/**
|
|
1973
1973
|
* <p>The definition of the input.</p>
|
|
@@ -1997,7 +1997,7 @@ export interface CreateInputRequest {
|
|
|
1997
1997
|
* <p>A brief description of the input.</p>
|
|
1998
1998
|
* @public
|
|
1999
1999
|
*/
|
|
2000
|
-
inputDescription?: string;
|
|
2000
|
+
inputDescription?: string | undefined;
|
|
2001
2001
|
/**
|
|
2002
2002
|
* <p>The definition of the input.</p>
|
|
2003
2003
|
* @public
|
|
@@ -2007,7 +2007,7 @@ export interface CreateInputRequest {
|
|
|
2007
2007
|
* <p>Metadata that can be used to manage the input.</p>
|
|
2008
2008
|
* @public
|
|
2009
2009
|
*/
|
|
2010
|
-
tags?: Tag[];
|
|
2010
|
+
tags?: Tag[] | undefined;
|
|
2011
2011
|
}
|
|
2012
2012
|
/**
|
|
2013
2013
|
* @public
|
|
@@ -2037,7 +2037,7 @@ export interface InputConfiguration {
|
|
|
2037
2037
|
* <p>A brief description of the input.</p>
|
|
2038
2038
|
* @public
|
|
2039
2039
|
*/
|
|
2040
|
-
inputDescription?: string;
|
|
2040
|
+
inputDescription?: string | undefined;
|
|
2041
2041
|
/**
|
|
2042
2042
|
* <p>The ARN of the input.</p>
|
|
2043
2043
|
* @public
|
|
@@ -2067,7 +2067,7 @@ export interface CreateInputResponse {
|
|
|
2067
2067
|
* <p>Information about the configuration of the input.</p>
|
|
2068
2068
|
* @public
|
|
2069
2069
|
*/
|
|
2070
|
-
inputConfiguration?: InputConfiguration;
|
|
2070
|
+
inputConfiguration?: InputConfiguration | undefined;
|
|
2071
2071
|
}
|
|
2072
2072
|
/**
|
|
2073
2073
|
* @public
|
|
@@ -2139,7 +2139,7 @@ export interface DescribeAlarmModelRequest {
|
|
|
2139
2139
|
* <p>The version of the alarm model.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
alarmModelVersion?: string;
|
|
2142
|
+
alarmModelVersion?: string | undefined;
|
|
2143
2143
|
}
|
|
2144
2144
|
/**
|
|
2145
2145
|
* @public
|
|
@@ -2149,22 +2149,22 @@ export interface DescribeAlarmModelResponse {
|
|
|
2149
2149
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
2150
2150
|
* @public
|
|
2151
2151
|
*/
|
|
2152
|
-
creationTime?: Date;
|
|
2152
|
+
creationTime?: Date | undefined;
|
|
2153
2153
|
/**
|
|
2154
2154
|
* <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>
|
|
2155
2155
|
* @public
|
|
2156
2156
|
*/
|
|
2157
|
-
alarmModelArn?: string;
|
|
2157
|
+
alarmModelArn?: string | undefined;
|
|
2158
2158
|
/**
|
|
2159
2159
|
* <p>The version of the alarm model.</p>
|
|
2160
2160
|
* @public
|
|
2161
2161
|
*/
|
|
2162
|
-
alarmModelVersion?: string;
|
|
2162
|
+
alarmModelVersion?: string | undefined;
|
|
2163
2163
|
/**
|
|
2164
2164
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
2165
2165
|
* @public
|
|
2166
2166
|
*/
|
|
2167
|
-
lastUpdateTime?: Date;
|
|
2167
|
+
lastUpdateTime?: Date | undefined;
|
|
2168
2168
|
/**
|
|
2169
2169
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
2170
2170
|
* <ul>
|
|
@@ -2190,61 +2190,61 @@ export interface DescribeAlarmModelResponse {
|
|
|
2190
2190
|
* </ul>
|
|
2191
2191
|
* @public
|
|
2192
2192
|
*/
|
|
2193
|
-
status?: AlarmModelVersionStatus;
|
|
2193
|
+
status?: AlarmModelVersionStatus | undefined;
|
|
2194
2194
|
/**
|
|
2195
2195
|
* <p>
|
|
2196
2196
|
* Contains information about the status of the alarm model.
|
|
2197
2197
|
* </p>
|
|
2198
2198
|
* @public
|
|
2199
2199
|
*/
|
|
2200
|
-
statusMessage?: string;
|
|
2200
|
+
statusMessage?: string | undefined;
|
|
2201
2201
|
/**
|
|
2202
2202
|
* <p>The name of the alarm model.</p>
|
|
2203
2203
|
* @public
|
|
2204
2204
|
*/
|
|
2205
|
-
alarmModelName?: string;
|
|
2205
|
+
alarmModelName?: string | undefined;
|
|
2206
2206
|
/**
|
|
2207
2207
|
* <p>The description of the alarm model.</p>
|
|
2208
2208
|
* @public
|
|
2209
2209
|
*/
|
|
2210
|
-
alarmModelDescription?: string;
|
|
2210
|
+
alarmModelDescription?: string | undefined;
|
|
2211
2211
|
/**
|
|
2212
2212
|
* <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>
|
|
2213
2213
|
* @public
|
|
2214
2214
|
*/
|
|
2215
|
-
roleArn?: string;
|
|
2215
|
+
roleArn?: string | undefined;
|
|
2216
2216
|
/**
|
|
2217
2217
|
* <p>An input attribute used as a key to create an alarm.
|
|
2218
2218
|
* AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
|
|
2219
2219
|
* associated with this key to the alarm.</p>
|
|
2220
2220
|
* @public
|
|
2221
2221
|
*/
|
|
2222
|
-
key?: string;
|
|
2222
|
+
key?: string | undefined;
|
|
2223
2223
|
/**
|
|
2224
2224
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
2225
2225
|
* @public
|
|
2226
2226
|
*/
|
|
2227
|
-
severity?: number;
|
|
2227
|
+
severity?: number | undefined;
|
|
2228
2228
|
/**
|
|
2229
2229
|
* <p>Defines when your alarm is invoked.</p>
|
|
2230
2230
|
* @public
|
|
2231
2231
|
*/
|
|
2232
|
-
alarmRule?: AlarmRule;
|
|
2232
|
+
alarmRule?: AlarmRule | undefined;
|
|
2233
2233
|
/**
|
|
2234
2234
|
* <p>Contains information about one or more notification actions.</p>
|
|
2235
2235
|
* @public
|
|
2236
2236
|
*/
|
|
2237
|
-
alarmNotification?: AlarmNotification;
|
|
2237
|
+
alarmNotification?: AlarmNotification | undefined;
|
|
2238
2238
|
/**
|
|
2239
2239
|
* <p>Contains information about one or more alarm actions.</p>
|
|
2240
2240
|
* @public
|
|
2241
2241
|
*/
|
|
2242
|
-
alarmEventActions?: AlarmEventActions;
|
|
2242
|
+
alarmEventActions?: AlarmEventActions | undefined;
|
|
2243
2243
|
/**
|
|
2244
2244
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
2245
2245
|
* @public
|
|
2246
2246
|
*/
|
|
2247
|
-
alarmCapabilities?: AlarmCapabilities;
|
|
2247
|
+
alarmCapabilities?: AlarmCapabilities | undefined;
|
|
2248
2248
|
}
|
|
2249
2249
|
/**
|
|
2250
2250
|
* @public
|
|
@@ -2259,7 +2259,7 @@ export interface DescribeDetectorModelRequest {
|
|
|
2259
2259
|
* <p>The version of the detector model.</p>
|
|
2260
2260
|
* @public
|
|
2261
2261
|
*/
|
|
2262
|
-
detectorModelVersion?: string;
|
|
2262
|
+
detectorModelVersion?: string | undefined;
|
|
2263
2263
|
}
|
|
2264
2264
|
/**
|
|
2265
2265
|
* <p>Information about the detector model.</p>
|
|
@@ -2270,12 +2270,12 @@ export interface DetectorModel {
|
|
|
2270
2270
|
* <p>Information that defines how a detector operates.</p>
|
|
2271
2271
|
* @public
|
|
2272
2272
|
*/
|
|
2273
|
-
detectorModelDefinition?: DetectorModelDefinition;
|
|
2273
|
+
detectorModelDefinition?: DetectorModelDefinition | undefined;
|
|
2274
2274
|
/**
|
|
2275
2275
|
* <p>Information about how the detector is configured.</p>
|
|
2276
2276
|
* @public
|
|
2277
2277
|
*/
|
|
2278
|
-
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
2278
|
+
detectorModelConfiguration?: DetectorModelConfiguration | undefined;
|
|
2279
2279
|
}
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @public
|
|
@@ -2285,7 +2285,7 @@ export interface DescribeDetectorModelResponse {
|
|
|
2285
2285
|
* <p>Information about the detector model.</p>
|
|
2286
2286
|
* @public
|
|
2287
2287
|
*/
|
|
2288
|
-
detectorModel?: DetectorModel;
|
|
2288
|
+
detectorModel?: DetectorModel | undefined;
|
|
2289
2289
|
}
|
|
2290
2290
|
/**
|
|
2291
2291
|
* @public
|
|
@@ -2321,7 +2321,7 @@ export interface DescribeDetectorModelAnalysisResponse {
|
|
|
2321
2321
|
* </ul>
|
|
2322
2322
|
* @public
|
|
2323
2323
|
*/
|
|
2324
|
-
status?: AnalysisStatus;
|
|
2324
|
+
status?: AnalysisStatus | undefined;
|
|
2325
2325
|
}
|
|
2326
2326
|
/**
|
|
2327
2327
|
* @public
|
|
@@ -2342,12 +2342,12 @@ export interface Input {
|
|
|
2342
2342
|
* <p>Information about the configuration of an input.</p>
|
|
2343
2343
|
* @public
|
|
2344
2344
|
*/
|
|
2345
|
-
inputConfiguration?: InputConfiguration;
|
|
2345
|
+
inputConfiguration?: InputConfiguration | undefined;
|
|
2346
2346
|
/**
|
|
2347
2347
|
* <p>The definition of the input.</p>
|
|
2348
2348
|
* @public
|
|
2349
2349
|
*/
|
|
2350
|
-
inputDefinition?: InputDefinition;
|
|
2350
|
+
inputDefinition?: InputDefinition | undefined;
|
|
2351
2351
|
}
|
|
2352
2352
|
/**
|
|
2353
2353
|
* @public
|
|
@@ -2357,7 +2357,7 @@ export interface DescribeInputResponse {
|
|
|
2357
2357
|
* <p>Information about the input.</p>
|
|
2358
2358
|
* @public
|
|
2359
2359
|
*/
|
|
2360
|
-
input?: Input;
|
|
2360
|
+
input?: Input | undefined;
|
|
2361
2361
|
}
|
|
2362
2362
|
/**
|
|
2363
2363
|
* @public
|
|
@@ -2380,7 +2380,7 @@ export interface DetectorDebugOption {
|
|
|
2380
2380
|
* detector model).</p>
|
|
2381
2381
|
* @public
|
|
2382
2382
|
*/
|
|
2383
|
-
keyValue?: string;
|
|
2383
|
+
keyValue?: string | undefined;
|
|
2384
2384
|
}
|
|
2385
2385
|
/**
|
|
2386
2386
|
* @public
|
|
@@ -2420,7 +2420,7 @@ export interface LoggingOptions {
|
|
|
2420
2420
|
* which the logging level is given.</p>
|
|
2421
2421
|
* @public
|
|
2422
2422
|
*/
|
|
2423
|
-
detectorDebugOptions?: DetectorDebugOption[];
|
|
2423
|
+
detectorDebugOptions?: DetectorDebugOption[] | undefined;
|
|
2424
2424
|
}
|
|
2425
2425
|
/**
|
|
2426
2426
|
* @public
|
|
@@ -2430,7 +2430,7 @@ export interface DescribeLoggingOptionsResponse {
|
|
|
2430
2430
|
* <p>The current settings of the AWS IoT Events logging options.</p>
|
|
2431
2431
|
* @public
|
|
2432
2432
|
*/
|
|
2433
|
-
loggingOptions?: LoggingOptions;
|
|
2433
|
+
loggingOptions?: LoggingOptions | undefined;
|
|
2434
2434
|
}
|
|
2435
2435
|
/**
|
|
2436
2436
|
* <p>The requested operation is not supported.</p>
|
|
@@ -2453,17 +2453,17 @@ export interface DetectorModelSummary {
|
|
|
2453
2453
|
* <p>The name of the detector model.</p>
|
|
2454
2454
|
* @public
|
|
2455
2455
|
*/
|
|
2456
|
-
detectorModelName?: string;
|
|
2456
|
+
detectorModelName?: string | undefined;
|
|
2457
2457
|
/**
|
|
2458
2458
|
* <p>A brief description of the detector model.</p>
|
|
2459
2459
|
* @public
|
|
2460
2460
|
*/
|
|
2461
|
-
detectorModelDescription?: string;
|
|
2461
|
+
detectorModelDescription?: string | undefined;
|
|
2462
2462
|
/**
|
|
2463
2463
|
* <p>The time the detector model was created.</p>
|
|
2464
2464
|
* @public
|
|
2465
2465
|
*/
|
|
2466
|
-
creationTime?: Date;
|
|
2466
|
+
creationTime?: Date | undefined;
|
|
2467
2467
|
}
|
|
2468
2468
|
/**
|
|
2469
2469
|
* <p>Information about the detector model version.</p>
|
|
@@ -2474,43 +2474,43 @@ export interface DetectorModelVersionSummary {
|
|
|
2474
2474
|
* <p>The name of the detector model.</p>
|
|
2475
2475
|
* @public
|
|
2476
2476
|
*/
|
|
2477
|
-
detectorModelName?: string;
|
|
2477
|
+
detectorModelName?: string | undefined;
|
|
2478
2478
|
/**
|
|
2479
2479
|
* <p>The ID of the detector model version.</p>
|
|
2480
2480
|
* @public
|
|
2481
2481
|
*/
|
|
2482
|
-
detectorModelVersion?: string;
|
|
2482
|
+
detectorModelVersion?: string | undefined;
|
|
2483
2483
|
/**
|
|
2484
2484
|
* <p>The ARN of the detector model version.</p>
|
|
2485
2485
|
* @public
|
|
2486
2486
|
*/
|
|
2487
|
-
detectorModelArn?: string;
|
|
2487
|
+
detectorModelArn?: string | undefined;
|
|
2488
2488
|
/**
|
|
2489
2489
|
* <p>The ARN of the role that grants the detector model permission to perform its tasks.</p>
|
|
2490
2490
|
* @public
|
|
2491
2491
|
*/
|
|
2492
|
-
roleArn?: string;
|
|
2492
|
+
roleArn?: string | undefined;
|
|
2493
2493
|
/**
|
|
2494
2494
|
* <p>The time the detector model version was created.</p>
|
|
2495
2495
|
* @public
|
|
2496
2496
|
*/
|
|
2497
|
-
creationTime?: Date;
|
|
2497
|
+
creationTime?: Date | undefined;
|
|
2498
2498
|
/**
|
|
2499
2499
|
* <p>The last time the detector model version was updated.</p>
|
|
2500
2500
|
* @public
|
|
2501
2501
|
*/
|
|
2502
|
-
lastUpdateTime?: Date;
|
|
2502
|
+
lastUpdateTime?: Date | undefined;
|
|
2503
2503
|
/**
|
|
2504
2504
|
* <p>The status of the detector model version.</p>
|
|
2505
2505
|
* @public
|
|
2506
2506
|
*/
|
|
2507
|
-
status?: DetectorModelVersionStatus;
|
|
2507
|
+
status?: DetectorModelVersionStatus | undefined;
|
|
2508
2508
|
/**
|
|
2509
2509
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
2510
2510
|
* </p>
|
|
2511
2511
|
* @public
|
|
2512
2512
|
*/
|
|
2513
|
-
evaluationMethod?: EvaluationMethod;
|
|
2513
|
+
evaluationMethod?: EvaluationMethod | undefined;
|
|
2514
2514
|
}
|
|
2515
2515
|
/**
|
|
2516
2516
|
* @public
|
|
@@ -2525,12 +2525,12 @@ export interface GetDetectorModelAnalysisResultsRequest {
|
|
|
2525
2525
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2526
2526
|
* @public
|
|
2527
2527
|
*/
|
|
2528
|
-
nextToken?: string;
|
|
2528
|
+
nextToken?: string | undefined;
|
|
2529
2529
|
/**
|
|
2530
2530
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2531
2531
|
* @public
|
|
2532
2532
|
*/
|
|
2533
|
-
maxResults?: number;
|
|
2533
|
+
maxResults?: number | undefined;
|
|
2534
2534
|
}
|
|
2535
2535
|
/**
|
|
2536
2536
|
* @public
|
|
@@ -2540,13 +2540,13 @@ export interface GetDetectorModelAnalysisResultsResponse {
|
|
|
2540
2540
|
* <p>Contains information about one or more analysis results.</p>
|
|
2541
2541
|
* @public
|
|
2542
2542
|
*/
|
|
2543
|
-
analysisResults?: AnalysisResult[];
|
|
2543
|
+
analysisResults?: AnalysisResult[] | undefined;
|
|
2544
2544
|
/**
|
|
2545
2545
|
* <p>The token that you can use to return the next set of results,
|
|
2546
2546
|
* or <code>null</code> if there are no more results.</p>
|
|
2547
2547
|
* @public
|
|
2548
2548
|
*/
|
|
2549
|
-
nextToken?: string;
|
|
2549
|
+
nextToken?: string | undefined;
|
|
2550
2550
|
}
|
|
2551
2551
|
/**
|
|
2552
2552
|
* <p>
|
|
@@ -2598,7 +2598,7 @@ export interface IotSiteWiseInputIdentifier {
|
|
|
2598
2598
|
* </p>
|
|
2599
2599
|
* @public
|
|
2600
2600
|
*/
|
|
2601
|
-
iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier;
|
|
2601
|
+
iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier | undefined;
|
|
2602
2602
|
}
|
|
2603
2603
|
/**
|
|
2604
2604
|
* <p>
|
|
@@ -2613,14 +2613,14 @@ export interface InputIdentifier {
|
|
|
2613
2613
|
* </p>
|
|
2614
2614
|
* @public
|
|
2615
2615
|
*/
|
|
2616
|
-
iotEventsInputIdentifier?: IotEventsInputIdentifier;
|
|
2616
|
+
iotEventsInputIdentifier?: IotEventsInputIdentifier | undefined;
|
|
2617
2617
|
/**
|
|
2618
2618
|
* <p>
|
|
2619
2619
|
* The identifer of the input routed from AWS IoT SiteWise.
|
|
2620
2620
|
* </p>
|
|
2621
2621
|
* @public
|
|
2622
2622
|
*/
|
|
2623
|
-
iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier;
|
|
2623
|
+
iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier | undefined;
|
|
2624
2624
|
}
|
|
2625
2625
|
/**
|
|
2626
2626
|
* <p>Information about the input.</p>
|
|
@@ -2631,32 +2631,32 @@ export interface InputSummary {
|
|
|
2631
2631
|
* <p>The name of the input.</p>
|
|
2632
2632
|
* @public
|
|
2633
2633
|
*/
|
|
2634
|
-
inputName?: string;
|
|
2634
|
+
inputName?: string | undefined;
|
|
2635
2635
|
/**
|
|
2636
2636
|
* <p>A brief description of the input.</p>
|
|
2637
2637
|
* @public
|
|
2638
2638
|
*/
|
|
2639
|
-
inputDescription?: string;
|
|
2639
|
+
inputDescription?: string | undefined;
|
|
2640
2640
|
/**
|
|
2641
2641
|
* <p>The ARN of the input.</p>
|
|
2642
2642
|
* @public
|
|
2643
2643
|
*/
|
|
2644
|
-
inputArn?: string;
|
|
2644
|
+
inputArn?: string | undefined;
|
|
2645
2645
|
/**
|
|
2646
2646
|
* <p>The time the input was created.</p>
|
|
2647
2647
|
* @public
|
|
2648
2648
|
*/
|
|
2649
|
-
creationTime?: Date;
|
|
2649
|
+
creationTime?: Date | undefined;
|
|
2650
2650
|
/**
|
|
2651
2651
|
* <p>The last time the input was updated.</p>
|
|
2652
2652
|
* @public
|
|
2653
2653
|
*/
|
|
2654
|
-
lastUpdateTime?: Date;
|
|
2654
|
+
lastUpdateTime?: Date | undefined;
|
|
2655
2655
|
/**
|
|
2656
2656
|
* <p>The status of the input.</p>
|
|
2657
2657
|
* @public
|
|
2658
2658
|
*/
|
|
2659
|
-
status?: InputStatus;
|
|
2659
|
+
status?: InputStatus | undefined;
|
|
2660
2660
|
}
|
|
2661
2661
|
/**
|
|
2662
2662
|
* @public
|
|
@@ -2666,12 +2666,12 @@ export interface ListAlarmModelsRequest {
|
|
|
2666
2666
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2667
2667
|
* @public
|
|
2668
2668
|
*/
|
|
2669
|
-
nextToken?: string;
|
|
2669
|
+
nextToken?: string | undefined;
|
|
2670
2670
|
/**
|
|
2671
2671
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2672
2672
|
* @public
|
|
2673
2673
|
*/
|
|
2674
|
-
maxResults?: number;
|
|
2674
|
+
maxResults?: number | undefined;
|
|
2675
2675
|
}
|
|
2676
2676
|
/**
|
|
2677
2677
|
* @public
|
|
@@ -2681,13 +2681,13 @@ export interface ListAlarmModelsResponse {
|
|
|
2681
2681
|
* <p>A list that summarizes each alarm model.</p>
|
|
2682
2682
|
* @public
|
|
2683
2683
|
*/
|
|
2684
|
-
alarmModelSummaries?: AlarmModelSummary[];
|
|
2684
|
+
alarmModelSummaries?: AlarmModelSummary[] | undefined;
|
|
2685
2685
|
/**
|
|
2686
2686
|
* <p>The token that you can use to return the next set of results,
|
|
2687
2687
|
* or <code>null</code> if there are no more results.</p>
|
|
2688
2688
|
* @public
|
|
2689
2689
|
*/
|
|
2690
|
-
nextToken?: string;
|
|
2690
|
+
nextToken?: string | undefined;
|
|
2691
2691
|
}
|
|
2692
2692
|
/**
|
|
2693
2693
|
* @public
|
|
@@ -2702,12 +2702,12 @@ export interface ListAlarmModelVersionsRequest {
|
|
|
2702
2702
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2703
2703
|
* @public
|
|
2704
2704
|
*/
|
|
2705
|
-
nextToken?: string;
|
|
2705
|
+
nextToken?: string | undefined;
|
|
2706
2706
|
/**
|
|
2707
2707
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2708
2708
|
* @public
|
|
2709
2709
|
*/
|
|
2710
|
-
maxResults?: number;
|
|
2710
|
+
maxResults?: number | undefined;
|
|
2711
2711
|
}
|
|
2712
2712
|
/**
|
|
2713
2713
|
* @public
|
|
@@ -2717,13 +2717,13 @@ export interface ListAlarmModelVersionsResponse {
|
|
|
2717
2717
|
* <p>A list that summarizes each alarm model version.</p>
|
|
2718
2718
|
* @public
|
|
2719
2719
|
*/
|
|
2720
|
-
alarmModelVersionSummaries?: AlarmModelVersionSummary[];
|
|
2720
|
+
alarmModelVersionSummaries?: AlarmModelVersionSummary[] | undefined;
|
|
2721
2721
|
/**
|
|
2722
2722
|
* <p>The token that you can use to return the next set of results,
|
|
2723
2723
|
* or <code>null</code> if there are no more results.</p>
|
|
2724
2724
|
* @public
|
|
2725
2725
|
*/
|
|
2726
|
-
nextToken?: string;
|
|
2726
|
+
nextToken?: string | undefined;
|
|
2727
2727
|
}
|
|
2728
2728
|
/**
|
|
2729
2729
|
* @public
|
|
@@ -2733,12 +2733,12 @@ export interface ListDetectorModelsRequest {
|
|
|
2733
2733
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2734
2734
|
* @public
|
|
2735
2735
|
*/
|
|
2736
|
-
nextToken?: string;
|
|
2736
|
+
nextToken?: string | undefined;
|
|
2737
2737
|
/**
|
|
2738
2738
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2739
2739
|
* @public
|
|
2740
2740
|
*/
|
|
2741
|
-
maxResults?: number;
|
|
2741
|
+
maxResults?: number | undefined;
|
|
2742
2742
|
}
|
|
2743
2743
|
/**
|
|
2744
2744
|
* @public
|
|
@@ -2748,13 +2748,13 @@ export interface ListDetectorModelsResponse {
|
|
|
2748
2748
|
* <p>Summary information about the detector models.</p>
|
|
2749
2749
|
* @public
|
|
2750
2750
|
*/
|
|
2751
|
-
detectorModelSummaries?: DetectorModelSummary[];
|
|
2751
|
+
detectorModelSummaries?: DetectorModelSummary[] | undefined;
|
|
2752
2752
|
/**
|
|
2753
2753
|
* <p>The token that you can use to return the next set of results,
|
|
2754
2754
|
* or <code>null</code> if there are no more results.</p>
|
|
2755
2755
|
* @public
|
|
2756
2756
|
*/
|
|
2757
|
-
nextToken?: string;
|
|
2757
|
+
nextToken?: string | undefined;
|
|
2758
2758
|
}
|
|
2759
2759
|
/**
|
|
2760
2760
|
* @public
|
|
@@ -2769,12 +2769,12 @@ export interface ListDetectorModelVersionsRequest {
|
|
|
2769
2769
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2770
2770
|
* @public
|
|
2771
2771
|
*/
|
|
2772
|
-
nextToken?: string;
|
|
2772
|
+
nextToken?: string | undefined;
|
|
2773
2773
|
/**
|
|
2774
2774
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2775
2775
|
* @public
|
|
2776
2776
|
*/
|
|
2777
|
-
maxResults?: number;
|
|
2777
|
+
maxResults?: number | undefined;
|
|
2778
2778
|
}
|
|
2779
2779
|
/**
|
|
2780
2780
|
* @public
|
|
@@ -2784,13 +2784,13 @@ export interface ListDetectorModelVersionsResponse {
|
|
|
2784
2784
|
* <p>Summary information about the detector model versions.</p>
|
|
2785
2785
|
* @public
|
|
2786
2786
|
*/
|
|
2787
|
-
detectorModelVersionSummaries?: DetectorModelVersionSummary[];
|
|
2787
|
+
detectorModelVersionSummaries?: DetectorModelVersionSummary[] | undefined;
|
|
2788
2788
|
/**
|
|
2789
2789
|
* <p>The token that you can use to return the next set of results,
|
|
2790
2790
|
* or <code>null</code> if there are no more results.</p>
|
|
2791
2791
|
* @public
|
|
2792
2792
|
*/
|
|
2793
|
-
nextToken?: string;
|
|
2793
|
+
nextToken?: string | undefined;
|
|
2794
2794
|
}
|
|
2795
2795
|
/**
|
|
2796
2796
|
* @public
|
|
@@ -2809,14 +2809,14 @@ export interface ListInputRoutingsRequest {
|
|
|
2809
2809
|
* </p>
|
|
2810
2810
|
* @public
|
|
2811
2811
|
*/
|
|
2812
|
-
maxResults?: number;
|
|
2812
|
+
maxResults?: number | undefined;
|
|
2813
2813
|
/**
|
|
2814
2814
|
* <p>
|
|
2815
2815
|
* The token that you can use to return the next set of results.
|
|
2816
2816
|
* </p>
|
|
2817
2817
|
* @public
|
|
2818
2818
|
*/
|
|
2819
|
-
nextToken?: string;
|
|
2819
|
+
nextToken?: string | undefined;
|
|
2820
2820
|
}
|
|
2821
2821
|
/**
|
|
2822
2822
|
* <p>
|
|
@@ -2831,14 +2831,14 @@ export interface RoutedResource {
|
|
|
2831
2831
|
* </p>
|
|
2832
2832
|
* @public
|
|
2833
2833
|
*/
|
|
2834
|
-
name?: string;
|
|
2834
|
+
name?: string | undefined;
|
|
2835
2835
|
/**
|
|
2836
2836
|
* <p>
|
|
2837
2837
|
* 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>.
|
|
2838
2838
|
* </p>
|
|
2839
2839
|
* @public
|
|
2840
2840
|
*/
|
|
2841
|
-
arn?: string;
|
|
2841
|
+
arn?: string | undefined;
|
|
2842
2842
|
}
|
|
2843
2843
|
/**
|
|
2844
2844
|
* @public
|
|
@@ -2850,7 +2850,7 @@ export interface ListInputRoutingsResponse {
|
|
|
2850
2850
|
* </p>
|
|
2851
2851
|
* @public
|
|
2852
2852
|
*/
|
|
2853
|
-
routedResources?: RoutedResource[];
|
|
2853
|
+
routedResources?: RoutedResource[] | undefined;
|
|
2854
2854
|
/**
|
|
2855
2855
|
* <p>
|
|
2856
2856
|
* The token that you can use to return the next set of results,
|
|
@@ -2858,7 +2858,7 @@ export interface ListInputRoutingsResponse {
|
|
|
2858
2858
|
* </p>
|
|
2859
2859
|
* @public
|
|
2860
2860
|
*/
|
|
2861
|
-
nextToken?: string;
|
|
2861
|
+
nextToken?: string | undefined;
|
|
2862
2862
|
}
|
|
2863
2863
|
/**
|
|
2864
2864
|
* @public
|
|
@@ -2868,12 +2868,12 @@ export interface ListInputsRequest {
|
|
|
2868
2868
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2869
2869
|
* @public
|
|
2870
2870
|
*/
|
|
2871
|
-
nextToken?: string;
|
|
2871
|
+
nextToken?: string | undefined;
|
|
2872
2872
|
/**
|
|
2873
2873
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2874
2874
|
* @public
|
|
2875
2875
|
*/
|
|
2876
|
-
maxResults?: number;
|
|
2876
|
+
maxResults?: number | undefined;
|
|
2877
2877
|
}
|
|
2878
2878
|
/**
|
|
2879
2879
|
* @public
|
|
@@ -2883,13 +2883,13 @@ export interface ListInputsResponse {
|
|
|
2883
2883
|
* <p>Summary information about the inputs.</p>
|
|
2884
2884
|
* @public
|
|
2885
2885
|
*/
|
|
2886
|
-
inputSummaries?: InputSummary[];
|
|
2886
|
+
inputSummaries?: InputSummary[] | undefined;
|
|
2887
2887
|
/**
|
|
2888
2888
|
* <p>The token that you can use to return the next set of results,
|
|
2889
2889
|
* or <code>null</code> if there are no more results.</p>
|
|
2890
2890
|
* @public
|
|
2891
2891
|
*/
|
|
2892
|
-
nextToken?: string;
|
|
2892
|
+
nextToken?: string | undefined;
|
|
2893
2893
|
}
|
|
2894
2894
|
/**
|
|
2895
2895
|
* @public
|
|
@@ -2909,7 +2909,7 @@ export interface ListTagsForResourceResponse {
|
|
|
2909
2909
|
* <p>The list of tags assigned to the resource.</p>
|
|
2910
2910
|
* @public
|
|
2911
2911
|
*/
|
|
2912
|
-
tags?: Tag[];
|
|
2912
|
+
tags?: Tag[] | undefined;
|
|
2913
2913
|
}
|
|
2914
2914
|
/**
|
|
2915
2915
|
* @public
|
|
@@ -2939,7 +2939,7 @@ export interface StartDetectorModelAnalysisResponse {
|
|
|
2939
2939
|
* <p>The ID that you can use to retrieve the analysis result.</p>
|
|
2940
2940
|
* @public
|
|
2941
2941
|
*/
|
|
2942
|
-
analysisId?: string;
|
|
2942
|
+
analysisId?: string | undefined;
|
|
2943
2943
|
}
|
|
2944
2944
|
/**
|
|
2945
2945
|
* @public
|
|
@@ -2994,7 +2994,7 @@ export interface UpdateAlarmModelRequest {
|
|
|
2994
2994
|
* <p>The description of the alarm model.</p>
|
|
2995
2995
|
* @public
|
|
2996
2996
|
*/
|
|
2997
|
-
alarmModelDescription?: string;
|
|
2997
|
+
alarmModelDescription?: string | undefined;
|
|
2998
2998
|
/**
|
|
2999
2999
|
* <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>
|
|
3000
3000
|
* @public
|
|
@@ -3004,7 +3004,7 @@ export interface UpdateAlarmModelRequest {
|
|
|
3004
3004
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
3005
3005
|
* @public
|
|
3006
3006
|
*/
|
|
3007
|
-
severity?: number;
|
|
3007
|
+
severity?: number | undefined;
|
|
3008
3008
|
/**
|
|
3009
3009
|
* <p>Defines when your alarm is invoked.</p>
|
|
3010
3010
|
* @public
|
|
@@ -3014,17 +3014,17 @@ export interface UpdateAlarmModelRequest {
|
|
|
3014
3014
|
* <p>Contains information about one or more notification actions.</p>
|
|
3015
3015
|
* @public
|
|
3016
3016
|
*/
|
|
3017
|
-
alarmNotification?: AlarmNotification;
|
|
3017
|
+
alarmNotification?: AlarmNotification | undefined;
|
|
3018
3018
|
/**
|
|
3019
3019
|
* <p>Contains information about one or more alarm actions.</p>
|
|
3020
3020
|
* @public
|
|
3021
3021
|
*/
|
|
3022
|
-
alarmEventActions?: AlarmEventActions;
|
|
3022
|
+
alarmEventActions?: AlarmEventActions | undefined;
|
|
3023
3023
|
/**
|
|
3024
3024
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
3025
3025
|
* @public
|
|
3026
3026
|
*/
|
|
3027
|
-
alarmCapabilities?: AlarmCapabilities;
|
|
3027
|
+
alarmCapabilities?: AlarmCapabilities | undefined;
|
|
3028
3028
|
}
|
|
3029
3029
|
/**
|
|
3030
3030
|
* @public
|
|
@@ -3034,22 +3034,22 @@ export interface UpdateAlarmModelResponse {
|
|
|
3034
3034
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
3035
3035
|
* @public
|
|
3036
3036
|
*/
|
|
3037
|
-
creationTime?: Date;
|
|
3037
|
+
creationTime?: Date | undefined;
|
|
3038
3038
|
/**
|
|
3039
3039
|
* <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>
|
|
3040
3040
|
* @public
|
|
3041
3041
|
*/
|
|
3042
|
-
alarmModelArn?: string;
|
|
3042
|
+
alarmModelArn?: string | undefined;
|
|
3043
3043
|
/**
|
|
3044
3044
|
* <p>The version of the alarm model.</p>
|
|
3045
3045
|
* @public
|
|
3046
3046
|
*/
|
|
3047
|
-
alarmModelVersion?: string;
|
|
3047
|
+
alarmModelVersion?: string | undefined;
|
|
3048
3048
|
/**
|
|
3049
3049
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
3050
3050
|
* @public
|
|
3051
3051
|
*/
|
|
3052
|
-
lastUpdateTime?: Date;
|
|
3052
|
+
lastUpdateTime?: Date | undefined;
|
|
3053
3053
|
/**
|
|
3054
3054
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
3055
3055
|
* <ul>
|
|
@@ -3075,7 +3075,7 @@ export interface UpdateAlarmModelResponse {
|
|
|
3075
3075
|
* </ul>
|
|
3076
3076
|
* @public
|
|
3077
3077
|
*/
|
|
3078
|
-
status?: AlarmModelVersionStatus;
|
|
3078
|
+
status?: AlarmModelVersionStatus | undefined;
|
|
3079
3079
|
}
|
|
3080
3080
|
/**
|
|
3081
3081
|
* @public
|
|
@@ -3095,7 +3095,7 @@ export interface UpdateDetectorModelRequest {
|
|
|
3095
3095
|
* <p>A brief description of the detector model.</p>
|
|
3096
3096
|
* @public
|
|
3097
3097
|
*/
|
|
3098
|
-
detectorModelDescription?: string;
|
|
3098
|
+
detectorModelDescription?: string | undefined;
|
|
3099
3099
|
/**
|
|
3100
3100
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
3101
3101
|
* @public
|
|
@@ -3106,7 +3106,7 @@ export interface UpdateDetectorModelRequest {
|
|
|
3106
3106
|
* </p>
|
|
3107
3107
|
* @public
|
|
3108
3108
|
*/
|
|
3109
|
-
evaluationMethod?: EvaluationMethod;
|
|
3109
|
+
evaluationMethod?: EvaluationMethod | undefined;
|
|
3110
3110
|
}
|
|
3111
3111
|
/**
|
|
3112
3112
|
* @public
|
|
@@ -3116,7 +3116,7 @@ export interface UpdateDetectorModelResponse {
|
|
|
3116
3116
|
* <p>Information about how the detector model is configured.</p>
|
|
3117
3117
|
* @public
|
|
3118
3118
|
*/
|
|
3119
|
-
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
3119
|
+
detectorModelConfiguration?: DetectorModelConfiguration | undefined;
|
|
3120
3120
|
}
|
|
3121
3121
|
/**
|
|
3122
3122
|
* @public
|
|
@@ -3131,7 +3131,7 @@ export interface UpdateInputRequest {
|
|
|
3131
3131
|
* <p>A brief description of the input.</p>
|
|
3132
3132
|
* @public
|
|
3133
3133
|
*/
|
|
3134
|
-
inputDescription?: string;
|
|
3134
|
+
inputDescription?: string | undefined;
|
|
3135
3135
|
/**
|
|
3136
3136
|
* <p>The definition of the input.</p>
|
|
3137
3137
|
* @public
|
|
@@ -3146,5 +3146,5 @@ export interface UpdateInputResponse {
|
|
|
3146
3146
|
* <p>Information about the configuration of the input.</p>
|
|
3147
3147
|
* @public
|
|
3148
3148
|
*/
|
|
3149
|
-
inputConfiguration?: InputConfiguration;
|
|
3149
|
+
inputConfiguration?: InputConfiguration | undefined;
|
|
3150
3150
|
}
|