@aws-sdk/client-iotsitewise 3.686.0 → 3.691.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.
|
@@ -77,22 +77,22 @@ export interface Identity {
|
|
|
77
77
|
* <p>An IAM Identity Center user identity.</p>
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
|
-
user?: UserIdentity;
|
|
80
|
+
user?: UserIdentity | undefined;
|
|
81
81
|
/**
|
|
82
82
|
* <p>An IAM Identity Center group identity.</p>
|
|
83
83
|
* @public
|
|
84
84
|
*/
|
|
85
|
-
group?: GroupIdentity;
|
|
85
|
+
group?: GroupIdentity | undefined;
|
|
86
86
|
/**
|
|
87
87
|
* <p>An IAM user identity.</p>
|
|
88
88
|
* @public
|
|
89
89
|
*/
|
|
90
|
-
iamUser?: IAMUserIdentity;
|
|
90
|
+
iamUser?: IAMUserIdentity | undefined;
|
|
91
91
|
/**
|
|
92
92
|
* <p>An IAM role identity.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
|
-
iamRole?: IAMRoleIdentity;
|
|
95
|
+
iamRole?: IAMRoleIdentity | undefined;
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
98
|
* @public
|
|
@@ -137,12 +137,12 @@ export interface Resource {
|
|
|
137
137
|
* <p>A portal resource.</p>
|
|
138
138
|
* @public
|
|
139
139
|
*/
|
|
140
|
-
portal?: PortalResource;
|
|
140
|
+
portal?: PortalResource | undefined;
|
|
141
141
|
/**
|
|
142
142
|
* <p>A project resource.</p>
|
|
143
143
|
* @public
|
|
144
144
|
*/
|
|
145
|
-
project?: ProjectResource;
|
|
145
|
+
project?: ProjectResource | undefined;
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
148
|
* <p>Contains an access policy that defines an identity's access to an IoT SiteWise Monitor
|
|
@@ -175,12 +175,12 @@ export interface AccessPolicySummary {
|
|
|
175
175
|
* <p>The date the access policy was created, in Unix epoch time.</p>
|
|
176
176
|
* @public
|
|
177
177
|
*/
|
|
178
|
-
creationDate?: Date;
|
|
178
|
+
creationDate?: Date | undefined;
|
|
179
179
|
/**
|
|
180
180
|
* <p>The date the access policy was last updated, in Unix epoch time.</p>
|
|
181
181
|
* @public
|
|
182
182
|
*/
|
|
183
|
-
lastUpdateDate?: Date;
|
|
183
|
+
lastUpdateDate?: Date | undefined;
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
186
|
* <p>Contains a definition for an action.</p>
|
|
@@ -234,17 +234,17 @@ export interface ActionSummary {
|
|
|
234
234
|
* <p>The ID of the action.</p>
|
|
235
235
|
* @public
|
|
236
236
|
*/
|
|
237
|
-
actionId?: string;
|
|
237
|
+
actionId?: string | undefined;
|
|
238
238
|
/**
|
|
239
239
|
* <p>The ID of the action definition.</p>
|
|
240
240
|
* @public
|
|
241
241
|
*/
|
|
242
|
-
actionDefinitionId?: string;
|
|
242
|
+
actionDefinitionId?: string | undefined;
|
|
243
243
|
/**
|
|
244
244
|
* <p>The resource the action will be taken on.</p>
|
|
245
245
|
* @public
|
|
246
246
|
*/
|
|
247
|
-
targetResource?: TargetResource;
|
|
247
|
+
targetResource?: TargetResource | undefined;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
250
|
* @public
|
|
@@ -268,32 +268,32 @@ export interface Aggregates {
|
|
|
268
268
|
* <p>The average (mean) value of the time series over a time interval window.</p>
|
|
269
269
|
* @public
|
|
270
270
|
*/
|
|
271
|
-
average?: number;
|
|
271
|
+
average?: number | undefined;
|
|
272
272
|
/**
|
|
273
273
|
* <p>The count of data points in the time series over a time interval window.</p>
|
|
274
274
|
* @public
|
|
275
275
|
*/
|
|
276
|
-
count?: number;
|
|
276
|
+
count?: number | undefined;
|
|
277
277
|
/**
|
|
278
278
|
* <p>The maximum value of the time series over a time interval window.</p>
|
|
279
279
|
* @public
|
|
280
280
|
*/
|
|
281
|
-
maximum?: number;
|
|
281
|
+
maximum?: number | undefined;
|
|
282
282
|
/**
|
|
283
283
|
* <p>The minimum value of the time series over a time interval window.</p>
|
|
284
284
|
* @public
|
|
285
285
|
*/
|
|
286
|
-
minimum?: number;
|
|
286
|
+
minimum?: number | undefined;
|
|
287
287
|
/**
|
|
288
288
|
* <p>The sum of the time series over a time interval window.</p>
|
|
289
289
|
* @public
|
|
290
290
|
*/
|
|
291
|
-
sum?: number;
|
|
291
|
+
sum?: number | undefined;
|
|
292
292
|
/**
|
|
293
293
|
* <p>The standard deviation of the time series over a time interval window.</p>
|
|
294
294
|
* @public
|
|
295
295
|
*/
|
|
296
|
-
standardDeviation?: number;
|
|
296
|
+
standardDeviation?: number | undefined;
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
299
|
* <p>Contains aggregated asset property values (for example, average, minimum, and
|
|
@@ -310,7 +310,7 @@ export interface AggregatedValue {
|
|
|
310
310
|
* <p>The quality of the aggregated data.</p>
|
|
311
311
|
* @public
|
|
312
312
|
*/
|
|
313
|
-
quality?: Quality;
|
|
313
|
+
quality?: Quality | undefined;
|
|
314
314
|
/**
|
|
315
315
|
* <p>The value of the aggregates.</p>
|
|
316
316
|
* @public
|
|
@@ -352,7 +352,7 @@ export interface Alarms {
|
|
|
352
352
|
* notifications</a> in the <i>IoT Events Developer Guide</i>.</p>
|
|
353
353
|
* @public
|
|
354
354
|
*/
|
|
355
|
-
notificationLambdaArn?: string;
|
|
355
|
+
notificationLambdaArn?: string | undefined;
|
|
356
356
|
}
|
|
357
357
|
/**
|
|
358
358
|
* @public
|
|
@@ -407,12 +407,12 @@ export interface AssetPropertyPathSegment {
|
|
|
407
407
|
* <p>The ID of the path segment.</p>
|
|
408
408
|
* @public
|
|
409
409
|
*/
|
|
410
|
-
id?: string;
|
|
410
|
+
id?: string | undefined;
|
|
411
411
|
/**
|
|
412
412
|
* <p>The name of the path segment.</p>
|
|
413
413
|
* @public
|
|
414
414
|
*/
|
|
415
|
-
name?: string;
|
|
415
|
+
name?: string | undefined;
|
|
416
416
|
}
|
|
417
417
|
/**
|
|
418
418
|
* <p>Contains asset property information.</p>
|
|
@@ -436,12 +436,12 @@ export interface AssetProperty {
|
|
|
436
436
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
437
437
|
* @public
|
|
438
438
|
*/
|
|
439
|
-
alias?: string;
|
|
439
|
+
alias?: string | undefined;
|
|
440
440
|
/**
|
|
441
441
|
* <p>The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
442
442
|
* @public
|
|
443
443
|
*/
|
|
444
|
-
notification?: PropertyNotification;
|
|
444
|
+
notification?: PropertyNotification | undefined;
|
|
445
445
|
/**
|
|
446
446
|
* <p>The data type of the asset property.</p>
|
|
447
447
|
* @public
|
|
@@ -452,22 +452,22 @@ export interface AssetProperty {
|
|
|
452
452
|
* have the <code>STRUCT</code> data type.</p>
|
|
453
453
|
* @public
|
|
454
454
|
*/
|
|
455
|
-
dataTypeSpec?: string;
|
|
455
|
+
dataTypeSpec?: string | undefined;
|
|
456
456
|
/**
|
|
457
457
|
* <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.</p>
|
|
458
458
|
* @public
|
|
459
459
|
*/
|
|
460
|
-
unit?: string;
|
|
460
|
+
unit?: string | undefined;
|
|
461
461
|
/**
|
|
462
462
|
* <p>The structured path to the property from the root of the asset.</p>
|
|
463
463
|
* @public
|
|
464
464
|
*/
|
|
465
|
-
path?: AssetPropertyPathSegment[];
|
|
465
|
+
path?: AssetPropertyPathSegment[] | undefined;
|
|
466
466
|
/**
|
|
467
467
|
* <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
468
468
|
* @public
|
|
469
469
|
*/
|
|
470
|
-
externalId?: string;
|
|
470
|
+
externalId?: string | undefined;
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
473
|
* <p>Contains information about a composite model in an asset. This object contains the asset's
|
|
@@ -484,7 +484,7 @@ export interface AssetCompositeModel {
|
|
|
484
484
|
* <p>The description of the composite model.</p>
|
|
485
485
|
* @public
|
|
486
486
|
*/
|
|
487
|
-
description?: string;
|
|
487
|
+
description?: string | undefined;
|
|
488
488
|
/**
|
|
489
489
|
* <p>The type of the composite model. For alarm composite models, this type is
|
|
490
490
|
* <code>AWS/ALARM</code>.</p>
|
|
@@ -500,12 +500,12 @@ export interface AssetCompositeModel {
|
|
|
500
500
|
* <p> The ID of the asset composite model. </p>
|
|
501
501
|
* @public
|
|
502
502
|
*/
|
|
503
|
-
id?: string;
|
|
503
|
+
id?: string | undefined;
|
|
504
504
|
/**
|
|
505
505
|
* <p>The external ID of the asset composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
506
506
|
* @public
|
|
507
507
|
*/
|
|
508
|
-
externalId?: string;
|
|
508
|
+
externalId?: string | undefined;
|
|
509
509
|
}
|
|
510
510
|
/**
|
|
511
511
|
* <p>Represents one level between a composite model and the root of the asset.</p>
|
|
@@ -516,12 +516,12 @@ export interface AssetCompositeModelPathSegment {
|
|
|
516
516
|
* <p>The ID of the path segment.</p>
|
|
517
517
|
* @public
|
|
518
518
|
*/
|
|
519
|
-
id?: string;
|
|
519
|
+
id?: string | undefined;
|
|
520
520
|
/**
|
|
521
521
|
* <p>The name of the path segment.</p>
|
|
522
522
|
* @public
|
|
523
523
|
*/
|
|
524
|
-
name?: string;
|
|
524
|
+
name?: string | undefined;
|
|
525
525
|
}
|
|
526
526
|
/**
|
|
527
527
|
* <p>Contains a summary of the composite model for a specific asset.</p>
|
|
@@ -541,7 +541,7 @@ export interface AssetCompositeModelSummary {
|
|
|
541
541
|
* of.</p>
|
|
542
542
|
* @public
|
|
543
543
|
*/
|
|
544
|
-
externalId?: string;
|
|
544
|
+
externalId?: string | undefined;
|
|
545
545
|
/**
|
|
546
546
|
* <p>The name of the composite model that this summary describes.</p>
|
|
547
547
|
* @public
|
|
@@ -616,7 +616,7 @@ export interface AssetHierarchy {
|
|
|
616
616
|
* <p>The ID of the hierarchy. This ID is a <code>hierarchyId</code>.</p>
|
|
617
617
|
* @public
|
|
618
618
|
*/
|
|
619
|
-
id?: string;
|
|
619
|
+
id?: string | undefined;
|
|
620
620
|
/**
|
|
621
621
|
* <p>The hierarchy name provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
622
622
|
* API operation.</p>
|
|
@@ -629,7 +629,7 @@ export interface AssetHierarchy {
|
|
|
629
629
|
* an asset hierarchy that already has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
630
630
|
* @public
|
|
631
631
|
*/
|
|
632
|
-
externalId?: string;
|
|
632
|
+
externalId?: string | undefined;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
635
|
* <p>Contains information about a parent asset and a child asset that are related through an
|
|
@@ -641,12 +641,12 @@ export interface AssetHierarchyInfo {
|
|
|
641
641
|
* <p>The ID of the parent asset in this asset relationship.</p>
|
|
642
642
|
* @public
|
|
643
643
|
*/
|
|
644
|
-
parentAssetId?: string;
|
|
644
|
+
parentAssetId?: string | undefined;
|
|
645
645
|
/**
|
|
646
646
|
* <p>The ID of the child asset in this asset relationship.</p>
|
|
647
647
|
* @public
|
|
648
648
|
*/
|
|
649
|
-
childAssetId?: string;
|
|
649
|
+
childAssetId?: string | undefined;
|
|
650
650
|
}
|
|
651
651
|
/**
|
|
652
652
|
* <p>Represents one level between a property and the root of the asset model.</p>
|
|
@@ -657,12 +657,12 @@ export interface AssetModelPropertyPathSegment {
|
|
|
657
657
|
* <p>The ID of the path segment.</p>
|
|
658
658
|
* @public
|
|
659
659
|
*/
|
|
660
|
-
id?: string;
|
|
660
|
+
id?: string | undefined;
|
|
661
661
|
/**
|
|
662
662
|
* <p>The name of the path segment.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
name?: string;
|
|
665
|
+
name?: string | undefined;
|
|
666
666
|
}
|
|
667
667
|
/**
|
|
668
668
|
* <p>Contains an asset attribute property. For more information, see
|
|
@@ -677,7 +677,7 @@ export interface Attribute {
|
|
|
677
677
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
678
678
|
* @public
|
|
679
679
|
*/
|
|
680
|
-
defaultValue?: string;
|
|
680
|
+
defaultValue?: string | undefined;
|
|
681
681
|
}
|
|
682
682
|
/**
|
|
683
683
|
* @public
|
|
@@ -727,7 +727,7 @@ export interface Measurement {
|
|
|
727
727
|
* By default, measurements are forwarded to the cloud.</p>
|
|
728
728
|
* @public
|
|
729
729
|
*/
|
|
730
|
-
processingConfig?: MeasurementProcessingConfig;
|
|
730
|
+
processingConfig?: MeasurementProcessingConfig | undefined;
|
|
731
731
|
}
|
|
732
732
|
/**
|
|
733
733
|
* @public
|
|
@@ -765,7 +765,7 @@ export interface VariableValue {
|
|
|
765
765
|
* <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
766
766
|
* @public
|
|
767
767
|
*/
|
|
768
|
-
propertyId?: string;
|
|
768
|
+
propertyId?: string | undefined;
|
|
769
769
|
/**
|
|
770
770
|
* <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name
|
|
771
771
|
* instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify
|
|
@@ -776,12 +776,12 @@ export interface VariableValue {
|
|
|
776
776
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
777
777
|
* @public
|
|
778
778
|
*/
|
|
779
|
-
hierarchyId?: string;
|
|
779
|
+
hierarchyId?: string | undefined;
|
|
780
780
|
/**
|
|
781
781
|
* <p>The path of the property.</p>
|
|
782
782
|
* @public
|
|
783
783
|
*/
|
|
784
|
-
propertyPath?: AssetModelPropertyPathSegment[];
|
|
784
|
+
propertyPath?: AssetModelPropertyPathSegment[] | undefined;
|
|
785
785
|
}
|
|
786
786
|
/**
|
|
787
787
|
* <p>Contains expression variable information.</p>
|
|
@@ -887,7 +887,7 @@ export interface TumblingWindow {
|
|
|
887
887
|
* </ul>
|
|
888
888
|
* @public
|
|
889
889
|
*/
|
|
890
|
-
offset?: string;
|
|
890
|
+
offset?: string | undefined;
|
|
891
891
|
}
|
|
892
892
|
/**
|
|
893
893
|
* <p>Contains a time interval window used for data aggregate computations (for example,
|
|
@@ -899,7 +899,7 @@ export interface MetricWindow {
|
|
|
899
899
|
* <p>The tumbling time interval window.</p>
|
|
900
900
|
* @public
|
|
901
901
|
*/
|
|
902
|
-
tumbling?: TumblingWindow;
|
|
902
|
+
tumbling?: TumblingWindow | undefined;
|
|
903
903
|
}
|
|
904
904
|
/**
|
|
905
905
|
* <p>Contains an asset metric property. With metrics, you can calculate aggregate functions,
|
|
@@ -939,7 +939,7 @@ export interface Metric {
|
|
|
939
939
|
* By default, metrics are forwarded to the cloud.</p>
|
|
940
940
|
* @public
|
|
941
941
|
*/
|
|
942
|
-
processingConfig?: MetricProcessingConfig;
|
|
942
|
+
processingConfig?: MetricProcessingConfig | undefined;
|
|
943
943
|
}
|
|
944
944
|
/**
|
|
945
945
|
* <p>The processing configuration for the given transform property.
|
|
@@ -957,7 +957,7 @@ export interface TransformProcessingConfig {
|
|
|
957
957
|
* <p>The forwarding configuration for a given property.</p>
|
|
958
958
|
* @public
|
|
959
959
|
*/
|
|
960
|
-
forwardingConfig?: ForwardingConfig;
|
|
960
|
+
forwardingConfig?: ForwardingConfig | undefined;
|
|
961
961
|
}
|
|
962
962
|
/**
|
|
963
963
|
* <p>Contains an asset transform property. A transform is a one-to-one mapping of a property's
|
|
@@ -988,7 +988,7 @@ export interface Transform {
|
|
|
988
988
|
* You can also configure transforms to be computed at the edge or in the cloud.</p>
|
|
989
989
|
* @public
|
|
990
990
|
*/
|
|
991
|
-
processingConfig?: TransformProcessingConfig;
|
|
991
|
+
processingConfig?: TransformProcessingConfig | undefined;
|
|
992
992
|
}
|
|
993
993
|
/**
|
|
994
994
|
* <p>Contains a property type, which can be one of <code>attribute</code>,
|
|
@@ -1001,27 +1001,27 @@ export interface PropertyType {
|
|
|
1001
1001
|
* such as the serial number of an <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">IIoT</a> wind turbine.</p>
|
|
1002
1002
|
* @public
|
|
1003
1003
|
*/
|
|
1004
|
-
attribute?: Attribute;
|
|
1004
|
+
attribute?: Attribute | undefined;
|
|
1005
1005
|
/**
|
|
1006
1006
|
* <p>Specifies an asset measurement property. A measurement represents a device's raw sensor
|
|
1007
1007
|
* data stream, such as timestamped temperature values or timestamped power values.</p>
|
|
1008
1008
|
* @public
|
|
1009
1009
|
*/
|
|
1010
|
-
measurement?: Measurement;
|
|
1010
|
+
measurement?: Measurement | undefined;
|
|
1011
1011
|
/**
|
|
1012
1012
|
* <p>Specifies an asset transform property. A transform contains a mathematical expression that
|
|
1013
1013
|
* maps a property's data points from one form to another, such as a unit conversion from Celsius
|
|
1014
1014
|
* to Fahrenheit.</p>
|
|
1015
1015
|
* @public
|
|
1016
1016
|
*/
|
|
1017
|
-
transform?: Transform;
|
|
1017
|
+
transform?: Transform | undefined;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* <p>Specifies an asset metric property. A metric contains a mathematical expression that uses
|
|
1020
1020
|
* aggregate functions to process all input data points over a time interval and output a single
|
|
1021
1021
|
* data point, such as to calculate the average hourly temperature.</p>
|
|
1022
1022
|
* @public
|
|
1023
1023
|
*/
|
|
1024
|
-
metric?: Metric;
|
|
1024
|
+
metric?: Metric | undefined;
|
|
1025
1025
|
}
|
|
1026
1026
|
/**
|
|
1027
1027
|
* <p>Contains information about an asset model property.</p>
|
|
@@ -1046,14 +1046,14 @@ export interface AssetModelProperty {
|
|
|
1046
1046
|
* </ul>
|
|
1047
1047
|
* @public
|
|
1048
1048
|
*/
|
|
1049
|
-
id?: string;
|
|
1049
|
+
id?: string | undefined;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* <p>The external ID (if any) provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1052
1052
|
* operation. You can assign an external ID by specifying
|
|
1053
1053
|
* this value as part of a call to <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>. However, you can't change the external ID if one is already assigned. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1054
1054
|
* @public
|
|
1055
1055
|
*/
|
|
1056
|
-
externalId?: string;
|
|
1056
|
+
externalId?: string | undefined;
|
|
1057
1057
|
/**
|
|
1058
1058
|
* <p>The name of the asset model property.</p>
|
|
1059
1059
|
* @public
|
|
@@ -1069,13 +1069,13 @@ export interface AssetModelProperty {
|
|
|
1069
1069
|
* have the <code>STRUCT</code> data type.</p>
|
|
1070
1070
|
* @public
|
|
1071
1071
|
*/
|
|
1072
|
-
dataTypeSpec?: string;
|
|
1072
|
+
dataTypeSpec?: string | undefined;
|
|
1073
1073
|
/**
|
|
1074
1074
|
* <p>The unit of the asset model property, such as <code>Newtons</code> or
|
|
1075
1075
|
* <code>RPM</code>.</p>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
unit?: string;
|
|
1078
|
+
unit?: string | undefined;
|
|
1079
1079
|
/**
|
|
1080
1080
|
* <p>The property type (see <code>PropertyType</code>).</p>
|
|
1081
1081
|
* @public
|
|
@@ -1085,7 +1085,7 @@ export interface AssetModelProperty {
|
|
|
1085
1085
|
* <p>The structured path to the property from the root of the asset model.</p>
|
|
1086
1086
|
* @public
|
|
1087
1087
|
*/
|
|
1088
|
-
path?: AssetModelPropertyPathSegment[];
|
|
1088
|
+
path?: AssetModelPropertyPathSegment[] | undefined;
|
|
1089
1089
|
}
|
|
1090
1090
|
/**
|
|
1091
1091
|
* <p>Contains information about a composite model in an asset model. This object contains the
|
|
@@ -1102,7 +1102,7 @@ export interface AssetModelCompositeModel {
|
|
|
1102
1102
|
* <p>The description of the composite model.</p>
|
|
1103
1103
|
* @public
|
|
1104
1104
|
*/
|
|
1105
|
-
description?: string;
|
|
1105
|
+
description?: string | undefined;
|
|
1106
1106
|
/**
|
|
1107
1107
|
* <p>The type of the composite model. For alarm composite models, this type is
|
|
1108
1108
|
* <code>AWS/ALARM</code>.</p>
|
|
@@ -1113,17 +1113,17 @@ export interface AssetModelCompositeModel {
|
|
|
1113
1113
|
* <p>The asset property definitions for this composite model.</p>
|
|
1114
1114
|
* @public
|
|
1115
1115
|
*/
|
|
1116
|
-
properties?: AssetModelProperty[];
|
|
1116
|
+
properties?: AssetModelProperty[] | undefined;
|
|
1117
1117
|
/**
|
|
1118
1118
|
* <p> The ID of the asset model composite model. </p>
|
|
1119
1119
|
* @public
|
|
1120
1120
|
*/
|
|
1121
|
-
id?: string;
|
|
1121
|
+
id?: string | undefined;
|
|
1122
1122
|
/**
|
|
1123
1123
|
* <p>The external ID of the asset model composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1124
1124
|
* @public
|
|
1125
1125
|
*/
|
|
1126
|
-
externalId?: string;
|
|
1126
|
+
externalId?: string | undefined;
|
|
1127
1127
|
}
|
|
1128
1128
|
/**
|
|
1129
1129
|
* <p>Contains an asset model property definition. This property definition is applied to all
|
|
@@ -1137,13 +1137,13 @@ export interface AssetModelPropertyDefinition {
|
|
|
1137
1137
|
* If you specify your own ID, it must be globally unique.</p>
|
|
1138
1138
|
* @public
|
|
1139
1139
|
*/
|
|
1140
|
-
id?: string;
|
|
1140
|
+
id?: string | undefined;
|
|
1141
1141
|
/**
|
|
1142
1142
|
* <p>An external ID to assign to the property definition. The external ID must be unique among
|
|
1143
1143
|
* property definitions within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1144
1144
|
* @public
|
|
1145
1145
|
*/
|
|
1146
|
-
externalId?: string;
|
|
1146
|
+
externalId?: string | undefined;
|
|
1147
1147
|
/**
|
|
1148
1148
|
* <p>The name of the property definition.</p>
|
|
1149
1149
|
* @public
|
|
@@ -1164,13 +1164,13 @@ export interface AssetModelPropertyDefinition {
|
|
|
1164
1164
|
* models.</p>
|
|
1165
1165
|
* @public
|
|
1166
1166
|
*/
|
|
1167
|
-
dataTypeSpec?: string;
|
|
1167
|
+
dataTypeSpec?: string | undefined;
|
|
1168
1168
|
/**
|
|
1169
1169
|
* <p>The unit of the property definition, such as <code>Newtons</code> or
|
|
1170
1170
|
* <code>RPM</code>.</p>
|
|
1171
1171
|
* @public
|
|
1172
1172
|
*/
|
|
1173
|
-
unit?: string;
|
|
1173
|
+
unit?: string | undefined;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* <p>The property definition type (see <code>PropertyType</code>). You can only specify one
|
|
1176
1176
|
* type in a property definition.</p>
|
|
@@ -1190,13 +1190,13 @@ export interface AssetModelCompositeModelDefinition {
|
|
|
1190
1190
|
* If you specify your own ID, it must be globally unique.</p>
|
|
1191
1191
|
* @public
|
|
1192
1192
|
*/
|
|
1193
|
-
id?: string;
|
|
1193
|
+
id?: string | undefined;
|
|
1194
1194
|
/**
|
|
1195
1195
|
* <p>An external ID to assign to the composite model. The external ID must be unique among
|
|
1196
1196
|
* composite models within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1197
1197
|
* @public
|
|
1198
1198
|
*/
|
|
1199
|
-
externalId?: string;
|
|
1199
|
+
externalId?: string | undefined;
|
|
1200
1200
|
/**
|
|
1201
1201
|
* <p>The name of the composite model.</p>
|
|
1202
1202
|
* @public
|
|
@@ -1206,7 +1206,7 @@ export interface AssetModelCompositeModelDefinition {
|
|
|
1206
1206
|
* <p>The description of the composite model.</p>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
description?: string;
|
|
1209
|
+
description?: string | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The type of the composite model. For alarm composite models, this type is
|
|
1212
1212
|
* <code>AWS/ALARM</code>.</p>
|
|
@@ -1217,7 +1217,7 @@ export interface AssetModelCompositeModelDefinition {
|
|
|
1217
1217
|
* <p>The asset property definitions for this composite model.</p>
|
|
1218
1218
|
* @public
|
|
1219
1219
|
*/
|
|
1220
|
-
properties?: AssetModelPropertyDefinition[];
|
|
1220
|
+
properties?: AssetModelPropertyDefinition[] | undefined;
|
|
1221
1221
|
}
|
|
1222
1222
|
/**
|
|
1223
1223
|
* <p>Represents one level between a composite model and the root of the asset model.</p>
|
|
@@ -1228,12 +1228,12 @@ export interface AssetModelCompositeModelPathSegment {
|
|
|
1228
1228
|
* <p>The ID of the path segment.</p>
|
|
1229
1229
|
* @public
|
|
1230
1230
|
*/
|
|
1231
|
-
id?: string;
|
|
1231
|
+
id?: string | undefined;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* <p>The name of the path segment.</p>
|
|
1234
1234
|
* @public
|
|
1235
1235
|
*/
|
|
1236
|
-
name?: string;
|
|
1236
|
+
name?: string | undefined;
|
|
1237
1237
|
}
|
|
1238
1238
|
/**
|
|
1239
1239
|
* <p>Contains a summary of the composite model.</p>
|
|
@@ -1249,7 +1249,7 @@ export interface AssetModelCompositeModelSummary {
|
|
|
1249
1249
|
* <p>The external ID of a composite model on this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1250
1250
|
* @public
|
|
1251
1251
|
*/
|
|
1252
|
-
externalId?: string;
|
|
1252
|
+
externalId?: string | undefined;
|
|
1253
1253
|
/**
|
|
1254
1254
|
* <p>The name of the composite model that this summary describes..</p>
|
|
1255
1255
|
* @public
|
|
@@ -1264,12 +1264,12 @@ export interface AssetModelCompositeModelSummary {
|
|
|
1264
1264
|
* <p>The description of the composite model that this summary describes..</p>
|
|
1265
1265
|
* @public
|
|
1266
1266
|
*/
|
|
1267
|
-
description?: string;
|
|
1267
|
+
description?: string | undefined;
|
|
1268
1268
|
/**
|
|
1269
1269
|
* <p>The path that includes all the pieces that make up the composite model.</p>
|
|
1270
1270
|
* @public
|
|
1271
1271
|
*/
|
|
1272
|
-
path?: AssetModelCompositeModelPathSegment[];
|
|
1272
|
+
path?: AssetModelCompositeModelPathSegment[] | undefined;
|
|
1273
1273
|
}
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model
|
|
@@ -1295,14 +1295,14 @@ export interface AssetModelHierarchy {
|
|
|
1295
1295
|
* </ul>
|
|
1296
1296
|
* @public
|
|
1297
1297
|
*/
|
|
1298
|
-
id?: string;
|
|
1298
|
+
id?: string | undefined;
|
|
1299
1299
|
/**
|
|
1300
1300
|
* <p>The external ID (if any) provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1301
1301
|
* operation. You can assign an external ID by specifying
|
|
1302
1302
|
* this value as part of a call to <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>. However, you can't change the external ID if one is already assigned. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1303
1303
|
* @public
|
|
1304
1304
|
*/
|
|
1305
|
-
externalId?: string;
|
|
1305
|
+
externalId?: string | undefined;
|
|
1306
1306
|
/**
|
|
1307
1307
|
* <p>The name of the asset model hierarchy that you specify by using the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or
|
|
1308
1308
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation.</p>
|
|
@@ -1332,13 +1332,13 @@ export interface AssetModelHierarchyDefinition {
|
|
|
1332
1332
|
* If you specify your own ID, it must be globally unique.</p>
|
|
1333
1333
|
* @public
|
|
1334
1334
|
*/
|
|
1335
|
-
id?: string;
|
|
1335
|
+
id?: string | undefined;
|
|
1336
1336
|
/**
|
|
1337
1337
|
* <p>An external ID to assign to the asset model hierarchy. The external ID must be unique
|
|
1338
1338
|
* among asset model hierarchies within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1339
1339
|
* @public
|
|
1340
1340
|
*/
|
|
1341
|
-
externalId?: string;
|
|
1341
|
+
externalId?: string | undefined;
|
|
1342
1342
|
/**
|
|
1343
1343
|
* <p>The name of the asset model hierarchy definition (as specified in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or
|
|
1344
1344
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation).</p>
|
|
@@ -1361,12 +1361,12 @@ export interface AssetModelPropertySummary {
|
|
|
1361
1361
|
* <p>The ID of the property.</p>
|
|
1362
1362
|
* @public
|
|
1363
1363
|
*/
|
|
1364
|
-
id?: string;
|
|
1364
|
+
id?: string | undefined;
|
|
1365
1365
|
/**
|
|
1366
1366
|
* <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1367
1367
|
* @public
|
|
1368
1368
|
*/
|
|
1369
|
-
externalId?: string;
|
|
1369
|
+
externalId?: string | undefined;
|
|
1370
1370
|
/**
|
|
1371
1371
|
* <p>The name of the property.</p>
|
|
1372
1372
|
* @public
|
|
@@ -1382,12 +1382,12 @@ export interface AssetModelPropertySummary {
|
|
|
1382
1382
|
* have the <code>STRUCT</code> data type.</p>
|
|
1383
1383
|
* @public
|
|
1384
1384
|
*/
|
|
1385
|
-
dataTypeSpec?: string;
|
|
1385
|
+
dataTypeSpec?: string | undefined;
|
|
1386
1386
|
/**
|
|
1387
1387
|
* <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the property.</p>
|
|
1388
1388
|
* @public
|
|
1389
1389
|
*/
|
|
1390
|
-
unit?: string;
|
|
1390
|
+
unit?: string | undefined;
|
|
1391
1391
|
/**
|
|
1392
1392
|
* <p>Contains a property type, which can be one of <code>attribute</code>,
|
|
1393
1393
|
* <code>measurement</code>, <code>metric</code>, or <code>transform</code>.</p>
|
|
@@ -1398,12 +1398,12 @@ export interface AssetModelPropertySummary {
|
|
|
1398
1398
|
* <p> The ID of the composite model that contains the asset model property. </p>
|
|
1399
1399
|
* @public
|
|
1400
1400
|
*/
|
|
1401
|
-
assetModelCompositeModelId?: string;
|
|
1401
|
+
assetModelCompositeModelId?: string | undefined;
|
|
1402
1402
|
/**
|
|
1403
1403
|
* <p>The structured path to the property from the root of the asset model.</p>
|
|
1404
1404
|
* @public
|
|
1405
1405
|
*/
|
|
1406
|
-
path?: AssetModelPropertyPathSegment[];
|
|
1406
|
+
path?: AssetModelPropertyPathSegment[] | undefined;
|
|
1407
1407
|
}
|
|
1408
1408
|
/**
|
|
1409
1409
|
* @public
|
|
@@ -1480,7 +1480,7 @@ export interface ErrorDetails {
|
|
|
1480
1480
|
* <p> A list of detailed errors. </p>
|
|
1481
1481
|
* @public
|
|
1482
1482
|
*/
|
|
1483
|
-
details?: DetailedError[];
|
|
1483
|
+
details?: DetailedError[] | undefined;
|
|
1484
1484
|
}
|
|
1485
1485
|
/**
|
|
1486
1486
|
* <p>Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
|
|
@@ -1497,7 +1497,7 @@ export interface AssetModelStatus {
|
|
|
1497
1497
|
* <p>Contains associated error information, if any.</p>
|
|
1498
1498
|
* @public
|
|
1499
1499
|
*/
|
|
1500
|
-
error?: ErrorDetails;
|
|
1500
|
+
error?: ErrorDetails | undefined;
|
|
1501
1501
|
}
|
|
1502
1502
|
/**
|
|
1503
1503
|
* @public
|
|
@@ -1525,7 +1525,7 @@ export interface AssetModelSummary {
|
|
|
1525
1525
|
* <p>The external ID of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1526
1526
|
* @public
|
|
1527
1527
|
*/
|
|
1528
|
-
externalId?: string;
|
|
1528
|
+
externalId?: string | undefined;
|
|
1529
1529
|
/**
|
|
1530
1530
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p>
|
|
1531
1531
|
* <p>
|
|
@@ -1555,7 +1555,7 @@ export interface AssetModelSummary {
|
|
|
1555
1555
|
* </ul>
|
|
1556
1556
|
* @public
|
|
1557
1557
|
*/
|
|
1558
|
-
assetModelType?: AssetModelType;
|
|
1558
|
+
assetModelType?: AssetModelType | undefined;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* <p>The asset model description.</p>
|
|
1561
1561
|
* @public
|
|
@@ -1580,7 +1580,7 @@ export interface AssetModelSummary {
|
|
|
1580
1580
|
* <p>The version number of the asset model.</p>
|
|
1581
1581
|
* @public
|
|
1582
1582
|
*/
|
|
1583
|
-
version?: string;
|
|
1583
|
+
version?: string | undefined;
|
|
1584
1584
|
}
|
|
1585
1585
|
/**
|
|
1586
1586
|
* @public
|
|
@@ -1611,33 +1611,33 @@ export interface AssetPropertySummary {
|
|
|
1611
1611
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
1612
1612
|
* @public
|
|
1613
1613
|
*/
|
|
1614
|
-
alias?: string;
|
|
1614
|
+
alias?: string | undefined;
|
|
1615
1615
|
/**
|
|
1616
1616
|
* <p> The unit of measure (such as Newtons or RPM) of the asset property. </p>
|
|
1617
1617
|
* @public
|
|
1618
1618
|
*/
|
|
1619
|
-
unit?: string;
|
|
1619
|
+
unit?: string | undefined;
|
|
1620
1620
|
/**
|
|
1621
1621
|
* <p>Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value
|
|
1622
1622
|
* updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1623
1623
|
* @public
|
|
1624
1624
|
*/
|
|
1625
|
-
notification?: PropertyNotification;
|
|
1625
|
+
notification?: PropertyNotification | undefined;
|
|
1626
1626
|
/**
|
|
1627
1627
|
* <p> The ID of the composite model that contains the asset property. </p>
|
|
1628
1628
|
* @public
|
|
1629
1629
|
*/
|
|
1630
|
-
assetCompositeModelId?: string;
|
|
1630
|
+
assetCompositeModelId?: string | undefined;
|
|
1631
1631
|
/**
|
|
1632
1632
|
* <p>The structured path to the property from the root of the asset.</p>
|
|
1633
1633
|
* @public
|
|
1634
1634
|
*/
|
|
1635
|
-
path?: AssetPropertyPathSegment[];
|
|
1635
|
+
path?: AssetPropertyPathSegment[] | undefined;
|
|
1636
1636
|
/**
|
|
1637
1637
|
* <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1638
1638
|
* @public
|
|
1639
1639
|
*/
|
|
1640
|
-
externalId?: string;
|
|
1640
|
+
externalId?: string | undefined;
|
|
1641
1641
|
}
|
|
1642
1642
|
/**
|
|
1643
1643
|
* <p>Contains a timestamp with optional nanosecond granularity.</p>
|
|
@@ -1654,7 +1654,7 @@ export interface TimeInNanos {
|
|
|
1654
1654
|
* <p>The nanosecond offset from <code>timeInSeconds</code>.</p>
|
|
1655
1655
|
* @public
|
|
1656
1656
|
*/
|
|
1657
|
-
offsetInNanos?: number;
|
|
1657
|
+
offsetInNanos?: number | undefined;
|
|
1658
1658
|
}
|
|
1659
1659
|
/**
|
|
1660
1660
|
* <p>Contains an asset property value (of a single type only).</p>
|
|
@@ -1665,22 +1665,22 @@ export interface Variant {
|
|
|
1665
1665
|
* <p>Asset property data of type string (sequence of characters).</p>
|
|
1666
1666
|
* @public
|
|
1667
1667
|
*/
|
|
1668
|
-
stringValue?: string;
|
|
1668
|
+
stringValue?: string | undefined;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* <p>Asset property data of type integer (whole number).</p>
|
|
1671
1671
|
* @public
|
|
1672
1672
|
*/
|
|
1673
|
-
integerValue?: number;
|
|
1673
|
+
integerValue?: number | undefined;
|
|
1674
1674
|
/**
|
|
1675
1675
|
* <p>Asset property data of type double (floating point number).</p>
|
|
1676
1676
|
* @public
|
|
1677
1677
|
*/
|
|
1678
|
-
doubleValue?: number;
|
|
1678
|
+
doubleValue?: number | undefined;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* <p>Asset property data of type Boolean (true or false).</p>
|
|
1681
1681
|
* @public
|
|
1682
1682
|
*/
|
|
1683
|
-
booleanValue?: boolean;
|
|
1683
|
+
booleanValue?: boolean | undefined;
|
|
1684
1684
|
}
|
|
1685
1685
|
/**
|
|
1686
1686
|
* <p>Contains asset property value information.</p>
|
|
@@ -1701,7 +1701,7 @@ export interface AssetPropertyValue {
|
|
|
1701
1701
|
* <p>The quality of the asset property value.</p>
|
|
1702
1702
|
* @public
|
|
1703
1703
|
*/
|
|
1704
|
-
quality?: Quality;
|
|
1704
|
+
quality?: Quality | undefined;
|
|
1705
1705
|
}
|
|
1706
1706
|
/**
|
|
1707
1707
|
* @public
|
|
@@ -1725,7 +1725,7 @@ export interface AssetRelationshipSummary {
|
|
|
1725
1725
|
* <code>HIERARCHY</code>.</p>
|
|
1726
1726
|
* @public
|
|
1727
1727
|
*/
|
|
1728
|
-
hierarchyInfo?: AssetHierarchyInfo;
|
|
1728
|
+
hierarchyInfo?: AssetHierarchyInfo | undefined;
|
|
1729
1729
|
/**
|
|
1730
1730
|
* <p>The relationship type of the assets in this relationship. This value is one of the
|
|
1731
1731
|
* following:</p>
|
|
@@ -1772,7 +1772,7 @@ export interface AssetStatus {
|
|
|
1772
1772
|
* <p>Contains associated error information, if any.</p>
|
|
1773
1773
|
* @public
|
|
1774
1774
|
*/
|
|
1775
|
-
error?: ErrorDetails;
|
|
1775
|
+
error?: ErrorDetails | undefined;
|
|
1776
1776
|
}
|
|
1777
1777
|
/**
|
|
1778
1778
|
* <p>Contains a summary of an asset.</p>
|
|
@@ -1826,12 +1826,12 @@ export interface AssetSummary {
|
|
|
1826
1826
|
* <p>A description for the asset.</p>
|
|
1827
1827
|
* @public
|
|
1828
1828
|
*/
|
|
1829
|
-
description?: string;
|
|
1829
|
+
description?: string | undefined;
|
|
1830
1830
|
/**
|
|
1831
1831
|
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1832
1832
|
* @public
|
|
1833
1833
|
*/
|
|
1834
|
-
externalId?: string;
|
|
1834
|
+
externalId?: string | undefined;
|
|
1835
1835
|
}
|
|
1836
1836
|
/**
|
|
1837
1837
|
* @public
|
|
@@ -1861,7 +1861,7 @@ export interface AssociateAssetsRequest {
|
|
|
1861
1861
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
1862
1862
|
* @public
|
|
1863
1863
|
*/
|
|
1864
|
-
clientToken?: string;
|
|
1864
|
+
clientToken?: string | undefined;
|
|
1865
1865
|
}
|
|
1866
1866
|
/**
|
|
1867
1867
|
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
@@ -2027,12 +2027,12 @@ export interface AssociatedAssetsSummary {
|
|
|
2027
2027
|
* <p>A description for the asset.</p>
|
|
2028
2028
|
* @public
|
|
2029
2029
|
*/
|
|
2030
|
-
description?: string;
|
|
2030
|
+
description?: string | undefined;
|
|
2031
2031
|
/**
|
|
2032
2032
|
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2033
2033
|
* @public
|
|
2034
2034
|
*/
|
|
2035
|
-
externalId?: string;
|
|
2035
|
+
externalId?: string | undefined;
|
|
2036
2036
|
}
|
|
2037
2037
|
/**
|
|
2038
2038
|
* @public
|
|
@@ -2059,7 +2059,7 @@ export interface AssociateTimeSeriesToAssetPropertyRequest {
|
|
|
2059
2059
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
2060
2060
|
* @public
|
|
2061
2061
|
*/
|
|
2062
|
-
clientToken?: string;
|
|
2062
|
+
clientToken?: string | undefined;
|
|
2063
2063
|
}
|
|
2064
2064
|
/**
|
|
2065
2065
|
* @public
|
|
@@ -2091,7 +2091,7 @@ export interface BatchAssociateProjectAssetsRequest {
|
|
|
2091
2091
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
2092
2092
|
* @public
|
|
2093
2093
|
*/
|
|
2094
|
-
clientToken?: string;
|
|
2094
|
+
clientToken?: string | undefined;
|
|
2095
2095
|
}
|
|
2096
2096
|
/**
|
|
2097
2097
|
* @public
|
|
@@ -2101,7 +2101,7 @@ export interface BatchAssociateProjectAssetsResponse {
|
|
|
2101
2101
|
* <p>A list of associated error information, if any.</p>
|
|
2102
2102
|
* @public
|
|
2103
2103
|
*/
|
|
2104
|
-
errors?: AssetErrorDetails[];
|
|
2104
|
+
errors?: AssetErrorDetails[] | undefined;
|
|
2105
2105
|
}
|
|
2106
2106
|
/**
|
|
2107
2107
|
* @public
|
|
@@ -2121,7 +2121,7 @@ export interface BatchDisassociateProjectAssetsRequest {
|
|
|
2121
2121
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
2122
2122
|
* @public
|
|
2123
2123
|
*/
|
|
2124
|
-
clientToken?: string;
|
|
2124
|
+
clientToken?: string | undefined;
|
|
2125
2125
|
}
|
|
2126
2126
|
/**
|
|
2127
2127
|
* @public
|
|
@@ -2131,7 +2131,7 @@ export interface BatchDisassociateProjectAssetsResponse {
|
|
|
2131
2131
|
* <p>A list of associated error information, if any.</p>
|
|
2132
2132
|
* @public
|
|
2133
2133
|
*/
|
|
2134
|
-
errors?: AssetErrorDetails[];
|
|
2134
|
+
errors?: AssetErrorDetails[] | undefined;
|
|
2135
2135
|
}
|
|
2136
2136
|
/**
|
|
2137
2137
|
* @public
|
|
@@ -2170,12 +2170,12 @@ export interface BatchGetAssetPropertyAggregatesEntry {
|
|
|
2170
2170
|
* <p>The ID of the asset in which the asset property was created.</p>
|
|
2171
2171
|
* @public
|
|
2172
2172
|
*/
|
|
2173
|
-
assetId?: string;
|
|
2173
|
+
assetId?: string | undefined;
|
|
2174
2174
|
/**
|
|
2175
2175
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
2176
2176
|
* @public
|
|
2177
2177
|
*/
|
|
2178
|
-
propertyId?: string;
|
|
2178
|
+
propertyId?: string | undefined;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
2181
2181
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -2183,7 +2183,7 @@ export interface BatchGetAssetPropertyAggregatesEntry {
|
|
|
2183
2183
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
2184
2184
|
* @public
|
|
2185
2185
|
*/
|
|
2186
|
-
propertyAlias?: string;
|
|
2186
|
+
propertyAlias?: string | undefined;
|
|
2187
2187
|
/**
|
|
2188
2188
|
* <p>The data aggregating function.</p>
|
|
2189
2189
|
* @public
|
|
@@ -2208,14 +2208,14 @@ export interface BatchGetAssetPropertyAggregatesEntry {
|
|
|
2208
2208
|
* <p>The quality by which to filter asset data.</p>
|
|
2209
2209
|
* @public
|
|
2210
2210
|
*/
|
|
2211
|
-
qualities?: Quality[];
|
|
2211
|
+
qualities?: Quality[] | undefined;
|
|
2212
2212
|
/**
|
|
2213
2213
|
* <p>The chronological sorting order of the requested information.</p>
|
|
2214
2214
|
* <p>Default: <code>ASCENDING</code>
|
|
2215
2215
|
* </p>
|
|
2216
2216
|
* @public
|
|
2217
2217
|
*/
|
|
2218
|
-
timeOrdering?: TimeOrdering;
|
|
2218
|
+
timeOrdering?: TimeOrdering | undefined;
|
|
2219
2219
|
}
|
|
2220
2220
|
/**
|
|
2221
2221
|
* @public
|
|
@@ -2231,7 +2231,7 @@ export interface BatchGetAssetPropertyAggregatesRequest {
|
|
|
2231
2231
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2232
2232
|
* @public
|
|
2233
2233
|
*/
|
|
2234
|
-
nextToken?: string;
|
|
2234
|
+
nextToken?: string | undefined;
|
|
2235
2235
|
/**
|
|
2236
2236
|
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
|
|
2237
2237
|
* first.</p>
|
|
@@ -2246,7 +2246,7 @@ export interface BatchGetAssetPropertyAggregatesRequest {
|
|
|
2246
2246
|
* </ul>
|
|
2247
2247
|
* @public
|
|
2248
2248
|
*/
|
|
2249
|
-
maxResults?: number;
|
|
2249
|
+
maxResults?: number | undefined;
|
|
2250
2250
|
}
|
|
2251
2251
|
/**
|
|
2252
2252
|
* @public
|
|
@@ -2331,7 +2331,7 @@ export interface BatchGetAssetPropertyAggregatesSkippedEntry {
|
|
|
2331
2331
|
* <p>The error information, such as the error code and the timestamp.</p>
|
|
2332
2332
|
* @public
|
|
2333
2333
|
*/
|
|
2334
|
-
errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo;
|
|
2334
|
+
errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo | undefined;
|
|
2335
2335
|
}
|
|
2336
2336
|
/**
|
|
2337
2337
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
@@ -2377,7 +2377,7 @@ export interface BatchGetAssetPropertyAggregatesResponse {
|
|
|
2377
2377
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2378
2378
|
* @public
|
|
2379
2379
|
*/
|
|
2380
|
-
nextToken?: string;
|
|
2380
|
+
nextToken?: string | undefined;
|
|
2381
2381
|
}
|
|
2382
2382
|
/**
|
|
2383
2383
|
* <p>The requested service is unavailable.</p>
|
|
@@ -2415,12 +2415,12 @@ export interface BatchGetAssetPropertyValueEntry {
|
|
|
2415
2415
|
* <p>The ID of the asset in which the asset property was created.</p>
|
|
2416
2416
|
* @public
|
|
2417
2417
|
*/
|
|
2418
|
-
assetId?: string;
|
|
2418
|
+
assetId?: string | undefined;
|
|
2419
2419
|
/**
|
|
2420
2420
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
2421
2421
|
* @public
|
|
2422
2422
|
*/
|
|
2423
|
-
propertyId?: string;
|
|
2423
|
+
propertyId?: string | undefined;
|
|
2424
2424
|
/**
|
|
2425
2425
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
2426
2426
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -2428,7 +2428,7 @@ export interface BatchGetAssetPropertyValueEntry {
|
|
|
2428
2428
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
2429
2429
|
* @public
|
|
2430
2430
|
*/
|
|
2431
|
-
propertyAlias?: string;
|
|
2431
|
+
propertyAlias?: string | undefined;
|
|
2432
2432
|
}
|
|
2433
2433
|
/**
|
|
2434
2434
|
* @public
|
|
@@ -2444,7 +2444,7 @@ export interface BatchGetAssetPropertyValueRequest {
|
|
|
2444
2444
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2445
2445
|
* @public
|
|
2446
2446
|
*/
|
|
2447
|
-
nextToken?: string;
|
|
2447
|
+
nextToken?: string | undefined;
|
|
2448
2448
|
}
|
|
2449
2449
|
/**
|
|
2450
2450
|
* @public
|
|
@@ -2516,7 +2516,7 @@ export interface BatchGetAssetPropertyValueSkippedEntry {
|
|
|
2516
2516
|
* <p>The error information, such as the error code and the timestamp.</p>
|
|
2517
2517
|
* @public
|
|
2518
2518
|
*/
|
|
2519
|
-
errorInfo?: BatchGetAssetPropertyValueErrorInfo;
|
|
2519
|
+
errorInfo?: BatchGetAssetPropertyValueErrorInfo | undefined;
|
|
2520
2520
|
}
|
|
2521
2521
|
/**
|
|
2522
2522
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
@@ -2532,7 +2532,7 @@ export interface BatchGetAssetPropertyValueSuccessEntry {
|
|
|
2532
2532
|
* <p>Contains asset property value information.</p>
|
|
2533
2533
|
* @public
|
|
2534
2534
|
*/
|
|
2535
|
-
assetPropertyValue?: AssetPropertyValue;
|
|
2535
|
+
assetPropertyValue?: AssetPropertyValue | undefined;
|
|
2536
2536
|
}
|
|
2537
2537
|
/**
|
|
2538
2538
|
* @public
|
|
@@ -2561,7 +2561,7 @@ export interface BatchGetAssetPropertyValueResponse {
|
|
|
2561
2561
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2562
2562
|
* @public
|
|
2563
2563
|
*/
|
|
2564
|
-
nextToken?: string;
|
|
2564
|
+
nextToken?: string | undefined;
|
|
2565
2565
|
}
|
|
2566
2566
|
/**
|
|
2567
2567
|
* <p>Contains information for an asset property historical value entry that is associated with
|
|
@@ -2588,12 +2588,12 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
|
|
|
2588
2588
|
* <p>The ID of the asset in which the asset property was created.</p>
|
|
2589
2589
|
* @public
|
|
2590
2590
|
*/
|
|
2591
|
-
assetId?: string;
|
|
2591
|
+
assetId?: string | undefined;
|
|
2592
2592
|
/**
|
|
2593
2593
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
2594
2594
|
* @public
|
|
2595
2595
|
*/
|
|
2596
|
-
propertyId?: string;
|
|
2596
|
+
propertyId?: string | undefined;
|
|
2597
2597
|
/**
|
|
2598
2598
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
2599
2599
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -2601,29 +2601,29 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
|
|
|
2601
2601
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
2602
2602
|
* @public
|
|
2603
2603
|
*/
|
|
2604
|
-
propertyAlias?: string;
|
|
2604
|
+
propertyAlias?: string | undefined;
|
|
2605
2605
|
/**
|
|
2606
2606
|
* <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
2607
2607
|
* @public
|
|
2608
2608
|
*/
|
|
2609
|
-
startDate?: Date;
|
|
2609
|
+
startDate?: Date | undefined;
|
|
2610
2610
|
/**
|
|
2611
2611
|
* <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
2612
2612
|
* @public
|
|
2613
2613
|
*/
|
|
2614
|
-
endDate?: Date;
|
|
2614
|
+
endDate?: Date | undefined;
|
|
2615
2615
|
/**
|
|
2616
2616
|
* <p>The quality by which to filter asset data.</p>
|
|
2617
2617
|
* @public
|
|
2618
2618
|
*/
|
|
2619
|
-
qualities?: Quality[];
|
|
2619
|
+
qualities?: Quality[] | undefined;
|
|
2620
2620
|
/**
|
|
2621
2621
|
* <p>The chronological sorting order of the requested information.</p>
|
|
2622
2622
|
* <p>Default: <code>ASCENDING</code>
|
|
2623
2623
|
* </p>
|
|
2624
2624
|
* @public
|
|
2625
2625
|
*/
|
|
2626
|
-
timeOrdering?: TimeOrdering;
|
|
2626
|
+
timeOrdering?: TimeOrdering | undefined;
|
|
2627
2627
|
}
|
|
2628
2628
|
/**
|
|
2629
2629
|
* @public
|
|
@@ -2639,7 +2639,7 @@ export interface BatchGetAssetPropertyValueHistoryRequest {
|
|
|
2639
2639
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2640
2640
|
* @public
|
|
2641
2641
|
*/
|
|
2642
|
-
nextToken?: string;
|
|
2642
|
+
nextToken?: string | undefined;
|
|
2643
2643
|
/**
|
|
2644
2644
|
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
|
|
2645
2645
|
* first.</p>
|
|
@@ -2654,7 +2654,7 @@ export interface BatchGetAssetPropertyValueHistoryRequest {
|
|
|
2654
2654
|
* </ul>
|
|
2655
2655
|
* @public
|
|
2656
2656
|
*/
|
|
2657
|
-
maxResults?: number;
|
|
2657
|
+
maxResults?: number | undefined;
|
|
2658
2658
|
}
|
|
2659
2659
|
/**
|
|
2660
2660
|
* @public
|
|
@@ -2726,7 +2726,7 @@ export interface BatchGetAssetPropertyValueHistorySkippedEntry {
|
|
|
2726
2726
|
* <p>The error information, such as the error code and the timestamp.</p>
|
|
2727
2727
|
* @public
|
|
2728
2728
|
*/
|
|
2729
|
-
errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo;
|
|
2729
|
+
errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo | undefined;
|
|
2730
2730
|
}
|
|
2731
2731
|
/**
|
|
2732
2732
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
@@ -2771,7 +2771,7 @@ export interface BatchGetAssetPropertyValueHistoryResponse {
|
|
|
2771
2771
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2772
2772
|
* @public
|
|
2773
2773
|
*/
|
|
2774
|
-
nextToken?: string;
|
|
2774
|
+
nextToken?: string | undefined;
|
|
2775
2775
|
}
|
|
2776
2776
|
/**
|
|
2777
2777
|
* <p>Contains a list of value updates for an asset property in the list of asset entries
|
|
@@ -2790,12 +2790,12 @@ export interface PutAssetPropertyValueEntry {
|
|
|
2790
2790
|
* <p>The ID of the asset to update.</p>
|
|
2791
2791
|
* @public
|
|
2792
2792
|
*/
|
|
2793
|
-
assetId?: string;
|
|
2793
|
+
assetId?: string | undefined;
|
|
2794
2794
|
/**
|
|
2795
2795
|
* <p>The ID of the asset property for this entry.</p>
|
|
2796
2796
|
* @public
|
|
2797
2797
|
*/
|
|
2798
|
-
propertyId?: string;
|
|
2798
|
+
propertyId?: string | undefined;
|
|
2799
2799
|
/**
|
|
2800
2800
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
2801
2801
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -2803,7 +2803,7 @@ export interface PutAssetPropertyValueEntry {
|
|
|
2803
2803
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
2804
2804
|
* @public
|
|
2805
2805
|
*/
|
|
2806
|
-
propertyAlias?: string;
|
|
2806
|
+
propertyAlias?: string | undefined;
|
|
2807
2807
|
/**
|
|
2808
2808
|
* <p>The list of property values to upload. You can specify up to 10
|
|
2809
2809
|
* <code>propertyValues</code> array elements. </p>
|
|
@@ -2913,14 +2913,14 @@ export interface CreateAccessPolicyRequest {
|
|
|
2913
2913
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
2914
2914
|
* @public
|
|
2915
2915
|
*/
|
|
2916
|
-
clientToken?: string;
|
|
2916
|
+
clientToken?: string | undefined;
|
|
2917
2917
|
/**
|
|
2918
2918
|
* <p>A list of key-value pairs that contain metadata for the access policy. For more
|
|
2919
2919
|
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your
|
|
2920
2920
|
* IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2921
2921
|
* @public
|
|
2922
2922
|
*/
|
|
2923
|
-
tags?: Record<string, string
|
|
2923
|
+
tags?: Record<string, string> | undefined;
|
|
2924
2924
|
}
|
|
2925
2925
|
/**
|
|
2926
2926
|
* @public
|
|
@@ -2959,31 +2959,31 @@ export interface CreateAssetRequest {
|
|
|
2959
2959
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
2960
2960
|
* @public
|
|
2961
2961
|
*/
|
|
2962
|
-
clientToken?: string;
|
|
2962
|
+
clientToken?: string | undefined;
|
|
2963
2963
|
/**
|
|
2964
2964
|
* <p>A list of key-value pairs that contain metadata for the asset. For more information, see
|
|
2965
2965
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
|
|
2966
2966
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2967
2967
|
* @public
|
|
2968
2968
|
*/
|
|
2969
|
-
tags?: Record<string, string
|
|
2969
|
+
tags?: Record<string, string> | undefined;
|
|
2970
2970
|
/**
|
|
2971
2971
|
* <p>A description for the asset.</p>
|
|
2972
2972
|
* @public
|
|
2973
2973
|
*/
|
|
2974
|
-
assetDescription?: string;
|
|
2974
|
+
assetDescription?: string | undefined;
|
|
2975
2975
|
/**
|
|
2976
2976
|
* <p>The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
2977
2977
|
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
2978
2978
|
* If you specify your own ID, it must be globally unique.</p>
|
|
2979
2979
|
* @public
|
|
2980
2980
|
*/
|
|
2981
|
-
assetId?: string;
|
|
2981
|
+
assetId?: string | undefined;
|
|
2982
2982
|
/**
|
|
2983
2983
|
* <p>An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2984
2984
|
* @public
|
|
2985
2985
|
*/
|
|
2986
|
-
assetExternalId?: string;
|
|
2986
|
+
assetExternalId?: string | undefined;
|
|
2987
2987
|
}
|
|
2988
2988
|
/**
|
|
2989
2989
|
* @public
|
|
@@ -3035,24 +3035,24 @@ export interface CreateAssetModelRequest {
|
|
|
3035
3035
|
* </ul>
|
|
3036
3036
|
* @public
|
|
3037
3037
|
*/
|
|
3038
|
-
assetModelType?: AssetModelType;
|
|
3038
|
+
assetModelType?: AssetModelType | undefined;
|
|
3039
3039
|
/**
|
|
3040
3040
|
* <p>The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
3041
3041
|
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
3042
3042
|
* If you specify your own ID, it must be globally unique.</p>
|
|
3043
3043
|
* @public
|
|
3044
3044
|
*/
|
|
3045
|
-
assetModelId?: string;
|
|
3045
|
+
assetModelId?: string | undefined;
|
|
3046
3046
|
/**
|
|
3047
3047
|
* <p>An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3048
3048
|
* @public
|
|
3049
3049
|
*/
|
|
3050
|
-
assetModelExternalId?: string;
|
|
3050
|
+
assetModelExternalId?: string | undefined;
|
|
3051
3051
|
/**
|
|
3052
3052
|
* <p>A description for the asset model.</p>
|
|
3053
3053
|
* @public
|
|
3054
3054
|
*/
|
|
3055
|
-
assetModelDescription?: string;
|
|
3055
|
+
assetModelDescription?: string | undefined;
|
|
3056
3056
|
/**
|
|
3057
3057
|
* <p>The property definitions of the asset model. For more information, see
|
|
3058
3058
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -3060,7 +3060,7 @@ export interface CreateAssetModelRequest {
|
|
|
3060
3060
|
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3061
3061
|
* @public
|
|
3062
3062
|
*/
|
|
3063
|
-
assetModelProperties?: AssetModelPropertyDefinition[];
|
|
3063
|
+
assetModelProperties?: AssetModelPropertyDefinition[] | undefined;
|
|
3064
3064
|
/**
|
|
3065
3065
|
* <p>The hierarchy definitions of the asset model. Each hierarchy specifies an asset model
|
|
3066
3066
|
* whose assets can be children of any other assets created from this asset model. For more
|
|
@@ -3069,7 +3069,7 @@ export interface CreateAssetModelRequest {
|
|
|
3069
3069
|
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3070
3070
|
* @public
|
|
3071
3071
|
*/
|
|
3072
|
-
assetModelHierarchies?: AssetModelHierarchyDefinition[];
|
|
3072
|
+
assetModelHierarchies?: AssetModelHierarchyDefinition[] | undefined;
|
|
3073
3073
|
/**
|
|
3074
3074
|
* <p>The composite models that are part of this asset model. It groups properties
|
|
3075
3075
|
* (such as attributes, measurements, transforms, and metrics) and child composite models that
|
|
@@ -3082,19 +3082,19 @@ export interface CreateAssetModelRequest {
|
|
|
3082
3082
|
* </note>
|
|
3083
3083
|
* @public
|
|
3084
3084
|
*/
|
|
3085
|
-
assetModelCompositeModels?: AssetModelCompositeModelDefinition[];
|
|
3085
|
+
assetModelCompositeModels?: AssetModelCompositeModelDefinition[] | undefined;
|
|
3086
3086
|
/**
|
|
3087
3087
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3088
3088
|
* @public
|
|
3089
3089
|
*/
|
|
3090
|
-
clientToken?: string;
|
|
3090
|
+
clientToken?: string | undefined;
|
|
3091
3091
|
/**
|
|
3092
3092
|
* <p>A list of key-value pairs that contain metadata for the asset model. For more information,
|
|
3093
3093
|
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
|
|
3094
3094
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3095
3095
|
* @public
|
|
3096
3096
|
*/
|
|
3097
|
-
tags?: Record<string, string
|
|
3097
|
+
tags?: Record<string, string> | undefined;
|
|
3098
3098
|
}
|
|
3099
3099
|
/**
|
|
3100
3100
|
* @public
|
|
@@ -3137,24 +3137,24 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3137
3137
|
* of.</p>
|
|
3138
3138
|
* @public
|
|
3139
3139
|
*/
|
|
3140
|
-
assetModelCompositeModelExternalId?: string;
|
|
3140
|
+
assetModelCompositeModelExternalId?: string | undefined;
|
|
3141
3141
|
/**
|
|
3142
3142
|
* <p>The ID of the parent composite model in this asset model relationship.</p>
|
|
3143
3143
|
* @public
|
|
3144
3144
|
*/
|
|
3145
|
-
parentAssetModelCompositeModelId?: string;
|
|
3145
|
+
parentAssetModelCompositeModelId?: string | undefined;
|
|
3146
3146
|
/**
|
|
3147
3147
|
* <p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this
|
|
3148
3148
|
* parameter is never required. However, if you prefer to supply your own ID instead, you can
|
|
3149
3149
|
* specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
|
|
3150
3150
|
* @public
|
|
3151
3151
|
*/
|
|
3152
|
-
assetModelCompositeModelId?: string;
|
|
3152
|
+
assetModelCompositeModelId?: string | undefined;
|
|
3153
3153
|
/**
|
|
3154
3154
|
* <p>A description for the composite model.</p>
|
|
3155
3155
|
* @public
|
|
3156
3156
|
*/
|
|
3157
|
-
assetModelCompositeModelDescription?: string;
|
|
3157
|
+
assetModelCompositeModelDescription?: string | undefined;
|
|
3158
3158
|
/**
|
|
3159
3159
|
* <p>A unique name for the composite model.</p>
|
|
3160
3160
|
* @public
|
|
@@ -3169,12 +3169,12 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3169
3169
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3170
3170
|
* @public
|
|
3171
3171
|
*/
|
|
3172
|
-
clientToken?: string;
|
|
3172
|
+
clientToken?: string | undefined;
|
|
3173
3173
|
/**
|
|
3174
3174
|
* <p>The ID of a component model which is reused to create this composite model.</p>
|
|
3175
3175
|
* @public
|
|
3176
3176
|
*/
|
|
3177
|
-
composedAssetModelId?: string;
|
|
3177
|
+
composedAssetModelId?: string | undefined;
|
|
3178
3178
|
/**
|
|
3179
3179
|
* <p>The property definitions of the composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models">
|
|
3180
3180
|
* Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -3182,7 +3182,7 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3182
3182
|
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3183
3183
|
* @public
|
|
3184
3184
|
*/
|
|
3185
|
-
assetModelCompositeModelProperties?: AssetModelPropertyDefinition[];
|
|
3185
|
+
assetModelCompositeModelProperties?: AssetModelPropertyDefinition[] | undefined;
|
|
3186
3186
|
/**
|
|
3187
3187
|
* <p>The expected current entity tag (ETag) for the asset model’s latest or active version (specified using <code>matchForVersionType</code>).
|
|
3188
3188
|
* The create request is rejected if the tag does not match the latest or active version's current entity tag.
|
|
@@ -3190,19 +3190,19 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3190
3190
|
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3191
3191
|
* @public
|
|
3192
3192
|
*/
|
|
3193
|
-
ifMatch?: string;
|
|
3193
|
+
ifMatch?: string | undefined;
|
|
3194
3194
|
/**
|
|
3195
3195
|
* <p>Accepts <b>*</b> to reject the create request if an active version
|
|
3196
3196
|
* (specified using <code>matchForVersionType</code> as <code>ACTIVE</code>) already exists for the asset model.</p>
|
|
3197
3197
|
* @public
|
|
3198
3198
|
*/
|
|
3199
|
-
ifNoneMatch?: string;
|
|
3199
|
+
ifNoneMatch?: string | undefined;
|
|
3200
3200
|
/**
|
|
3201
3201
|
* <p>Specifies the asset model version type (<code>LATEST</code> or <code>ACTIVE</code>) used in
|
|
3202
3202
|
* conjunction with <code>If-Match</code> or <code>If-None-Match</code> headers to determine the target ETag for the create operation.</p>
|
|
3203
3203
|
* @public
|
|
3204
3204
|
*/
|
|
3205
|
-
matchForVersionType?: AssetModelVersionType;
|
|
3205
|
+
matchForVersionType?: AssetModelVersionType | undefined;
|
|
3206
3206
|
}
|
|
3207
3207
|
/**
|
|
3208
3208
|
* @public
|
|
@@ -3289,7 +3289,7 @@ export interface File {
|
|
|
3289
3289
|
* data.</p>
|
|
3290
3290
|
* @public
|
|
3291
3291
|
*/
|
|
3292
|
-
versionId?: string;
|
|
3292
|
+
versionId?: string | undefined;
|
|
3293
3293
|
}
|
|
3294
3294
|
/**
|
|
3295
3295
|
* @public
|
|
@@ -3335,12 +3335,12 @@ export interface FileFormat {
|
|
|
3335
3335
|
* <p>The file is in .CSV format.</p>
|
|
3336
3336
|
* @public
|
|
3337
3337
|
*/
|
|
3338
|
-
csv?: Csv;
|
|
3338
|
+
csv?: Csv | undefined;
|
|
3339
3339
|
/**
|
|
3340
3340
|
* <p>The file is in parquet format.</p>
|
|
3341
3341
|
* @public
|
|
3342
3342
|
*/
|
|
3343
|
-
parquet?: Parquet;
|
|
3343
|
+
parquet?: Parquet | undefined;
|
|
3344
3344
|
}
|
|
3345
3345
|
/**
|
|
3346
3346
|
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
@@ -3387,12 +3387,12 @@ export interface CreateBulkImportJobRequest {
|
|
|
3387
3387
|
* computed. If set to false, historical data is ingested into IoT SiteWise as is.</p>
|
|
3388
3388
|
* @public
|
|
3389
3389
|
*/
|
|
3390
|
-
adaptiveIngestion?: boolean;
|
|
3390
|
+
adaptiveIngestion?: boolean | undefined;
|
|
3391
3391
|
/**
|
|
3392
3392
|
* <p>If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.</p>
|
|
3393
3393
|
* @public
|
|
3394
3394
|
*/
|
|
3395
|
-
deleteFilesAfterImport?: boolean;
|
|
3395
|
+
deleteFilesAfterImport?: boolean | undefined;
|
|
3396
3396
|
}
|
|
3397
3397
|
/**
|
|
3398
3398
|
* @public
|
|
@@ -3476,7 +3476,7 @@ export interface CreateDashboardRequest {
|
|
|
3476
3476
|
* <p>A description for the dashboard.</p>
|
|
3477
3477
|
* @public
|
|
3478
3478
|
*/
|
|
3479
|
-
dashboardDescription?: string;
|
|
3479
|
+
dashboardDescription?: string | undefined;
|
|
3480
3480
|
/**
|
|
3481
3481
|
* <p>The dashboard definition specified in a JSON literal. For detailed information, see
|
|
3482
3482
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -3487,14 +3487,14 @@ export interface CreateDashboardRequest {
|
|
|
3487
3487
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3488
3488
|
* @public
|
|
3489
3489
|
*/
|
|
3490
|
-
clientToken?: string;
|
|
3490
|
+
clientToken?: string | undefined;
|
|
3491
3491
|
/**
|
|
3492
3492
|
* <p>A list of key-value pairs that contain metadata for the dashboard. For more information,
|
|
3493
3493
|
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
|
|
3494
3494
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3495
3495
|
* @public
|
|
3496
3496
|
*/
|
|
3497
|
-
tags?: Record<string, string
|
|
3497
|
+
tags?: Record<string, string> | undefined;
|
|
3498
3498
|
}
|
|
3499
3499
|
/**
|
|
3500
3500
|
* @public
|
|
@@ -3565,17 +3565,17 @@ export interface GatewayPlatform {
|
|
|
3565
3565
|
* <p>A gateway that runs on IoT Greengrass.</p>
|
|
3566
3566
|
* @public
|
|
3567
3567
|
*/
|
|
3568
|
-
greengrass?: Greengrass;
|
|
3568
|
+
greengrass?: Greengrass | undefined;
|
|
3569
3569
|
/**
|
|
3570
3570
|
* <p>A gateway that runs on IoT Greengrass V2.</p>
|
|
3571
3571
|
* @public
|
|
3572
3572
|
*/
|
|
3573
|
-
greengrassV2?: GreengrassV2;
|
|
3573
|
+
greengrassV2?: GreengrassV2 | undefined;
|
|
3574
3574
|
/**
|
|
3575
3575
|
* <p>A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>
|
|
3576
3576
|
* @public
|
|
3577
3577
|
*/
|
|
3578
|
-
siemensIE?: SiemensIE;
|
|
3578
|
+
siemensIE?: SiemensIE | undefined;
|
|
3579
3579
|
}
|
|
3580
3580
|
/**
|
|
3581
3581
|
* @public
|
|
@@ -3597,7 +3597,7 @@ export interface CreateGatewayRequest {
|
|
|
3597
3597
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3598
3598
|
* @public
|
|
3599
3599
|
*/
|
|
3600
|
-
tags?: Record<string, string
|
|
3600
|
+
tags?: Record<string, string> | undefined;
|
|
3601
3601
|
}
|
|
3602
3602
|
/**
|
|
3603
3603
|
* @public
|
|
@@ -3658,7 +3658,7 @@ export interface CreatePortalRequest {
|
|
|
3658
3658
|
* <p>A description for the portal.</p>
|
|
3659
3659
|
* @public
|
|
3660
3660
|
*/
|
|
3661
|
-
portalDescription?: string;
|
|
3661
|
+
portalDescription?: string | undefined;
|
|
3662
3662
|
/**
|
|
3663
3663
|
* <p>The Amazon Web Services administrator's contact email address.</p>
|
|
3664
3664
|
* @public
|
|
@@ -3668,13 +3668,13 @@ export interface CreatePortalRequest {
|
|
|
3668
3668
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3669
3669
|
* @public
|
|
3670
3670
|
*/
|
|
3671
|
-
clientToken?: string;
|
|
3671
|
+
clientToken?: string | undefined;
|
|
3672
3672
|
/**
|
|
3673
3673
|
* <p>A logo image to display in the portal. Upload a square, high-resolution image. The
|
|
3674
3674
|
* image is displayed on a dark background.</p>
|
|
3675
3675
|
* @public
|
|
3676
3676
|
*/
|
|
3677
|
-
portalLogoImageFile?: ImageFile;
|
|
3677
|
+
portalLogoImageFile?: ImageFile | undefined;
|
|
3678
3678
|
/**
|
|
3679
3679
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of a service role that allows the portal's users to access your IoT SiteWise
|
|
3680
3680
|
* resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the
|
|
@@ -3688,7 +3688,7 @@ export interface CreatePortalRequest {
|
|
|
3688
3688
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3689
3689
|
* @public
|
|
3690
3690
|
*/
|
|
3691
|
-
tags?: Record<string, string
|
|
3691
|
+
tags?: Record<string, string> | undefined;
|
|
3692
3692
|
/**
|
|
3693
3693
|
* <p>The service to use to authenticate users to the portal. Choose from the following
|
|
3694
3694
|
* options:</p>
|
|
@@ -3712,7 +3712,7 @@ export interface CreatePortalRequest {
|
|
|
3712
3712
|
* </p>
|
|
3713
3713
|
* @public
|
|
3714
3714
|
*/
|
|
3715
|
-
portalAuthMode?: AuthMode;
|
|
3715
|
+
portalAuthMode?: AuthMode | undefined;
|
|
3716
3716
|
/**
|
|
3717
3717
|
* <p>The email address that sends alarm notifications.</p>
|
|
3718
3718
|
* <important>
|
|
@@ -3722,14 +3722,14 @@ export interface CreatePortalRequest {
|
|
|
3722
3722
|
* </important>
|
|
3723
3723
|
* @public
|
|
3724
3724
|
*/
|
|
3725
|
-
notificationSenderEmail?: string;
|
|
3725
|
+
notificationSenderEmail?: string | undefined;
|
|
3726
3726
|
/**
|
|
3727
3727
|
* <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
|
|
3728
3728
|
* You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
|
|
3729
3729
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html">Monitoring with alarms</a> in the <i>IoT SiteWise Application Guide</i>.</p>
|
|
3730
3730
|
* @public
|
|
3731
3731
|
*/
|
|
3732
|
-
alarms?: Alarms;
|
|
3732
|
+
alarms?: Alarms | undefined;
|
|
3733
3733
|
}
|
|
3734
3734
|
/**
|
|
3735
3735
|
* @public
|
|
@@ -3753,12 +3753,12 @@ export interface MonitorErrorDetails {
|
|
|
3753
3753
|
* <p>The error code.</p>
|
|
3754
3754
|
* @public
|
|
3755
3755
|
*/
|
|
3756
|
-
code?: MonitorErrorCode;
|
|
3756
|
+
code?: MonitorErrorCode | undefined;
|
|
3757
3757
|
/**
|
|
3758
3758
|
* <p>The error message.</p>
|
|
3759
3759
|
* @public
|
|
3760
3760
|
*/
|
|
3761
|
-
message?: string;
|
|
3761
|
+
message?: string | undefined;
|
|
3762
3762
|
}
|
|
3763
3763
|
/**
|
|
3764
3764
|
* @public
|
|
@@ -3789,7 +3789,7 @@ export interface PortalStatus {
|
|
|
3789
3789
|
* <p>Contains associated error information, if any.</p>
|
|
3790
3790
|
* @public
|
|
3791
3791
|
*/
|
|
3792
|
-
error?: MonitorErrorDetails;
|
|
3792
|
+
error?: MonitorErrorDetails | undefined;
|
|
3793
3793
|
}
|
|
3794
3794
|
/**
|
|
3795
3795
|
* @public
|
|
@@ -3845,19 +3845,19 @@ export interface CreateProjectRequest {
|
|
|
3845
3845
|
* <p>A description for the project.</p>
|
|
3846
3846
|
* @public
|
|
3847
3847
|
*/
|
|
3848
|
-
projectDescription?: string;
|
|
3848
|
+
projectDescription?: string | undefined;
|
|
3849
3849
|
/**
|
|
3850
3850
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3851
3851
|
* @public
|
|
3852
3852
|
*/
|
|
3853
|
-
clientToken?: string;
|
|
3853
|
+
clientToken?: string | undefined;
|
|
3854
3854
|
/**
|
|
3855
3855
|
* <p>A list of key-value pairs that contain metadata for the project. For more information, see
|
|
3856
3856
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
|
|
3857
3857
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3858
3858
|
* @public
|
|
3859
3859
|
*/
|
|
3860
|
-
tags?: Record<string, string
|
|
3860
|
+
tags?: Record<string, string> | undefined;
|
|
3861
3861
|
}
|
|
3862
3862
|
/**
|
|
3863
3863
|
* @public
|
|
@@ -3890,7 +3890,7 @@ export interface DeleteAccessPolicyRequest {
|
|
|
3890
3890
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3891
3891
|
* @public
|
|
3892
3892
|
*/
|
|
3893
|
-
clientToken?: string;
|
|
3893
|
+
clientToken?: string | undefined;
|
|
3894
3894
|
}
|
|
3895
3895
|
/**
|
|
3896
3896
|
* @public
|
|
@@ -3911,7 +3911,7 @@ export interface DeleteAssetRequest {
|
|
|
3911
3911
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3912
3912
|
* @public
|
|
3913
3913
|
*/
|
|
3914
|
-
clientToken?: string;
|
|
3914
|
+
clientToken?: string | undefined;
|
|
3915
3915
|
}
|
|
3916
3916
|
/**
|
|
3917
3917
|
* @public
|
|
@@ -3938,7 +3938,7 @@ export interface DeleteAssetModelRequest {
|
|
|
3938
3938
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3939
3939
|
* @public
|
|
3940
3940
|
*/
|
|
3941
|
-
clientToken?: string;
|
|
3941
|
+
clientToken?: string | undefined;
|
|
3942
3942
|
/**
|
|
3943
3943
|
* <p>The expected current entity tag (ETag) for the asset model’s latest or active version (specified using <code>matchForVersionType</code>).
|
|
3944
3944
|
* The delete request is rejected if the tag does not match the latest or active version's current entity tag.
|
|
@@ -3946,19 +3946,19 @@ export interface DeleteAssetModelRequest {
|
|
|
3946
3946
|
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3947
3947
|
* @public
|
|
3948
3948
|
*/
|
|
3949
|
-
ifMatch?: string;
|
|
3949
|
+
ifMatch?: string | undefined;
|
|
3950
3950
|
/**
|
|
3951
3951
|
* <p>Accepts <b>*</b> to reject the delete request if an active version
|
|
3952
3952
|
* (specified using <code>matchForVersionType</code> as <code>ACTIVE</code>) already exists for the asset model.</p>
|
|
3953
3953
|
* @public
|
|
3954
3954
|
*/
|
|
3955
|
-
ifNoneMatch?: string;
|
|
3955
|
+
ifNoneMatch?: string | undefined;
|
|
3956
3956
|
/**
|
|
3957
3957
|
* <p>Specifies the asset model version type (<code>LATEST</code> or <code>ACTIVE</code>) used in
|
|
3958
3958
|
* conjunction with <code>If-Match</code> or <code>If-None-Match</code> headers to determine the target ETag for the delete operation.</p>
|
|
3959
3959
|
* @public
|
|
3960
3960
|
*/
|
|
3961
|
-
matchForVersionType?: AssetModelVersionType;
|
|
3961
|
+
matchForVersionType?: AssetModelVersionType | undefined;
|
|
3962
3962
|
}
|
|
3963
3963
|
/**
|
|
3964
3964
|
* @public
|
|
@@ -3989,7 +3989,7 @@ export interface DeleteAssetModelCompositeModelRequest {
|
|
|
3989
3989
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3990
3990
|
* @public
|
|
3991
3991
|
*/
|
|
3992
|
-
clientToken?: string;
|
|
3992
|
+
clientToken?: string | undefined;
|
|
3993
3993
|
/**
|
|
3994
3994
|
* <p>The expected current entity tag (ETag) for the asset model’s latest or active version (specified using <code>matchForVersionType</code>).
|
|
3995
3995
|
* The delete request is rejected if the tag does not match the latest or active version's current entity tag.
|
|
@@ -3997,19 +3997,19 @@ export interface DeleteAssetModelCompositeModelRequest {
|
|
|
3997
3997
|
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3998
3998
|
* @public
|
|
3999
3999
|
*/
|
|
4000
|
-
ifMatch?: string;
|
|
4000
|
+
ifMatch?: string | undefined;
|
|
4001
4001
|
/**
|
|
4002
4002
|
* <p>Accepts <b>*</b> to reject the delete request if an active version
|
|
4003
4003
|
* (specified using <code>matchForVersionType</code> as <code>ACTIVE</code>) already exists for the asset model.</p>
|
|
4004
4004
|
* @public
|
|
4005
4005
|
*/
|
|
4006
|
-
ifNoneMatch?: string;
|
|
4006
|
+
ifNoneMatch?: string | undefined;
|
|
4007
4007
|
/**
|
|
4008
4008
|
* <p>Specifies the asset model version type (<code>LATEST</code> or <code>ACTIVE</code>) used in
|
|
4009
4009
|
* conjunction with <code>If-Match</code> or <code>If-None-Match</code> headers to determine the target ETag for the delete operation.</p>
|
|
4010
4010
|
* @public
|
|
4011
4011
|
*/
|
|
4012
|
-
matchForVersionType?: AssetModelVersionType;
|
|
4012
|
+
matchForVersionType?: AssetModelVersionType | undefined;
|
|
4013
4013
|
}
|
|
4014
4014
|
/**
|
|
4015
4015
|
* @public
|
|
@@ -4035,7 +4035,7 @@ export interface DeleteDashboardRequest {
|
|
|
4035
4035
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
4036
4036
|
* @public
|
|
4037
4037
|
*/
|
|
4038
|
-
clientToken?: string;
|
|
4038
|
+
clientToken?: string | undefined;
|
|
4039
4039
|
}
|
|
4040
4040
|
/**
|
|
4041
4041
|
* @public
|
|
@@ -4065,7 +4065,7 @@ export interface DeletePortalRequest {
|
|
|
4065
4065
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
4066
4066
|
* @public
|
|
4067
4067
|
*/
|
|
4068
|
-
clientToken?: string;
|
|
4068
|
+
clientToken?: string | undefined;
|
|
4069
4069
|
}
|
|
4070
4070
|
/**
|
|
4071
4071
|
* @public
|
|
@@ -4091,7 +4091,7 @@ export interface DeleteProjectRequest {
|
|
|
4091
4091
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
4092
4092
|
* @public
|
|
4093
4093
|
*/
|
|
4094
|
-
clientToken?: string;
|
|
4094
|
+
clientToken?: string | undefined;
|
|
4095
4095
|
}
|
|
4096
4096
|
/**
|
|
4097
4097
|
* @public
|
|
@@ -4106,24 +4106,24 @@ export interface DeleteTimeSeriesRequest {
|
|
|
4106
4106
|
* <p>The alias that identifies the time series.</p>
|
|
4107
4107
|
* @public
|
|
4108
4108
|
*/
|
|
4109
|
-
alias?: string;
|
|
4109
|
+
alias?: string | undefined;
|
|
4110
4110
|
/**
|
|
4111
4111
|
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4112
4112
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4113
4113
|
* @public
|
|
4114
4114
|
*/
|
|
4115
|
-
assetId?: string;
|
|
4115
|
+
assetId?: string | undefined;
|
|
4116
4116
|
/**
|
|
4117
4117
|
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4118
4118
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4119
4119
|
* @public
|
|
4120
4120
|
*/
|
|
4121
|
-
propertyId?: string;
|
|
4121
|
+
propertyId?: string | undefined;
|
|
4122
4122
|
/**
|
|
4123
4123
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
4124
4124
|
* @public
|
|
4125
4125
|
*/
|
|
4126
|
-
clientToken?: string;
|
|
4126
|
+
clientToken?: string | undefined;
|
|
4127
4127
|
}
|
|
4128
4128
|
/**
|
|
4129
4129
|
* @public
|
|
@@ -4235,7 +4235,7 @@ export interface DescribeAssetRequest {
|
|
|
4235
4235
|
* <p> Whether or not to exclude asset properties from the response. </p>
|
|
4236
4236
|
* @public
|
|
4237
4237
|
*/
|
|
4238
|
-
excludeProperties?: boolean;
|
|
4238
|
+
excludeProperties?: boolean | undefined;
|
|
4239
4239
|
}
|
|
4240
4240
|
/**
|
|
4241
4241
|
* @public
|
|
@@ -4280,7 +4280,7 @@ export interface DescribeAssetResponse {
|
|
|
4280
4280
|
* <p>The composite models for the asset.</p>
|
|
4281
4281
|
* @public
|
|
4282
4282
|
*/
|
|
4283
|
-
assetCompositeModels?: AssetCompositeModel[];
|
|
4283
|
+
assetCompositeModels?: AssetCompositeModel[] | undefined;
|
|
4284
4284
|
/**
|
|
4285
4285
|
* <p>The date the asset was created, in Unix epoch time.</p>
|
|
4286
4286
|
* @public
|
|
@@ -4300,17 +4300,17 @@ export interface DescribeAssetResponse {
|
|
|
4300
4300
|
* <p>A description for the asset.</p>
|
|
4301
4301
|
* @public
|
|
4302
4302
|
*/
|
|
4303
|
-
assetDescription?: string;
|
|
4303
|
+
assetDescription?: string | undefined;
|
|
4304
4304
|
/**
|
|
4305
4305
|
* <p>The list of the immediate child custom composite model summaries for the asset.</p>
|
|
4306
4306
|
* @public
|
|
4307
4307
|
*/
|
|
4308
|
-
assetCompositeModelSummaries?: AssetCompositeModelSummary[];
|
|
4308
|
+
assetCompositeModelSummaries?: AssetCompositeModelSummary[] | undefined;
|
|
4309
4309
|
/**
|
|
4310
4310
|
* <p>The external ID of the asset, if any.</p>
|
|
4311
4311
|
* @public
|
|
4312
4312
|
*/
|
|
4313
|
-
assetExternalId?: string;
|
|
4313
|
+
assetExternalId?: string | undefined;
|
|
4314
4314
|
}
|
|
4315
4315
|
/**
|
|
4316
4316
|
* @public
|
|
@@ -4352,7 +4352,7 @@ export interface DescribeAssetCompositeModelResponse {
|
|
|
4352
4352
|
* property from the created model it's a part of.</p>
|
|
4353
4353
|
* @public
|
|
4354
4354
|
*/
|
|
4355
|
-
assetCompositeModelExternalId?: string;
|
|
4355
|
+
assetCompositeModelExternalId?: string | undefined;
|
|
4356
4356
|
/**
|
|
4357
4357
|
* <p>The path to the composite model listing the parent composite models.</p>
|
|
4358
4358
|
* @public
|
|
@@ -4388,7 +4388,7 @@ export interface DescribeAssetCompositeModelResponse {
|
|
|
4388
4388
|
* <p>The available actions for a composite model on this asset.</p>
|
|
4389
4389
|
* @public
|
|
4390
4390
|
*/
|
|
4391
|
-
actionDefinitions?: ActionDefinition[];
|
|
4391
|
+
actionDefinitions?: ActionDefinition[] | undefined;
|
|
4392
4392
|
}
|
|
4393
4393
|
/**
|
|
4394
4394
|
* @public
|
|
@@ -4404,14 +4404,14 @@ export interface DescribeAssetModelRequest {
|
|
|
4404
4404
|
* <p> Whether or not to exclude asset model properties from the response. </p>
|
|
4405
4405
|
* @public
|
|
4406
4406
|
*/
|
|
4407
|
-
excludeProperties?: boolean;
|
|
4407
|
+
excludeProperties?: boolean | undefined;
|
|
4408
4408
|
/**
|
|
4409
4409
|
* <p>The version alias that specifies the latest or active version of the asset model.
|
|
4410
4410
|
* The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
|
|
4411
4411
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4412
4412
|
* @public
|
|
4413
4413
|
*/
|
|
4414
|
-
assetModelVersion?: string;
|
|
4414
|
+
assetModelVersion?: string | undefined;
|
|
4415
4415
|
}
|
|
4416
4416
|
/**
|
|
4417
4417
|
* @public
|
|
@@ -4426,7 +4426,7 @@ export interface DescribeAssetModelResponse {
|
|
|
4426
4426
|
* <p>The external ID of the asset model, if any.</p>
|
|
4427
4427
|
* @public
|
|
4428
4428
|
*/
|
|
4429
|
-
assetModelExternalId?: string;
|
|
4429
|
+
assetModelExternalId?: string | undefined;
|
|
4430
4430
|
/**
|
|
4431
4431
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p>
|
|
4432
4432
|
* <p>
|
|
@@ -4456,7 +4456,7 @@ export interface DescribeAssetModelResponse {
|
|
|
4456
4456
|
* </ul>
|
|
4457
4457
|
* @public
|
|
4458
4458
|
*/
|
|
4459
|
-
assetModelType?: AssetModelType;
|
|
4459
|
+
assetModelType?: AssetModelType | undefined;
|
|
4460
4460
|
/**
|
|
4461
4461
|
* <p>The asset model's description.</p>
|
|
4462
4462
|
* @public
|
|
@@ -4481,13 +4481,13 @@ export interface DescribeAssetModelResponse {
|
|
|
4481
4481
|
* type <code>AWS/ALARMS</code>.</p>
|
|
4482
4482
|
* @public
|
|
4483
4483
|
*/
|
|
4484
|
-
assetModelCompositeModels?: AssetModelCompositeModel[];
|
|
4484
|
+
assetModelCompositeModels?: AssetModelCompositeModel[] | undefined;
|
|
4485
4485
|
/**
|
|
4486
4486
|
* <p>The list of the immediate child custom composite model summaries for the asset
|
|
4487
4487
|
* model.</p>
|
|
4488
4488
|
* @public
|
|
4489
4489
|
*/
|
|
4490
|
-
assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[];
|
|
4490
|
+
assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[] | undefined;
|
|
4491
4491
|
/**
|
|
4492
4492
|
* <p>The date the asset model was created, in Unix epoch time.</p>
|
|
4493
4493
|
* @public
|
|
@@ -4509,7 +4509,7 @@ export interface DescribeAssetModelResponse {
|
|
|
4509
4509
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4510
4510
|
* @public
|
|
4511
4511
|
*/
|
|
4512
|
-
assetModelVersion?: string;
|
|
4512
|
+
assetModelVersion?: string | undefined;
|
|
4513
4513
|
/**
|
|
4514
4514
|
* <p>The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make
|
|
4515
4515
|
* concurrent updates safely to the resource. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html">Optimistic locking for asset model writes</a>
|
|
@@ -4520,7 +4520,7 @@ export interface DescribeAssetModelResponse {
|
|
|
4520
4520
|
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4521
4521
|
* @public
|
|
4522
4522
|
*/
|
|
4523
|
-
eTag?: string;
|
|
4523
|
+
eTag?: string | undefined;
|
|
4524
4524
|
}
|
|
4525
4525
|
/**
|
|
4526
4526
|
* @public
|
|
@@ -4544,7 +4544,7 @@ export interface DescribeAssetModelCompositeModelRequest {
|
|
|
4544
4544
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4545
4545
|
* @public
|
|
4546
4546
|
*/
|
|
4547
|
-
assetModelVersion?: string;
|
|
4547
|
+
assetModelVersion?: string | undefined;
|
|
4548
4548
|
}
|
|
4549
4549
|
/**
|
|
4550
4550
|
* <p>Represents a composite model that composed an asset model of type
|
|
@@ -4556,7 +4556,7 @@ export interface CompositionRelationshipItem {
|
|
|
4556
4556
|
* <p>The ID of the component.</p>
|
|
4557
4557
|
* @public
|
|
4558
4558
|
*/
|
|
4559
|
-
id?: string;
|
|
4559
|
+
id?: string | undefined;
|
|
4560
4560
|
}
|
|
4561
4561
|
/**
|
|
4562
4562
|
* <p>Metadata for the composition relationship established by using
|
|
@@ -4570,7 +4570,7 @@ export interface CompositionDetails {
|
|
|
4570
4570
|
* <p>An array detailing the composition relationship for this composite model.</p>
|
|
4571
4571
|
* @public
|
|
4572
4572
|
*/
|
|
4573
|
-
compositionRelationship?: CompositionRelationshipItem[];
|
|
4573
|
+
compositionRelationship?: CompositionRelationshipItem[] | undefined;
|
|
4574
4574
|
}
|
|
4575
4575
|
/**
|
|
4576
4576
|
* @public
|
|
@@ -4590,7 +4590,7 @@ export interface DescribeAssetModelCompositeModelResponse {
|
|
|
4590
4590
|
* <p>The external ID of a composite model on this asset model.</p>
|
|
4591
4591
|
* @public
|
|
4592
4592
|
*/
|
|
4593
|
-
assetModelCompositeModelExternalId?: string;
|
|
4593
|
+
assetModelCompositeModelExternalId?: string | undefined;
|
|
4594
4594
|
/**
|
|
4595
4595
|
* <p>The path to the composite model listing the parent composite models.</p>
|
|
4596
4596
|
* @public
|
|
@@ -4625,7 +4625,7 @@ export interface DescribeAssetModelCompositeModelResponse {
|
|
|
4625
4625
|
* path of the composition relationship for this composite model.</p>
|
|
4626
4626
|
* @public
|
|
4627
4627
|
*/
|
|
4628
|
-
compositionDetails?: CompositionDetails;
|
|
4628
|
+
compositionDetails?: CompositionDetails | undefined;
|
|
4629
4629
|
/**
|
|
4630
4630
|
* <p>The list of composite model summaries for the composite model.</p>
|
|
4631
4631
|
* @public
|
|
@@ -4635,7 +4635,7 @@ export interface DescribeAssetModelCompositeModelResponse {
|
|
|
4635
4635
|
* <p>The available actions for a composite model on this asset model.</p>
|
|
4636
4636
|
* @public
|
|
4637
4637
|
*/
|
|
4638
|
-
actionDefinitions?: ActionDefinition[];
|
|
4638
|
+
actionDefinitions?: ActionDefinition[] | undefined;
|
|
4639
4639
|
}
|
|
4640
4640
|
/**
|
|
4641
4641
|
* @public
|
|
@@ -4676,12 +4676,12 @@ export interface Property {
|
|
|
4676
4676
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
4677
4677
|
* @public
|
|
4678
4678
|
*/
|
|
4679
|
-
alias?: string;
|
|
4679
|
+
alias?: string | undefined;
|
|
4680
4680
|
/**
|
|
4681
4681
|
* <p>The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
4682
4682
|
* @public
|
|
4683
4683
|
*/
|
|
4684
|
-
notification?: PropertyNotification;
|
|
4684
|
+
notification?: PropertyNotification | undefined;
|
|
4685
4685
|
/**
|
|
4686
4686
|
* <p>The property data type.</p>
|
|
4687
4687
|
* @public
|
|
@@ -4691,22 +4691,22 @@ export interface Property {
|
|
|
4691
4691
|
* <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.</p>
|
|
4692
4692
|
* @public
|
|
4693
4693
|
*/
|
|
4694
|
-
unit?: string;
|
|
4694
|
+
unit?: string | undefined;
|
|
4695
4695
|
/**
|
|
4696
4696
|
* <p>The property type (see <code>PropertyType</code>). A property contains one type.</p>
|
|
4697
4697
|
* @public
|
|
4698
4698
|
*/
|
|
4699
|
-
type?: PropertyType;
|
|
4699
|
+
type?: PropertyType | undefined;
|
|
4700
4700
|
/**
|
|
4701
4701
|
* <p>The structured path to the property from the root of the asset.</p>
|
|
4702
4702
|
* @public
|
|
4703
4703
|
*/
|
|
4704
|
-
path?: AssetPropertyPathSegment[];
|
|
4704
|
+
path?: AssetPropertyPathSegment[] | undefined;
|
|
4705
4705
|
/**
|
|
4706
4706
|
* <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4707
4707
|
* @public
|
|
4708
4708
|
*/
|
|
4709
|
-
externalId?: string;
|
|
4709
|
+
externalId?: string | undefined;
|
|
4710
4710
|
}
|
|
4711
4711
|
/**
|
|
4712
4712
|
* <p>Contains information about a composite model property on an asset.</p>
|
|
@@ -4732,12 +4732,12 @@ export interface CompositeModelProperty {
|
|
|
4732
4732
|
* <p> The ID of the composite model that contains the property. </p>
|
|
4733
4733
|
* @public
|
|
4734
4734
|
*/
|
|
4735
|
-
id?: string;
|
|
4735
|
+
id?: string | undefined;
|
|
4736
4736
|
/**
|
|
4737
4737
|
* <p>The external ID of the composite model that contains the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4738
4738
|
* @public
|
|
4739
4739
|
*/
|
|
4740
|
-
externalId?: string;
|
|
4740
|
+
externalId?: string | undefined;
|
|
4741
4741
|
}
|
|
4742
4742
|
/**
|
|
4743
4743
|
* @public
|
|
@@ -4765,18 +4765,18 @@ export interface DescribeAssetPropertyResponse {
|
|
|
4765
4765
|
* <code>compositeModel</code>.</p>
|
|
4766
4766
|
* @public
|
|
4767
4767
|
*/
|
|
4768
|
-
assetProperty?: Property;
|
|
4768
|
+
assetProperty?: Property | undefined;
|
|
4769
4769
|
/**
|
|
4770
4770
|
* <p>The composite model that declares this asset property, if this asset property exists in a
|
|
4771
4771
|
* composite model.</p>
|
|
4772
4772
|
* @public
|
|
4773
4773
|
*/
|
|
4774
|
-
compositeModel?: CompositeModelProperty;
|
|
4774
|
+
compositeModel?: CompositeModelProperty | undefined;
|
|
4775
4775
|
/**
|
|
4776
4776
|
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4777
4777
|
* @public
|
|
4778
4778
|
*/
|
|
4779
|
-
assetExternalId?: string;
|
|
4779
|
+
assetExternalId?: string | undefined;
|
|
4780
4780
|
}
|
|
4781
4781
|
/**
|
|
4782
4782
|
* @public
|
|
@@ -4870,12 +4870,12 @@ export interface DescribeBulkImportJobResponse {
|
|
|
4870
4870
|
* computed. If set to false, historical data is ingested into IoT SiteWise as is.</p>
|
|
4871
4871
|
* @public
|
|
4872
4872
|
*/
|
|
4873
|
-
adaptiveIngestion?: boolean;
|
|
4873
|
+
adaptiveIngestion?: boolean | undefined;
|
|
4874
4874
|
/**
|
|
4875
4875
|
* <p>If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.</p>
|
|
4876
4876
|
* @public
|
|
4877
4877
|
*/
|
|
4878
|
-
deleteFilesAfterImport?: boolean;
|
|
4878
|
+
deleteFilesAfterImport?: boolean | undefined;
|
|
4879
4879
|
}
|
|
4880
4880
|
/**
|
|
4881
4881
|
* @public
|
|
@@ -4918,7 +4918,7 @@ export interface DescribeDashboardResponse {
|
|
|
4918
4918
|
* <p>The dashboard's description.</p>
|
|
4919
4919
|
* @public
|
|
4920
4920
|
*/
|
|
4921
|
-
dashboardDescription?: string;
|
|
4921
|
+
dashboardDescription?: string | undefined;
|
|
4922
4922
|
/**
|
|
4923
4923
|
* <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating
|
|
4924
4924
|
* dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -4984,7 +4984,7 @@ export interface ConfigurationStatus {
|
|
|
4984
4984
|
* <p>Contains associated error information, if any.</p>
|
|
4985
4985
|
* @public
|
|
4986
4986
|
*/
|
|
4987
|
-
error?: ConfigurationErrorDetails;
|
|
4987
|
+
error?: ConfigurationErrorDetails | undefined;
|
|
4988
4988
|
}
|
|
4989
4989
|
/**
|
|
4990
4990
|
* @public
|
|
@@ -5012,7 +5012,7 @@ export interface DescribeDefaultEncryptionConfigurationResponse {
|
|
|
5012
5012
|
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
5013
5013
|
* @public
|
|
5014
5014
|
*/
|
|
5015
|
-
kmsKeyArn?: string;
|
|
5015
|
+
kmsKeyArn?: string | undefined;
|
|
5016
5016
|
/**
|
|
5017
5017
|
* <p>The status of the account configuration. This contains the
|
|
5018
5018
|
* <code>ConfigurationState</code>. If there's an error, it also contains the
|
|
@@ -5106,7 +5106,7 @@ export interface DescribeGatewayResponse {
|
|
|
5106
5106
|
* <p>The gateway's platform.</p>
|
|
5107
5107
|
* @public
|
|
5108
5108
|
*/
|
|
5109
|
-
gatewayPlatform?: GatewayPlatform;
|
|
5109
|
+
gatewayPlatform?: GatewayPlatform | undefined;
|
|
5110
5110
|
/**
|
|
5111
5111
|
* <p>A list of gateway capability summaries that each contain a namespace and status. Each
|
|
5112
5112
|
* gateway capability defines data sources for the gateway. To retrieve a capability
|
|
@@ -5276,7 +5276,7 @@ export interface DescribePortalResponse {
|
|
|
5276
5276
|
* <p>The portal's description.</p>
|
|
5277
5277
|
* @public
|
|
5278
5278
|
*/
|
|
5279
|
-
portalDescription?: string;
|
|
5279
|
+
portalDescription?: string | undefined;
|
|
5280
5280
|
/**
|
|
5281
5281
|
* <p>The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes
|
|
5282
5282
|
* <code>portalClientId</code> for only portals that use IAM Identity Center to authenticate users.</p>
|
|
@@ -5314,29 +5314,29 @@ export interface DescribePortalResponse {
|
|
|
5314
5314
|
* <p>The portal's logo image, which is available at a URL.</p>
|
|
5315
5315
|
* @public
|
|
5316
5316
|
*/
|
|
5317
|
-
portalLogoImageLocation?: ImageLocation;
|
|
5317
|
+
portalLogoImageLocation?: ImageLocation | undefined;
|
|
5318
5318
|
/**
|
|
5319
5319
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the service role that allows the portal's users to access your IoT SiteWise
|
|
5320
5320
|
* resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the
|
|
5321
5321
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
5322
5322
|
* @public
|
|
5323
5323
|
*/
|
|
5324
|
-
roleArn?: string;
|
|
5324
|
+
roleArn?: string | undefined;
|
|
5325
5325
|
/**
|
|
5326
5326
|
* <p>The service to use to authenticate users to the portal.</p>
|
|
5327
5327
|
* @public
|
|
5328
5328
|
*/
|
|
5329
|
-
portalAuthMode?: AuthMode;
|
|
5329
|
+
portalAuthMode?: AuthMode | undefined;
|
|
5330
5330
|
/**
|
|
5331
5331
|
* <p>The email address that sends alarm notifications.</p>
|
|
5332
5332
|
* @public
|
|
5333
5333
|
*/
|
|
5334
|
-
notificationSenderEmail?: string;
|
|
5334
|
+
notificationSenderEmail?: string | undefined;
|
|
5335
5335
|
/**
|
|
5336
5336
|
* <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.</p>
|
|
5337
5337
|
* @public
|
|
5338
5338
|
*/
|
|
5339
|
-
alarms?: Alarms;
|
|
5339
|
+
alarms?: Alarms | undefined;
|
|
5340
5340
|
}
|
|
5341
5341
|
/**
|
|
5342
5342
|
* @public
|
|
@@ -5379,7 +5379,7 @@ export interface DescribeProjectResponse {
|
|
|
5379
5379
|
* <p>The project's description.</p>
|
|
5380
5380
|
* @public
|
|
5381
5381
|
*/
|
|
5382
|
-
projectDescription?: string;
|
|
5382
|
+
projectDescription?: string | undefined;
|
|
5383
5383
|
/**
|
|
5384
5384
|
* <p>The date the project was created, in Unix epoch time.</p>
|
|
5385
5385
|
* @public
|
|
@@ -5450,7 +5450,7 @@ export interface RetentionPeriod {
|
|
|
5450
5450
|
* </note>
|
|
5451
5451
|
* @public
|
|
5452
5452
|
*/
|
|
5453
|
-
numberOfDays?: number;
|
|
5453
|
+
numberOfDays?: number | undefined;
|
|
5454
5454
|
/**
|
|
5455
5455
|
* <p>If true, your data is kept indefinitely.</p>
|
|
5456
5456
|
* <note>
|
|
@@ -5459,7 +5459,7 @@ export interface RetentionPeriod {
|
|
|
5459
5459
|
* </note>
|
|
5460
5460
|
* @public
|
|
5461
5461
|
*/
|
|
5462
|
-
unlimited?: boolean;
|
|
5462
|
+
unlimited?: boolean | undefined;
|
|
5463
5463
|
}
|
|
5464
5464
|
/**
|
|
5465
5465
|
* @public
|
|
@@ -5494,12 +5494,12 @@ export interface WarmTierRetentionPeriod {
|
|
|
5494
5494
|
* <p>The number of days the data is stored in the warm tier.</p>
|
|
5495
5495
|
* @public
|
|
5496
5496
|
*/
|
|
5497
|
-
numberOfDays?: number;
|
|
5497
|
+
numberOfDays?: number | undefined;
|
|
5498
5498
|
/**
|
|
5499
5499
|
* <p>If set to true, the data is stored indefinitely in the warm tier.</p>
|
|
5500
5500
|
* @public
|
|
5501
5501
|
*/
|
|
5502
|
-
unlimited?: boolean;
|
|
5502
|
+
unlimited?: boolean | undefined;
|
|
5503
5503
|
}
|
|
5504
5504
|
/**
|
|
5505
5505
|
* @public
|
|
@@ -5527,7 +5527,7 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
5527
5527
|
* <p>Contains information about the storage destination.</p>
|
|
5528
5528
|
* @public
|
|
5529
5529
|
*/
|
|
5530
|
-
multiLayerStorage?: MultiLayerStorage;
|
|
5530
|
+
multiLayerStorage?: MultiLayerStorage | undefined;
|
|
5531
5531
|
/**
|
|
5532
5532
|
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
5533
5533
|
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
@@ -5548,12 +5548,12 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
5548
5548
|
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5549
5549
|
* @public
|
|
5550
5550
|
*/
|
|
5551
|
-
disassociatedDataStorage?: DisassociatedDataStorageState;
|
|
5551
|
+
disassociatedDataStorage?: DisassociatedDataStorageState | undefined;
|
|
5552
5552
|
/**
|
|
5553
5553
|
* <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
5554
5554
|
* @public
|
|
5555
5555
|
*/
|
|
5556
|
-
retentionPeriod?: RetentionPeriod;
|
|
5556
|
+
retentionPeriod?: RetentionPeriod | undefined;
|
|
5557
5557
|
/**
|
|
5558
5558
|
* <p>Contains current status information for the configuration.</p>
|
|
5559
5559
|
* @public
|
|
@@ -5563,17 +5563,17 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
5563
5563
|
* <p>The date the storage configuration was last updated, in Unix epoch time.</p>
|
|
5564
5564
|
* @public
|
|
5565
5565
|
*/
|
|
5566
|
-
lastUpdateDate?: Date;
|
|
5566
|
+
lastUpdateDate?: Date | undefined;
|
|
5567
5567
|
/**
|
|
5568
5568
|
* <p>A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.</p>
|
|
5569
5569
|
* @public
|
|
5570
5570
|
*/
|
|
5571
|
-
warmTier?: WarmTierState;
|
|
5571
|
+
warmTier?: WarmTierState | undefined;
|
|
5572
5572
|
/**
|
|
5573
5573
|
* <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
|
|
5574
5574
|
* @public
|
|
5575
5575
|
*/
|
|
5576
|
-
warmTierRetentionPeriod?: WarmTierRetentionPeriod;
|
|
5576
|
+
warmTierRetentionPeriod?: WarmTierRetentionPeriod | undefined;
|
|
5577
5577
|
}
|
|
5578
5578
|
/**
|
|
5579
5579
|
* @public
|
|
@@ -5583,19 +5583,19 @@ export interface DescribeTimeSeriesRequest {
|
|
|
5583
5583
|
* <p>The alias that identifies the time series.</p>
|
|
5584
5584
|
* @public
|
|
5585
5585
|
*/
|
|
5586
|
-
alias?: string;
|
|
5586
|
+
alias?: string | undefined;
|
|
5587
5587
|
/**
|
|
5588
5588
|
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5589
5589
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5590
5590
|
* @public
|
|
5591
5591
|
*/
|
|
5592
|
-
assetId?: string;
|
|
5592
|
+
assetId?: string | undefined;
|
|
5593
5593
|
/**
|
|
5594
5594
|
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5595
5595
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5596
5596
|
* @public
|
|
5597
5597
|
*/
|
|
5598
|
-
propertyId?: string;
|
|
5598
|
+
propertyId?: string | undefined;
|
|
5599
5599
|
}
|
|
5600
5600
|
/**
|
|
5601
5601
|
* @public
|
|
@@ -5605,17 +5605,17 @@ export interface DescribeTimeSeriesResponse {
|
|
|
5605
5605
|
* <p>The ID of the asset in which the asset property was created.</p>
|
|
5606
5606
|
* @public
|
|
5607
5607
|
*/
|
|
5608
|
-
assetId?: string;
|
|
5608
|
+
assetId?: string | undefined;
|
|
5609
5609
|
/**
|
|
5610
5610
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
5611
5611
|
* @public
|
|
5612
5612
|
*/
|
|
5613
|
-
propertyId?: string;
|
|
5613
|
+
propertyId?: string | undefined;
|
|
5614
5614
|
/**
|
|
5615
5615
|
* <p>The alias that identifies the time series.</p>
|
|
5616
5616
|
* @public
|
|
5617
5617
|
*/
|
|
5618
|
-
alias?: string;
|
|
5618
|
+
alias?: string | undefined;
|
|
5619
5619
|
/**
|
|
5620
5620
|
* <p>The ID of the time series.</p>
|
|
5621
5621
|
* @public
|
|
@@ -5635,7 +5635,7 @@ export interface DescribeTimeSeriesResponse {
|
|
|
5635
5635
|
* Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
|
|
5636
5636
|
* @public
|
|
5637
5637
|
*/
|
|
5638
|
-
dataTypeSpec?: string;
|
|
5638
|
+
dataTypeSpec?: string | undefined;
|
|
5639
5639
|
/**
|
|
5640
5640
|
* <p>The date that the time series was created, in Unix epoch time.</p>
|
|
5641
5641
|
* @public
|
|
@@ -5685,7 +5685,7 @@ export interface DisassociateAssetsRequest {
|
|
|
5685
5685
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
5686
5686
|
* @public
|
|
5687
5687
|
*/
|
|
5688
|
-
clientToken?: string;
|
|
5688
|
+
clientToken?: string | undefined;
|
|
5689
5689
|
}
|
|
5690
5690
|
/**
|
|
5691
5691
|
* @public
|
|
@@ -5712,7 +5712,7 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
|
5712
5712
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
5713
5713
|
* @public
|
|
5714
5714
|
*/
|
|
5715
|
-
clientToken?: string;
|
|
5715
|
+
clientToken?: string | undefined;
|
|
5716
5716
|
}
|
|
5717
5717
|
/**
|
|
5718
5718
|
* @public
|
|
@@ -5737,7 +5737,7 @@ export interface ExecuteActionRequest {
|
|
|
5737
5737
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
5738
5738
|
* @public
|
|
5739
5739
|
*/
|
|
5740
|
-
clientToken?: string;
|
|
5740
|
+
clientToken?: string | undefined;
|
|
5741
5741
|
}
|
|
5742
5742
|
/**
|
|
5743
5743
|
* @public
|
|
@@ -5762,12 +5762,12 @@ export interface ExecuteQueryRequest {
|
|
|
5762
5762
|
* <p>The string that specifies the next page of results.</p>
|
|
5763
5763
|
* @public
|
|
5764
5764
|
*/
|
|
5765
|
-
nextToken?: string;
|
|
5765
|
+
nextToken?: string | undefined;
|
|
5766
5766
|
/**
|
|
5767
5767
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5768
5768
|
* @public
|
|
5769
5769
|
*/
|
|
5770
|
-
maxResults?: number;
|
|
5770
|
+
maxResults?: number | undefined;
|
|
5771
5771
|
}
|
|
5772
5772
|
/**
|
|
5773
5773
|
* @public
|
|
@@ -5793,7 +5793,7 @@ export interface ColumnType {
|
|
|
5793
5793
|
* <p>The allowed data types that the column has as it's value.</p>
|
|
5794
5794
|
* @public
|
|
5795
5795
|
*/
|
|
5796
|
-
scalarType?: ScalarType;
|
|
5796
|
+
scalarType?: ScalarType | undefined;
|
|
5797
5797
|
}
|
|
5798
5798
|
/**
|
|
5799
5799
|
* <p>A description of the column in the query results.</p>
|
|
@@ -5804,12 +5804,12 @@ export interface ColumnInfo {
|
|
|
5804
5804
|
* <p>The name of the column description.</p>
|
|
5805
5805
|
* @public
|
|
5806
5806
|
*/
|
|
5807
|
-
name?: string;
|
|
5807
|
+
name?: string | undefined;
|
|
5808
5808
|
/**
|
|
5809
5809
|
* <p>The type of the column description.</p>
|
|
5810
5810
|
* @public
|
|
5811
5811
|
*/
|
|
5812
|
-
type?: ColumnType;
|
|
5812
|
+
type?: ColumnType | undefined;
|
|
5813
5813
|
}
|
|
5814
5814
|
/**
|
|
5815
5815
|
* <p>The query timed out.</p>
|
|
@@ -5843,12 +5843,12 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5843
5843
|
* <p>The ID of the asset, in UUID format.</p>
|
|
5844
5844
|
* @public
|
|
5845
5845
|
*/
|
|
5846
|
-
assetId?: string;
|
|
5846
|
+
assetId?: string | undefined;
|
|
5847
5847
|
/**
|
|
5848
5848
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
5849
5849
|
* @public
|
|
5850
5850
|
*/
|
|
5851
|
-
propertyId?: string;
|
|
5851
|
+
propertyId?: string | undefined;
|
|
5852
5852
|
/**
|
|
5853
5853
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
5854
5854
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -5856,7 +5856,7 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5856
5856
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
5857
5857
|
* @public
|
|
5858
5858
|
*/
|
|
5859
|
-
propertyAlias?: string;
|
|
5859
|
+
propertyAlias?: string | undefined;
|
|
5860
5860
|
/**
|
|
5861
5861
|
* <p>The data aggregating function.</p>
|
|
5862
5862
|
* @public
|
|
@@ -5871,7 +5871,7 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5871
5871
|
* <p>The quality by which to filter asset data.</p>
|
|
5872
5872
|
* @public
|
|
5873
5873
|
*/
|
|
5874
|
-
qualities?: Quality[];
|
|
5874
|
+
qualities?: Quality[] | undefined;
|
|
5875
5875
|
/**
|
|
5876
5876
|
* <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
5877
5877
|
* @public
|
|
@@ -5888,12 +5888,12 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5888
5888
|
* </p>
|
|
5889
5889
|
* @public
|
|
5890
5890
|
*/
|
|
5891
|
-
timeOrdering?: TimeOrdering;
|
|
5891
|
+
timeOrdering?: TimeOrdering | undefined;
|
|
5892
5892
|
/**
|
|
5893
5893
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
5894
5894
|
* @public
|
|
5895
5895
|
*/
|
|
5896
|
-
nextToken?: string;
|
|
5896
|
+
nextToken?: string | undefined;
|
|
5897
5897
|
/**
|
|
5898
5898
|
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
|
|
5899
5899
|
* first.</p>
|
|
@@ -5908,7 +5908,7 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5908
5908
|
* </ul>
|
|
5909
5909
|
* @public
|
|
5910
5910
|
*/
|
|
5911
|
-
maxResults?: number;
|
|
5911
|
+
maxResults?: number | undefined;
|
|
5912
5912
|
}
|
|
5913
5913
|
/**
|
|
5914
5914
|
* @public
|
|
@@ -5923,7 +5923,7 @@ export interface GetAssetPropertyAggregatesResponse {
|
|
|
5923
5923
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
5924
5924
|
* @public
|
|
5925
5925
|
*/
|
|
5926
|
-
nextToken?: string;
|
|
5926
|
+
nextToken?: string | undefined;
|
|
5927
5927
|
}
|
|
5928
5928
|
/**
|
|
5929
5929
|
* @public
|
|
@@ -5933,12 +5933,12 @@ export interface GetAssetPropertyValueRequest {
|
|
|
5933
5933
|
* <p>The ID of the asset, in UUID format.</p>
|
|
5934
5934
|
* @public
|
|
5935
5935
|
*/
|
|
5936
|
-
assetId?: string;
|
|
5936
|
+
assetId?: string | undefined;
|
|
5937
5937
|
/**
|
|
5938
5938
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
5939
5939
|
* @public
|
|
5940
5940
|
*/
|
|
5941
|
-
propertyId?: string;
|
|
5941
|
+
propertyId?: string | undefined;
|
|
5942
5942
|
/**
|
|
5943
5943
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
5944
5944
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -5946,7 +5946,7 @@ export interface GetAssetPropertyValueRequest {
|
|
|
5946
5946
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
5947
5947
|
* @public
|
|
5948
5948
|
*/
|
|
5949
|
-
propertyAlias?: string;
|
|
5949
|
+
propertyAlias?: string | undefined;
|
|
5950
5950
|
}
|
|
5951
5951
|
/**
|
|
5952
5952
|
* @public
|
|
@@ -5956,7 +5956,7 @@ export interface GetAssetPropertyValueResponse {
|
|
|
5956
5956
|
* <p>The current asset property value.</p>
|
|
5957
5957
|
* @public
|
|
5958
5958
|
*/
|
|
5959
|
-
propertyValue?: AssetPropertyValue;
|
|
5959
|
+
propertyValue?: AssetPropertyValue | undefined;
|
|
5960
5960
|
}
|
|
5961
5961
|
/**
|
|
5962
5962
|
* @public
|
|
@@ -5966,12 +5966,12 @@ export interface GetAssetPropertyValueHistoryRequest {
|
|
|
5966
5966
|
* <p>The ID of the asset, in UUID format.</p>
|
|
5967
5967
|
* @public
|
|
5968
5968
|
*/
|
|
5969
|
-
assetId?: string;
|
|
5969
|
+
assetId?: string | undefined;
|
|
5970
5970
|
/**
|
|
5971
5971
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
5972
5972
|
* @public
|
|
5973
5973
|
*/
|
|
5974
|
-
propertyId?: string;
|
|
5974
|
+
propertyId?: string | undefined;
|
|
5975
5975
|
/**
|
|
5976
5976
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
5977
5977
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -5979,34 +5979,34 @@ export interface GetAssetPropertyValueHistoryRequest {
|
|
|
5979
5979
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
5980
5980
|
* @public
|
|
5981
5981
|
*/
|
|
5982
|
-
propertyAlias?: string;
|
|
5982
|
+
propertyAlias?: string | undefined;
|
|
5983
5983
|
/**
|
|
5984
5984
|
* <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
5985
5985
|
* @public
|
|
5986
5986
|
*/
|
|
5987
|
-
startDate?: Date;
|
|
5987
|
+
startDate?: Date | undefined;
|
|
5988
5988
|
/**
|
|
5989
5989
|
* <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
5990
5990
|
* @public
|
|
5991
5991
|
*/
|
|
5992
|
-
endDate?: Date;
|
|
5992
|
+
endDate?: Date | undefined;
|
|
5993
5993
|
/**
|
|
5994
5994
|
* <p>The quality by which to filter asset data.</p>
|
|
5995
5995
|
* @public
|
|
5996
5996
|
*/
|
|
5997
|
-
qualities?: Quality[];
|
|
5997
|
+
qualities?: Quality[] | undefined;
|
|
5998
5998
|
/**
|
|
5999
5999
|
* <p>The chronological sorting order of the requested information.</p>
|
|
6000
6000
|
* <p>Default: <code>ASCENDING</code>
|
|
6001
6001
|
* </p>
|
|
6002
6002
|
* @public
|
|
6003
6003
|
*/
|
|
6004
|
-
timeOrdering?: TimeOrdering;
|
|
6004
|
+
timeOrdering?: TimeOrdering | undefined;
|
|
6005
6005
|
/**
|
|
6006
6006
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6007
6007
|
* @public
|
|
6008
6008
|
*/
|
|
6009
|
-
nextToken?: string;
|
|
6009
|
+
nextToken?: string | undefined;
|
|
6010
6010
|
/**
|
|
6011
6011
|
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
|
|
6012
6012
|
* first.</p>
|
|
@@ -6021,7 +6021,7 @@ export interface GetAssetPropertyValueHistoryRequest {
|
|
|
6021
6021
|
* </ul>
|
|
6022
6022
|
* @public
|
|
6023
6023
|
*/
|
|
6024
|
-
maxResults?: number;
|
|
6024
|
+
maxResults?: number | undefined;
|
|
6025
6025
|
}
|
|
6026
6026
|
/**
|
|
6027
6027
|
* @public
|
|
@@ -6036,7 +6036,7 @@ export interface GetAssetPropertyValueHistoryResponse {
|
|
|
6036
6036
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6037
6037
|
* @public
|
|
6038
6038
|
*/
|
|
6039
|
-
nextToken?: string;
|
|
6039
|
+
nextToken?: string | undefined;
|
|
6040
6040
|
}
|
|
6041
6041
|
/**
|
|
6042
6042
|
* @public
|
|
@@ -6046,12 +6046,12 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6046
6046
|
* <p>The ID of the asset, in UUID format.</p>
|
|
6047
6047
|
* @public
|
|
6048
6048
|
*/
|
|
6049
|
-
assetId?: string;
|
|
6049
|
+
assetId?: string | undefined;
|
|
6050
6050
|
/**
|
|
6051
6051
|
* <p>The ID of the asset property, in UUID format.</p>
|
|
6052
6052
|
* @public
|
|
6053
6053
|
*/
|
|
6054
|
-
propertyId?: string;
|
|
6054
|
+
propertyId?: string | undefined;
|
|
6055
6055
|
/**
|
|
6056
6056
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
6057
6057
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
@@ -6059,7 +6059,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6059
6059
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
6060
6060
|
* @public
|
|
6061
6061
|
*/
|
|
6062
|
-
propertyAlias?: string;
|
|
6062
|
+
propertyAlias?: string | undefined;
|
|
6063
6063
|
/**
|
|
6064
6064
|
* <p>The exclusive start of the range from which to interpolate data, expressed in seconds in
|
|
6065
6065
|
* Unix epoch time.</p>
|
|
@@ -6070,7 +6070,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6070
6070
|
* <p>The nanosecond offset converted from <code>startTimeInSeconds</code>.</p>
|
|
6071
6071
|
* @public
|
|
6072
6072
|
*/
|
|
6073
|
-
startTimeOffsetInNanos?: number;
|
|
6073
|
+
startTimeOffsetInNanos?: number | undefined;
|
|
6074
6074
|
/**
|
|
6075
6075
|
* <p>The inclusive end of the range from which to interpolate data, expressed in seconds in
|
|
6076
6076
|
* Unix epoch time.</p>
|
|
@@ -6081,7 +6081,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6081
6081
|
* <p>The nanosecond offset converted from <code>endTimeInSeconds</code>.</p>
|
|
6082
6082
|
* @public
|
|
6083
6083
|
*/
|
|
6084
|
-
endTimeOffsetInNanos?: number;
|
|
6084
|
+
endTimeOffsetInNanos?: number | undefined;
|
|
6085
6085
|
/**
|
|
6086
6086
|
* <p>The quality of the asset property value. You can use this parameter as a filter to choose
|
|
6087
6087
|
* only the asset property values that have a specific quality.</p>
|
|
@@ -6098,12 +6098,12 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6098
6098
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6099
6099
|
* @public
|
|
6100
6100
|
*/
|
|
6101
|
-
nextToken?: string;
|
|
6101
|
+
nextToken?: string | undefined;
|
|
6102
6102
|
/**
|
|
6103
6103
|
* <p>The maximum number of results to return for each paginated request. If not specified, the default value is 10.</p>
|
|
6104
6104
|
* @public
|
|
6105
6105
|
*/
|
|
6106
|
-
maxResults?: number;
|
|
6106
|
+
maxResults?: number | undefined;
|
|
6107
6107
|
/**
|
|
6108
6108
|
* <p>The interpolation type.</p>
|
|
6109
6109
|
* <p>Valid values: <code>LINEAR_INTERPOLATION | LOCF_INTERPOLATION</code>
|
|
@@ -6162,7 +6162,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
6162
6162
|
* compute the second interpolated value, and so on. </p>
|
|
6163
6163
|
* @public
|
|
6164
6164
|
*/
|
|
6165
|
-
intervalWindowInSeconds?: number;
|
|
6165
|
+
intervalWindowInSeconds?: number | undefined;
|
|
6166
6166
|
}
|
|
6167
6167
|
/**
|
|
6168
6168
|
* <p>Contains information about an interpolated asset property value.</p>
|
|
@@ -6193,7 +6193,7 @@ export interface GetInterpolatedAssetPropertyValuesResponse {
|
|
|
6193
6193
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6194
6194
|
* @public
|
|
6195
6195
|
*/
|
|
6196
|
-
nextToken?: string;
|
|
6196
|
+
nextToken?: string | undefined;
|
|
6197
6197
|
}
|
|
6198
6198
|
/**
|
|
6199
6199
|
* @public
|
|
@@ -6229,43 +6229,43 @@ export interface ListAccessPoliciesRequest {
|
|
|
6229
6229
|
* if you specify <code>identityId</code>.</p>
|
|
6230
6230
|
* @public
|
|
6231
6231
|
*/
|
|
6232
|
-
identityType?: IdentityType;
|
|
6232
|
+
identityType?: IdentityType | undefined;
|
|
6233
6233
|
/**
|
|
6234
6234
|
* <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
|
|
6235
6235
|
* <code>GROUP</code> for <code>identityType</code>.</p>
|
|
6236
6236
|
* @public
|
|
6237
6237
|
*/
|
|
6238
|
-
identityId?: string;
|
|
6238
|
+
identityId?: string | undefined;
|
|
6239
6239
|
/**
|
|
6240
6240
|
* <p>The type of resource (portal or project). This parameter is required if you specify
|
|
6241
6241
|
* <code>resourceId</code>.</p>
|
|
6242
6242
|
* @public
|
|
6243
6243
|
*/
|
|
6244
|
-
resourceType?: ResourceType;
|
|
6244
|
+
resourceType?: ResourceType | undefined;
|
|
6245
6245
|
/**
|
|
6246
6246
|
* <p>The ID of the resource. This parameter is required if you specify
|
|
6247
6247
|
* <code>resourceType</code>.</p>
|
|
6248
6248
|
* @public
|
|
6249
6249
|
*/
|
|
6250
|
-
resourceId?: string;
|
|
6250
|
+
resourceId?: string | undefined;
|
|
6251
6251
|
/**
|
|
6252
6252
|
* <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
|
|
6253
6253
|
* <i>IAM User Guide</i>. This parameter is required if you specify
|
|
6254
6254
|
* <code>IAM</code> for <code>identityType</code>.</p>
|
|
6255
6255
|
* @public
|
|
6256
6256
|
*/
|
|
6257
|
-
iamArn?: string;
|
|
6257
|
+
iamArn?: string | undefined;
|
|
6258
6258
|
/**
|
|
6259
6259
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6260
6260
|
* @public
|
|
6261
6261
|
*/
|
|
6262
|
-
nextToken?: string;
|
|
6262
|
+
nextToken?: string | undefined;
|
|
6263
6263
|
/**
|
|
6264
6264
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6265
6265
|
* <p>Default: 50</p>
|
|
6266
6266
|
* @public
|
|
6267
6267
|
*/
|
|
6268
|
-
maxResults?: number;
|
|
6268
|
+
maxResults?: number | undefined;
|
|
6269
6269
|
}
|
|
6270
6270
|
/**
|
|
6271
6271
|
* @public
|
|
@@ -6280,7 +6280,7 @@ export interface ListAccessPoliciesResponse {
|
|
|
6280
6280
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6281
6281
|
* @public
|
|
6282
6282
|
*/
|
|
6283
|
-
nextToken?: string;
|
|
6283
|
+
nextToken?: string | undefined;
|
|
6284
6284
|
}
|
|
6285
6285
|
/**
|
|
6286
6286
|
* @public
|
|
@@ -6311,12 +6311,12 @@ export interface ListActionsRequest {
|
|
|
6311
6311
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6312
6312
|
* @public
|
|
6313
6313
|
*/
|
|
6314
|
-
nextToken?: string;
|
|
6314
|
+
nextToken?: string | undefined;
|
|
6315
6315
|
/**
|
|
6316
6316
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6317
6317
|
* @public
|
|
6318
6318
|
*/
|
|
6319
|
-
maxResults?: number;
|
|
6319
|
+
maxResults?: number | undefined;
|
|
6320
6320
|
}
|
|
6321
6321
|
/**
|
|
6322
6322
|
* @public
|
|
@@ -6347,20 +6347,20 @@ export interface ListAssetModelCompositeModelsRequest {
|
|
|
6347
6347
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6348
6348
|
* @public
|
|
6349
6349
|
*/
|
|
6350
|
-
nextToken?: string;
|
|
6350
|
+
nextToken?: string | undefined;
|
|
6351
6351
|
/**
|
|
6352
6352
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6353
6353
|
* <p>Default: 50</p>
|
|
6354
6354
|
* @public
|
|
6355
6355
|
*/
|
|
6356
|
-
maxResults?: number;
|
|
6356
|
+
maxResults?: number | undefined;
|
|
6357
6357
|
/**
|
|
6358
6358
|
* <p>The version alias that specifies the latest or active version of the asset model.
|
|
6359
6359
|
* The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
|
|
6360
6360
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6361
6361
|
* @public
|
|
6362
6362
|
*/
|
|
6363
|
-
assetModelVersion?: string;
|
|
6363
|
+
assetModelVersion?: string | undefined;
|
|
6364
6364
|
}
|
|
6365
6365
|
/**
|
|
6366
6366
|
* @public
|
|
@@ -6375,7 +6375,7 @@ export interface ListAssetModelCompositeModelsResponse {
|
|
|
6375
6375
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6376
6376
|
* @public
|
|
6377
6377
|
*/
|
|
6378
|
-
nextToken?: string;
|
|
6378
|
+
nextToken?: string | undefined;
|
|
6379
6379
|
}
|
|
6380
6380
|
/**
|
|
6381
6381
|
* @public
|
|
@@ -6403,12 +6403,12 @@ export interface ListAssetModelPropertiesRequest {
|
|
|
6403
6403
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6404
6404
|
* @public
|
|
6405
6405
|
*/
|
|
6406
|
-
nextToken?: string;
|
|
6406
|
+
nextToken?: string | undefined;
|
|
6407
6407
|
/**
|
|
6408
6408
|
* <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
|
|
6409
6409
|
* @public
|
|
6410
6410
|
*/
|
|
6411
|
-
maxResults?: number;
|
|
6411
|
+
maxResults?: number | undefined;
|
|
6412
6412
|
/**
|
|
6413
6413
|
* <p> Filters the requested list of asset model properties. You can choose one of the following
|
|
6414
6414
|
* options:</p>
|
|
@@ -6428,14 +6428,14 @@ export interface ListAssetModelPropertiesRequest {
|
|
|
6428
6428
|
* </p>
|
|
6429
6429
|
* @public
|
|
6430
6430
|
*/
|
|
6431
|
-
filter?: ListAssetModelPropertiesFilter;
|
|
6431
|
+
filter?: ListAssetModelPropertiesFilter | undefined;
|
|
6432
6432
|
/**
|
|
6433
6433
|
* <p>The version alias that specifies the latest or active version of the asset model.
|
|
6434
6434
|
* The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
|
|
6435
6435
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6436
6436
|
* @public
|
|
6437
6437
|
*/
|
|
6438
|
-
assetModelVersion?: string;
|
|
6438
|
+
assetModelVersion?: string | undefined;
|
|
6439
6439
|
}
|
|
6440
6440
|
/**
|
|
6441
6441
|
* @public
|
|
@@ -6450,7 +6450,7 @@ export interface ListAssetModelPropertiesResponse {
|
|
|
6450
6450
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6451
6451
|
* @public
|
|
6452
6452
|
*/
|
|
6453
|
-
nextToken?: string;
|
|
6453
|
+
nextToken?: string | undefined;
|
|
6454
6454
|
}
|
|
6455
6455
|
/**
|
|
6456
6456
|
* @public
|
|
@@ -6472,25 +6472,25 @@ export interface ListAssetModelsRequest {
|
|
|
6472
6472
|
* </ul>
|
|
6473
6473
|
* @public
|
|
6474
6474
|
*/
|
|
6475
|
-
assetModelTypes?: AssetModelType[];
|
|
6475
|
+
assetModelTypes?: AssetModelType[] | undefined;
|
|
6476
6476
|
/**
|
|
6477
6477
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6478
6478
|
* @public
|
|
6479
6479
|
*/
|
|
6480
|
-
nextToken?: string;
|
|
6480
|
+
nextToken?: string | undefined;
|
|
6481
6481
|
/**
|
|
6482
6482
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6483
6483
|
* <p>Default: 50</p>
|
|
6484
6484
|
* @public
|
|
6485
6485
|
*/
|
|
6486
|
-
maxResults?: number;
|
|
6486
|
+
maxResults?: number | undefined;
|
|
6487
6487
|
/**
|
|
6488
6488
|
* <p>The version alias that specifies the latest or active version of the asset model.
|
|
6489
6489
|
* The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
|
|
6490
6490
|
* Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6491
6491
|
* @public
|
|
6492
6492
|
*/
|
|
6493
|
-
assetModelVersion?: string;
|
|
6493
|
+
assetModelVersion?: string | undefined;
|
|
6494
6494
|
}
|
|
6495
6495
|
/**
|
|
6496
6496
|
* @public
|
|
@@ -6505,7 +6505,7 @@ export interface ListAssetModelsResponse {
|
|
|
6505
6505
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6506
6506
|
* @public
|
|
6507
6507
|
*/
|
|
6508
|
-
nextToken?: string;
|
|
6508
|
+
nextToken?: string | undefined;
|
|
6509
6509
|
}
|
|
6510
6510
|
/**
|
|
6511
6511
|
* @public
|
|
@@ -6533,12 +6533,12 @@ export interface ListAssetPropertiesRequest {
|
|
|
6533
6533
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6534
6534
|
* @public
|
|
6535
6535
|
*/
|
|
6536
|
-
nextToken?: string;
|
|
6536
|
+
nextToken?: string | undefined;
|
|
6537
6537
|
/**
|
|
6538
6538
|
* <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
|
|
6539
6539
|
* @public
|
|
6540
6540
|
*/
|
|
6541
|
-
maxResults?: number;
|
|
6541
|
+
maxResults?: number | undefined;
|
|
6542
6542
|
/**
|
|
6543
6543
|
* <p> Filters the requested list of asset properties. You can choose one of the following
|
|
6544
6544
|
* options:</p>
|
|
@@ -6558,7 +6558,7 @@ export interface ListAssetPropertiesRequest {
|
|
|
6558
6558
|
* </p>
|
|
6559
6559
|
* @public
|
|
6560
6560
|
*/
|
|
6561
|
-
filter?: ListAssetPropertiesFilter;
|
|
6561
|
+
filter?: ListAssetPropertiesFilter | undefined;
|
|
6562
6562
|
}
|
|
6563
6563
|
/**
|
|
6564
6564
|
* @public
|
|
@@ -6573,7 +6573,7 @@ export interface ListAssetPropertiesResponse {
|
|
|
6573
6573
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6574
6574
|
* @public
|
|
6575
6575
|
*/
|
|
6576
|
-
nextToken?: string;
|
|
6576
|
+
nextToken?: string | undefined;
|
|
6577
6577
|
}
|
|
6578
6578
|
/**
|
|
6579
6579
|
* @public
|
|
@@ -6614,12 +6614,12 @@ export interface ListAssetRelationshipsRequest {
|
|
|
6614
6614
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6615
6615
|
* @public
|
|
6616
6616
|
*/
|
|
6617
|
-
nextToken?: string;
|
|
6617
|
+
nextToken?: string | undefined;
|
|
6618
6618
|
/**
|
|
6619
6619
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6620
6620
|
* @public
|
|
6621
6621
|
*/
|
|
6622
|
-
maxResults?: number;
|
|
6622
|
+
maxResults?: number | undefined;
|
|
6623
6623
|
}
|
|
6624
6624
|
/**
|
|
6625
6625
|
* @public
|
|
@@ -6634,7 +6634,7 @@ export interface ListAssetRelationshipsResponse {
|
|
|
6634
6634
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6635
6635
|
* @public
|
|
6636
6636
|
*/
|
|
6637
|
-
nextToken?: string;
|
|
6637
|
+
nextToken?: string | undefined;
|
|
6638
6638
|
}
|
|
6639
6639
|
/**
|
|
6640
6640
|
* @public
|
|
@@ -6656,20 +6656,20 @@ export interface ListAssetsRequest {
|
|
|
6656
6656
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6657
6657
|
* @public
|
|
6658
6658
|
*/
|
|
6659
|
-
nextToken?: string;
|
|
6659
|
+
nextToken?: string | undefined;
|
|
6660
6660
|
/**
|
|
6661
6661
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6662
6662
|
* <p>Default: 50</p>
|
|
6663
6663
|
* @public
|
|
6664
6664
|
*/
|
|
6665
|
-
maxResults?: number;
|
|
6665
|
+
maxResults?: number | undefined;
|
|
6666
6666
|
/**
|
|
6667
6667
|
* <p>The ID of the asset model by which to filter the list of assets. This parameter is
|
|
6668
6668
|
* required if you choose <code>ALL</code> for <code>filter</code>. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6669
6669
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6670
6670
|
* @public
|
|
6671
6671
|
*/
|
|
6672
|
-
assetModelId?: string;
|
|
6672
|
+
assetModelId?: string | undefined;
|
|
6673
6673
|
/**
|
|
6674
6674
|
* <p>The filter for the requested list of assets. Choose one of the following options:</p>
|
|
6675
6675
|
* <ul>
|
|
@@ -6689,7 +6689,7 @@ export interface ListAssetsRequest {
|
|
|
6689
6689
|
* </p>
|
|
6690
6690
|
* @public
|
|
6691
6691
|
*/
|
|
6692
|
-
filter?: ListAssetsFilter;
|
|
6692
|
+
filter?: ListAssetsFilter | undefined;
|
|
6693
6693
|
}
|
|
6694
6694
|
/**
|
|
6695
6695
|
* @public
|
|
@@ -6704,7 +6704,7 @@ export interface ListAssetsResponse {
|
|
|
6704
6704
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6705
6705
|
* @public
|
|
6706
6706
|
*/
|
|
6707
|
-
nextToken?: string;
|
|
6707
|
+
nextToken?: string | undefined;
|
|
6708
6708
|
}
|
|
6709
6709
|
/**
|
|
6710
6710
|
* @public
|
|
@@ -6736,7 +6736,7 @@ export interface ListAssociatedAssetsRequest {
|
|
|
6736
6736
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6737
6737
|
* @public
|
|
6738
6738
|
*/
|
|
6739
|
-
hierarchyId?: string;
|
|
6739
|
+
hierarchyId?: string | undefined;
|
|
6740
6740
|
/**
|
|
6741
6741
|
* <p>The direction to list associated assets. Choose one of the following options:</p>
|
|
6742
6742
|
* <ul>
|
|
@@ -6754,18 +6754,18 @@ export interface ListAssociatedAssetsRequest {
|
|
|
6754
6754
|
* </p>
|
|
6755
6755
|
* @public
|
|
6756
6756
|
*/
|
|
6757
|
-
traversalDirection?: TraversalDirection;
|
|
6757
|
+
traversalDirection?: TraversalDirection | undefined;
|
|
6758
6758
|
/**
|
|
6759
6759
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6760
6760
|
* @public
|
|
6761
6761
|
*/
|
|
6762
|
-
nextToken?: string;
|
|
6762
|
+
nextToken?: string | undefined;
|
|
6763
6763
|
/**
|
|
6764
6764
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6765
6765
|
* <p>Default: 50</p>
|
|
6766
6766
|
* @public
|
|
6767
6767
|
*/
|
|
6768
|
-
maxResults?: number;
|
|
6768
|
+
maxResults?: number | undefined;
|
|
6769
6769
|
}
|
|
6770
6770
|
/**
|
|
6771
6771
|
* @public
|
|
@@ -6780,7 +6780,7 @@ export interface ListAssociatedAssetsResponse {
|
|
|
6780
6780
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6781
6781
|
* @public
|
|
6782
6782
|
*/
|
|
6783
|
-
nextToken?: string;
|
|
6783
|
+
nextToken?: string | undefined;
|
|
6784
6784
|
}
|
|
6785
6785
|
/**
|
|
6786
6786
|
* @public
|
|
@@ -6807,17 +6807,17 @@ export interface ListBulkImportJobsRequest {
|
|
|
6807
6807
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6808
6808
|
* @public
|
|
6809
6809
|
*/
|
|
6810
|
-
nextToken?: string;
|
|
6810
|
+
nextToken?: string | undefined;
|
|
6811
6811
|
/**
|
|
6812
6812
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6813
6813
|
* @public
|
|
6814
6814
|
*/
|
|
6815
|
-
maxResults?: number;
|
|
6815
|
+
maxResults?: number | undefined;
|
|
6816
6816
|
/**
|
|
6817
6817
|
* <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
|
|
6818
6818
|
* @public
|
|
6819
6819
|
*/
|
|
6820
|
-
filter?: ListBulkImportJobsFilter;
|
|
6820
|
+
filter?: ListBulkImportJobsFilter | undefined;
|
|
6821
6821
|
}
|
|
6822
6822
|
/**
|
|
6823
6823
|
* <p>Contains the job summary information.</p>
|
|
@@ -6881,7 +6881,7 @@ export interface ListBulkImportJobsResponse {
|
|
|
6881
6881
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6882
6882
|
* @public
|
|
6883
6883
|
*/
|
|
6884
|
-
nextToken?: string;
|
|
6884
|
+
nextToken?: string | undefined;
|
|
6885
6885
|
}
|
|
6886
6886
|
/**
|
|
6887
6887
|
* @public
|
|
@@ -6897,13 +6897,13 @@ export interface ListCompositionRelationshipsRequest {
|
|
|
6897
6897
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6898
6898
|
* @public
|
|
6899
6899
|
*/
|
|
6900
|
-
nextToken?: string;
|
|
6900
|
+
nextToken?: string | undefined;
|
|
6901
6901
|
/**
|
|
6902
6902
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6903
6903
|
* <p>Default: 50</p>
|
|
6904
6904
|
* @public
|
|
6905
6905
|
*/
|
|
6906
|
-
maxResults?: number;
|
|
6906
|
+
maxResults?: number | undefined;
|
|
6907
6907
|
}
|
|
6908
6908
|
/**
|
|
6909
6909
|
* <p>Contains a summary of the components of the composite model.</p>
|
|
@@ -6940,7 +6940,7 @@ export interface ListCompositionRelationshipsResponse {
|
|
|
6940
6940
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6941
6941
|
* @public
|
|
6942
6942
|
*/
|
|
6943
|
-
nextToken?: string;
|
|
6943
|
+
nextToken?: string | undefined;
|
|
6944
6944
|
}
|
|
6945
6945
|
/**
|
|
6946
6946
|
* @public
|
|
@@ -6955,13 +6955,13 @@ export interface ListDashboardsRequest {
|
|
|
6955
6955
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
6956
6956
|
* @public
|
|
6957
6957
|
*/
|
|
6958
|
-
nextToken?: string;
|
|
6958
|
+
nextToken?: string | undefined;
|
|
6959
6959
|
/**
|
|
6960
6960
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6961
6961
|
* <p>Default: 50</p>
|
|
6962
6962
|
* @public
|
|
6963
6963
|
*/
|
|
6964
|
-
maxResults?: number;
|
|
6964
|
+
maxResults?: number | undefined;
|
|
6965
6965
|
}
|
|
6966
6966
|
/**
|
|
6967
6967
|
* <p>Contains a dashboard summary.</p>
|
|
@@ -6982,17 +6982,17 @@ export interface DashboardSummary {
|
|
|
6982
6982
|
* <p>The dashboard's description.</p>
|
|
6983
6983
|
* @public
|
|
6984
6984
|
*/
|
|
6985
|
-
description?: string;
|
|
6985
|
+
description?: string | undefined;
|
|
6986
6986
|
/**
|
|
6987
6987
|
* <p>The date the dashboard was created, in Unix epoch time.</p>
|
|
6988
6988
|
* @public
|
|
6989
6989
|
*/
|
|
6990
|
-
creationDate?: Date;
|
|
6990
|
+
creationDate?: Date | undefined;
|
|
6991
6991
|
/**
|
|
6992
6992
|
* <p>The date the dashboard was last updated, in Unix epoch time.</p>
|
|
6993
6993
|
* @public
|
|
6994
6994
|
*/
|
|
6995
|
-
lastUpdateDate?: Date;
|
|
6995
|
+
lastUpdateDate?: Date | undefined;
|
|
6996
6996
|
}
|
|
6997
6997
|
/**
|
|
6998
6998
|
* @public
|
|
@@ -7007,7 +7007,7 @@ export interface ListDashboardsResponse {
|
|
|
7007
7007
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7008
7008
|
* @public
|
|
7009
7009
|
*/
|
|
7010
|
-
nextToken?: string;
|
|
7010
|
+
nextToken?: string | undefined;
|
|
7011
7011
|
}
|
|
7012
7012
|
/**
|
|
7013
7013
|
* @public
|
|
@@ -7017,13 +7017,13 @@ export interface ListGatewaysRequest {
|
|
|
7017
7017
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
7018
7018
|
* @public
|
|
7019
7019
|
*/
|
|
7020
|
-
nextToken?: string;
|
|
7020
|
+
nextToken?: string | undefined;
|
|
7021
7021
|
/**
|
|
7022
7022
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
7023
7023
|
* <p>Default: 50</p>
|
|
7024
7024
|
* @public
|
|
7025
7025
|
*/
|
|
7026
|
-
maxResults?: number;
|
|
7026
|
+
maxResults?: number | undefined;
|
|
7027
7027
|
}
|
|
7028
7028
|
/**
|
|
7029
7029
|
* <p>Contains a summary of a gateway.</p>
|
|
@@ -7044,14 +7044,14 @@ export interface GatewaySummary {
|
|
|
7044
7044
|
* <p>Contains a gateway's platform information.</p>
|
|
7045
7045
|
* @public
|
|
7046
7046
|
*/
|
|
7047
|
-
gatewayPlatform?: GatewayPlatform;
|
|
7047
|
+
gatewayPlatform?: GatewayPlatform | undefined;
|
|
7048
7048
|
/**
|
|
7049
7049
|
* <p>A list of gateway capability summaries that each contain a namespace and status. Each
|
|
7050
7050
|
* gateway capability defines data sources for the gateway. To retrieve a capability
|
|
7051
7051
|
* configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
|
|
7052
7052
|
* @public
|
|
7053
7053
|
*/
|
|
7054
|
-
gatewayCapabilitySummaries?: GatewayCapabilitySummary[];
|
|
7054
|
+
gatewayCapabilitySummaries?: GatewayCapabilitySummary[] | undefined;
|
|
7055
7055
|
/**
|
|
7056
7056
|
* <p>The date the gateway was created, in Unix epoch time.</p>
|
|
7057
7057
|
* @public
|
|
@@ -7076,7 +7076,7 @@ export interface ListGatewaysResponse {
|
|
|
7076
7076
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7077
7077
|
* @public
|
|
7078
7078
|
*/
|
|
7079
|
-
nextToken?: string;
|
|
7079
|
+
nextToken?: string | undefined;
|
|
7080
7080
|
}
|
|
7081
7081
|
/**
|
|
7082
7082
|
* @public
|
|
@@ -7086,13 +7086,13 @@ export interface ListPortalsRequest {
|
|
|
7086
7086
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
7087
7087
|
* @public
|
|
7088
7088
|
*/
|
|
7089
|
-
nextToken?: string;
|
|
7089
|
+
nextToken?: string | undefined;
|
|
7090
7090
|
/**
|
|
7091
7091
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
7092
7092
|
* <p>Default: 50</p>
|
|
7093
7093
|
* @public
|
|
7094
7094
|
*/
|
|
7095
|
-
maxResults?: number;
|
|
7095
|
+
maxResults?: number | undefined;
|
|
7096
7096
|
}
|
|
7097
7097
|
/**
|
|
7098
7098
|
* <p>Contains a portal summary.</p>
|
|
@@ -7113,7 +7113,7 @@ export interface PortalSummary {
|
|
|
7113
7113
|
* <p>The portal's description.</p>
|
|
7114
7114
|
* @public
|
|
7115
7115
|
*/
|
|
7116
|
-
description?: string;
|
|
7116
|
+
description?: string | undefined;
|
|
7117
7117
|
/**
|
|
7118
7118
|
* <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
|
|
7119
7119
|
* use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
|
|
@@ -7125,19 +7125,19 @@ export interface PortalSummary {
|
|
|
7125
7125
|
* <p>The date the portal was created, in Unix epoch time.</p>
|
|
7126
7126
|
* @public
|
|
7127
7127
|
*/
|
|
7128
|
-
creationDate?: Date;
|
|
7128
|
+
creationDate?: Date | undefined;
|
|
7129
7129
|
/**
|
|
7130
7130
|
* <p>The date the portal was last updated, in Unix epoch time.</p>
|
|
7131
7131
|
* @public
|
|
7132
7132
|
*/
|
|
7133
|
-
lastUpdateDate?: Date;
|
|
7133
|
+
lastUpdateDate?: Date | undefined;
|
|
7134
7134
|
/**
|
|
7135
7135
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the service role that allows the portal's users to access your IoT SiteWise
|
|
7136
7136
|
* resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the
|
|
7137
7137
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
7138
7138
|
* @public
|
|
7139
7139
|
*/
|
|
7140
|
-
roleArn?: string;
|
|
7140
|
+
roleArn?: string | undefined;
|
|
7141
7141
|
/**
|
|
7142
7142
|
* <p>Contains information about the current status of a portal.</p>
|
|
7143
7143
|
* @public
|
|
@@ -7152,12 +7152,12 @@ export interface ListPortalsResponse {
|
|
|
7152
7152
|
* <p>A list that summarizes each portal.</p>
|
|
7153
7153
|
* @public
|
|
7154
7154
|
*/
|
|
7155
|
-
portalSummaries?: PortalSummary[];
|
|
7155
|
+
portalSummaries?: PortalSummary[] | undefined;
|
|
7156
7156
|
/**
|
|
7157
7157
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7158
7158
|
* @public
|
|
7159
7159
|
*/
|
|
7160
|
-
nextToken?: string;
|
|
7160
|
+
nextToken?: string | undefined;
|
|
7161
7161
|
}
|
|
7162
7162
|
/**
|
|
7163
7163
|
* @public
|
|
@@ -7172,13 +7172,13 @@ export interface ListProjectAssetsRequest {
|
|
|
7172
7172
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
7173
7173
|
* @public
|
|
7174
7174
|
*/
|
|
7175
|
-
nextToken?: string;
|
|
7175
|
+
nextToken?: string | undefined;
|
|
7176
7176
|
/**
|
|
7177
7177
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
7178
7178
|
* <p>Default: 50</p>
|
|
7179
7179
|
* @public
|
|
7180
7180
|
*/
|
|
7181
|
-
maxResults?: number;
|
|
7181
|
+
maxResults?: number | undefined;
|
|
7182
7182
|
}
|
|
7183
7183
|
/**
|
|
7184
7184
|
* @public
|
|
@@ -7193,7 +7193,7 @@ export interface ListProjectAssetsResponse {
|
|
|
7193
7193
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7194
7194
|
* @public
|
|
7195
7195
|
*/
|
|
7196
|
-
nextToken?: string;
|
|
7196
|
+
nextToken?: string | undefined;
|
|
7197
7197
|
}
|
|
7198
7198
|
/**
|
|
7199
7199
|
* @public
|
|
@@ -7208,13 +7208,13 @@ export interface ListProjectsRequest {
|
|
|
7208
7208
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
7209
7209
|
* @public
|
|
7210
7210
|
*/
|
|
7211
|
-
nextToken?: string;
|
|
7211
|
+
nextToken?: string | undefined;
|
|
7212
7212
|
/**
|
|
7213
7213
|
* <p>The maximum number of results to return for each paginated request.</p>
|
|
7214
7214
|
* <p>Default: 50</p>
|
|
7215
7215
|
* @public
|
|
7216
7216
|
*/
|
|
7217
|
-
maxResults?: number;
|
|
7217
|
+
maxResults?: number | undefined;
|
|
7218
7218
|
}
|
|
7219
7219
|
/**
|
|
7220
7220
|
* <p>Contains project summary information.</p>
|
|
@@ -7235,17 +7235,17 @@ export interface ProjectSummary {
|
|
|
7235
7235
|
* <p>The project's description.</p>
|
|
7236
7236
|
* @public
|
|
7237
7237
|
*/
|
|
7238
|
-
description?: string;
|
|
7238
|
+
description?: string | undefined;
|
|
7239
7239
|
/**
|
|
7240
7240
|
* <p>The date the project was created, in Unix epoch time.</p>
|
|
7241
7241
|
* @public
|
|
7242
7242
|
*/
|
|
7243
|
-
creationDate?: Date;
|
|
7243
|
+
creationDate?: Date | undefined;
|
|
7244
7244
|
/**
|
|
7245
7245
|
* <p>The date the project was last updated, in Unix epoch time.</p>
|
|
7246
7246
|
* @public
|
|
7247
7247
|
*/
|
|
7248
|
-
lastUpdateDate?: Date;
|
|
7248
|
+
lastUpdateDate?: Date | undefined;
|
|
7249
7249
|
}
|
|
7250
7250
|
/**
|
|
7251
7251
|
* @public
|
|
@@ -7260,7 +7260,7 @@ export interface ListProjectsResponse {
|
|
|
7260
7260
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7261
7261
|
* @public
|
|
7262
7262
|
*/
|
|
7263
|
-
nextToken?: string;
|
|
7263
|
+
nextToken?: string | undefined;
|
|
7264
7264
|
}
|
|
7265
7265
|
/**
|
|
7266
7266
|
* @public
|
|
@@ -7282,7 +7282,7 @@ export interface ListTagsForResourceResponse {
|
|
|
7282
7282
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
7283
7283
|
* @public
|
|
7284
7284
|
*/
|
|
7285
|
-
tags?: Record<string, string
|
|
7285
|
+
tags?: Record<string, string> | undefined;
|
|
7286
7286
|
}
|
|
7287
7287
|
/**
|
|
7288
7288
|
* <p>You are not authorized.</p>
|