@aws-sdk/client-iotsitewise 3.379.1 → 3.382.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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +753 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,6 +6,7 @@ import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseSer
6
6
  */
7
7
  export interface GroupIdentity {
8
8
  /**
9
+ * @public
9
10
  * <p>The IAM Identity Center ID of the group.</p>
10
11
  */
11
12
  id: string | undefined;
@@ -17,6 +18,7 @@ export interface GroupIdentity {
17
18
  */
18
19
  export interface IAMRoleIdentity {
19
20
  /**
21
+ * @public
20
22
  * <p>The ARN of the IAM role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
21
23
  * <i>IAM User Guide</i>.</p>
22
24
  */
@@ -28,6 +30,7 @@ export interface IAMRoleIdentity {
28
30
  */
29
31
  export interface IAMUserIdentity {
30
32
  /**
33
+ * @public
31
34
  * <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
32
35
  * <i>IAM User Guide</i>.</p>
33
36
  * <note>
@@ -44,6 +47,7 @@ export interface IAMUserIdentity {
44
47
  */
45
48
  export interface UserIdentity {
46
49
  /**
50
+ * @public
47
51
  * <p>The IAM Identity Center ID of the user.</p>
48
52
  */
49
53
  id: string | undefined;
@@ -58,18 +62,22 @@ export interface UserIdentity {
58
62
  */
59
63
  export interface Identity {
60
64
  /**
65
+ * @public
61
66
  * <p>An IAM Identity Center user identity.</p>
62
67
  */
63
68
  user?: UserIdentity;
64
69
  /**
70
+ * @public
65
71
  * <p>An IAM Identity Center group identity.</p>
66
72
  */
67
73
  group?: GroupIdentity;
68
74
  /**
75
+ * @public
69
76
  * <p>An IAM user identity.</p>
70
77
  */
71
78
  iamUser?: IAMUserIdentity;
72
79
  /**
80
+ * @public
73
81
  * <p>An IAM role identity.</p>
74
82
  */
75
83
  iamRole?: IAMRoleIdentity;
@@ -92,6 +100,7 @@ export type Permission = (typeof Permission)[keyof typeof Permission];
92
100
  */
93
101
  export interface PortalResource {
94
102
  /**
103
+ * @public
95
104
  * <p>The ID of the portal.</p>
96
105
  */
97
106
  id: string | undefined;
@@ -102,6 +111,7 @@ export interface PortalResource {
102
111
  */
103
112
  export interface ProjectResource {
104
113
  /**
114
+ * @public
105
115
  * <p>The ID of the project.</p>
106
116
  */
107
117
  id: string | undefined;
@@ -112,10 +122,12 @@ export interface ProjectResource {
112
122
  */
113
123
  export interface Resource {
114
124
  /**
125
+ * @public
115
126
  * <p>A portal resource.</p>
116
127
  */
117
128
  portal?: PortalResource;
118
129
  /**
130
+ * @public
119
131
  * <p>A project resource.</p>
120
132
  */
121
133
  project?: ProjectResource;
@@ -127,27 +139,33 @@ export interface Resource {
127
139
  */
128
140
  export interface AccessPolicySummary {
129
141
  /**
142
+ * @public
130
143
  * <p>The ID of the access policy.</p>
131
144
  */
132
145
  id: string | undefined;
133
146
  /**
147
+ * @public
134
148
  * <p>The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).</p>
135
149
  */
136
150
  identity: Identity | undefined;
137
151
  /**
152
+ * @public
138
153
  * <p>The IoT SiteWise Monitor resource (a portal or project).</p>
139
154
  */
140
155
  resource: Resource | undefined;
141
156
  /**
157
+ * @public
142
158
  * <p>The permissions for the access policy. Note that a project <code>ADMINISTRATOR</code> is
143
159
  * also known as a project owner.</p>
144
160
  */
145
161
  permission: Permission | string | undefined;
146
162
  /**
163
+ * @public
147
164
  * <p>The date the access policy was created, in Unix epoch time.</p>
148
165
  */
149
166
  creationDate?: Date;
150
167
  /**
168
+ * @public
151
169
  * <p>The date the access policy was last updated, in Unix epoch time.</p>
152
170
  */
153
171
  lastUpdateDate?: Date;
@@ -171,26 +189,32 @@ export type Quality = (typeof Quality)[keyof typeof Quality];
171
189
  */
172
190
  export interface Aggregates {
173
191
  /**
192
+ * @public
174
193
  * <p>The average (mean) value of the time series over a time interval window.</p>
175
194
  */
176
195
  average?: number;
177
196
  /**
197
+ * @public
178
198
  * <p>The count of data points in the time series over a time interval window.</p>
179
199
  */
180
200
  count?: number;
181
201
  /**
202
+ * @public
182
203
  * <p>The maximum value of the time series over a time interval window.</p>
183
204
  */
184
205
  maximum?: number;
185
206
  /**
207
+ * @public
186
208
  * <p>The minimum value of the time series over a time interval window.</p>
187
209
  */
188
210
  minimum?: number;
189
211
  /**
212
+ * @public
190
213
  * <p>The sum of the time series over a time interval window.</p>
191
214
  */
192
215
  sum?: number;
193
216
  /**
217
+ * @public
194
218
  * <p>The standard deviation of the time series over a time interval window.</p>
195
219
  */
196
220
  standardDeviation?: number;
@@ -202,14 +226,17 @@ export interface Aggregates {
202
226
  */
203
227
  export interface AggregatedValue {
204
228
  /**
229
+ * @public
205
230
  * <p>The date the aggregating computations occurred, in Unix epoch time.</p>
206
231
  */
207
232
  timestamp: Date | undefined;
208
233
  /**
234
+ * @public
209
235
  * <p>The quality of the aggregated data.</p>
210
236
  */
211
237
  quality?: Quality | string;
212
238
  /**
239
+ * @public
213
240
  * <p>The value of the aggregates.</p>
214
241
  */
215
242
  value: Aggregates | undefined;
@@ -238,11 +265,13 @@ export type AggregateType = (typeof AggregateType)[keyof typeof AggregateType];
238
265
  */
239
266
  export interface Alarms {
240
267
  /**
268
+ * @public
241
269
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows the alarm to perform actions and access Amazon Web Services
242
270
  * resources and services, such as IoT Events.</p>
243
271
  */
244
272
  alarmRoleArn: string | undefined;
245
273
  /**
274
+ * @public
246
275
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function that manages alarm notifications. For more
247
276
  * information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">Managing alarm
248
277
  * notifications</a> in the <i>IoT Events Developer Guide</i>.</p>
@@ -283,10 +312,12 @@ export type PropertyNotificationState = (typeof PropertyNotificationState)[keyof
283
312
  */
284
313
  export interface PropertyNotification {
285
314
  /**
315
+ * @public
286
316
  * <p>The MQTT topic to which IoT SiteWise publishes property value update notifications.</p>
287
317
  */
288
318
  topic: string | undefined;
289
319
  /**
320
+ * @public
290
321
  * <p>The current notification state.</p>
291
322
  */
292
323
  state: PropertyNotificationState | string | undefined;
@@ -297,14 +328,17 @@ export interface PropertyNotification {
297
328
  */
298
329
  export interface AssetProperty {
299
330
  /**
331
+ * @public
300
332
  * <p>The ID of the asset property.</p>
301
333
  */
302
334
  id: string | undefined;
303
335
  /**
336
+ * @public
304
337
  * <p>The name of the property.</p>
305
338
  */
306
339
  name: string | undefined;
307
340
  /**
341
+ * @public
308
342
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
309
343
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
310
344
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -312,19 +346,23 @@ export interface AssetProperty {
312
346
  */
313
347
  alias?: string;
314
348
  /**
349
+ * @public
315
350
  * <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>
316
351
  */
317
352
  notification?: PropertyNotification;
318
353
  /**
354
+ * @public
319
355
  * <p>The data type of the asset property.</p>
320
356
  */
321
357
  dataType: PropertyDataType | string | undefined;
322
358
  /**
359
+ * @public
323
360
  * <p>The data type of the structure for this property. This parameter exists on properties that
324
361
  * have the <code>STRUCT</code> data type.</p>
325
362
  */
326
363
  dataTypeSpec?: string;
327
364
  /**
365
+ * @public
328
366
  * <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.</p>
329
367
  */
330
368
  unit?: string;
@@ -336,23 +374,28 @@ export interface AssetProperty {
336
374
  */
337
375
  export interface AssetCompositeModel {
338
376
  /**
377
+ * @public
339
378
  * <p>The name of the composite model.</p>
340
379
  */
341
380
  name: string | undefined;
342
381
  /**
382
+ * @public
343
383
  * <p>The description of the composite model.</p>
344
384
  */
345
385
  description?: string;
346
386
  /**
387
+ * @public
347
388
  * <p>The type of the composite model. For alarm composite models, this type is
348
389
  * <code>AWS/ALARM</code>.</p>
349
390
  */
350
391
  type: string | undefined;
351
392
  /**
393
+ * @public
352
394
  * <p>The asset properties that this composite model defines.</p>
353
395
  */
354
396
  properties: AssetProperty[] | undefined;
355
397
  /**
398
+ * @public
356
399
  * <p>
357
400
  * The ID of the asset composite model.
358
401
  * </p>
@@ -376,14 +419,17 @@ export type AssetErrorCode = (typeof AssetErrorCode)[keyof typeof AssetErrorCode
376
419
  */
377
420
  export interface AssetErrorDetails {
378
421
  /**
422
+ * @public
379
423
  * <p>The ID of the asset.</p>
380
424
  */
381
425
  assetId: string | undefined;
382
426
  /**
427
+ * @public
383
428
  * <p>The error code.</p>
384
429
  */
385
430
  code: AssetErrorCode | string | undefined;
386
431
  /**
432
+ * @public
387
433
  * <p>The error message.</p>
388
434
  */
389
435
  message: string | undefined;
@@ -394,10 +440,12 @@ export interface AssetErrorDetails {
394
440
  */
395
441
  export interface AssetHierarchy {
396
442
  /**
443
+ * @public
397
444
  * <p>The ID of the hierarchy. This ID is a <code>hierarchyId</code>.</p>
398
445
  */
399
446
  id?: string;
400
447
  /**
448
+ * @public
401
449
  * <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>
402
450
  * API operation.</p>
403
451
  */
@@ -410,10 +458,12 @@ export interface AssetHierarchy {
410
458
  */
411
459
  export interface AssetHierarchyInfo {
412
460
  /**
461
+ * @public
413
462
  * <p>The ID of the parent asset in this asset relationship.</p>
414
463
  */
415
464
  parentAssetId?: string;
416
465
  /**
466
+ * @public
417
467
  * <p>The ID of the child asset in this asset relationship.</p>
418
468
  */
419
469
  childAssetId?: string;
@@ -425,6 +475,7 @@ export interface AssetHierarchyInfo {
425
475
  */
426
476
  export interface Attribute {
427
477
  /**
478
+ * @public
428
479
  * <p>The default value of the asset model property attribute. All assets that you create from
429
480
  * the asset model contain this attribute value. You can update an attribute's value after you
430
481
  * create an asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html">Updating attribute values</a> in the
@@ -450,6 +501,7 @@ export type ForwardingConfigState = (typeof ForwardingConfigState)[keyof typeof
450
501
  */
451
502
  export interface ForwardingConfig {
452
503
  /**
504
+ * @public
453
505
  * <p>The forwarding state for the given property. </p>
454
506
  */
455
507
  state: ForwardingConfigState | string | undefined;
@@ -462,6 +514,7 @@ export interface ForwardingConfig {
462
514
  */
463
515
  export interface MeasurementProcessingConfig {
464
516
  /**
517
+ * @public
465
518
  * <p>The forwarding configuration for the given measurement property. </p>
466
519
  */
467
520
  forwardingConfig: ForwardingConfig | undefined;
@@ -473,6 +526,7 @@ export interface MeasurementProcessingConfig {
473
526
  */
474
527
  export interface Measurement {
475
528
  /**
529
+ * @public
476
530
  * <p>The processing configuration for the given measurement property.
477
531
  * You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud.
478
532
  * By default, measurements are forwarded to the cloud.</p>
@@ -499,6 +553,7 @@ export type ComputeLocation = (typeof ComputeLocation)[keyof typeof ComputeLocat
499
553
  */
500
554
  export interface MetricProcessingConfig {
501
555
  /**
556
+ * @public
502
557
  * <p>The compute location for the given metric property. </p>
503
558
  */
504
559
  computeLocation: ComputeLocation | string | undefined;
@@ -509,11 +564,13 @@ export interface MetricProcessingConfig {
509
564
  */
510
565
  export interface VariableValue {
511
566
  /**
567
+ * @public
512
568
  * <p>The ID of the property to use as the variable. You can use the property <code>name</code>
513
569
  * if it's from the same asset model.</p>
514
570
  */
515
571
  propertyId: string | undefined;
516
572
  /**
573
+ * @public
517
574
  * <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name
518
575
  * instead of the hierarchy's ID.</p>
519
576
  * <p>You use a hierarchy ID instead of a model ID because you can have several hierarchies
@@ -529,10 +586,12 @@ export interface VariableValue {
529
586
  */
530
587
  export interface ExpressionVariable {
531
588
  /**
589
+ * @public
532
590
  * <p>The friendly name of the variable to be used in the expression.</p>
533
591
  */
534
592
  name: string | undefined;
535
593
  /**
594
+ * @public
536
595
  * <p>The variable that identifies an asset property from which to use values.</p>
537
596
  */
538
597
  value: VariableValue | undefined;
@@ -552,6 +611,7 @@ export interface ExpressionVariable {
552
611
  */
553
612
  export interface TumblingWindow {
554
613
  /**
614
+ * @public
555
615
  * <p>The time interval for the tumbling window. The interval time must be between 1 minute and
556
616
  * 1 week.</p>
557
617
  * <p>IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight each week (UTC),
@@ -563,6 +623,7 @@ export interface TumblingWindow {
563
623
  */
564
624
  interval: string | undefined;
565
625
  /**
626
+ * @public
566
627
  * <p>The offset for the tumbling window. The <code>offset</code> parameter accepts the
567
628
  * following:</p>
568
629
  * <ul>
@@ -632,6 +693,7 @@ export interface TumblingWindow {
632
693
  */
633
694
  export interface MetricWindow {
634
695
  /**
696
+ * @public
635
697
  * <p>The tumbling time interval window.</p>
636
698
  */
637
699
  tumbling?: TumblingWindow;
@@ -650,6 +712,7 @@ export interface MetricWindow {
650
712
  */
651
713
  export interface Metric {
652
714
  /**
715
+ * @public
653
716
  * <p>The mathematical expression that defines the metric aggregation function. You can specify
654
717
  * up to 10 variables per expression. You can specify up to 10 functions
655
718
  * per expression. </p>
@@ -657,15 +720,18 @@ export interface Metric {
657
720
  */
658
721
  expression: string | undefined;
659
722
  /**
723
+ * @public
660
724
  * <p>The list of variables used in the expression.</p>
661
725
  */
662
726
  variables: ExpressionVariable[] | undefined;
663
727
  /**
728
+ * @public
664
729
  * <p>The window (time interval) over which IoT SiteWise computes the metric's aggregation expression.
665
730
  * IoT SiteWise computes one data point per <code>window</code>.</p>
666
731
  */
667
732
  window: MetricWindow | undefined;
668
733
  /**
734
+ * @public
669
735
  * <p>The processing configuration for the given metric property.
670
736
  * You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud.
671
737
  * By default, metrics are forwarded to the cloud.</p>
@@ -680,10 +746,12 @@ export interface Metric {
680
746
  */
681
747
  export interface TransformProcessingConfig {
682
748
  /**
749
+ * @public
683
750
  * <p>The compute location for the given transform property. </p>
684
751
  */
685
752
  computeLocation: ComputeLocation | string | undefined;
686
753
  /**
754
+ * @public
687
755
  * <p>The forwarding configuration for a given property.</p>
688
756
  */
689
757
  forwardingConfig?: ForwardingConfig;
@@ -699,6 +767,7 @@ export interface TransformProcessingConfig {
699
767
  */
700
768
  export interface Transform {
701
769
  /**
770
+ * @public
702
771
  * <p>The mathematical expression that defines the transformation function. You can specify up
703
772
  * to 10 variables per expression. You can specify up to 10 functions per
704
773
  * expression. </p>
@@ -706,10 +775,12 @@ export interface Transform {
706
775
  */
707
776
  expression: string | undefined;
708
777
  /**
778
+ * @public
709
779
  * <p>The list of variables used in the expression.</p>
710
780
  */
711
781
  variables: ExpressionVariable[] | undefined;
712
782
  /**
783
+ * @public
713
784
  * <p>The processing configuration for the given transform property.
714
785
  * You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud.
715
786
  * You can also configure transforms to be computed at the edge or in the cloud.</p>
@@ -723,22 +794,26 @@ export interface Transform {
723
794
  */
724
795
  export interface PropertyType {
725
796
  /**
797
+ * @public
726
798
  * <p>Specifies an asset attribute property. An attribute generally contains static information,
727
799
  * such as the serial number of an <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">IIoT</a> wind turbine.</p>
728
800
  */
729
801
  attribute?: Attribute;
730
802
  /**
803
+ * @public
731
804
  * <p>Specifies an asset measurement property. A measurement represents a device's raw sensor
732
805
  * data stream, such as timestamped temperature values or timestamped power values.</p>
733
806
  */
734
807
  measurement?: Measurement;
735
808
  /**
809
+ * @public
736
810
  * <p>Specifies an asset transform property. A transform contains a mathematical expression that
737
811
  * maps a property's data points from one form to another, such as a unit conversion from Celsius
738
812
  * to Fahrenheit.</p>
739
813
  */
740
814
  transform?: Transform;
741
815
  /**
816
+ * @public
742
817
  * <p>Specifies an asset metric property. A metric contains a mathematical expression that uses
743
818
  * aggregate functions to process all input data points over a time interval and output a single
744
819
  * data point, such as to calculate the average hourly temperature.</p>
@@ -751,28 +826,34 @@ export interface PropertyType {
751
826
  */
752
827
  export interface AssetModelProperty {
753
828
  /**
829
+ * @public
754
830
  * <p>The ID of the asset model property.</p>
755
831
  */
756
832
  id?: string;
757
833
  /**
834
+ * @public
758
835
  * <p>The name of the asset model property.</p>
759
836
  */
760
837
  name: string | undefined;
761
838
  /**
839
+ * @public
762
840
  * <p>The data type of the asset model property.</p>
763
841
  */
764
842
  dataType: PropertyDataType | string | undefined;
765
843
  /**
844
+ * @public
766
845
  * <p>The data type of the structure for this property. This parameter exists on properties that
767
846
  * have the <code>STRUCT</code> data type.</p>
768
847
  */
769
848
  dataTypeSpec?: string;
770
849
  /**
850
+ * @public
771
851
  * <p>The unit of the asset model property, such as <code>Newtons</code> or
772
852
  * <code>RPM</code>.</p>
773
853
  */
774
854
  unit?: string;
775
855
  /**
856
+ * @public
776
857
  * <p>The property type (see <code>PropertyType</code>).</p>
777
858
  */
778
859
  type: PropertyType | undefined;
@@ -784,23 +865,28 @@ export interface AssetModelProperty {
784
865
  */
785
866
  export interface AssetModelCompositeModel {
786
867
  /**
868
+ * @public
787
869
  * <p>The name of the composite model.</p>
788
870
  */
789
871
  name: string | undefined;
790
872
  /**
873
+ * @public
791
874
  * <p>The description of the composite model.</p>
792
875
  */
793
876
  description?: string;
794
877
  /**
878
+ * @public
795
879
  * <p>The type of the composite model. For alarm composite models, this type is
796
880
  * <code>AWS/ALARM</code>.</p>
797
881
  */
798
882
  type: string | undefined;
799
883
  /**
884
+ * @public
800
885
  * <p>The asset property definitions for this composite model.</p>
801
886
  */
802
887
  properties?: AssetModelProperty[];
803
888
  /**
889
+ * @public
804
890
  * <p>
805
891
  * The ID of the asset model composite model.
806
892
  * </p>
@@ -814,16 +900,19 @@ export interface AssetModelCompositeModel {
814
900
  */
815
901
  export interface AssetModelPropertyDefinition {
816
902
  /**
903
+ * @public
817
904
  * <p>The name of the property definition.</p>
818
905
  */
819
906
  name: string | undefined;
820
907
  /**
908
+ * @public
821
909
  * <p>The data type of the property definition.</p>
822
910
  * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to
823
911
  * identify the type of the structure for this property.</p>
824
912
  */
825
913
  dataType: PropertyDataType | string | undefined;
826
914
  /**
915
+ * @public
827
916
  * <p>The data type of the structure for this property. This parameter is required on properties
828
917
  * that have the <code>STRUCT</code> data type.</p>
829
918
  * <p>The options for this parameter depend on the type of the composite model in which you
@@ -832,11 +921,13 @@ export interface AssetModelPropertyDefinition {
832
921
  */
833
922
  dataTypeSpec?: string;
834
923
  /**
924
+ * @public
835
925
  * <p>The unit of the property definition, such as <code>Newtons</code> or
836
926
  * <code>RPM</code>.</p>
837
927
  */
838
928
  unit?: string;
839
929
  /**
930
+ * @public
840
931
  * <p>The property definition type (see <code>PropertyType</code>). You can only specify one
841
932
  * type in a property definition.</p>
842
933
  */
@@ -849,19 +940,23 @@ export interface AssetModelPropertyDefinition {
849
940
  */
850
941
  export interface AssetModelCompositeModelDefinition {
851
942
  /**
943
+ * @public
852
944
  * <p>The name of the composite model.</p>
853
945
  */
854
946
  name: string | undefined;
855
947
  /**
948
+ * @public
856
949
  * <p>The description of the composite model.</p>
857
950
  */
858
951
  description?: string;
859
952
  /**
953
+ * @public
860
954
  * <p>The type of the composite model. For alarm composite models, this type is
861
955
  * <code>AWS/ALARM</code>.</p>
862
956
  */
863
957
  type: string | undefined;
864
958
  /**
959
+ * @public
865
960
  * <p>The asset property definitions for this composite model.</p>
866
961
  */
867
962
  properties?: AssetModelPropertyDefinition[];
@@ -873,15 +968,18 @@ export interface AssetModelCompositeModelDefinition {
873
968
  */
874
969
  export interface AssetModelHierarchy {
875
970
  /**
971
+ * @public
876
972
  * <p>The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>.</p>
877
973
  */
878
974
  id?: string;
879
975
  /**
976
+ * @public
880
977
  * <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
881
978
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation.</p>
882
979
  */
883
980
  name: string | undefined;
884
981
  /**
982
+ * @public
885
983
  * <p>The ID of the asset model. All assets in this hierarchy must be instances of the
886
984
  * <code>childAssetModelId</code> asset model.</p>
887
985
  */
@@ -894,11 +992,13 @@ export interface AssetModelHierarchy {
894
992
  */
895
993
  export interface AssetModelHierarchyDefinition {
896
994
  /**
995
+ * @public
897
996
  * <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
898
997
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation).</p>
899
998
  */
900
999
  name: string | undefined;
901
1000
  /**
1001
+ * @public
902
1002
  * <p>The ID of an asset model for this hierarchy.</p>
903
1003
  */
904
1004
  childAssetModelId: string | undefined;
@@ -909,32 +1009,39 @@ export interface AssetModelHierarchyDefinition {
909
1009
  */
910
1010
  export interface AssetModelPropertySummary {
911
1011
  /**
1012
+ * @public
912
1013
  * <p>The ID of the property.</p>
913
1014
  */
914
1015
  id?: string;
915
1016
  /**
1017
+ * @public
916
1018
  * <p>The name of the property.</p>
917
1019
  */
918
1020
  name: string | undefined;
919
1021
  /**
1022
+ * @public
920
1023
  * <p>The data type of the property.</p>
921
1024
  */
922
1025
  dataType: PropertyDataType | string | undefined;
923
1026
  /**
1027
+ * @public
924
1028
  * <p>The data type of the structure for this property. This parameter exists on properties that
925
1029
  * have the <code>STRUCT</code> data type.</p>
926
1030
  */
927
1031
  dataTypeSpec?: string;
928
1032
  /**
1033
+ * @public
929
1034
  * <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the property.</p>
930
1035
  */
931
1036
  unit?: string;
932
1037
  /**
1038
+ * @public
933
1039
  * <p>Contains a property type, which can be one of <code>attribute</code>,
934
1040
  * <code>measurement</code>, <code>metric</code>, or <code>transform</code>.</p>
935
1041
  */
936
1042
  type: PropertyType | undefined;
937
1043
  /**
1044
+ * @public
938
1045
  * <p>
939
1046
  * The ID of the composite model that contains the asset model property.
940
1047
  * </p>
@@ -987,10 +1094,12 @@ export type DetailedErrorCode = (typeof DetailedErrorCode)[keyof typeof Detailed
987
1094
  */
988
1095
  export interface DetailedError {
989
1096
  /**
1097
+ * @public
990
1098
  * <p>The error code. </p>
991
1099
  */
992
1100
  code: DetailedErrorCode | string | undefined;
993
1101
  /**
1102
+ * @public
994
1103
  * <p>The error message. </p>
995
1104
  */
996
1105
  message: string | undefined;
@@ -1001,14 +1110,17 @@ export interface DetailedError {
1001
1110
  */
1002
1111
  export interface ErrorDetails {
1003
1112
  /**
1113
+ * @public
1004
1114
  * <p>The error code.</p>
1005
1115
  */
1006
1116
  code: ErrorCode | string | undefined;
1007
1117
  /**
1118
+ * @public
1008
1119
  * <p>The error message.</p>
1009
1120
  */
1010
1121
  message: string | undefined;
1011
1122
  /**
1123
+ * @public
1012
1124
  * <p> A list of detailed errors. </p>
1013
1125
  */
1014
1126
  details?: DetailedError[];
@@ -1020,10 +1132,12 @@ export interface ErrorDetails {
1020
1132
  */
1021
1133
  export interface AssetModelStatus {
1022
1134
  /**
1135
+ * @public
1023
1136
  * <p>The current state of the asset model.</p>
1024
1137
  */
1025
1138
  state: AssetModelState | string | undefined;
1026
1139
  /**
1140
+ * @public
1027
1141
  * <p>Contains associated error information, if any.</p>
1028
1142
  */
1029
1143
  error?: ErrorDetails;
@@ -1034,10 +1148,12 @@ export interface AssetModelStatus {
1034
1148
  */
1035
1149
  export interface AssetModelSummary {
1036
1150
  /**
1151
+ * @public
1037
1152
  * <p>The ID of the asset model (used with IoT SiteWise APIs).</p>
1038
1153
  */
1039
1154
  id: string | undefined;
1040
1155
  /**
1156
+ * @public
1041
1157
  * <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>
1042
1158
  * <p>
1043
1159
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
@@ -1045,22 +1161,27 @@ export interface AssetModelSummary {
1045
1161
  */
1046
1162
  arn: string | undefined;
1047
1163
  /**
1164
+ * @public
1048
1165
  * <p>The name of the asset model.</p>
1049
1166
  */
1050
1167
  name: string | undefined;
1051
1168
  /**
1169
+ * @public
1052
1170
  * <p>The asset model description.</p>
1053
1171
  */
1054
1172
  description: string | undefined;
1055
1173
  /**
1174
+ * @public
1056
1175
  * <p>The date the asset model was created, in Unix epoch time.</p>
1057
1176
  */
1058
1177
  creationDate: Date | undefined;
1059
1178
  /**
1179
+ * @public
1060
1180
  * <p>The date the asset model was last updated, in Unix epoch time.</p>
1061
1181
  */
1062
1182
  lastUpdateDate: Date | undefined;
1063
1183
  /**
1184
+ * @public
1064
1185
  * <p>The current status of the asset model.</p>
1065
1186
  */
1066
1187
  status: AssetModelStatus | undefined;
@@ -1071,10 +1192,12 @@ export interface AssetModelSummary {
1071
1192
  */
1072
1193
  export interface AssetPropertySummary {
1073
1194
  /**
1195
+ * @public
1074
1196
  * <p>The ID of the property.</p>
1075
1197
  */
1076
1198
  id?: string;
1077
1199
  /**
1200
+ * @public
1078
1201
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
1079
1202
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
1080
1203
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -1082,17 +1205,20 @@ export interface AssetPropertySummary {
1082
1205
  */
1083
1206
  alias?: string;
1084
1207
  /**
1208
+ * @public
1085
1209
  * <p>
1086
1210
  * The unit of measure (such as Newtons or RPM) of the asset property.
1087
1211
  * </p>
1088
1212
  */
1089
1213
  unit?: string;
1090
1214
  /**
1215
+ * @public
1091
1216
  * <p>Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value
1092
1217
  * 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>
1093
1218
  */
1094
1219
  notification?: PropertyNotification;
1095
1220
  /**
1221
+ * @public
1096
1222
  * <p>
1097
1223
  * The ID of the composite model that contains the asset property.
1098
1224
  * </p>
@@ -1105,11 +1231,13 @@ export interface AssetPropertySummary {
1105
1231
  */
1106
1232
  export interface TimeInNanos {
1107
1233
  /**
1234
+ * @public
1108
1235
  * <p>The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is
1109
1236
  * provided by <code>offsetInNanos</code>.</p>
1110
1237
  */
1111
1238
  timeInSeconds: number | undefined;
1112
1239
  /**
1240
+ * @public
1113
1241
  * <p>The nanosecond offset from <code>timeInSeconds</code>.</p>
1114
1242
  */
1115
1243
  offsetInNanos?: number;
@@ -1120,18 +1248,22 @@ export interface TimeInNanos {
1120
1248
  */
1121
1249
  export interface Variant {
1122
1250
  /**
1251
+ * @public
1123
1252
  * <p>Asset property data of type string (sequence of characters).</p>
1124
1253
  */
1125
1254
  stringValue?: string;
1126
1255
  /**
1256
+ * @public
1127
1257
  * <p>Asset property data of type integer (whole number).</p>
1128
1258
  */
1129
1259
  integerValue?: number;
1130
1260
  /**
1261
+ * @public
1131
1262
  * <p>Asset property data of type double (floating point number).</p>
1132
1263
  */
1133
1264
  doubleValue?: number;
1134
1265
  /**
1266
+ * @public
1135
1267
  * <p>Asset property data of type Boolean (true or false).</p>
1136
1268
  */
1137
1269
  booleanValue?: boolean;
@@ -1142,14 +1274,17 @@ export interface Variant {
1142
1274
  */
1143
1275
  export interface AssetPropertyValue {
1144
1276
  /**
1277
+ * @public
1145
1278
  * <p>The value of the asset property (see <code>Variant</code>).</p>
1146
1279
  */
1147
1280
  value: Variant | undefined;
1148
1281
  /**
1282
+ * @public
1149
1283
  * <p>The timestamp of the asset property value.</p>
1150
1284
  */
1151
1285
  timestamp: TimeInNanos | undefined;
1152
1286
  /**
1287
+ * @public
1153
1288
  * <p>The quality of the asset property value.</p>
1154
1289
  */
1155
1290
  quality?: Quality | string;
@@ -1171,12 +1306,14 @@ export type AssetRelationshipType = (typeof AssetRelationshipType)[keyof typeof
1171
1306
  */
1172
1307
  export interface AssetRelationshipSummary {
1173
1308
  /**
1309
+ * @public
1174
1310
  * <p>The assets that are related through an asset hierarchy.</p>
1175
1311
  * <p>This object is present if the <code>relationshipType</code> is
1176
1312
  * <code>HIERARCHY</code>.</p>
1177
1313
  */
1178
1314
  hierarchyInfo?: AssetHierarchyInfo;
1179
1315
  /**
1316
+ * @public
1180
1317
  * <p>The relationship type of the assets in this relationship. This value is one of the
1181
1318
  * following:</p>
1182
1319
  * <ul>
@@ -1213,10 +1350,12 @@ export type AssetState = (typeof AssetState)[keyof typeof AssetState];
1213
1350
  */
1214
1351
  export interface AssetStatus {
1215
1352
  /**
1353
+ * @public
1216
1354
  * <p>The current status of the asset.</p>
1217
1355
  */
1218
1356
  state: AssetState | string | undefined;
1219
1357
  /**
1358
+ * @public
1220
1359
  * <p>Contains associated error information, if any.</p>
1221
1360
  */
1222
1361
  error?: ErrorDetails;
@@ -1227,10 +1366,12 @@ export interface AssetStatus {
1227
1366
  */
1228
1367
  export interface AssetSummary {
1229
1368
  /**
1369
+ * @public
1230
1370
  * <p>The ID of the asset.</p>
1231
1371
  */
1232
1372
  id: string | undefined;
1233
1373
  /**
1374
+ * @public
1234
1375
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
1235
1376
  * <p>
1236
1377
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
@@ -1238,30 +1379,37 @@ export interface AssetSummary {
1238
1379
  */
1239
1380
  arn: string | undefined;
1240
1381
  /**
1382
+ * @public
1241
1383
  * <p>The name of the asset.</p>
1242
1384
  */
1243
1385
  name: string | undefined;
1244
1386
  /**
1387
+ * @public
1245
1388
  * <p>The ID of the asset model used to create this asset.</p>
1246
1389
  */
1247
1390
  assetModelId: string | undefined;
1248
1391
  /**
1392
+ * @public
1249
1393
  * <p>The date the asset was created, in Unix epoch time.</p>
1250
1394
  */
1251
1395
  creationDate: Date | undefined;
1252
1396
  /**
1397
+ * @public
1253
1398
  * <p>The date the asset was last updated, in Unix epoch time.</p>
1254
1399
  */
1255
1400
  lastUpdateDate: Date | undefined;
1256
1401
  /**
1402
+ * @public
1257
1403
  * <p>The current status of the asset.</p>
1258
1404
  */
1259
1405
  status: AssetStatus | undefined;
1260
1406
  /**
1407
+ * @public
1261
1408
  * <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
1262
1409
  */
1263
1410
  hierarchies: AssetHierarchy[] | undefined;
1264
1411
  /**
1412
+ * @public
1265
1413
  * <p>A description for the asset.</p>
1266
1414
  */
1267
1415
  description?: string;
@@ -1271,20 +1419,24 @@ export interface AssetSummary {
1271
1419
  */
1272
1420
  export interface AssociateAssetsRequest {
1273
1421
  /**
1422
+ * @public
1274
1423
  * <p>The ID of the parent asset.</p>
1275
1424
  */
1276
1425
  assetId: string | undefined;
1277
1426
  /**
1427
+ * @public
1278
1428
  * <p>The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings
1279
1429
  * of assets to be formed that all come from the same asset model. For more information, see
1280
1430
  * <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>
1281
1431
  */
1282
1432
  hierarchyId: string | undefined;
1283
1433
  /**
1434
+ * @public
1284
1435
  * <p>The ID of the child asset to be associated.</p>
1285
1436
  */
1286
1437
  childAssetId: string | undefined;
1287
1438
  /**
1439
+ * @public
1288
1440
  * <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>
1289
1441
  */
1290
1442
  clientToken?: string;
@@ -1298,10 +1450,12 @@ export declare class ConflictingOperationException extends __BaseException {
1298
1450
  readonly name: "ConflictingOperationException";
1299
1451
  readonly $fault: "client";
1300
1452
  /**
1453
+ * @public
1301
1454
  * <p>The ID of the resource that conflicts with this operation.</p>
1302
1455
  */
1303
1456
  resourceId: string | undefined;
1304
1457
  /**
1458
+ * @public
1305
1459
  * <p>The ARN of the resource that conflicts with this operation.</p>
1306
1460
  */
1307
1461
  resourceArn: string | undefined;
@@ -1358,10 +1512,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1358
1512
  readonly name: "ResourceAlreadyExistsException";
1359
1513
  readonly $fault: "client";
1360
1514
  /**
1515
+ * @public
1361
1516
  * <p>The ID of the resource that already exists.</p>
1362
1517
  */
1363
1518
  resourceId: string | undefined;
1364
1519
  /**
1520
+ * @public
1365
1521
  * <p>The ARN of the resource that already exists.</p>
1366
1522
  */
1367
1523
  resourceArn: string | undefined;
@@ -1403,10 +1559,12 @@ export declare class ThrottlingException extends __BaseException {
1403
1559
  */
1404
1560
  export interface AssociatedAssetsSummary {
1405
1561
  /**
1562
+ * @public
1406
1563
  * <p>The ID of the asset.</p>
1407
1564
  */
1408
1565
  id: string | undefined;
1409
1566
  /**
1567
+ * @public
1410
1568
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
1411
1569
  * <p>
1412
1570
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
@@ -1414,30 +1572,37 @@ export interface AssociatedAssetsSummary {
1414
1572
  */
1415
1573
  arn: string | undefined;
1416
1574
  /**
1575
+ * @public
1417
1576
  * <p>The name of the asset.</p>
1418
1577
  */
1419
1578
  name: string | undefined;
1420
1579
  /**
1580
+ * @public
1421
1581
  * <p>The ID of the asset model used to create the asset.</p>
1422
1582
  */
1423
1583
  assetModelId: string | undefined;
1424
1584
  /**
1585
+ * @public
1425
1586
  * <p>The date the asset was created, in Unix epoch time.</p>
1426
1587
  */
1427
1588
  creationDate: Date | undefined;
1428
1589
  /**
1590
+ * @public
1429
1591
  * <p>The date the asset was last updated, in Unix epoch time.</p>
1430
1592
  */
1431
1593
  lastUpdateDate: Date | undefined;
1432
1594
  /**
1595
+ * @public
1433
1596
  * <p>The current status of the asset.</p>
1434
1597
  */
1435
1598
  status: AssetStatus | undefined;
1436
1599
  /**
1600
+ * @public
1437
1601
  * <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
1438
1602
  */
1439
1603
  hierarchies: AssetHierarchy[] | undefined;
1440
1604
  /**
1605
+ * @public
1441
1606
  * <p>A description for the asset.</p>
1442
1607
  */
1443
1608
  description?: string;
@@ -1447,18 +1612,22 @@ export interface AssociatedAssetsSummary {
1447
1612
  */
1448
1613
  export interface AssociateTimeSeriesToAssetPropertyRequest {
1449
1614
  /**
1615
+ * @public
1450
1616
  * <p>The alias that identifies the time series.</p>
1451
1617
  */
1452
1618
  alias: string | undefined;
1453
1619
  /**
1620
+ * @public
1454
1621
  * <p>The ID of the asset in which the asset property was created.</p>
1455
1622
  */
1456
1623
  assetId: string | undefined;
1457
1624
  /**
1625
+ * @public
1458
1626
  * <p>The ID of the asset property.</p>
1459
1627
  */
1460
1628
  propertyId: string | undefined;
1461
1629
  /**
1630
+ * @public
1462
1631
  * <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>
1463
1632
  */
1464
1633
  clientToken?: string;
@@ -1480,14 +1649,17 @@ export type AuthMode = (typeof AuthMode)[keyof typeof AuthMode];
1480
1649
  */
1481
1650
  export interface BatchAssociateProjectAssetsRequest {
1482
1651
  /**
1652
+ * @public
1483
1653
  * <p>The ID of the project to which to associate the assets.</p>
1484
1654
  */
1485
1655
  projectId: string | undefined;
1486
1656
  /**
1657
+ * @public
1487
1658
  * <p>The IDs of the assets to be associated to the project.</p>
1488
1659
  */
1489
1660
  assetIds: string[] | undefined;
1490
1661
  /**
1662
+ * @public
1491
1663
  * <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>
1492
1664
  */
1493
1665
  clientToken?: string;
@@ -1497,6 +1669,7 @@ export interface BatchAssociateProjectAssetsRequest {
1497
1669
  */
1498
1670
  export interface BatchAssociateProjectAssetsResponse {
1499
1671
  /**
1672
+ * @public
1500
1673
  * <p>A list of associated error information, if any.</p>
1501
1674
  */
1502
1675
  errors?: AssetErrorDetails[];
@@ -1506,14 +1679,17 @@ export interface BatchAssociateProjectAssetsResponse {
1506
1679
  */
1507
1680
  export interface BatchDisassociateProjectAssetsRequest {
1508
1681
  /**
1682
+ * @public
1509
1683
  * <p>The ID of the project from which to disassociate the assets.</p>
1510
1684
  */
1511
1685
  projectId: string | undefined;
1512
1686
  /**
1687
+ * @public
1513
1688
  * <p>The IDs of the assets to be disassociated from the project.</p>
1514
1689
  */
1515
1690
  assetIds: string[] | undefined;
1516
1691
  /**
1692
+ * @public
1517
1693
  * <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>
1518
1694
  */
1519
1695
  clientToken?: string;
@@ -1523,6 +1699,7 @@ export interface BatchDisassociateProjectAssetsRequest {
1523
1699
  */
1524
1700
  export interface BatchDisassociateProjectAssetsResponse {
1525
1701
  /**
1702
+ * @public
1526
1703
  * <p>A list of associated error information, if any.</p>
1527
1704
  */
1528
1705
  errors?: AssetErrorDetails[];
@@ -1556,18 +1733,22 @@ export type TimeOrdering = (typeof TimeOrdering)[keyof typeof TimeOrdering];
1556
1733
  */
1557
1734
  export interface BatchGetAssetPropertyAggregatesEntry {
1558
1735
  /**
1736
+ * @public
1559
1737
  * <p>The ID of the entry.</p>
1560
1738
  */
1561
1739
  entryId: string | undefined;
1562
1740
  /**
1741
+ * @public
1563
1742
  * <p>The ID of the asset in which the asset property was created.</p>
1564
1743
  */
1565
1744
  assetId?: string;
1566
1745
  /**
1746
+ * @public
1567
1747
  * <p>The ID of the asset property.</p>
1568
1748
  */
1569
1749
  propertyId?: string;
1570
1750
  /**
1751
+ * @public
1571
1752
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
1572
1753
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
1573
1754
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -1575,26 +1756,32 @@ export interface BatchGetAssetPropertyAggregatesEntry {
1575
1756
  */
1576
1757
  propertyAlias?: string;
1577
1758
  /**
1759
+ * @public
1578
1760
  * <p>The data aggregating function.</p>
1579
1761
  */
1580
1762
  aggregateTypes: (AggregateType | string)[] | undefined;
1581
1763
  /**
1764
+ * @public
1582
1765
  * <p>The time interval over which to aggregate data.</p>
1583
1766
  */
1584
1767
  resolution: string | undefined;
1585
1768
  /**
1769
+ * @public
1586
1770
  * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
1587
1771
  */
1588
1772
  startDate: Date | undefined;
1589
1773
  /**
1774
+ * @public
1590
1775
  * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
1591
1776
  */
1592
1777
  endDate: Date | undefined;
1593
1778
  /**
1779
+ * @public
1594
1780
  * <p>The quality by which to filter asset data.</p>
1595
1781
  */
1596
1782
  qualities?: (Quality | string)[];
1597
1783
  /**
1784
+ * @public
1598
1785
  * <p>The chronological sorting order of the requested information.</p>
1599
1786
  * <p>Default: <code>ASCENDING</code>
1600
1787
  * </p>
@@ -1606,15 +1793,18 @@ export interface BatchGetAssetPropertyAggregatesEntry {
1606
1793
  */
1607
1794
  export interface BatchGetAssetPropertyAggregatesRequest {
1608
1795
  /**
1796
+ * @public
1609
1797
  * <p>The list of asset property aggregate entries for the batch get request. You can specify up
1610
1798
  * to 16 entries per request.</p>
1611
1799
  */
1612
1800
  entries: BatchGetAssetPropertyAggregatesEntry[] | undefined;
1613
1801
  /**
1802
+ * @public
1614
1803
  * <p>The token to be used for the next set of paginated results.</p>
1615
1804
  */
1616
1805
  nextToken?: string;
1617
1806
  /**
1807
+ * @public
1618
1808
  * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
1619
1809
  * first.</p>
1620
1810
  * <ul>
@@ -1649,14 +1839,17 @@ export type BatchGetAssetPropertyAggregatesErrorCode = (typeof BatchGetAssetProp
1649
1839
  */
1650
1840
  export interface BatchGetAssetPropertyAggregatesErrorEntry {
1651
1841
  /**
1842
+ * @public
1652
1843
  * <p>The error code.</p>
1653
1844
  */
1654
1845
  errorCode: BatchGetAssetPropertyAggregatesErrorCode | string | undefined;
1655
1846
  /**
1847
+ * @public
1656
1848
  * <p>The associated error message.</p>
1657
1849
  */
1658
1850
  errorMessage: string | undefined;
1659
1851
  /**
1852
+ * @public
1660
1853
  * <p>The ID of the entry.</p>
1661
1854
  */
1662
1855
  entryId: string | undefined;
@@ -1680,10 +1873,12 @@ export type BatchEntryCompletionStatus = (typeof BatchEntryCompletionStatus)[key
1680
1873
  */
1681
1874
  export interface BatchGetAssetPropertyAggregatesErrorInfo {
1682
1875
  /**
1876
+ * @public
1683
1877
  * <p>The error code.</p>
1684
1878
  */
1685
1879
  errorCode: BatchGetAssetPropertyAggregatesErrorCode | string | undefined;
1686
1880
  /**
1881
+ * @public
1687
1882
  * <p>The date the error occurred, in Unix epoch time.</p>
1688
1883
  */
1689
1884
  errorTimestamp: Date | undefined;
@@ -1694,14 +1889,17 @@ export interface BatchGetAssetPropertyAggregatesErrorInfo {
1694
1889
  */
1695
1890
  export interface BatchGetAssetPropertyAggregatesSkippedEntry {
1696
1891
  /**
1892
+ * @public
1697
1893
  * <p>The ID of the entry.</p>
1698
1894
  */
1699
1895
  entryId: string | undefined;
1700
1896
  /**
1897
+ * @public
1701
1898
  * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1702
1899
  */
1703
1900
  completionStatus: BatchEntryCompletionStatus | string | undefined;
1704
1901
  /**
1902
+ * @public
1705
1903
  * <p>The error information, such as the error code and the timestamp.</p>
1706
1904
  */
1707
1905
  errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo;
@@ -1712,10 +1910,12 @@ export interface BatchGetAssetPropertyAggregatesSkippedEntry {
1712
1910
  */
1713
1911
  export interface BatchGetAssetPropertyAggregatesSuccessEntry {
1714
1912
  /**
1913
+ * @public
1715
1914
  * <p>The ID of the entry.</p>
1716
1915
  */
1717
1916
  entryId: string | undefined;
1718
1917
  /**
1918
+ * @public
1719
1919
  * <p>The requested aggregated asset property values (for example, average, minimum, and
1720
1920
  * maximum).</p>
1721
1921
  */
@@ -1726,22 +1926,26 @@ export interface BatchGetAssetPropertyAggregatesSuccessEntry {
1726
1926
  */
1727
1927
  export interface BatchGetAssetPropertyAggregatesResponse {
1728
1928
  /**
1929
+ * @public
1729
1930
  * <p>A list of the errors (if any) associated with the batch request. Each error entry
1730
1931
  * contains the <code>entryId</code> of the entry that failed.</p>
1731
1932
  */
1732
1933
  errorEntries: BatchGetAssetPropertyAggregatesErrorEntry[] | undefined;
1733
1934
  /**
1935
+ * @public
1734
1936
  * <p>A list of entries that were processed successfully by this batch request. Each success entry
1735
1937
  * contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
1736
1938
  */
1737
1939
  successEntries: BatchGetAssetPropertyAggregatesSuccessEntry[] | undefined;
1738
1940
  /**
1941
+ * @public
1739
1942
  * <p>A list of entries that were not processed by this batch request.
1740
1943
  * because these entries had been completely processed by previous paginated requests.
1741
1944
  * Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
1742
1945
  */
1743
1946
  skippedEntries: BatchGetAssetPropertyAggregatesSkippedEntry[] | undefined;
1744
1947
  /**
1948
+ * @public
1745
1949
  * <p>The token for the next set of results, or null if there are no additional results.</p>
1746
1950
  */
1747
1951
  nextToken?: string;
@@ -1774,18 +1978,22 @@ export declare class ServiceUnavailableException extends __BaseException {
1774
1978
  */
1775
1979
  export interface BatchGetAssetPropertyValueEntry {
1776
1980
  /**
1981
+ * @public
1777
1982
  * <p>The ID of the entry.</p>
1778
1983
  */
1779
1984
  entryId: string | undefined;
1780
1985
  /**
1986
+ * @public
1781
1987
  * <p>The ID of the asset in which the asset property was created.</p>
1782
1988
  */
1783
1989
  assetId?: string;
1784
1990
  /**
1991
+ * @public
1785
1992
  * <p>The ID of the asset property.</p>
1786
1993
  */
1787
1994
  propertyId?: string;
1788
1995
  /**
1996
+ * @public
1789
1997
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
1790
1998
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
1791
1999
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -1798,11 +2006,13 @@ export interface BatchGetAssetPropertyValueEntry {
1798
2006
  */
1799
2007
  export interface BatchGetAssetPropertyValueRequest {
1800
2008
  /**
2009
+ * @public
1801
2010
  * <p>The list of asset property value entries for the batch get request. You can specify up to
1802
2011
  * 128 entries per request.</p>
1803
2012
  */
1804
2013
  entries: BatchGetAssetPropertyValueEntry[] | undefined;
1805
2014
  /**
2015
+ * @public
1806
2016
  * <p>The token to be used for the next set of paginated results.</p>
1807
2017
  */
1808
2018
  nextToken?: string;
@@ -1827,14 +2037,17 @@ export type BatchGetAssetPropertyValueErrorCode = (typeof BatchGetAssetPropertyV
1827
2037
  */
1828
2038
  export interface BatchGetAssetPropertyValueErrorEntry {
1829
2039
  /**
2040
+ * @public
1830
2041
  * <p>The error code.</p>
1831
2042
  */
1832
2043
  errorCode: BatchGetAssetPropertyValueErrorCode | string | undefined;
1833
2044
  /**
2045
+ * @public
1834
2046
  * <p>The associated error message.</p>
1835
2047
  */
1836
2048
  errorMessage: string | undefined;
1837
2049
  /**
2050
+ * @public
1838
2051
  * <p>The ID of the entry.</p>
1839
2052
  */
1840
2053
  entryId: string | undefined;
@@ -1845,10 +2058,12 @@ export interface BatchGetAssetPropertyValueErrorEntry {
1845
2058
  */
1846
2059
  export interface BatchGetAssetPropertyValueErrorInfo {
1847
2060
  /**
2061
+ * @public
1848
2062
  * <p>The error code.</p>
1849
2063
  */
1850
2064
  errorCode: BatchGetAssetPropertyValueErrorCode | string | undefined;
1851
2065
  /**
2066
+ * @public
1852
2067
  * <p>The date the error occurred, in Unix epoch time.</p>
1853
2068
  */
1854
2069
  errorTimestamp: Date | undefined;
@@ -1859,14 +2074,17 @@ export interface BatchGetAssetPropertyValueErrorInfo {
1859
2074
  */
1860
2075
  export interface BatchGetAssetPropertyValueSkippedEntry {
1861
2076
  /**
2077
+ * @public
1862
2078
  * <p>The ID of the entry.</p>
1863
2079
  */
1864
2080
  entryId: string | undefined;
1865
2081
  /**
2082
+ * @public
1866
2083
  * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
1867
2084
  */
1868
2085
  completionStatus: BatchEntryCompletionStatus | string | undefined;
1869
2086
  /**
2087
+ * @public
1870
2088
  * <p>The error information, such as the error code and the timestamp.</p>
1871
2089
  */
1872
2090
  errorInfo?: BatchGetAssetPropertyValueErrorInfo;
@@ -1877,10 +2095,12 @@ export interface BatchGetAssetPropertyValueSkippedEntry {
1877
2095
  */
1878
2096
  export interface BatchGetAssetPropertyValueSuccessEntry {
1879
2097
  /**
2098
+ * @public
1880
2099
  * <p>The ID of the entry.</p>
1881
2100
  */
1882
2101
  entryId: string | undefined;
1883
2102
  /**
2103
+ * @public
1884
2104
  * <p>Contains asset property value information.</p>
1885
2105
  */
1886
2106
  assetPropertyValue?: AssetPropertyValue;
@@ -1890,22 +2110,26 @@ export interface BatchGetAssetPropertyValueSuccessEntry {
1890
2110
  */
1891
2111
  export interface BatchGetAssetPropertyValueResponse {
1892
2112
  /**
2113
+ * @public
1893
2114
  * <p>A list of the errors (if any) associated with the batch request. Each error entry
1894
2115
  * contains the <code>entryId</code> of the entry that failed.</p>
1895
2116
  */
1896
2117
  errorEntries: BatchGetAssetPropertyValueErrorEntry[] | undefined;
1897
2118
  /**
2119
+ * @public
1898
2120
  * <p>A list of entries that were processed successfully by this batch request. Each success entry
1899
2121
  * contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
1900
2122
  */
1901
2123
  successEntries: BatchGetAssetPropertyValueSuccessEntry[] | undefined;
1902
2124
  /**
2125
+ * @public
1903
2126
  * <p>A list of entries that were not processed by this batch request.
1904
2127
  * because these entries had been completely processed by previous paginated requests.
1905
2128
  * Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
1906
2129
  */
1907
2130
  skippedEntries: BatchGetAssetPropertyValueSkippedEntry[] | undefined;
1908
2131
  /**
2132
+ * @public
1909
2133
  * <p>The token for the next set of results, or null if there are no additional results.</p>
1910
2134
  */
1911
2135
  nextToken?: string;
@@ -1927,18 +2151,22 @@ export interface BatchGetAssetPropertyValueResponse {
1927
2151
  */
1928
2152
  export interface BatchGetAssetPropertyValueHistoryEntry {
1929
2153
  /**
2154
+ * @public
1930
2155
  * <p>The ID of the entry.</p>
1931
2156
  */
1932
2157
  entryId: string | undefined;
1933
2158
  /**
2159
+ * @public
1934
2160
  * <p>The ID of the asset in which the asset property was created.</p>
1935
2161
  */
1936
2162
  assetId?: string;
1937
2163
  /**
2164
+ * @public
1938
2165
  * <p>The ID of the asset property.</p>
1939
2166
  */
1940
2167
  propertyId?: string;
1941
2168
  /**
2169
+ * @public
1942
2170
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
1943
2171
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
1944
2172
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -1946,18 +2174,22 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
1946
2174
  */
1947
2175
  propertyAlias?: string;
1948
2176
  /**
2177
+ * @public
1949
2178
  * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
1950
2179
  */
1951
2180
  startDate?: Date;
1952
2181
  /**
2182
+ * @public
1953
2183
  * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
1954
2184
  */
1955
2185
  endDate?: Date;
1956
2186
  /**
2187
+ * @public
1957
2188
  * <p>The quality by which to filter asset data.</p>
1958
2189
  */
1959
2190
  qualities?: (Quality | string)[];
1960
2191
  /**
2192
+ * @public
1961
2193
  * <p>The chronological sorting order of the requested information.</p>
1962
2194
  * <p>Default: <code>ASCENDING</code>
1963
2195
  * </p>
@@ -1969,15 +2201,18 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
1969
2201
  */
1970
2202
  export interface BatchGetAssetPropertyValueHistoryRequest {
1971
2203
  /**
2204
+ * @public
1972
2205
  * <p>The list of asset property historical value entries for the batch get request. You can
1973
2206
  * specify up to 16 entries per request.</p>
1974
2207
  */
1975
2208
  entries: BatchGetAssetPropertyValueHistoryEntry[] | undefined;
1976
2209
  /**
2210
+ * @public
1977
2211
  * <p>The token to be used for the next set of paginated results.</p>
1978
2212
  */
1979
2213
  nextToken?: string;
1980
2214
  /**
2215
+ * @public
1981
2216
  * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
1982
2217
  * first.</p>
1983
2218
  * <ul>
@@ -2012,14 +2247,17 @@ export type BatchGetAssetPropertyValueHistoryErrorCode = (typeof BatchGetAssetPr
2012
2247
  */
2013
2248
  export interface BatchGetAssetPropertyValueHistoryErrorEntry {
2014
2249
  /**
2250
+ * @public
2015
2251
  * <p>The error code.</p>
2016
2252
  */
2017
2253
  errorCode: BatchGetAssetPropertyValueHistoryErrorCode | string | undefined;
2018
2254
  /**
2255
+ * @public
2019
2256
  * <p>The associated error message.</p>
2020
2257
  */
2021
2258
  errorMessage: string | undefined;
2022
2259
  /**
2260
+ * @public
2023
2261
  * <p>The ID of the entry.</p>
2024
2262
  */
2025
2263
  entryId: string | undefined;
@@ -2030,10 +2268,12 @@ export interface BatchGetAssetPropertyValueHistoryErrorEntry {
2030
2268
  */
2031
2269
  export interface BatchGetAssetPropertyValueHistoryErrorInfo {
2032
2270
  /**
2271
+ * @public
2033
2272
  * <p>The error code.</p>
2034
2273
  */
2035
2274
  errorCode: BatchGetAssetPropertyValueHistoryErrorCode | string | undefined;
2036
2275
  /**
2276
+ * @public
2037
2277
  * <p>The date the error occurred, in Unix epoch time.</p>
2038
2278
  */
2039
2279
  errorTimestamp: Date | undefined;
@@ -2044,14 +2284,17 @@ export interface BatchGetAssetPropertyValueHistoryErrorInfo {
2044
2284
  */
2045
2285
  export interface BatchGetAssetPropertyValueHistorySkippedEntry {
2046
2286
  /**
2287
+ * @public
2047
2288
  * <p>The ID of the entry.</p>
2048
2289
  */
2049
2290
  entryId: string | undefined;
2050
2291
  /**
2292
+ * @public
2051
2293
  * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html">BatchGetAssetPropertyValueHistory</a> API.</p>
2052
2294
  */
2053
2295
  completionStatus: BatchEntryCompletionStatus | string | undefined;
2054
2296
  /**
2297
+ * @public
2055
2298
  * <p>The error information, such as the error code and the timestamp.</p>
2056
2299
  */
2057
2300
  errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo;
@@ -2062,10 +2305,12 @@ export interface BatchGetAssetPropertyValueHistorySkippedEntry {
2062
2305
  */
2063
2306
  export interface BatchGetAssetPropertyValueHistorySuccessEntry {
2064
2307
  /**
2308
+ * @public
2065
2309
  * <p>The ID of the entry.</p>
2066
2310
  */
2067
2311
  entryId: string | undefined;
2068
2312
  /**
2313
+ * @public
2069
2314
  * <p>The requested historical values for the specified asset property.</p>
2070
2315
  */
2071
2316
  assetPropertyValueHistory: AssetPropertyValue[] | undefined;
@@ -2075,22 +2320,26 @@ export interface BatchGetAssetPropertyValueHistorySuccessEntry {
2075
2320
  */
2076
2321
  export interface BatchGetAssetPropertyValueHistoryResponse {
2077
2322
  /**
2323
+ * @public
2078
2324
  * <p>A list of the errors (if any) associated with the batch request. Each error entry
2079
2325
  * contains the <code>entryId</code> of the entry that failed.</p>
2080
2326
  */
2081
2327
  errorEntries: BatchGetAssetPropertyValueHistoryErrorEntry[] | undefined;
2082
2328
  /**
2329
+ * @public
2083
2330
  * <p>A list of entries that were processed successfully by this batch request. Each success entry
2084
2331
  * contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
2085
2332
  */
2086
2333
  successEntries: BatchGetAssetPropertyValueHistorySuccessEntry[] | undefined;
2087
2334
  /**
2335
+ * @public
2088
2336
  * <p>A list of entries that were not processed by this batch request.
2089
2337
  * because these entries had been completely processed by previous paginated requests.
2090
2338
  * Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
2091
2339
  */
2092
2340
  skippedEntries: BatchGetAssetPropertyValueHistorySkippedEntry[] | undefined;
2093
2341
  /**
2342
+ * @public
2094
2343
  * <p>The token for the next set of results, or null if there are no additional results.</p>
2095
2344
  */
2096
2345
  nextToken?: string;
@@ -2103,19 +2352,23 @@ export interface BatchGetAssetPropertyValueHistoryResponse {
2103
2352
  */
2104
2353
  export interface PutAssetPropertyValueEntry {
2105
2354
  /**
2355
+ * @public
2106
2356
  * <p>The user specified ID for the entry. You can use this ID to identify which entries
2107
2357
  * failed.</p>
2108
2358
  */
2109
2359
  entryId: string | undefined;
2110
2360
  /**
2361
+ * @public
2111
2362
  * <p>The ID of the asset to update.</p>
2112
2363
  */
2113
2364
  assetId?: string;
2114
2365
  /**
2366
+ * @public
2115
2367
  * <p>The ID of the asset property for this entry.</p>
2116
2368
  */
2117
2369
  propertyId?: string;
2118
2370
  /**
2371
+ * @public
2119
2372
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
2120
2373
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
2121
2374
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -2123,6 +2376,7 @@ export interface PutAssetPropertyValueEntry {
2123
2376
  */
2124
2377
  propertyAlias?: string;
2125
2378
  /**
2379
+ * @public
2126
2380
  * <p>The list of property values to upload. You can specify up to 10
2127
2381
  * <code>propertyValues</code> array elements. </p>
2128
2382
  */
@@ -2133,6 +2387,7 @@ export interface PutAssetPropertyValueEntry {
2133
2387
  */
2134
2388
  export interface BatchPutAssetPropertyValueRequest {
2135
2389
  /**
2390
+ * @public
2136
2391
  * <p>The list of asset property value entries for the batch put request. You can specify up to
2137
2392
  * 10 entries per request.</p>
2138
2393
  */
@@ -2163,14 +2418,17 @@ export type BatchPutAssetPropertyValueErrorCode = (typeof BatchPutAssetPropertyV
2163
2418
  */
2164
2419
  export interface BatchPutAssetPropertyError {
2165
2420
  /**
2421
+ * @public
2166
2422
  * <p>The error code.</p>
2167
2423
  */
2168
2424
  errorCode: BatchPutAssetPropertyValueErrorCode | string | undefined;
2169
2425
  /**
2426
+ * @public
2170
2427
  * <p>The associated error message.</p>
2171
2428
  */
2172
2429
  errorMessage: string | undefined;
2173
2430
  /**
2431
+ * @public
2174
2432
  * <p>A list of timestamps for each error, if any.</p>
2175
2433
  */
2176
2434
  timestamps: TimeInNanos[] | undefined;
@@ -2182,10 +2440,12 @@ export interface BatchPutAssetPropertyError {
2182
2440
  */
2183
2441
  export interface BatchPutAssetPropertyErrorEntry {
2184
2442
  /**
2443
+ * @public
2185
2444
  * <p>The ID of the failed entry.</p>
2186
2445
  */
2187
2446
  entryId: string | undefined;
2188
2447
  /**
2448
+ * @public
2189
2449
  * <p>The list of update property value errors.</p>
2190
2450
  */
2191
2451
  errors: BatchPutAssetPropertyError[] | undefined;
@@ -2195,6 +2455,7 @@ export interface BatchPutAssetPropertyErrorEntry {
2195
2455
  */
2196
2456
  export interface BatchPutAssetPropertyValueResponse {
2197
2457
  /**
2458
+ * @public
2198
2459
  * <p>A list of the errors (if any) associated with the batch put request. Each error entry
2199
2460
  * contains the <code>entryId</code> of the entry that failed.</p>
2200
2461
  */
@@ -2205,22 +2466,27 @@ export interface BatchPutAssetPropertyValueResponse {
2205
2466
  */
2206
2467
  export interface CreateAccessPolicyRequest {
2207
2468
  /**
2469
+ * @public
2208
2470
  * <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
2209
2471
  */
2210
2472
  accessPolicyIdentity: Identity | undefined;
2211
2473
  /**
2474
+ * @public
2212
2475
  * <p>The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.</p>
2213
2476
  */
2214
2477
  accessPolicyResource: Resource | undefined;
2215
2478
  /**
2479
+ * @public
2216
2480
  * <p>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</p>
2217
2481
  */
2218
2482
  accessPolicyPermission: Permission | string | undefined;
2219
2483
  /**
2484
+ * @public
2220
2485
  * <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>
2221
2486
  */
2222
2487
  clientToken?: string;
2223
2488
  /**
2489
+ * @public
2224
2490
  * <p>A list of key-value pairs that contain metadata for the access policy. For more
2225
2491
  * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your
2226
2492
  * IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2232,10 +2498,12 @@ export interface CreateAccessPolicyRequest {
2232
2498
  */
2233
2499
  export interface CreateAccessPolicyResponse {
2234
2500
  /**
2501
+ * @public
2235
2502
  * <p>The ID of the access policy.</p>
2236
2503
  */
2237
2504
  accessPolicyId: string | undefined;
2238
2505
  /**
2506
+ * @public
2239
2507
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the access policy, which has the following format.</p>
2240
2508
  * <p>
2241
2509
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}</code>
@@ -2248,24 +2516,29 @@ export interface CreateAccessPolicyResponse {
2248
2516
  */
2249
2517
  export interface CreateAssetRequest {
2250
2518
  /**
2519
+ * @public
2251
2520
  * <p>A friendly name for the asset.</p>
2252
2521
  */
2253
2522
  assetName: string | undefined;
2254
2523
  /**
2524
+ * @public
2255
2525
  * <p>The ID of the asset model from which to create the asset.</p>
2256
2526
  */
2257
2527
  assetModelId: string | undefined;
2258
2528
  /**
2529
+ * @public
2259
2530
  * <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>
2260
2531
  */
2261
2532
  clientToken?: string;
2262
2533
  /**
2534
+ * @public
2263
2535
  * <p>A list of key-value pairs that contain metadata for the asset. For more information, see
2264
2536
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2265
2537
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
2266
2538
  */
2267
2539
  tags?: Record<string, string>;
2268
2540
  /**
2541
+ * @public
2269
2542
  * <p>A description for the asset.</p>
2270
2543
  */
2271
2544
  assetDescription?: string;
@@ -2275,11 +2548,13 @@ export interface CreateAssetRequest {
2275
2548
  */
2276
2549
  export interface CreateAssetResponse {
2277
2550
  /**
2551
+ * @public
2278
2552
  * <p>The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other
2279
2553
  * IoT SiteWise APIs.</p>
2280
2554
  */
2281
2555
  assetId: string | undefined;
2282
2556
  /**
2557
+ * @public
2283
2558
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
2284
2559
  * <p>
2285
2560
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
@@ -2287,6 +2562,7 @@ export interface CreateAssetResponse {
2287
2562
  */
2288
2563
  assetArn: string | undefined;
2289
2564
  /**
2565
+ * @public
2290
2566
  * <p>The status of the asset, which contains a state (<code>CREATING</code> after successfully
2291
2567
  * calling this operation) and any error message.</p>
2292
2568
  */
@@ -2297,14 +2573,17 @@ export interface CreateAssetResponse {
2297
2573
  */
2298
2574
  export interface CreateAssetModelRequest {
2299
2575
  /**
2576
+ * @public
2300
2577
  * <p>A unique, friendly name for the asset model.</p>
2301
2578
  */
2302
2579
  assetModelName: string | undefined;
2303
2580
  /**
2581
+ * @public
2304
2582
  * <p>A description for the asset model.</p>
2305
2583
  */
2306
2584
  assetModelDescription?: string;
2307
2585
  /**
2586
+ * @public
2308
2587
  * <p>The property definitions of the asset model. For more information, see
2309
2588
  * <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>
2310
2589
  * <p>You can specify up to 200 properties per asset model. For more
@@ -2312,6 +2591,7 @@ export interface CreateAssetModelRequest {
2312
2591
  */
2313
2592
  assetModelProperties?: AssetModelPropertyDefinition[];
2314
2593
  /**
2594
+ * @public
2315
2595
  * <p>The hierarchy definitions of the asset model. Each hierarchy specifies an asset model
2316
2596
  * whose assets can be children of any other assets created from this asset model. For more
2317
2597
  * 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>
@@ -2320,6 +2600,7 @@ export interface CreateAssetModelRequest {
2320
2600
  */
2321
2601
  assetModelHierarchies?: AssetModelHierarchyDefinition[];
2322
2602
  /**
2603
+ * @public
2323
2604
  * <p>The composite asset models that are part of this asset model.
2324
2605
  * Composite asset models are asset models that contain specific properties. Each composite model
2325
2606
  * has a type that defines the properties that the composite model supports. Use composite asset
@@ -2327,10 +2608,12 @@ export interface CreateAssetModelRequest {
2327
2608
  */
2328
2609
  assetModelCompositeModels?: AssetModelCompositeModelDefinition[];
2329
2610
  /**
2611
+ * @public
2330
2612
  * <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>
2331
2613
  */
2332
2614
  clientToken?: string;
2333
2615
  /**
2616
+ * @public
2334
2617
  * <p>A list of key-value pairs that contain metadata for the asset model. For more information,
2335
2618
  * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2336
2619
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2342,10 +2625,12 @@ export interface CreateAssetModelRequest {
2342
2625
  */
2343
2626
  export interface CreateAssetModelResponse {
2344
2627
  /**
2628
+ * @public
2345
2629
  * <p>The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.</p>
2346
2630
  */
2347
2631
  assetModelId: string | undefined;
2348
2632
  /**
2633
+ * @public
2349
2634
  * <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>
2350
2635
  * <p>
2351
2636
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
@@ -2353,6 +2638,7 @@ export interface CreateAssetModelResponse {
2353
2638
  */
2354
2639
  assetModelArn: string | undefined;
2355
2640
  /**
2641
+ * @public
2356
2642
  * <p>The status of the asset model, which contains a state (<code>CREATING</code> after
2357
2643
  * successfully calling this operation) and any error message.</p>
2358
2644
  */
@@ -2364,11 +2650,13 @@ export interface CreateAssetModelResponse {
2364
2650
  */
2365
2651
  export interface ErrorReportLocation {
2366
2652
  /**
2653
+ * @public
2367
2654
  * <p>The name of the Amazon S3 bucket to which errors associated with the bulk import job are
2368
2655
  * sent.</p>
2369
2656
  */
2370
2657
  bucket: string | undefined;
2371
2658
  /**
2659
+ * @public
2372
2660
  * <p>Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has
2373
2661
  * a key that is its unique identifier in the bucket. Each object in a bucket has exactly one
2374
2662
  * key. The prefix must end with a forward slash (/). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects
@@ -2382,15 +2670,18 @@ export interface ErrorReportLocation {
2382
2670
  */
2383
2671
  export interface File {
2384
2672
  /**
2673
+ * @public
2385
2674
  * <p>The name of the Amazon S3 bucket from which data is imported.</p>
2386
2675
  */
2387
2676
  bucket: string | undefined;
2388
2677
  /**
2678
+ * @public
2389
2679
  * <p>The key of the Amazon S3 object that contains your data. Each object has a key that is a unique
2390
2680
  * identifier. Each object has exactly one key.</p>
2391
2681
  */
2392
2682
  key: string | undefined;
2393
2683
  /**
2684
+ * @public
2394
2685
  * <p>The version ID to identify a specific version of the Amazon S3 object that contains your
2395
2686
  * data.</p>
2396
2687
  */
@@ -2420,6 +2711,7 @@ export type ColumnName = (typeof ColumnName)[keyof typeof ColumnName];
2420
2711
  */
2421
2712
  export interface Csv {
2422
2713
  /**
2714
+ * @public
2423
2715
  * <p>The column names specified in the .csv file.</p>
2424
2716
  */
2425
2717
  columnNames?: (ColumnName | string)[];
@@ -2430,6 +2722,7 @@ export interface Csv {
2430
2722
  */
2431
2723
  export interface FileFormat {
2432
2724
  /**
2725
+ * @public
2433
2726
  * <p>The .csv file format.</p>
2434
2727
  */
2435
2728
  csv?: Csv;
@@ -2440,6 +2733,7 @@ export interface FileFormat {
2440
2733
  */
2441
2734
  export interface JobConfiguration {
2442
2735
  /**
2736
+ * @public
2443
2737
  * <p>The file format of the data in Amazon S3.</p>
2444
2738
  */
2445
2739
  fileFormat: FileFormat | undefined;
@@ -2449,22 +2743,27 @@ export interface JobConfiguration {
2449
2743
  */
2450
2744
  export interface CreateBulkImportJobRequest {
2451
2745
  /**
2746
+ * @public
2452
2747
  * <p>The unique name that helps identify the job request.</p>
2453
2748
  */
2454
2749
  jobName: string | undefined;
2455
2750
  /**
2751
+ * @public
2456
2752
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data.</p>
2457
2753
  */
2458
2754
  jobRoleArn: string | undefined;
2459
2755
  /**
2756
+ * @public
2460
2757
  * <p>The files in the specified Amazon S3 bucket that contain your data.</p>
2461
2758
  */
2462
2759
  files: File[] | undefined;
2463
2760
  /**
2761
+ * @public
2464
2762
  * <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
2465
2763
  */
2466
2764
  errorReportLocation: ErrorReportLocation | undefined;
2467
2765
  /**
2766
+ * @public
2468
2767
  * <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
2469
2768
  */
2470
2769
  jobConfiguration: JobConfiguration | undefined;
@@ -2490,14 +2789,17 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
2490
2789
  */
2491
2790
  export interface CreateBulkImportJobResponse {
2492
2791
  /**
2792
+ * @public
2493
2793
  * <p>The ID of the job.</p>
2494
2794
  */
2495
2795
  jobId: string | undefined;
2496
2796
  /**
2797
+ * @public
2497
2798
  * <p>The unique name that helps identify the job request.</p>
2498
2799
  */
2499
2800
  jobName: string | undefined;
2500
2801
  /**
2802
+ * @public
2501
2803
  * <p>The status of the bulk import job can be one of following values.</p>
2502
2804
  * <ul>
2503
2805
  * <li>
@@ -2535,27 +2837,33 @@ export interface CreateBulkImportJobResponse {
2535
2837
  */
2536
2838
  export interface CreateDashboardRequest {
2537
2839
  /**
2840
+ * @public
2538
2841
  * <p>The ID of the project in which to create the dashboard.</p>
2539
2842
  */
2540
2843
  projectId: string | undefined;
2541
2844
  /**
2845
+ * @public
2542
2846
  * <p>A friendly name for the dashboard.</p>
2543
2847
  */
2544
2848
  dashboardName: string | undefined;
2545
2849
  /**
2850
+ * @public
2546
2851
  * <p>A description for the dashboard.</p>
2547
2852
  */
2548
2853
  dashboardDescription?: string;
2549
2854
  /**
2855
+ * @public
2550
2856
  * <p>The dashboard definition specified in a JSON literal. For detailed information, see
2551
2857
  * <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>
2552
2858
  */
2553
2859
  dashboardDefinition: string | undefined;
2554
2860
  /**
2861
+ * @public
2555
2862
  * <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>
2556
2863
  */
2557
2864
  clientToken?: string;
2558
2865
  /**
2866
+ * @public
2559
2867
  * <p>A list of key-value pairs that contain metadata for the dashboard. For more information,
2560
2868
  * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2561
2869
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2567,10 +2875,12 @@ export interface CreateDashboardRequest {
2567
2875
  */
2568
2876
  export interface CreateDashboardResponse {
2569
2877
  /**
2878
+ * @public
2570
2879
  * <p>The ID of the dashboard.</p>
2571
2880
  */
2572
2881
  dashboardId: string | undefined;
2573
2882
  /**
2883
+ * @public
2574
2884
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
2575
2885
  * <p>
2576
2886
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dashboard/$\{DashboardId\}</code>
@@ -2587,6 +2897,7 @@ export interface CreateDashboardResponse {
2587
2897
  */
2588
2898
  export interface Greengrass {
2589
2899
  /**
2900
+ * @public
2590
2901
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's
2591
2902
  * ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the
2592
2903
  * <i>IoT Greengrass API Reference</i>.</p>
@@ -2603,6 +2914,7 @@ export interface Greengrass {
2603
2914
  */
2604
2915
  export interface GreengrassV2 {
2605
2916
  /**
2917
+ * @public
2606
2918
  * <p>The name of the IoT thing for your IoT Greengrass V2 core device.</p>
2607
2919
  */
2608
2920
  coreDeviceThingName: string | undefined;
@@ -2613,10 +2925,12 @@ export interface GreengrassV2 {
2613
2925
  */
2614
2926
  export interface GatewayPlatform {
2615
2927
  /**
2928
+ * @public
2616
2929
  * <p>A gateway that runs on IoT Greengrass.</p>
2617
2930
  */
2618
2931
  greengrass?: Greengrass;
2619
2932
  /**
2933
+ * @public
2620
2934
  * <p>A gateway that runs on IoT Greengrass V2.</p>
2621
2935
  */
2622
2936
  greengrassV2?: GreengrassV2;
@@ -2626,14 +2940,17 @@ export interface GatewayPlatform {
2626
2940
  */
2627
2941
  export interface CreateGatewayRequest {
2628
2942
  /**
2943
+ * @public
2629
2944
  * <p>A unique, friendly name for the gateway.</p>
2630
2945
  */
2631
2946
  gatewayName: string | undefined;
2632
2947
  /**
2948
+ * @public
2633
2949
  * <p>The gateway's platform. You can only specify one platform in a gateway.</p>
2634
2950
  */
2635
2951
  gatewayPlatform: GatewayPlatform | undefined;
2636
2952
  /**
2953
+ * @public
2637
2954
  * <p>A list of key-value pairs that contain metadata for the gateway. For more information, see
2638
2955
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2639
2956
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2645,10 +2962,12 @@ export interface CreateGatewayRequest {
2645
2962
  */
2646
2963
  export interface CreateGatewayResponse {
2647
2964
  /**
2965
+ * @public
2648
2966
  * <p>The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.</p>
2649
2967
  */
2650
2968
  gatewayId: string | undefined;
2651
2969
  /**
2970
+ * @public
2652
2971
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p>
2653
2972
  * <p>
2654
2973
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:gateway/$\{GatewayId\}</code>
@@ -2673,11 +2992,13 @@ export type ImageFileType = (typeof ImageFileType)[keyof typeof ImageFileType];
2673
2992
  */
2674
2993
  export interface ImageFile {
2675
2994
  /**
2995
+ * @public
2676
2996
  * <p>The image file contents, represented as a base64-encoded string. The file size must be
2677
2997
  * less than 1 MB.</p>
2678
2998
  */
2679
2999
  data: Uint8Array | undefined;
2680
3000
  /**
3001
+ * @public
2681
3002
  * <p>The file type of the image.</p>
2682
3003
  */
2683
3004
  type: ImageFileType | string | undefined;
@@ -2687,39 +3008,47 @@ export interface ImageFile {
2687
3008
  */
2688
3009
  export interface CreatePortalRequest {
2689
3010
  /**
3011
+ * @public
2690
3012
  * <p>A friendly name for the portal.</p>
2691
3013
  */
2692
3014
  portalName: string | undefined;
2693
3015
  /**
3016
+ * @public
2694
3017
  * <p>A description for the portal.</p>
2695
3018
  */
2696
3019
  portalDescription?: string;
2697
3020
  /**
3021
+ * @public
2698
3022
  * <p>The Amazon Web Services administrator's contact email address.</p>
2699
3023
  */
2700
3024
  portalContactEmail: string | undefined;
2701
3025
  /**
3026
+ * @public
2702
3027
  * <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>
2703
3028
  */
2704
3029
  clientToken?: string;
2705
3030
  /**
3031
+ * @public
2706
3032
  * <p>A logo image to display in the portal. Upload a square, high-resolution image. The
2707
3033
  * image is displayed on a dark background.</p>
2708
3034
  */
2709
3035
  portalLogoImageFile?: ImageFile;
2710
3036
  /**
3037
+ * @public
2711
3038
  * <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
2712
3039
  * 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
2713
3040
  * <i>IoT SiteWise User Guide</i>.</p>
2714
3041
  */
2715
3042
  roleArn: string | undefined;
2716
3043
  /**
3044
+ * @public
2717
3045
  * <p>A list of key-value pairs that contain metadata for the portal. For more information, see
2718
3046
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2719
3047
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
2720
3048
  */
2721
3049
  tags?: Record<string, string>;
2722
3050
  /**
3051
+ * @public
2723
3052
  * <p>The service to use to authenticate users to the portal. Choose from the following
2724
3053
  * options:</p>
2725
3054
  * <ul>
@@ -2743,6 +3072,7 @@ export interface CreatePortalRequest {
2743
3072
  */
2744
3073
  portalAuthMode?: AuthMode | string;
2745
3074
  /**
3075
+ * @public
2746
3076
  * <p>The email address that sends alarm notifications.</p>
2747
3077
  * <important>
2748
3078
  * <p>If you use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">IoT Events managed Lambda
@@ -2752,6 +3082,7 @@ export interface CreatePortalRequest {
2752
3082
  */
2753
3083
  notificationSenderEmail?: string;
2754
3084
  /**
3085
+ * @public
2755
3086
  * <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
2756
3087
  * You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
2757
3088
  * 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>
@@ -2777,10 +3108,12 @@ export type MonitorErrorCode = (typeof MonitorErrorCode)[keyof typeof MonitorErr
2777
3108
  */
2778
3109
  export interface MonitorErrorDetails {
2779
3110
  /**
3111
+ * @public
2780
3112
  * <p>The error code.</p>
2781
3113
  */
2782
3114
  code?: MonitorErrorCode | string;
2783
3115
  /**
3116
+ * @public
2784
3117
  * <p>The error message.</p>
2785
3118
  */
2786
3119
  message?: string;
@@ -2806,10 +3139,12 @@ export type PortalState = (typeof PortalState)[keyof typeof PortalState];
2806
3139
  */
2807
3140
  export interface PortalStatus {
2808
3141
  /**
3142
+ * @public
2809
3143
  * <p>The current state of the portal.</p>
2810
3144
  */
2811
3145
  state: PortalState | string | undefined;
2812
3146
  /**
3147
+ * @public
2813
3148
  * <p>Contains associated error information, if any.</p>
2814
3149
  */
2815
3150
  error?: MonitorErrorDetails;
@@ -2819,10 +3154,12 @@ export interface PortalStatus {
2819
3154
  */
2820
3155
  export interface CreatePortalResponse {
2821
3156
  /**
3157
+ * @public
2822
3158
  * <p>The ID of the created portal.</p>
2823
3159
  */
2824
3160
  portalId: string | undefined;
2825
3161
  /**
3162
+ * @public
2826
3163
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the portal, which has the following format.</p>
2827
3164
  * <p>
2828
3165
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}</code>
@@ -2830,17 +3167,20 @@ export interface CreatePortalResponse {
2830
3167
  */
2831
3168
  portalArn: string | undefined;
2832
3169
  /**
3170
+ * @public
2833
3171
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
2834
3172
  * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
2835
3173
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
2836
3174
  */
2837
3175
  portalStartUrl: string | undefined;
2838
3176
  /**
3177
+ * @public
2839
3178
  * <p>The status of the portal, which contains a state (<code>CREATING</code> after successfully
2840
3179
  * calling this operation) and any error message.</p>
2841
3180
  */
2842
3181
  portalStatus: PortalStatus | undefined;
2843
3182
  /**
3183
+ * @public
2844
3184
  * <p>The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.</p>
2845
3185
  */
2846
3186
  ssoApplicationId: string | undefined;
@@ -2850,22 +3190,27 @@ export interface CreatePortalResponse {
2850
3190
  */
2851
3191
  export interface CreateProjectRequest {
2852
3192
  /**
3193
+ * @public
2853
3194
  * <p>The ID of the portal in which to create the project.</p>
2854
3195
  */
2855
3196
  portalId: string | undefined;
2856
3197
  /**
3198
+ * @public
2857
3199
  * <p>A friendly name for the project.</p>
2858
3200
  */
2859
3201
  projectName: string | undefined;
2860
3202
  /**
3203
+ * @public
2861
3204
  * <p>A description for the project.</p>
2862
3205
  */
2863
3206
  projectDescription?: string;
2864
3207
  /**
3208
+ * @public
2865
3209
  * <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>
2866
3210
  */
2867
3211
  clientToken?: string;
2868
3212
  /**
3213
+ * @public
2869
3214
  * <p>A list of key-value pairs that contain metadata for the project. For more information, see
2870
3215
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2871
3216
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2877,10 +3222,12 @@ export interface CreateProjectRequest {
2877
3222
  */
2878
3223
  export interface CreateProjectResponse {
2879
3224
  /**
3225
+ * @public
2880
3226
  * <p>The ID of the project.</p>
2881
3227
  */
2882
3228
  projectId: string | undefined;
2883
3229
  /**
3230
+ * @public
2884
3231
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p>
2885
3232
  * <p>
2886
3233
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:project/$\{ProjectId\}</code>
@@ -2893,10 +3240,12 @@ export interface CreateProjectResponse {
2893
3240
  */
2894
3241
  export interface DeleteAccessPolicyRequest {
2895
3242
  /**
3243
+ * @public
2896
3244
  * <p>The ID of the access policy to be deleted.</p>
2897
3245
  */
2898
3246
  accessPolicyId: string | undefined;
2899
3247
  /**
3248
+ * @public
2900
3249
  * <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>
2901
3250
  */
2902
3251
  clientToken?: string;
@@ -2911,10 +3260,12 @@ export interface DeleteAccessPolicyResponse {
2911
3260
  */
2912
3261
  export interface DeleteAssetRequest {
2913
3262
  /**
3263
+ * @public
2914
3264
  * <p>The ID of the asset to delete.</p>
2915
3265
  */
2916
3266
  assetId: string | undefined;
2917
3267
  /**
3268
+ * @public
2918
3269
  * <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>
2919
3270
  */
2920
3271
  clientToken?: string;
@@ -2924,6 +3275,7 @@ export interface DeleteAssetRequest {
2924
3275
  */
2925
3276
  export interface DeleteAssetResponse {
2926
3277
  /**
3278
+ * @public
2927
3279
  * <p>The status of the asset, which contains a state (<code>DELETING</code> after successfully
2928
3280
  * calling this operation) and any error message.</p>
2929
3281
  */
@@ -2934,10 +3286,12 @@ export interface DeleteAssetResponse {
2934
3286
  */
2935
3287
  export interface DeleteAssetModelRequest {
2936
3288
  /**
3289
+ * @public
2937
3290
  * <p>The ID of the asset model to delete.</p>
2938
3291
  */
2939
3292
  assetModelId: string | undefined;
2940
3293
  /**
3294
+ * @public
2941
3295
  * <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>
2942
3296
  */
2943
3297
  clientToken?: string;
@@ -2947,6 +3301,7 @@ export interface DeleteAssetModelRequest {
2947
3301
  */
2948
3302
  export interface DeleteAssetModelResponse {
2949
3303
  /**
3304
+ * @public
2950
3305
  * <p>The status of the asset model, which contains a state (<code>DELETING</code> after
2951
3306
  * successfully calling this operation) and any error message.</p>
2952
3307
  */
@@ -2957,10 +3312,12 @@ export interface DeleteAssetModelResponse {
2957
3312
  */
2958
3313
  export interface DeleteDashboardRequest {
2959
3314
  /**
3315
+ * @public
2960
3316
  * <p>The ID of the dashboard to delete.</p>
2961
3317
  */
2962
3318
  dashboardId: string | undefined;
2963
3319
  /**
3320
+ * @public
2964
3321
  * <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>
2965
3322
  */
2966
3323
  clientToken?: string;
@@ -2975,6 +3332,7 @@ export interface DeleteDashboardResponse {
2975
3332
  */
2976
3333
  export interface DeleteGatewayRequest {
2977
3334
  /**
3335
+ * @public
2978
3336
  * <p>The ID of the gateway to delete.</p>
2979
3337
  */
2980
3338
  gatewayId: string | undefined;
@@ -2984,10 +3342,12 @@ export interface DeleteGatewayRequest {
2984
3342
  */
2985
3343
  export interface DeletePortalRequest {
2986
3344
  /**
3345
+ * @public
2987
3346
  * <p>The ID of the portal to delete.</p>
2988
3347
  */
2989
3348
  portalId: string | undefined;
2990
3349
  /**
3350
+ * @public
2991
3351
  * <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>
2992
3352
  */
2993
3353
  clientToken?: string;
@@ -2997,6 +3357,7 @@ export interface DeletePortalRequest {
2997
3357
  */
2998
3358
  export interface DeletePortalResponse {
2999
3359
  /**
3360
+ * @public
3000
3361
  * <p>The status of the portal, which contains a state (<code>DELETING</code> after successfully
3001
3362
  * calling this operation) and any error message.</p>
3002
3363
  */
@@ -3007,10 +3368,12 @@ export interface DeletePortalResponse {
3007
3368
  */
3008
3369
  export interface DeleteProjectRequest {
3009
3370
  /**
3371
+ * @public
3010
3372
  * <p>The ID of the project.</p>
3011
3373
  */
3012
3374
  projectId: string | undefined;
3013
3375
  /**
3376
+ * @public
3014
3377
  * <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>
3015
3378
  */
3016
3379
  clientToken?: string;
@@ -3025,18 +3388,22 @@ export interface DeleteProjectResponse {
3025
3388
  */
3026
3389
  export interface DeleteTimeSeriesRequest {
3027
3390
  /**
3391
+ * @public
3028
3392
  * <p>The alias that identifies the time series.</p>
3029
3393
  */
3030
3394
  alias?: string;
3031
3395
  /**
3396
+ * @public
3032
3397
  * <p>The ID of the asset in which the asset property was created.</p>
3033
3398
  */
3034
3399
  assetId?: string;
3035
3400
  /**
3401
+ * @public
3036
3402
  * <p>The ID of the asset property.</p>
3037
3403
  */
3038
3404
  propertyId?: string;
3039
3405
  /**
3406
+ * @public
3040
3407
  * <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>
3041
3408
  */
3042
3409
  clientToken?: string;
@@ -3046,6 +3413,7 @@ export interface DeleteTimeSeriesRequest {
3046
3413
  */
3047
3414
  export interface DescribeAccessPolicyRequest {
3048
3415
  /**
3416
+ * @public
3049
3417
  * <p>The ID of the access policy.</p>
3050
3418
  */
3051
3419
  accessPolicyId: string | undefined;
@@ -3055,10 +3423,12 @@ export interface DescribeAccessPolicyRequest {
3055
3423
  */
3056
3424
  export interface DescribeAccessPolicyResponse {
3057
3425
  /**
3426
+ * @public
3058
3427
  * <p>The ID of the access policy.</p>
3059
3428
  */
3060
3429
  accessPolicyId: string | undefined;
3061
3430
  /**
3431
+ * @public
3062
3432
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the access policy, which has the following format.</p>
3063
3433
  * <p>
3064
3434
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}</code>
@@ -3066,25 +3436,30 @@ export interface DescribeAccessPolicyResponse {
3066
3436
  */
3067
3437
  accessPolicyArn: string | undefined;
3068
3438
  /**
3439
+ * @public
3069
3440
  * <p>The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy
3070
3441
  * applies.</p>
3071
3442
  */
3072
3443
  accessPolicyIdentity: Identity | undefined;
3073
3444
  /**
3445
+ * @public
3074
3446
  * <p>The IoT SiteWise Monitor resource (portal or project) to which this access policy provides
3075
3447
  * access.</p>
3076
3448
  */
3077
3449
  accessPolicyResource: Resource | undefined;
3078
3450
  /**
3451
+ * @public
3079
3452
  * <p>The access policy permission. Note that a project <code>ADMINISTRATOR</code> is also known
3080
3453
  * as a project owner.</p>
3081
3454
  */
3082
3455
  accessPolicyPermission: Permission | string | undefined;
3083
3456
  /**
3457
+ * @public
3084
3458
  * <p>The date the access policy was created, in Unix epoch time.</p>
3085
3459
  */
3086
3460
  accessPolicyCreationDate: Date | undefined;
3087
3461
  /**
3462
+ * @public
3088
3463
  * <p>The date the access policy was last updated, in Unix epoch time.</p>
3089
3464
  */
3090
3465
  accessPolicyLastUpdateDate: Date | undefined;
@@ -3094,10 +3469,12 @@ export interface DescribeAccessPolicyResponse {
3094
3469
  */
3095
3470
  export interface DescribeAssetRequest {
3096
3471
  /**
3472
+ * @public
3097
3473
  * <p>The ID of the asset.</p>
3098
3474
  */
3099
3475
  assetId: string | undefined;
3100
3476
  /**
3477
+ * @public
3101
3478
  * <p>
3102
3479
  * Whether or not to exclude asset properties from the response.
3103
3480
  * </p>
@@ -3109,10 +3486,12 @@ export interface DescribeAssetRequest {
3109
3486
  */
3110
3487
  export interface DescribeAssetResponse {
3111
3488
  /**
3489
+ * @public
3112
3490
  * <p>The ID of the asset.</p>
3113
3491
  */
3114
3492
  assetId: string | undefined;
3115
3493
  /**
3494
+ * @public
3116
3495
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
3117
3496
  * <p>
3118
3497
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
@@ -3120,40 +3499,49 @@ export interface DescribeAssetResponse {
3120
3499
  */
3121
3500
  assetArn: string | undefined;
3122
3501
  /**
3502
+ * @public
3123
3503
  * <p>The name of the asset.</p>
3124
3504
  */
3125
3505
  assetName: string | undefined;
3126
3506
  /**
3507
+ * @public
3127
3508
  * <p>The ID of the asset model that was used to create the asset.</p>
3128
3509
  */
3129
3510
  assetModelId: string | undefined;
3130
3511
  /**
3512
+ * @public
3131
3513
  * <p>The list of asset properties for the asset.</p>
3132
3514
  * <p>This object doesn't include properties that you define in composite models. You can find
3133
3515
  * composite model properties in the <code>assetCompositeModels</code> object.</p>
3134
3516
  */
3135
3517
  assetProperties: AssetProperty[] | undefined;
3136
3518
  /**
3519
+ * @public
3137
3520
  * <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
3138
3521
  */
3139
3522
  assetHierarchies: AssetHierarchy[] | undefined;
3140
3523
  /**
3524
+ * @public
3141
3525
  * <p>The composite models for the asset.</p>
3142
3526
  */
3143
3527
  assetCompositeModels?: AssetCompositeModel[];
3144
3528
  /**
3529
+ * @public
3145
3530
  * <p>The date the asset was created, in Unix epoch time.</p>
3146
3531
  */
3147
3532
  assetCreationDate: Date | undefined;
3148
3533
  /**
3534
+ * @public
3149
3535
  * <p>The date the asset was last updated, in Unix epoch time.</p>
3150
3536
  */
3151
3537
  assetLastUpdateDate: Date | undefined;
3152
3538
  /**
3539
+ * @public
3153
3540
  * <p>The current status of the asset, which contains a state and any error message.</p>
3154
3541
  */
3155
3542
  assetStatus: AssetStatus | undefined;
3156
3543
  /**
3544
+ * @public
3157
3545
  * <p>A description for the asset.</p>
3158
3546
  */
3159
3547
  assetDescription?: string;
@@ -3163,10 +3551,12 @@ export interface DescribeAssetResponse {
3163
3551
  */
3164
3552
  export interface DescribeAssetModelRequest {
3165
3553
  /**
3554
+ * @public
3166
3555
  * <p>The ID of the asset model.</p>
3167
3556
  */
3168
3557
  assetModelId: string | undefined;
3169
3558
  /**
3559
+ * @public
3170
3560
  * <p>
3171
3561
  * Whether or not to exclude asset model properties from the response.
3172
3562
  * </p>
@@ -3178,10 +3568,12 @@ export interface DescribeAssetModelRequest {
3178
3568
  */
3179
3569
  export interface DescribeAssetModelResponse {
3180
3570
  /**
3571
+ * @public
3181
3572
  * <p>The ID of the asset model.</p>
3182
3573
  */
3183
3574
  assetModelId: string | undefined;
3184
3575
  /**
3576
+ * @public
3185
3577
  * <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>
3186
3578
  * <p>
3187
3579
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
@@ -3189,38 +3581,46 @@ export interface DescribeAssetModelResponse {
3189
3581
  */
3190
3582
  assetModelArn: string | undefined;
3191
3583
  /**
3584
+ * @public
3192
3585
  * <p>The name of the asset model.</p>
3193
3586
  */
3194
3587
  assetModelName: string | undefined;
3195
3588
  /**
3589
+ * @public
3196
3590
  * <p>The asset model's description.</p>
3197
3591
  */
3198
3592
  assetModelDescription: string | undefined;
3199
3593
  /**
3594
+ * @public
3200
3595
  * <p>The list of asset properties for the asset model.</p>
3201
3596
  * <p>This object doesn't include properties that you define in composite models. You can find
3202
3597
  * composite model properties in the <code>assetModelCompositeModels</code> object.</p>
3203
3598
  */
3204
3599
  assetModelProperties: AssetModelProperty[] | undefined;
3205
3600
  /**
3601
+ * @public
3206
3602
  * <p>A list of asset model hierarchies that each contain a <code>childAssetModelId</code> and a
3207
3603
  * <code>hierarchyId</code> (named <code>id</code>). A hierarchy specifies allowed parent/child
3208
3604
  * asset relationships for an asset model.</p>
3209
3605
  */
3210
3606
  assetModelHierarchies: AssetModelHierarchy[] | undefined;
3211
3607
  /**
3608
+ * @public
3212
3609
  * <p>The list of composite asset models for the asset model.</p>
3213
3610
  */
3214
3611
  assetModelCompositeModels?: AssetModelCompositeModel[];
3215
3612
  /**
3613
+ * @public
3216
3614
  * <p>The date the asset model was created, in Unix epoch time.</p>
3217
3615
  */
3218
3616
  assetModelCreationDate: Date | undefined;
3219
3617
  /**
3618
+ * @public
3220
3619
  * <p>The date the asset model was last updated, in Unix epoch time.</p>
3221
3620
  */
3222
3621
  assetModelLastUpdateDate: Date | undefined;
3223
3622
  /**
3623
+ * @public
3224
3624
  * <p>The current status of the asset model, which contains a state and any error
3225
3625
  * message.</p>
3226
3626
  */
@@ -3231,10 +3631,12 @@ export interface DescribeAssetModelResponse {
3231
3631
  */
3232
3632
  export interface DescribeAssetPropertyRequest {
3233
3633
  /**
3634
+ * @public
3234
3635
  * <p>The ID of the asset.</p>
3235
3636
  */
3236
3637
  assetId: string | undefined;
3237
3638
  /**
3639
+ * @public
3238
3640
  * <p>The ID of the asset property.</p>
3239
3641
  */
3240
3642
  propertyId: string | undefined;
@@ -3245,14 +3647,17 @@ export interface DescribeAssetPropertyRequest {
3245
3647
  */
3246
3648
  export interface Property {
3247
3649
  /**
3650
+ * @public
3248
3651
  * <p>The ID of the asset property.</p>
3249
3652
  */
3250
3653
  id: string | undefined;
3251
3654
  /**
3655
+ * @public
3252
3656
  * <p>The name of the property.</p>
3253
3657
  */
3254
3658
  name: string | undefined;
3255
3659
  /**
3660
+ * @public
3256
3661
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
3257
3662
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
3258
3663
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -3260,18 +3665,22 @@ export interface Property {
3260
3665
  */
3261
3666
  alias?: string;
3262
3667
  /**
3668
+ * @public
3263
3669
  * <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>
3264
3670
  */
3265
3671
  notification?: PropertyNotification;
3266
3672
  /**
3673
+ * @public
3267
3674
  * <p>The property data type.</p>
3268
3675
  */
3269
3676
  dataType: PropertyDataType | string | undefined;
3270
3677
  /**
3678
+ * @public
3271
3679
  * <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.</p>
3272
3680
  */
3273
3681
  unit?: string;
3274
3682
  /**
3683
+ * @public
3275
3684
  * <p>The property type (see <code>PropertyType</code>). A property contains one type.</p>
3276
3685
  */
3277
3686
  type?: PropertyType;
@@ -3282,18 +3691,22 @@ export interface Property {
3282
3691
  */
3283
3692
  export interface CompositeModelProperty {
3284
3693
  /**
3694
+ * @public
3285
3695
  * <p>The name of the property.</p>
3286
3696
  */
3287
3697
  name: string | undefined;
3288
3698
  /**
3699
+ * @public
3289
3700
  * <p>The type of the composite model that defines this property.</p>
3290
3701
  */
3291
3702
  type: string | undefined;
3292
3703
  /**
3704
+ * @public
3293
3705
  * <p>Contains asset property information.</p>
3294
3706
  */
3295
3707
  assetProperty: Property | undefined;
3296
3708
  /**
3709
+ * @public
3297
3710
  * <p>
3298
3711
  * The ID of the composite model that contains the property.
3299
3712
  * </p>
@@ -3305,18 +3718,22 @@ export interface CompositeModelProperty {
3305
3718
  */
3306
3719
  export interface DescribeAssetPropertyResponse {
3307
3720
  /**
3721
+ * @public
3308
3722
  * <p>The ID of the asset.</p>
3309
3723
  */
3310
3724
  assetId: string | undefined;
3311
3725
  /**
3726
+ * @public
3312
3727
  * <p>The name of the asset.</p>
3313
3728
  */
3314
3729
  assetName: string | undefined;
3315
3730
  /**
3731
+ * @public
3316
3732
  * <p>The ID of the asset model.</p>
3317
3733
  */
3318
3734
  assetModelId: string | undefined;
3319
3735
  /**
3736
+ * @public
3320
3737
  * <p>The asset property's definition, alias, and notification state.</p>
3321
3738
  * <p>This response includes this object for normal asset properties. If you describe an asset
3322
3739
  * property in a composite model, this response includes the asset property information in
@@ -3324,6 +3741,7 @@ export interface DescribeAssetPropertyResponse {
3324
3741
  */
3325
3742
  assetProperty?: Property;
3326
3743
  /**
3744
+ * @public
3327
3745
  * <p>The composite asset model that declares this asset property, if this asset property exists
3328
3746
  * in a composite model.</p>
3329
3747
  */
@@ -3334,6 +3752,7 @@ export interface DescribeAssetPropertyResponse {
3334
3752
  */
3335
3753
  export interface DescribeBulkImportJobRequest {
3336
3754
  /**
3755
+ * @public
3337
3756
  * <p>The ID of the job.</p>
3338
3757
  */
3339
3758
  jobId: string | undefined;
@@ -3343,14 +3762,17 @@ export interface DescribeBulkImportJobRequest {
3343
3762
  */
3344
3763
  export interface DescribeBulkImportJobResponse {
3345
3764
  /**
3765
+ * @public
3346
3766
  * <p>The ID of the job.</p>
3347
3767
  */
3348
3768
  jobId: string | undefined;
3349
3769
  /**
3770
+ * @public
3350
3771
  * <p>The unique name that helps identify the job request.</p>
3351
3772
  */
3352
3773
  jobName: string | undefined;
3353
3774
  /**
3775
+ * @public
3354
3776
  * <p>The status of the bulk import job can be one of following values.</p>
3355
3777
  * <ul>
3356
3778
  * <li>
@@ -3383,26 +3805,32 @@ export interface DescribeBulkImportJobResponse {
3383
3805
  */
3384
3806
  jobStatus: JobStatus | string | undefined;
3385
3807
  /**
3808
+ * @public
3386
3809
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data.</p>
3387
3810
  */
3388
3811
  jobRoleArn: string | undefined;
3389
3812
  /**
3813
+ * @public
3390
3814
  * <p>The files in the specified Amazon S3 bucket that contain your data.</p>
3391
3815
  */
3392
3816
  files: File[] | undefined;
3393
3817
  /**
3818
+ * @public
3394
3819
  * <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
3395
3820
  */
3396
3821
  errorReportLocation: ErrorReportLocation | undefined;
3397
3822
  /**
3823
+ * @public
3398
3824
  * <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
3399
3825
  */
3400
3826
  jobConfiguration: JobConfiguration | undefined;
3401
3827
  /**
3828
+ * @public
3402
3829
  * <p>The date the job was created, in Unix epoch TIME.</p>
3403
3830
  */
3404
3831
  jobCreationDate: Date | undefined;
3405
3832
  /**
3833
+ * @public
3406
3834
  * <p>The date the job was last updated, in Unix epoch time.</p>
3407
3835
  */
3408
3836
  jobLastUpdateDate: Date | undefined;
@@ -3412,6 +3840,7 @@ export interface DescribeBulkImportJobResponse {
3412
3840
  */
3413
3841
  export interface DescribeDashboardRequest {
3414
3842
  /**
3843
+ * @public
3415
3844
  * <p>The ID of the dashboard.</p>
3416
3845
  */
3417
3846
  dashboardId: string | undefined;
@@ -3421,10 +3850,12 @@ export interface DescribeDashboardRequest {
3421
3850
  */
3422
3851
  export interface DescribeDashboardResponse {
3423
3852
  /**
3853
+ * @public
3424
3854
  * <p>The ID of the dashboard.</p>
3425
3855
  */
3426
3856
  dashboardId: string | undefined;
3427
3857
  /**
3858
+ * @public
3428
3859
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
3429
3860
  * <p>
3430
3861
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dashboard/$\{DashboardId\}</code>
@@ -3432,27 +3863,33 @@ export interface DescribeDashboardResponse {
3432
3863
  */
3433
3864
  dashboardArn: string | undefined;
3434
3865
  /**
3866
+ * @public
3435
3867
  * <p>The name of the dashboard.</p>
3436
3868
  */
3437
3869
  dashboardName: string | undefined;
3438
3870
  /**
3871
+ * @public
3439
3872
  * <p>The ID of the project that the dashboard is in.</p>
3440
3873
  */
3441
3874
  projectId: string | undefined;
3442
3875
  /**
3876
+ * @public
3443
3877
  * <p>The dashboard's description.</p>
3444
3878
  */
3445
3879
  dashboardDescription?: string;
3446
3880
  /**
3881
+ * @public
3447
3882
  * <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
3448
3883
  * dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
3449
3884
  */
3450
3885
  dashboardDefinition: string | undefined;
3451
3886
  /**
3887
+ * @public
3452
3888
  * <p>The date the dashboard was created, in Unix epoch time.</p>
3453
3889
  */
3454
3890
  dashboardCreationDate: Date | undefined;
3455
3891
  /**
3892
+ * @public
3456
3893
  * <p>The date the dashboard was last updated, in Unix epoch time.</p>
3457
3894
  */
3458
3895
  dashboardLastUpdateDate: Date | undefined;
@@ -3468,10 +3905,12 @@ export interface DescribeDefaultEncryptionConfigurationRequest {
3468
3905
  */
3469
3906
  export interface ConfigurationErrorDetails {
3470
3907
  /**
3908
+ * @public
3471
3909
  * <p>The error code.</p>
3472
3910
  */
3473
3911
  code: ErrorCode | string | undefined;
3474
3912
  /**
3913
+ * @public
3475
3914
  * <p>The error message.</p>
3476
3915
  */
3477
3916
  message: string | undefined;
@@ -3495,10 +3934,12 @@ export type ConfigurationState = (typeof ConfigurationState)[keyof typeof Config
3495
3934
  */
3496
3935
  export interface ConfigurationStatus {
3497
3936
  /**
3937
+ * @public
3498
3938
  * <p>The current state of the configuration.</p>
3499
3939
  */
3500
3940
  state: ConfigurationState | string | undefined;
3501
3941
  /**
3942
+ * @public
3502
3943
  * <p>Contains associated error information, if any.</p>
3503
3944
  */
3504
3945
  error?: ConfigurationErrorDetails;
@@ -3520,15 +3961,18 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
3520
3961
  */
3521
3962
  export interface DescribeDefaultEncryptionConfigurationResponse {
3522
3963
  /**
3964
+ * @public
3523
3965
  * <p>The type of encryption used for the encryption configuration.</p>
3524
3966
  */
3525
3967
  encryptionType: EncryptionType | string | undefined;
3526
3968
  /**
3969
+ * @public
3527
3970
  * <p>The key ARN of the customer managed key used for KMS encryption if you use
3528
3971
  * <code>KMS_BASED_ENCRYPTION</code>.</p>
3529
3972
  */
3530
3973
  kmsKeyArn?: string;
3531
3974
  /**
3975
+ * @public
3532
3976
  * <p>The status of the account configuration. This contains the
3533
3977
  * <code>ConfigurationState</code>. If there's an error, it also contains the
3534
3978
  * <code>ErrorDetails</code>.</p>
@@ -3540,6 +3984,7 @@ export interface DescribeDefaultEncryptionConfigurationResponse {
3540
3984
  */
3541
3985
  export interface DescribeGatewayRequest {
3542
3986
  /**
3987
+ * @public
3543
3988
  * <p>The ID of the gateway device.</p>
3544
3989
  */
3545
3990
  gatewayId: string | undefined;
@@ -3564,6 +4009,7 @@ export type CapabilitySyncStatus = (typeof CapabilitySyncStatus)[keyof typeof Ca
3564
4009
  */
3565
4010
  export interface GatewayCapabilitySummary {
3566
4011
  /**
4012
+ * @public
3567
4013
  * <p>The namespace of the capability configuration.
3568
4014
  * For example, if you configure OPC-UA
3569
4015
  * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
@@ -3572,6 +4018,7 @@ export interface GatewayCapabilitySummary {
3572
4018
  */
3573
4019
  capabilityNamespace: string | undefined;
3574
4020
  /**
4021
+ * @public
3575
4022
  * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
3576
4023
  * <ul>
3577
4024
  * <li>
@@ -3595,14 +4042,17 @@ export interface GatewayCapabilitySummary {
3595
4042
  */
3596
4043
  export interface DescribeGatewayResponse {
3597
4044
  /**
4045
+ * @public
3598
4046
  * <p>The ID of the gateway device.</p>
3599
4047
  */
3600
4048
  gatewayId: string | undefined;
3601
4049
  /**
4050
+ * @public
3602
4051
  * <p>The name of the gateway.</p>
3603
4052
  */
3604
4053
  gatewayName: string | undefined;
3605
4054
  /**
4055
+ * @public
3606
4056
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p>
3607
4057
  * <p>
3608
4058
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:gateway/$\{GatewayId\}</code>
@@ -3610,20 +4060,24 @@ export interface DescribeGatewayResponse {
3610
4060
  */
3611
4061
  gatewayArn: string | undefined;
3612
4062
  /**
4063
+ * @public
3613
4064
  * <p>The gateway's platform.</p>
3614
4065
  */
3615
4066
  gatewayPlatform?: GatewayPlatform;
3616
4067
  /**
4068
+ * @public
3617
4069
  * <p>A list of gateway capability summaries that each contain a namespace and status. Each
3618
4070
  * gateway capability defines data sources for the gateway. To retrieve a capability
3619
4071
  * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
3620
4072
  */
3621
4073
  gatewayCapabilitySummaries: GatewayCapabilitySummary[] | undefined;
3622
4074
  /**
4075
+ * @public
3623
4076
  * <p>The date the gateway was created, in Unix epoch time.</p>
3624
4077
  */
3625
4078
  creationDate: Date | undefined;
3626
4079
  /**
4080
+ * @public
3627
4081
  * <p>The date the gateway was last updated, in Unix epoch time.</p>
3628
4082
  */
3629
4083
  lastUpdateDate: Date | undefined;
@@ -3633,10 +4087,12 @@ export interface DescribeGatewayResponse {
3633
4087
  */
3634
4088
  export interface DescribeGatewayCapabilityConfigurationRequest {
3635
4089
  /**
4090
+ * @public
3636
4091
  * <p>The ID of the gateway that defines the capability configuration.</p>
3637
4092
  */
3638
4093
  gatewayId: string | undefined;
3639
4094
  /**
4095
+ * @public
3640
4096
  * <p>The namespace of the capability configuration.
3641
4097
  * For example, if you configure OPC-UA
3642
4098
  * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
@@ -3650,19 +4106,23 @@ export interface DescribeGatewayCapabilityConfigurationRequest {
3650
4106
  */
3651
4107
  export interface DescribeGatewayCapabilityConfigurationResponse {
3652
4108
  /**
4109
+ * @public
3653
4110
  * <p>The ID of the gateway that defines the capability configuration.</p>
3654
4111
  */
3655
4112
  gatewayId: string | undefined;
3656
4113
  /**
4114
+ * @public
3657
4115
  * <p>The namespace of the gateway capability.</p>
3658
4116
  */
3659
4117
  capabilityNamespace: string | undefined;
3660
4118
  /**
4119
+ * @public
3661
4120
  * <p>The JSON document that defines the gateway capability's configuration. For more
3662
4121
  * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
3663
4122
  */
3664
4123
  capabilityConfiguration: string | undefined;
3665
4124
  /**
4125
+ * @public
3666
4126
  * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
3667
4127
  * <ul>
3668
4128
  * <li>
@@ -3705,6 +4165,7 @@ export type LoggingLevel = (typeof LoggingLevel)[keyof typeof LoggingLevel];
3705
4165
  */
3706
4166
  export interface LoggingOptions {
3707
4167
  /**
4168
+ * @public
3708
4169
  * <p>The IoT SiteWise logging verbosity level.</p>
3709
4170
  */
3710
4171
  level: LoggingLevel | string | undefined;
@@ -3714,6 +4175,7 @@ export interface LoggingOptions {
3714
4175
  */
3715
4176
  export interface DescribeLoggingOptionsResponse {
3716
4177
  /**
4178
+ * @public
3717
4179
  * <p>The current logging options.</p>
3718
4180
  */
3719
4181
  loggingOptions: LoggingOptions | undefined;
@@ -3723,6 +4185,7 @@ export interface DescribeLoggingOptionsResponse {
3723
4185
  */
3724
4186
  export interface DescribePortalRequest {
3725
4187
  /**
4188
+ * @public
3726
4189
  * <p>The ID of the portal.</p>
3727
4190
  */
3728
4191
  portalId: string | undefined;
@@ -3733,10 +4196,12 @@ export interface DescribePortalRequest {
3733
4196
  */
3734
4197
  export interface ImageLocation {
3735
4198
  /**
4199
+ * @public
3736
4200
  * <p>The ID of the image.</p>
3737
4201
  */
3738
4202
  id: string | undefined;
3739
4203
  /**
4204
+ * @public
3740
4205
  * <p>The URL where the image is available. The URL is valid for 15 minutes so that you can view
3741
4206
  * and download the image</p>
3742
4207
  */
@@ -3747,10 +4212,12 @@ export interface ImageLocation {
3747
4212
  */
3748
4213
  export interface DescribePortalResponse {
3749
4214
  /**
4215
+ * @public
3750
4216
  * <p>The ID of the portal.</p>
3751
4217
  */
3752
4218
  portalId: string | undefined;
3753
4219
  /**
4220
+ * @public
3754
4221
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the portal, which has the following format.</p>
3755
4222
  * <p>
3756
4223
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}</code>
@@ -3758,59 +4225,72 @@ export interface DescribePortalResponse {
3758
4225
  */
3759
4226
  portalArn: string | undefined;
3760
4227
  /**
4228
+ * @public
3761
4229
  * <p>The name of the portal.</p>
3762
4230
  */
3763
4231
  portalName: string | undefined;
3764
4232
  /**
4233
+ * @public
3765
4234
  * <p>The portal's description.</p>
3766
4235
  */
3767
4236
  portalDescription?: string;
3768
4237
  /**
4238
+ * @public
3769
4239
  * <p>The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes
3770
4240
  * <code>portalClientId</code> for only portals that use IAM Identity Center to authenticate users.</p>
3771
4241
  */
3772
4242
  portalClientId: string | undefined;
3773
4243
  /**
4244
+ * @public
3774
4245
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
3775
4246
  * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
3776
4247
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
3777
4248
  */
3778
4249
  portalStartUrl: string | undefined;
3779
4250
  /**
4251
+ * @public
3780
4252
  * <p>The Amazon Web Services administrator's contact email address.</p>
3781
4253
  */
3782
4254
  portalContactEmail: string | undefined;
3783
4255
  /**
4256
+ * @public
3784
4257
  * <p>The current status of the portal, which contains a state and any error message.</p>
3785
4258
  */
3786
4259
  portalStatus: PortalStatus | undefined;
3787
4260
  /**
4261
+ * @public
3788
4262
  * <p>The date the portal was created, in Unix epoch time.</p>
3789
4263
  */
3790
4264
  portalCreationDate: Date | undefined;
3791
4265
  /**
4266
+ * @public
3792
4267
  * <p>The date the portal was last updated, in Unix epoch time.</p>
3793
4268
  */
3794
4269
  portalLastUpdateDate: Date | undefined;
3795
4270
  /**
4271
+ * @public
3796
4272
  * <p>The portal's logo image, which is available at a URL.</p>
3797
4273
  */
3798
4274
  portalLogoImageLocation?: ImageLocation;
3799
4275
  /**
4276
+ * @public
3800
4277
  * <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
3801
4278
  * 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
3802
4279
  * <i>IoT SiteWise User Guide</i>.</p>
3803
4280
  */
3804
4281
  roleArn?: string;
3805
4282
  /**
4283
+ * @public
3806
4284
  * <p>The service to use to authenticate users to the portal.</p>
3807
4285
  */
3808
4286
  portalAuthMode?: AuthMode | string;
3809
4287
  /**
4288
+ * @public
3810
4289
  * <p>The email address that sends alarm notifications.</p>
3811
4290
  */
3812
4291
  notificationSenderEmail?: string;
3813
4292
  /**
4293
+ * @public
3814
4294
  * <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.</p>
3815
4295
  */
3816
4296
  alarms?: Alarms;
@@ -3820,6 +4300,7 @@ export interface DescribePortalResponse {
3820
4300
  */
3821
4301
  export interface DescribeProjectRequest {
3822
4302
  /**
4303
+ * @public
3823
4304
  * <p>The ID of the project.</p>
3824
4305
  */
3825
4306
  projectId: string | undefined;
@@ -3829,10 +4310,12 @@ export interface DescribeProjectRequest {
3829
4310
  */
3830
4311
  export interface DescribeProjectResponse {
3831
4312
  /**
4313
+ * @public
3832
4314
  * <p>The ID of the project.</p>
3833
4315
  */
3834
4316
  projectId: string | undefined;
3835
4317
  /**
4318
+ * @public
3836
4319
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p>
3837
4320
  * <p>
3838
4321
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:project/$\{ProjectId\}</code>
@@ -3840,22 +4323,27 @@ export interface DescribeProjectResponse {
3840
4323
  */
3841
4324
  projectArn: string | undefined;
3842
4325
  /**
4326
+ * @public
3843
4327
  * <p>The name of the project.</p>
3844
4328
  */
3845
4329
  projectName: string | undefined;
3846
4330
  /**
4331
+ * @public
3847
4332
  * <p>The ID of the portal that the project is in.</p>
3848
4333
  */
3849
4334
  portalId: string | undefined;
3850
4335
  /**
4336
+ * @public
3851
4337
  * <p>The project's description.</p>
3852
4338
  */
3853
4339
  projectDescription?: string;
3854
4340
  /**
4341
+ * @public
3855
4342
  * <p>The date the project was created, in Unix epoch time.</p>
3856
4343
  */
3857
4344
  projectCreationDate: Date | undefined;
3858
4345
  /**
4346
+ * @public
3859
4347
  * <p>The date the project was last updated, in Unix epoch time.</p>
3860
4348
  */
3861
4349
  projectLastUpdateDate: Date | undefined;
@@ -3883,12 +4371,14 @@ export type DisassociatedDataStorageState = (typeof DisassociatedDataStorageStat
3883
4371
  */
3884
4372
  export interface CustomerManagedS3Storage {
3885
4373
  /**
4374
+ * @public
3886
4375
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Amazon S3 object. For more information about how to find the ARN for an
3887
4376
  * Amazon S3 object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html">Amazon S3 resources</a> in the
3888
4377
  * <i>Amazon Simple Storage Service User Guide</i>.</p>
3889
4378
  */
3890
4379
  s3ResourceArn: string | undefined;
3891
4380
  /**
4381
+ * @public
3892
4382
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.</p>
3893
4383
  */
3894
4384
  roleArn: string | undefined;
@@ -3899,6 +4389,7 @@ export interface CustomerManagedS3Storage {
3899
4389
  */
3900
4390
  export interface MultiLayerStorage {
3901
4391
  /**
4392
+ * @public
3902
4393
  * <p>Contains information about a customer managed Amazon S3 bucket.</p>
3903
4394
  */
3904
4395
  customerManagedS3Storage: CustomerManagedS3Storage | undefined;
@@ -3909,6 +4400,7 @@ export interface MultiLayerStorage {
3909
4400
  */
3910
4401
  export interface RetentionPeriod {
3911
4402
  /**
4403
+ * @public
3912
4404
  * <p>The number of days that your data is kept.</p>
3913
4405
  * <note>
3914
4406
  * <p>If you specified a value for this parameter, the <code>unlimited</code> parameter must
@@ -3917,6 +4409,7 @@ export interface RetentionPeriod {
3917
4409
  */
3918
4410
  numberOfDays?: number;
3919
4411
  /**
4412
+ * @public
3920
4413
  * <p>If true, your data is kept indefinitely.</p>
3921
4414
  * <note>
3922
4415
  * <p>If configured to <code>true</code>, you must not specify a value for the
@@ -3942,6 +4435,7 @@ export type StorageType = (typeof StorageType)[keyof typeof StorageType];
3942
4435
  */
3943
4436
  export interface DescribeStorageConfigurationResponse {
3944
4437
  /**
4438
+ * @public
3945
4439
  * <p>The storage tier that you specified for your data.
3946
4440
  * The <code>storageType</code> parameter can be one of the following values:</p>
3947
4441
  * <ul>
@@ -3959,10 +4453,12 @@ export interface DescribeStorageConfigurationResponse {
3959
4453
  */
3960
4454
  storageType: StorageType | string | undefined;
3961
4455
  /**
4456
+ * @public
3962
4457
  * <p>Contains information about the storage destination.</p>
3963
4458
  */
3964
4459
  multiLayerStorage?: MultiLayerStorage;
3965
4460
  /**
4461
+ * @public
3966
4462
  * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
3967
4463
  * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
3968
4464
  * <ul>
@@ -3983,14 +4479,17 @@ export interface DescribeStorageConfigurationResponse {
3983
4479
  */
3984
4480
  disassociatedDataStorage?: DisassociatedDataStorageState | string;
3985
4481
  /**
4482
+ * @public
3986
4483
  * <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
3987
4484
  */
3988
4485
  retentionPeriod?: RetentionPeriod;
3989
4486
  /**
4487
+ * @public
3990
4488
  * <p>Contains current status information for the configuration.</p>
3991
4489
  */
3992
4490
  configurationStatus: ConfigurationStatus | undefined;
3993
4491
  /**
4492
+ * @public
3994
4493
  * <p>The date the storage configuration was last updated, in Unix epoch time.</p>
3995
4494
  */
3996
4495
  lastUpdateDate?: Date;
@@ -4000,14 +4499,17 @@ export interface DescribeStorageConfigurationResponse {
4000
4499
  */
4001
4500
  export interface DescribeTimeSeriesRequest {
4002
4501
  /**
4502
+ * @public
4003
4503
  * <p>The alias that identifies the time series.</p>
4004
4504
  */
4005
4505
  alias?: string;
4006
4506
  /**
4507
+ * @public
4007
4508
  * <p>The ID of the asset in which the asset property was created.</p>
4008
4509
  */
4009
4510
  assetId?: string;
4010
4511
  /**
4512
+ * @public
4011
4513
  * <p>The ID of the asset property.</p>
4012
4514
  */
4013
4515
  propertyId?: string;
@@ -4017,27 +4519,33 @@ export interface DescribeTimeSeriesRequest {
4017
4519
  */
4018
4520
  export interface DescribeTimeSeriesResponse {
4019
4521
  /**
4522
+ * @public
4020
4523
  * <p>The ID of the asset in which the asset property was created.</p>
4021
4524
  */
4022
4525
  assetId?: string;
4023
4526
  /**
4527
+ * @public
4024
4528
  * <p>The ID of the asset property.</p>
4025
4529
  */
4026
4530
  propertyId?: string;
4027
4531
  /**
4532
+ * @public
4028
4533
  * <p>The alias that identifies the time series.</p>
4029
4534
  */
4030
4535
  alias?: string;
4031
4536
  /**
4537
+ * @public
4032
4538
  * <p>The ID of the time series.</p>
4033
4539
  */
4034
4540
  timeSeriesId: string | undefined;
4035
4541
  /**
4542
+ * @public
4036
4543
  * <p>The data type of the time series.</p>
4037
4544
  * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
4038
4545
  */
4039
4546
  dataType: PropertyDataType | string | undefined;
4040
4547
  /**
4548
+ * @public
4041
4549
  * <p>The data type of the structure for this time series. This parameter is required for time series
4042
4550
  * that have the <code>STRUCT</code> data type.</p>
4043
4551
  * <p>The options for this parameter depend on the type of the composite model
@@ -4046,14 +4554,17 @@ export interface DescribeTimeSeriesResponse {
4046
4554
  */
4047
4555
  dataTypeSpec?: string;
4048
4556
  /**
4557
+ * @public
4049
4558
  * <p>The date that the time series was created, in Unix epoch time.</p>
4050
4559
  */
4051
4560
  timeSeriesCreationDate: Date | undefined;
4052
4561
  /**
4562
+ * @public
4053
4563
  * <p>The date that the time series was last updated, in Unix epoch time.</p>
4054
4564
  */
4055
4565
  timeSeriesLastUpdateDate: Date | undefined;
4056
4566
  /**
4567
+ * @public
4057
4568
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
4058
4569
  * <p>
4059
4570
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
@@ -4066,10 +4577,12 @@ export interface DescribeTimeSeriesResponse {
4066
4577
  */
4067
4578
  export interface DisassociateAssetsRequest {
4068
4579
  /**
4580
+ * @public
4069
4581
  * <p>The ID of the parent asset from which to disassociate the child asset.</p>
4070
4582
  */
4071
4583
  assetId: string | undefined;
4072
4584
  /**
4585
+ * @public
4073
4586
  * <p>The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings
4074
4587
  * of assets to be formed that all come from the same asset model. You can use the hierarchy ID
4075
4588
  * to identify the correct asset to disassociate. For more information, see
@@ -4077,10 +4590,12 @@ export interface DisassociateAssetsRequest {
4077
4590
  */
4078
4591
  hierarchyId: string | undefined;
4079
4592
  /**
4593
+ * @public
4080
4594
  * <p>The ID of the child asset to disassociate.</p>
4081
4595
  */
4082
4596
  childAssetId: string | undefined;
4083
4597
  /**
4598
+ * @public
4084
4599
  * <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>
4085
4600
  */
4086
4601
  clientToken?: string;
@@ -4090,18 +4605,22 @@ export interface DisassociateAssetsRequest {
4090
4605
  */
4091
4606
  export interface DisassociateTimeSeriesFromAssetPropertyRequest {
4092
4607
  /**
4608
+ * @public
4093
4609
  * <p>The alias that identifies the time series.</p>
4094
4610
  */
4095
4611
  alias: string | undefined;
4096
4612
  /**
4613
+ * @public
4097
4614
  * <p>The ID of the asset in which the asset property was created.</p>
4098
4615
  */
4099
4616
  assetId: string | undefined;
4100
4617
  /**
4618
+ * @public
4101
4619
  * <p>The ID of the asset property.</p>
4102
4620
  */
4103
4621
  propertyId: string | undefined;
4104
4622
  /**
4623
+ * @public
4105
4624
  * <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>
4106
4625
  */
4107
4626
  clientToken?: string;
@@ -4111,14 +4630,17 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
4111
4630
  */
4112
4631
  export interface GetAssetPropertyAggregatesRequest {
4113
4632
  /**
4633
+ * @public
4114
4634
  * <p>The ID of the asset.</p>
4115
4635
  */
4116
4636
  assetId?: string;
4117
4637
  /**
4638
+ * @public
4118
4639
  * <p>The ID of the asset property.</p>
4119
4640
  */
4120
4641
  propertyId?: string;
4121
4642
  /**
4643
+ * @public
4122
4644
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
4123
4645
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
4124
4646
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -4126,36 +4648,44 @@ export interface GetAssetPropertyAggregatesRequest {
4126
4648
  */
4127
4649
  propertyAlias?: string;
4128
4650
  /**
4651
+ * @public
4129
4652
  * <p>The data aggregating function.</p>
4130
4653
  */
4131
4654
  aggregateTypes: (AggregateType | string)[] | undefined;
4132
4655
  /**
4656
+ * @public
4133
4657
  * <p>The time interval over which to aggregate data.</p>
4134
4658
  */
4135
4659
  resolution: string | undefined;
4136
4660
  /**
4661
+ * @public
4137
4662
  * <p>The quality by which to filter asset data.</p>
4138
4663
  */
4139
4664
  qualities?: (Quality | string)[];
4140
4665
  /**
4666
+ * @public
4141
4667
  * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
4142
4668
  */
4143
4669
  startDate: Date | undefined;
4144
4670
  /**
4671
+ * @public
4145
4672
  * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
4146
4673
  */
4147
4674
  endDate: Date | undefined;
4148
4675
  /**
4676
+ * @public
4149
4677
  * <p>The chronological sorting order of the requested information.</p>
4150
4678
  * <p>Default: <code>ASCENDING</code>
4151
4679
  * </p>
4152
4680
  */
4153
4681
  timeOrdering?: TimeOrdering | string;
4154
4682
  /**
4683
+ * @public
4155
4684
  * <p>The token to be used for the next set of paginated results.</p>
4156
4685
  */
4157
4686
  nextToken?: string;
4158
4687
  /**
4688
+ * @public
4159
4689
  * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
4160
4690
  * first.</p>
4161
4691
  * <ul>
@@ -4175,10 +4705,12 @@ export interface GetAssetPropertyAggregatesRequest {
4175
4705
  */
4176
4706
  export interface GetAssetPropertyAggregatesResponse {
4177
4707
  /**
4708
+ * @public
4178
4709
  * <p>The requested aggregated values.</p>
4179
4710
  */
4180
4711
  aggregatedValues: AggregatedValue[] | undefined;
4181
4712
  /**
4713
+ * @public
4182
4714
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4183
4715
  */
4184
4716
  nextToken?: string;
@@ -4188,14 +4720,17 @@ export interface GetAssetPropertyAggregatesResponse {
4188
4720
  */
4189
4721
  export interface GetAssetPropertyValueRequest {
4190
4722
  /**
4723
+ * @public
4191
4724
  * <p>The ID of the asset.</p>
4192
4725
  */
4193
4726
  assetId?: string;
4194
4727
  /**
4728
+ * @public
4195
4729
  * <p>The ID of the asset property.</p>
4196
4730
  */
4197
4731
  propertyId?: string;
4198
4732
  /**
4733
+ * @public
4199
4734
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
4200
4735
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
4201
4736
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -4208,6 +4743,7 @@ export interface GetAssetPropertyValueRequest {
4208
4743
  */
4209
4744
  export interface GetAssetPropertyValueResponse {
4210
4745
  /**
4746
+ * @public
4211
4747
  * <p>The current asset property value.</p>
4212
4748
  */
4213
4749
  propertyValue?: AssetPropertyValue;
@@ -4217,14 +4753,17 @@ export interface GetAssetPropertyValueResponse {
4217
4753
  */
4218
4754
  export interface GetAssetPropertyValueHistoryRequest {
4219
4755
  /**
4756
+ * @public
4220
4757
  * <p>The ID of the asset.</p>
4221
4758
  */
4222
4759
  assetId?: string;
4223
4760
  /**
4761
+ * @public
4224
4762
  * <p>The ID of the asset property.</p>
4225
4763
  */
4226
4764
  propertyId?: string;
4227
4765
  /**
4766
+ * @public
4228
4767
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
4229
4768
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
4230
4769
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -4232,28 +4771,34 @@ export interface GetAssetPropertyValueHistoryRequest {
4232
4771
  */
4233
4772
  propertyAlias?: string;
4234
4773
  /**
4774
+ * @public
4235
4775
  * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
4236
4776
  */
4237
4777
  startDate?: Date;
4238
4778
  /**
4779
+ * @public
4239
4780
  * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
4240
4781
  */
4241
4782
  endDate?: Date;
4242
4783
  /**
4784
+ * @public
4243
4785
  * <p>The quality by which to filter asset data.</p>
4244
4786
  */
4245
4787
  qualities?: (Quality | string)[];
4246
4788
  /**
4789
+ * @public
4247
4790
  * <p>The chronological sorting order of the requested information.</p>
4248
4791
  * <p>Default: <code>ASCENDING</code>
4249
4792
  * </p>
4250
4793
  */
4251
4794
  timeOrdering?: TimeOrdering | string;
4252
4795
  /**
4796
+ * @public
4253
4797
  * <p>The token to be used for the next set of paginated results.</p>
4254
4798
  */
4255
4799
  nextToken?: string;
4256
4800
  /**
4801
+ * @public
4257
4802
  * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
4258
4803
  * first.</p>
4259
4804
  * <ul>
@@ -4273,10 +4818,12 @@ export interface GetAssetPropertyValueHistoryRequest {
4273
4818
  */
4274
4819
  export interface GetAssetPropertyValueHistoryResponse {
4275
4820
  /**
4821
+ * @public
4276
4822
  * <p>The asset property's value history.</p>
4277
4823
  */
4278
4824
  assetPropertyValueHistory: AssetPropertyValue[] | undefined;
4279
4825
  /**
4826
+ * @public
4280
4827
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4281
4828
  */
4282
4829
  nextToken?: string;
@@ -4286,14 +4833,17 @@ export interface GetAssetPropertyValueHistoryResponse {
4286
4833
  */
4287
4834
  export interface GetInterpolatedAssetPropertyValuesRequest {
4288
4835
  /**
4836
+ * @public
4289
4837
  * <p>The ID of the asset.</p>
4290
4838
  */
4291
4839
  assetId?: string;
4292
4840
  /**
4841
+ * @public
4293
4842
  * <p>The ID of the asset property.</p>
4294
4843
  */
4295
4844
  propertyId?: string;
4296
4845
  /**
4846
+ * @public
4297
4847
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
4298
4848
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
4299
4849
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -4301,42 +4851,51 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
4301
4851
  */
4302
4852
  propertyAlias?: string;
4303
4853
  /**
4854
+ * @public
4304
4855
  * <p>The exclusive start of the range from which to interpolate data, expressed in seconds in
4305
4856
  * Unix epoch time.</p>
4306
4857
  */
4307
4858
  startTimeInSeconds: number | undefined;
4308
4859
  /**
4860
+ * @public
4309
4861
  * <p>The nanosecond offset converted from <code>startTimeInSeconds</code>.</p>
4310
4862
  */
4311
4863
  startTimeOffsetInNanos?: number;
4312
4864
  /**
4865
+ * @public
4313
4866
  * <p>The inclusive end of the range from which to interpolate data, expressed in seconds in
4314
4867
  * Unix epoch time.</p>
4315
4868
  */
4316
4869
  endTimeInSeconds: number | undefined;
4317
4870
  /**
4871
+ * @public
4318
4872
  * <p>The nanosecond offset converted from <code>endTimeInSeconds</code>.</p>
4319
4873
  */
4320
4874
  endTimeOffsetInNanos?: number;
4321
4875
  /**
4876
+ * @public
4322
4877
  * <p>The quality of the asset property value. You can use this parameter as a filter to choose
4323
4878
  * only the asset property values that have a specific quality.</p>
4324
4879
  */
4325
4880
  quality: Quality | string | undefined;
4326
4881
  /**
4882
+ * @public
4327
4883
  * <p>The time interval in seconds over which to interpolate data. Each interval starts when the
4328
4884
  * previous one ends.</p>
4329
4885
  */
4330
4886
  intervalInSeconds: number | undefined;
4331
4887
  /**
4888
+ * @public
4332
4889
  * <p>The token to be used for the next set of paginated results.</p>
4333
4890
  */
4334
4891
  nextToken?: string;
4335
4892
  /**
4893
+ * @public
4336
4894
  * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 10.</p>
4337
4895
  */
4338
4896
  maxResults?: number;
4339
4897
  /**
4898
+ * @public
4340
4899
  * <p>The interpolation type.</p>
4341
4900
  * <p>Valid values: <code>LINEAR_INTERPOLATION | LOCF_INTERPOLATION</code>
4342
4901
  * </p>
@@ -4367,6 +4926,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
4367
4926
  */
4368
4927
  type: string | undefined;
4369
4928
  /**
4929
+ * @public
4370
4930
  * <p>The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by
4371
4931
  * using data points from the timestamp of each interval, minus the window to the timestamp of
4372
4932
  * each interval plus the window. If not specified, the window ranges between the start time
@@ -4400,10 +4960,12 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
4400
4960
  */
4401
4961
  export interface InterpolatedAssetPropertyValue {
4402
4962
  /**
4963
+ * @public
4403
4964
  * <p>Contains a timestamp with optional nanosecond granularity.</p>
4404
4965
  */
4405
4966
  timestamp: TimeInNanos | undefined;
4406
4967
  /**
4968
+ * @public
4407
4969
  * <p>Contains an asset property value (of a single type only).</p>
4408
4970
  */
4409
4971
  value: Variant | undefined;
@@ -4413,10 +4975,12 @@ export interface InterpolatedAssetPropertyValue {
4413
4975
  */
4414
4976
  export interface GetInterpolatedAssetPropertyValuesResponse {
4415
4977
  /**
4978
+ * @public
4416
4979
  * <p>The requested interpolated values.</p>
4417
4980
  */
4418
4981
  interpolatedAssetPropertyValues: InterpolatedAssetPropertyValue[] | undefined;
4419
4982
  /**
4983
+ * @public
4420
4984
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4421
4985
  */
4422
4986
  nextToken?: string;
@@ -4451,36 +5015,43 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
4451
5015
  */
4452
5016
  export interface ListAccessPoliciesRequest {
4453
5017
  /**
5018
+ * @public
4454
5019
  * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
4455
5020
  * if you specify <code>identityId</code>.</p>
4456
5021
  */
4457
5022
  identityType?: IdentityType | string;
4458
5023
  /**
5024
+ * @public
4459
5025
  * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
4460
5026
  * <code>GROUP</code> for <code>identityType</code>.</p>
4461
5027
  */
4462
5028
  identityId?: string;
4463
5029
  /**
5030
+ * @public
4464
5031
  * <p>The type of resource (portal or project). This parameter is required if you specify
4465
5032
  * <code>resourceId</code>.</p>
4466
5033
  */
4467
5034
  resourceType?: ResourceType | string;
4468
5035
  /**
5036
+ * @public
4469
5037
  * <p>The ID of the resource. This parameter is required if you specify
4470
5038
  * <code>resourceType</code>.</p>
4471
5039
  */
4472
5040
  resourceId?: string;
4473
5041
  /**
5042
+ * @public
4474
5043
  * <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
4475
5044
  * <i>IAM User Guide</i>. This parameter is required if you specify
4476
5045
  * <code>IAM</code> for <code>identityType</code>.</p>
4477
5046
  */
4478
5047
  iamArn?: string;
4479
5048
  /**
5049
+ * @public
4480
5050
  * <p>The token to be used for the next set of paginated results.</p>
4481
5051
  */
4482
5052
  nextToken?: string;
4483
5053
  /**
5054
+ * @public
4484
5055
  * <p>The maximum number of results to return for each paginated request.</p>
4485
5056
  * <p>Default: 50</p>
4486
5057
  */
@@ -4491,10 +5062,12 @@ export interface ListAccessPoliciesRequest {
4491
5062
  */
4492
5063
  export interface ListAccessPoliciesResponse {
4493
5064
  /**
5065
+ * @public
4494
5066
  * <p>A list that summarizes each access policy.</p>
4495
5067
  */
4496
5068
  accessPolicySummaries: AccessPolicySummary[] | undefined;
4497
5069
  /**
5070
+ * @public
4498
5071
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4499
5072
  */
4500
5073
  nextToken?: string;
@@ -4516,18 +5089,22 @@ export type ListAssetModelPropertiesFilter = (typeof ListAssetModelPropertiesFil
4516
5089
  */
4517
5090
  export interface ListAssetModelPropertiesRequest {
4518
5091
  /**
5092
+ * @public
4519
5093
  * <p>The ID of the asset model.</p>
4520
5094
  */
4521
5095
  assetModelId: string | undefined;
4522
5096
  /**
5097
+ * @public
4523
5098
  * <p>The token to be used for the next set of paginated results.</p>
4524
5099
  */
4525
5100
  nextToken?: string;
4526
5101
  /**
5102
+ * @public
4527
5103
  * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
4528
5104
  */
4529
5105
  maxResults?: number;
4530
5106
  /**
5107
+ * @public
4531
5108
  * <p> Filters the requested list of asset model properties. You can choose one of the following
4532
5109
  * options:</p>
4533
5110
  * <ul>
@@ -4552,10 +5129,12 @@ export interface ListAssetModelPropertiesRequest {
4552
5129
  */
4553
5130
  export interface ListAssetModelPropertiesResponse {
4554
5131
  /**
5132
+ * @public
4555
5133
  * <p>A list that summarizes the properties associated with the specified asset model.</p>
4556
5134
  */
4557
5135
  assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
4558
5136
  /**
5137
+ * @public
4559
5138
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4560
5139
  */
4561
5140
  nextToken?: string;
@@ -4565,10 +5144,12 @@ export interface ListAssetModelPropertiesResponse {
4565
5144
  */
4566
5145
  export interface ListAssetModelsRequest {
4567
5146
  /**
5147
+ * @public
4568
5148
  * <p>The token to be used for the next set of paginated results.</p>
4569
5149
  */
4570
5150
  nextToken?: string;
4571
5151
  /**
5152
+ * @public
4572
5153
  * <p>The maximum number of results to return for each paginated request.</p>
4573
5154
  * <p>Default: 50</p>
4574
5155
  */
@@ -4579,10 +5160,12 @@ export interface ListAssetModelsRequest {
4579
5160
  */
4580
5161
  export interface ListAssetModelsResponse {
4581
5162
  /**
5163
+ * @public
4582
5164
  * <p>A list that summarizes each asset model.</p>
4583
5165
  */
4584
5166
  assetModelSummaries: AssetModelSummary[] | undefined;
4585
5167
  /**
5168
+ * @public
4586
5169
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4587
5170
  */
4588
5171
  nextToken?: string;
@@ -4604,18 +5187,22 @@ export type ListAssetPropertiesFilter = (typeof ListAssetPropertiesFilter)[keyof
4604
5187
  */
4605
5188
  export interface ListAssetPropertiesRequest {
4606
5189
  /**
5190
+ * @public
4607
5191
  * <p>The ID of the asset.</p>
4608
5192
  */
4609
5193
  assetId: string | undefined;
4610
5194
  /**
5195
+ * @public
4611
5196
  * <p>The token to be used for the next set of paginated results.</p>
4612
5197
  */
4613
5198
  nextToken?: string;
4614
5199
  /**
5200
+ * @public
4615
5201
  * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
4616
5202
  */
4617
5203
  maxResults?: number;
4618
5204
  /**
5205
+ * @public
4619
5206
  * <p> Filters the requested list of asset properties. You can choose one of the following
4620
5207
  * options:</p>
4621
5208
  * <ul>
@@ -4640,10 +5227,12 @@ export interface ListAssetPropertiesRequest {
4640
5227
  */
4641
5228
  export interface ListAssetPropertiesResponse {
4642
5229
  /**
5230
+ * @public
4643
5231
  * <p>A list that summarizes the properties associated with the specified asset.</p>
4644
5232
  */
4645
5233
  assetPropertySummaries: AssetPropertySummary[] | undefined;
4646
5234
  /**
5235
+ * @public
4647
5236
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4648
5237
  */
4649
5238
  nextToken?: string;
@@ -4664,10 +5253,12 @@ export type TraversalType = (typeof TraversalType)[keyof typeof TraversalType];
4664
5253
  */
4665
5254
  export interface ListAssetRelationshipsRequest {
4666
5255
  /**
5256
+ * @public
4667
5257
  * <p>The ID of the asset.</p>
4668
5258
  */
4669
5259
  assetId: string | undefined;
4670
5260
  /**
5261
+ * @public
4671
5262
  * <p>The type of traversal to use to identify asset relationships. Choose the following
4672
5263
  * option:</p>
4673
5264
  * <ul>
@@ -4681,10 +5272,12 @@ export interface ListAssetRelationshipsRequest {
4681
5272
  */
4682
5273
  traversalType: TraversalType | string | undefined;
4683
5274
  /**
5275
+ * @public
4684
5276
  * <p>The token to be used for the next set of paginated results.</p>
4685
5277
  */
4686
5278
  nextToken?: string;
4687
5279
  /**
5280
+ * @public
4688
5281
  * <p>The maximum number of results to return for each paginated request.</p>
4689
5282
  */
4690
5283
  maxResults?: number;
@@ -4694,10 +5287,12 @@ export interface ListAssetRelationshipsRequest {
4694
5287
  */
4695
5288
  export interface ListAssetRelationshipsResponse {
4696
5289
  /**
5290
+ * @public
4697
5291
  * <p>A list that summarizes each asset relationship.</p>
4698
5292
  */
4699
5293
  assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
4700
5294
  /**
5295
+ * @public
4701
5296
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4702
5297
  */
4703
5298
  nextToken?: string;
@@ -4719,20 +5314,24 @@ export type ListAssetsFilter = (typeof ListAssetsFilter)[keyof typeof ListAssets
4719
5314
  */
4720
5315
  export interface ListAssetsRequest {
4721
5316
  /**
5317
+ * @public
4722
5318
  * <p>The token to be used for the next set of paginated results.</p>
4723
5319
  */
4724
5320
  nextToken?: string;
4725
5321
  /**
5322
+ * @public
4726
5323
  * <p>The maximum number of results to return for each paginated request.</p>
4727
5324
  * <p>Default: 50</p>
4728
5325
  */
4729
5326
  maxResults?: number;
4730
5327
  /**
5328
+ * @public
4731
5329
  * <p>The ID of the asset model by which to filter the list of assets. This parameter is
4732
5330
  * required if you choose <code>ALL</code> for <code>filter</code>.</p>
4733
5331
  */
4734
5332
  assetModelId?: string;
4735
5333
  /**
5334
+ * @public
4736
5335
  * <p>The filter for the requested list of assets. Choose one of the following options:</p>
4737
5336
  * <ul>
4738
5337
  * <li>
@@ -4757,10 +5356,12 @@ export interface ListAssetsRequest {
4757
5356
  */
4758
5357
  export interface ListAssetsResponse {
4759
5358
  /**
5359
+ * @public
4760
5360
  * <p>A list that summarizes each asset.</p>
4761
5361
  */
4762
5362
  assetSummaries: AssetSummary[] | undefined;
4763
5363
  /**
5364
+ * @public
4764
5365
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4765
5366
  */
4766
5367
  nextToken?: string;
@@ -4782,10 +5383,12 @@ export type TraversalDirection = (typeof TraversalDirection)[keyof typeof Traver
4782
5383
  */
4783
5384
  export interface ListAssociatedAssetsRequest {
4784
5385
  /**
5386
+ * @public
4785
5387
  * <p>The ID of the asset to query.</p>
4786
5388
  */
4787
5389
  assetId: string | undefined;
4788
5390
  /**
5391
+ * @public
4789
5392
  * <p>The ID of the hierarchy by which child assets are associated to the asset. To find a
4790
5393
  * hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This
4791
5394
  * parameter is required if you choose <code>CHILD</code> for
@@ -4794,6 +5397,7 @@ export interface ListAssociatedAssetsRequest {
4794
5397
  */
4795
5398
  hierarchyId?: string;
4796
5399
  /**
5400
+ * @public
4797
5401
  * <p>The direction to list associated assets. Choose one of the following options:</p>
4798
5402
  * <ul>
4799
5403
  * <li>
@@ -4812,10 +5416,12 @@ export interface ListAssociatedAssetsRequest {
4812
5416
  */
4813
5417
  traversalDirection?: TraversalDirection | string;
4814
5418
  /**
5419
+ * @public
4815
5420
  * <p>The token to be used for the next set of paginated results.</p>
4816
5421
  */
4817
5422
  nextToken?: string;
4818
5423
  /**
5424
+ * @public
4819
5425
  * <p>The maximum number of results to return for each paginated request.</p>
4820
5426
  * <p>Default: 50</p>
4821
5427
  */
@@ -4826,10 +5432,12 @@ export interface ListAssociatedAssetsRequest {
4826
5432
  */
4827
5433
  export interface ListAssociatedAssetsResponse {
4828
5434
  /**
5435
+ * @public
4829
5436
  * <p>A list that summarizes the associated assets.</p>
4830
5437
  */
4831
5438
  assetSummaries: AssociatedAssetsSummary[] | undefined;
4832
5439
  /**
5440
+ * @public
4833
5441
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4834
5442
  */
4835
5443
  nextToken?: string;
@@ -4856,14 +5464,17 @@ export type ListBulkImportJobsFilter = (typeof ListBulkImportJobsFilter)[keyof t
4856
5464
  */
4857
5465
  export interface ListBulkImportJobsRequest {
4858
5466
  /**
5467
+ * @public
4859
5468
  * <p>The token to be used for the next set of paginated results.</p>
4860
5469
  */
4861
5470
  nextToken?: string;
4862
5471
  /**
5472
+ * @public
4863
5473
  * <p>The maximum number of results to return for each paginated request.</p>
4864
5474
  */
4865
5475
  maxResults?: number;
4866
5476
  /**
5477
+ * @public
4867
5478
  * <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
4868
5479
  */
4869
5480
  filter?: ListBulkImportJobsFilter | string;
@@ -4874,14 +5485,17 @@ export interface ListBulkImportJobsRequest {
4874
5485
  */
4875
5486
  export interface JobSummary {
4876
5487
  /**
5488
+ * @public
4877
5489
  * <p>The ID of the job.</p>
4878
5490
  */
4879
5491
  id: string | undefined;
4880
5492
  /**
5493
+ * @public
4881
5494
  * <p>The unique name that helps identify the job request.</p>
4882
5495
  */
4883
5496
  name: string | undefined;
4884
5497
  /**
5498
+ * @public
4885
5499
  * <p>The status of the bulk import job can be one of following values.</p>
4886
5500
  * <ul>
4887
5501
  * <li>
@@ -4919,10 +5533,12 @@ export interface JobSummary {
4919
5533
  */
4920
5534
  export interface ListBulkImportJobsResponse {
4921
5535
  /**
5536
+ * @public
4922
5537
  * <p>One or more job summaries to list.</p>
4923
5538
  */
4924
5539
  jobSummaries: JobSummary[] | undefined;
4925
5540
  /**
5541
+ * @public
4926
5542
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4927
5543
  */
4928
5544
  nextToken?: string;
@@ -4932,14 +5548,17 @@ export interface ListBulkImportJobsResponse {
4932
5548
  */
4933
5549
  export interface ListDashboardsRequest {
4934
5550
  /**
5551
+ * @public
4935
5552
  * <p>The ID of the project.</p>
4936
5553
  */
4937
5554
  projectId: string | undefined;
4938
5555
  /**
5556
+ * @public
4939
5557
  * <p>The token to be used for the next set of paginated results.</p>
4940
5558
  */
4941
5559
  nextToken?: string;
4942
5560
  /**
5561
+ * @public
4943
5562
  * <p>The maximum number of results to return for each paginated request.</p>
4944
5563
  * <p>Default: 50</p>
4945
5564
  */
@@ -4951,22 +5570,27 @@ export interface ListDashboardsRequest {
4951
5570
  */
4952
5571
  export interface DashboardSummary {
4953
5572
  /**
5573
+ * @public
4954
5574
  * <p>The ID of the dashboard.</p>
4955
5575
  */
4956
5576
  id: string | undefined;
4957
5577
  /**
5578
+ * @public
4958
5579
  * <p>The name of the dashboard</p>
4959
5580
  */
4960
5581
  name: string | undefined;
4961
5582
  /**
5583
+ * @public
4962
5584
  * <p>The dashboard's description.</p>
4963
5585
  */
4964
5586
  description?: string;
4965
5587
  /**
5588
+ * @public
4966
5589
  * <p>The date the dashboard was created, in Unix epoch time.</p>
4967
5590
  */
4968
5591
  creationDate?: Date;
4969
5592
  /**
5593
+ * @public
4970
5594
  * <p>The date the dashboard was last updated, in Unix epoch time.</p>
4971
5595
  */
4972
5596
  lastUpdateDate?: Date;
@@ -4976,10 +5600,12 @@ export interface DashboardSummary {
4976
5600
  */
4977
5601
  export interface ListDashboardsResponse {
4978
5602
  /**
5603
+ * @public
4979
5604
  * <p>A list that summarizes each dashboard in the project.</p>
4980
5605
  */
4981
5606
  dashboardSummaries: DashboardSummary[] | undefined;
4982
5607
  /**
5608
+ * @public
4983
5609
  * <p>The token for the next set of results, or null if there are no additional results.</p>
4984
5610
  */
4985
5611
  nextToken?: string;
@@ -4989,10 +5615,12 @@ export interface ListDashboardsResponse {
4989
5615
  */
4990
5616
  export interface ListGatewaysRequest {
4991
5617
  /**
5618
+ * @public
4992
5619
  * <p>The token to be used for the next set of paginated results.</p>
4993
5620
  */
4994
5621
  nextToken?: string;
4995
5622
  /**
5623
+ * @public
4996
5624
  * <p>The maximum number of results to return for each paginated request.</p>
4997
5625
  * <p>Default: 50</p>
4998
5626
  */
@@ -5004,28 +5632,34 @@ export interface ListGatewaysRequest {
5004
5632
  */
5005
5633
  export interface GatewaySummary {
5006
5634
  /**
5635
+ * @public
5007
5636
  * <p>The ID of the gateway device.</p>
5008
5637
  */
5009
5638
  gatewayId: string | undefined;
5010
5639
  /**
5640
+ * @public
5011
5641
  * <p>The name of the asset.</p>
5012
5642
  */
5013
5643
  gatewayName: string | undefined;
5014
5644
  /**
5645
+ * @public
5015
5646
  * <p>Contains a gateway's platform information.</p>
5016
5647
  */
5017
5648
  gatewayPlatform?: GatewayPlatform;
5018
5649
  /**
5650
+ * @public
5019
5651
  * <p>A list of gateway capability summaries that each contain a namespace and status. Each
5020
5652
  * gateway capability defines data sources for the gateway. To retrieve a capability
5021
5653
  * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
5022
5654
  */
5023
5655
  gatewayCapabilitySummaries?: GatewayCapabilitySummary[];
5024
5656
  /**
5657
+ * @public
5025
5658
  * <p>The date the gateway was created, in Unix epoch time.</p>
5026
5659
  */
5027
5660
  creationDate: Date | undefined;
5028
5661
  /**
5662
+ * @public
5029
5663
  * <p>The date the gateway was last updated, in Unix epoch time.</p>
5030
5664
  */
5031
5665
  lastUpdateDate: Date | undefined;
@@ -5035,10 +5669,12 @@ export interface GatewaySummary {
5035
5669
  */
5036
5670
  export interface ListGatewaysResponse {
5037
5671
  /**
5672
+ * @public
5038
5673
  * <p>A list that summarizes each gateway.</p>
5039
5674
  */
5040
5675
  gatewaySummaries: GatewaySummary[] | undefined;
5041
5676
  /**
5677
+ * @public
5042
5678
  * <p>The token for the next set of results, or null if there are no additional results.</p>
5043
5679
  */
5044
5680
  nextToken?: string;
@@ -5048,10 +5684,12 @@ export interface ListGatewaysResponse {
5048
5684
  */
5049
5685
  export interface ListPortalsRequest {
5050
5686
  /**
5687
+ * @public
5051
5688
  * <p>The token to be used for the next set of paginated results.</p>
5052
5689
  */
5053
5690
  nextToken?: string;
5054
5691
  /**
5692
+ * @public
5055
5693
  * <p>The maximum number of results to return for each paginated request.</p>
5056
5694
  * <p>Default: 50</p>
5057
5695
  */
@@ -5063,38 +5701,46 @@ export interface ListPortalsRequest {
5063
5701
  */
5064
5702
  export interface PortalSummary {
5065
5703
  /**
5704
+ * @public
5066
5705
  * <p>The ID of the portal.</p>
5067
5706
  */
5068
5707
  id: string | undefined;
5069
5708
  /**
5709
+ * @public
5070
5710
  * <p>The name of the portal.</p>
5071
5711
  */
5072
5712
  name: string | undefined;
5073
5713
  /**
5714
+ * @public
5074
5715
  * <p>The portal's description.</p>
5075
5716
  */
5076
5717
  description?: string;
5077
5718
  /**
5719
+ * @public
5078
5720
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
5079
5721
  * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
5080
5722
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
5081
5723
  */
5082
5724
  startUrl: string | undefined;
5083
5725
  /**
5726
+ * @public
5084
5727
  * <p>The date the portal was created, in Unix epoch time.</p>
5085
5728
  */
5086
5729
  creationDate?: Date;
5087
5730
  /**
5731
+ * @public
5088
5732
  * <p>The date the portal was last updated, in Unix epoch time.</p>
5089
5733
  */
5090
5734
  lastUpdateDate?: Date;
5091
5735
  /**
5736
+ * @public
5092
5737
  * <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
5093
5738
  * 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
5094
5739
  * <i>IoT SiteWise User Guide</i>.</p>
5095
5740
  */
5096
5741
  roleArn?: string;
5097
5742
  /**
5743
+ * @public
5098
5744
  * <p>Contains information about the current status of a portal.</p>
5099
5745
  */
5100
5746
  status: PortalStatus | undefined;
@@ -5104,10 +5750,12 @@ export interface PortalSummary {
5104
5750
  */
5105
5751
  export interface ListPortalsResponse {
5106
5752
  /**
5753
+ * @public
5107
5754
  * <p>A list that summarizes each portal.</p>
5108
5755
  */
5109
5756
  portalSummaries?: PortalSummary[];
5110
5757
  /**
5758
+ * @public
5111
5759
  * <p>The token for the next set of results, or null if there are no additional results.</p>
5112
5760
  */
5113
5761
  nextToken?: string;
@@ -5117,14 +5765,17 @@ export interface ListPortalsResponse {
5117
5765
  */
5118
5766
  export interface ListProjectAssetsRequest {
5119
5767
  /**
5768
+ * @public
5120
5769
  * <p>The ID of the project.</p>
5121
5770
  */
5122
5771
  projectId: string | undefined;
5123
5772
  /**
5773
+ * @public
5124
5774
  * <p>The token to be used for the next set of paginated results.</p>
5125
5775
  */
5126
5776
  nextToken?: string;
5127
5777
  /**
5778
+ * @public
5128
5779
  * <p>The maximum number of results to return for each paginated request.</p>
5129
5780
  * <p>Default: 50</p>
5130
5781
  */
@@ -5135,10 +5786,12 @@ export interface ListProjectAssetsRequest {
5135
5786
  */
5136
5787
  export interface ListProjectAssetsResponse {
5137
5788
  /**
5789
+ * @public
5138
5790
  * <p>A list that contains the IDs of each asset associated with the project.</p>
5139
5791
  */
5140
5792
  assetIds: string[] | undefined;
5141
5793
  /**
5794
+ * @public
5142
5795
  * <p>The token for the next set of results, or null if there are no additional results.</p>
5143
5796
  */
5144
5797
  nextToken?: string;
@@ -5148,14 +5801,17 @@ export interface ListProjectAssetsResponse {
5148
5801
  */
5149
5802
  export interface ListProjectsRequest {
5150
5803
  /**
5804
+ * @public
5151
5805
  * <p>The ID of the portal.</p>
5152
5806
  */
5153
5807
  portalId: string | undefined;
5154
5808
  /**
5809
+ * @public
5155
5810
  * <p>The token to be used for the next set of paginated results.</p>
5156
5811
  */
5157
5812
  nextToken?: string;
5158
5813
  /**
5814
+ * @public
5159
5815
  * <p>The maximum number of results to return for each paginated request.</p>
5160
5816
  * <p>Default: 50</p>
5161
5817
  */
@@ -5167,22 +5823,27 @@ export interface ListProjectsRequest {
5167
5823
  */
5168
5824
  export interface ProjectSummary {
5169
5825
  /**
5826
+ * @public
5170
5827
  * <p>The ID of the project.</p>
5171
5828
  */
5172
5829
  id: string | undefined;
5173
5830
  /**
5831
+ * @public
5174
5832
  * <p>The name of the project.</p>
5175
5833
  */
5176
5834
  name: string | undefined;
5177
5835
  /**
5836
+ * @public
5178
5837
  * <p>The project's description.</p>
5179
5838
  */
5180
5839
  description?: string;
5181
5840
  /**
5841
+ * @public
5182
5842
  * <p>The date the project was created, in Unix epoch time.</p>
5183
5843
  */
5184
5844
  creationDate?: Date;
5185
5845
  /**
5846
+ * @public
5186
5847
  * <p>The date the project was last updated, in Unix epoch time.</p>
5187
5848
  */
5188
5849
  lastUpdateDate?: Date;
@@ -5192,10 +5853,12 @@ export interface ProjectSummary {
5192
5853
  */
5193
5854
  export interface ListProjectsResponse {
5194
5855
  /**
5856
+ * @public
5195
5857
  * <p>A list that summarizes each project in the portal.</p>
5196
5858
  */
5197
5859
  projectSummaries: ProjectSummary[] | undefined;
5198
5860
  /**
5861
+ * @public
5199
5862
  * <p>The token for the next set of results, or null if there are no additional results.</p>
5200
5863
  */
5201
5864
  nextToken?: string;
@@ -5205,6 +5868,7 @@ export interface ListProjectsResponse {
5205
5868
  */
5206
5869
  export interface ListTagsForResourceRequest {
5207
5870
  /**
5871
+ * @public
5208
5872
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
5209
5873
  */
5210
5874
  resourceArn: string | undefined;
@@ -5214,6 +5878,7 @@ export interface ListTagsForResourceRequest {
5214
5878
  */
5215
5879
  export interface ListTagsForResourceResponse {
5216
5880
  /**
5881
+ * @public
5217
5882
  * <p>The list of key-value pairs that contain metadata for the resource. For more information,
5218
5883
  * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
5219
5884
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -5249,22 +5914,27 @@ export type ListTimeSeriesType = (typeof ListTimeSeriesType)[keyof typeof ListTi
5249
5914
  */
5250
5915
  export interface ListTimeSeriesRequest {
5251
5916
  /**
5917
+ * @public
5252
5918
  * <p>The token to be used for the next set of paginated results.</p>
5253
5919
  */
5254
5920
  nextToken?: string;
5255
5921
  /**
5922
+ * @public
5256
5923
  * <p>The maximum number of results to return for each paginated request.</p>
5257
5924
  */
5258
5925
  maxResults?: number;
5259
5926
  /**
5927
+ * @public
5260
5928
  * <p>The ID of the asset in which the asset property was created.</p>
5261
5929
  */
5262
5930
  assetId?: string;
5263
5931
  /**
5932
+ * @public
5264
5933
  * <p>The alias prefix of the time series.</p>
5265
5934
  */
5266
5935
  aliasPrefix?: string;
5267
5936
  /**
5937
+ * @public
5268
5938
  * <p>The type of the time series. The time series type can be one of the following
5269
5939
  * values:</p>
5270
5940
  * <ul>
@@ -5288,27 +5958,33 @@ export interface ListTimeSeriesRequest {
5288
5958
  */
5289
5959
  export interface TimeSeriesSummary {
5290
5960
  /**
5961
+ * @public
5291
5962
  * <p>The ID of the asset in which the asset property was created.</p>
5292
5963
  */
5293
5964
  assetId?: string;
5294
5965
  /**
5966
+ * @public
5295
5967
  * <p>The ID of the asset property.</p>
5296
5968
  */
5297
5969
  propertyId?: string;
5298
5970
  /**
5971
+ * @public
5299
5972
  * <p>The alias that identifies the time series.</p>
5300
5973
  */
5301
5974
  alias?: string;
5302
5975
  /**
5976
+ * @public
5303
5977
  * <p>The ID of the time series.</p>
5304
5978
  */
5305
5979
  timeSeriesId: string | undefined;
5306
5980
  /**
5981
+ * @public
5307
5982
  * <p>The data type of the time series.</p>
5308
5983
  * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
5309
5984
  */
5310
5985
  dataType: PropertyDataType | string | undefined;
5311
5986
  /**
5987
+ * @public
5312
5988
  * <p>The data type of the structure for this time series. This parameter is required for time series
5313
5989
  * that have the <code>STRUCT</code> data type.</p>
5314
5990
  * <p>The options for this parameter depend on the type of the composite model
@@ -5317,14 +5993,17 @@ export interface TimeSeriesSummary {
5317
5993
  */
5318
5994
  dataTypeSpec?: string;
5319
5995
  /**
5996
+ * @public
5320
5997
  * <p>The date that the time series was created, in Unix epoch time.</p>
5321
5998
  */
5322
5999
  timeSeriesCreationDate: Date | undefined;
5323
6000
  /**
6001
+ * @public
5324
6002
  * <p>The date that the time series was last updated, in Unix epoch time.</p>
5325
6003
  */
5326
6004
  timeSeriesLastUpdateDate: Date | undefined;
5327
6005
  /**
6006
+ * @public
5328
6007
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
5329
6008
  * <p>
5330
6009
  * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
@@ -5337,10 +6016,12 @@ export interface TimeSeriesSummary {
5337
6016
  */
5338
6017
  export interface ListTimeSeriesResponse {
5339
6018
  /**
6019
+ * @public
5340
6020
  * <p>One or more time series summaries to list.</p>
5341
6021
  */
5342
6022
  TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
5343
6023
  /**
6024
+ * @public
5344
6025
  * <p>The token for the next set of results, or null if there are no additional results.</p>
5345
6026
  */
5346
6027
  nextToken?: string;
@@ -5350,10 +6031,12 @@ export interface ListTimeSeriesResponse {
5350
6031
  */
5351
6032
  export interface PutDefaultEncryptionConfigurationRequest {
5352
6033
  /**
6034
+ * @public
5353
6035
  * <p>The type of encryption used for the encryption configuration.</p>
5354
6036
  */
5355
6037
  encryptionType: EncryptionType | string | undefined;
5356
6038
  /**
6039
+ * @public
5357
6040
  * <p>The Key ID of the customer managed key used for KMS encryption. This is required if you
5358
6041
  * use <code>KMS_BASED_ENCRYPTION</code>.</p>
5359
6042
  */
@@ -5364,15 +6047,18 @@ export interface PutDefaultEncryptionConfigurationRequest {
5364
6047
  */
5365
6048
  export interface PutDefaultEncryptionConfigurationResponse {
5366
6049
  /**
6050
+ * @public
5367
6051
  * <p>The type of encryption used for the encryption configuration.</p>
5368
6052
  */
5369
6053
  encryptionType: EncryptionType | string | undefined;
5370
6054
  /**
6055
+ * @public
5371
6056
  * <p>The Key ARN of the KMS key used for KMS encryption if you use
5372
6057
  * <code>KMS_BASED_ENCRYPTION</code>.</p>
5373
6058
  */
5374
6059
  kmsKeyArn?: string;
5375
6060
  /**
6061
+ * @public
5376
6062
  * <p>The status of the account configuration. This contains the
5377
6063
  * <code>ConfigurationState</code>. If there is an error, it also contains the
5378
6064
  * <code>ErrorDetails</code>.</p>
@@ -5384,6 +6070,7 @@ export interface PutDefaultEncryptionConfigurationResponse {
5384
6070
  */
5385
6071
  export interface PutLoggingOptionsRequest {
5386
6072
  /**
6073
+ * @public
5387
6074
  * <p>The logging options to set.</p>
5388
6075
  */
5389
6076
  loggingOptions: LoggingOptions | undefined;
@@ -5398,6 +6085,7 @@ export interface PutLoggingOptionsResponse {
5398
6085
  */
5399
6086
  export interface PutStorageConfigurationRequest {
5400
6087
  /**
6088
+ * @public
5401
6089
  * <p>The storage tier that you specified for your data.
5402
6090
  * The <code>storageType</code> parameter can be one of the following values:</p>
5403
6091
  * <ul>
@@ -5415,11 +6103,13 @@ export interface PutStorageConfigurationRequest {
5415
6103
  */
5416
6104
  storageType: StorageType | string | undefined;
5417
6105
  /**
6106
+ * @public
5418
6107
  * <p>Identifies a storage destination. If you specified <code>MULTI_LAYER_STORAGE</code> for the storage type,
5419
6108
  * you must specify a <code>MultiLayerStorage</code> object.</p>
5420
6109
  */
5421
6110
  multiLayerStorage?: MultiLayerStorage;
5422
6111
  /**
6112
+ * @public
5423
6113
  * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
5424
6114
  * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
5425
6115
  * <ul>
@@ -5440,6 +6130,7 @@ export interface PutStorageConfigurationRequest {
5440
6130
  */
5441
6131
  disassociatedDataStorage?: DisassociatedDataStorageState | string;
5442
6132
  /**
6133
+ * @public
5443
6134
  * <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
5444
6135
  */
5445
6136
  retentionPeriod?: RetentionPeriod;
@@ -5449,6 +6140,7 @@ export interface PutStorageConfigurationRequest {
5449
6140
  */
5450
6141
  export interface PutStorageConfigurationResponse {
5451
6142
  /**
6143
+ * @public
5452
6144
  * <p>The storage tier that you specified for your data.
5453
6145
  * The <code>storageType</code> parameter can be one of the following values:</p>
5454
6146
  * <ul>
@@ -5466,10 +6158,12 @@ export interface PutStorageConfigurationResponse {
5466
6158
  */
5467
6159
  storageType: StorageType | string | undefined;
5468
6160
  /**
6161
+ * @public
5469
6162
  * <p>Contains information about the storage destination.</p>
5470
6163
  */
5471
6164
  multiLayerStorage?: MultiLayerStorage;
5472
6165
  /**
6166
+ * @public
5473
6167
  * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
5474
6168
  * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
5475
6169
  * <ul>
@@ -5490,10 +6184,12 @@ export interface PutStorageConfigurationResponse {
5490
6184
  */
5491
6185
  disassociatedDataStorage?: DisassociatedDataStorageState | string;
5492
6186
  /**
6187
+ * @public
5493
6188
  * <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
5494
6189
  */
5495
6190
  retentionPeriod?: RetentionPeriod;
5496
6191
  /**
6192
+ * @public
5497
6193
  * <p>Contains current status information for the configuration.</p>
5498
6194
  */
5499
6195
  configurationStatus: ConfigurationStatus | undefined;
@@ -5503,10 +6199,12 @@ export interface PutStorageConfigurationResponse {
5503
6199
  */
5504
6200
  export interface TagResourceRequest {
5505
6201
  /**
6202
+ * @public
5506
6203
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</p>
5507
6204
  */
5508
6205
  resourceArn: string | undefined;
5509
6206
  /**
6207
+ * @public
5510
6208
  * <p>A list of key-value pairs that contain metadata for the resource. For more information,
5511
6209
  * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
5512
6210
  * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -5528,6 +6226,7 @@ export declare class TooManyTagsException extends __BaseException {
5528
6226
  readonly name: "TooManyTagsException";
5529
6227
  readonly $fault: "client";
5530
6228
  /**
6229
+ * @public
5531
6230
  * <p>The name of the resource with too many tags.</p>
5532
6231
  */
5533
6232
  resourceName?: string;
@@ -5541,10 +6240,12 @@ export declare class TooManyTagsException extends __BaseException {
5541
6240
  */
5542
6241
  export interface UntagResourceRequest {
5543
6242
  /**
6243
+ * @public
5544
6244
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</p>
5545
6245
  */
5546
6246
  resourceArn: string | undefined;
5547
6247
  /**
6248
+ * @public
5548
6249
  * <p>A list of keys for tags to remove from the resource.</p>
5549
6250
  */
5550
6251
  tagKeys: string[] | undefined;
@@ -5559,22 +6260,27 @@ export interface UntagResourceResponse {
5559
6260
  */
5560
6261
  export interface UpdateAccessPolicyRequest {
5561
6262
  /**
6263
+ * @public
5562
6264
  * <p>The ID of the access policy.</p>
5563
6265
  */
5564
6266
  accessPolicyId: string | undefined;
5565
6267
  /**
6268
+ * @public
5566
6269
  * <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
5567
6270
  */
5568
6271
  accessPolicyIdentity: Identity | undefined;
5569
6272
  /**
6273
+ * @public
5570
6274
  * <p>The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.</p>
5571
6275
  */
5572
6276
  accessPolicyResource: Resource | undefined;
5573
6277
  /**
6278
+ * @public
5574
6279
  * <p>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</p>
5575
6280
  */
5576
6281
  accessPolicyPermission: Permission | string | undefined;
5577
6282
  /**
6283
+ * @public
5578
6284
  * <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>
5579
6285
  */
5580
6286
  clientToken?: string;
@@ -5589,18 +6295,22 @@ export interface UpdateAccessPolicyResponse {
5589
6295
  */
5590
6296
  export interface UpdateAssetRequest {
5591
6297
  /**
6298
+ * @public
5592
6299
  * <p>The ID of the asset to update.</p>
5593
6300
  */
5594
6301
  assetId: string | undefined;
5595
6302
  /**
6303
+ * @public
5596
6304
  * <p>A friendly name for the asset.</p>
5597
6305
  */
5598
6306
  assetName: string | undefined;
5599
6307
  /**
6308
+ * @public
5600
6309
  * <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>
5601
6310
  */
5602
6311
  clientToken?: string;
5603
6312
  /**
6313
+ * @public
5604
6314
  * <p>A description for the asset.</p>
5605
6315
  */
5606
6316
  assetDescription?: string;
@@ -5610,6 +6320,7 @@ export interface UpdateAssetRequest {
5610
6320
  */
5611
6321
  export interface UpdateAssetResponse {
5612
6322
  /**
6323
+ * @public
5613
6324
  * <p>The status of the asset, which contains a state (<code>UPDATING</code> after successfully
5614
6325
  * calling this operation) and any error message.</p>
5615
6326
  */
@@ -5620,18 +6331,22 @@ export interface UpdateAssetResponse {
5620
6331
  */
5621
6332
  export interface UpdateAssetModelRequest {
5622
6333
  /**
6334
+ * @public
5623
6335
  * <p>The ID of the asset model to update.</p>
5624
6336
  */
5625
6337
  assetModelId: string | undefined;
5626
6338
  /**
6339
+ * @public
5627
6340
  * <p>A unique, friendly name for the asset model.</p>
5628
6341
  */
5629
6342
  assetModelName: string | undefined;
5630
6343
  /**
6344
+ * @public
5631
6345
  * <p>A description for the asset model.</p>
5632
6346
  */
5633
6347
  assetModelDescription?: string;
5634
6348
  /**
6349
+ * @public
5635
6350
  * <p>The updated property definitions of the asset model. For more information, see
5636
6351
  * <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>
5637
6352
  * <p>You can specify up to 200 properties per asset model. For more
@@ -5639,6 +6354,7 @@ export interface UpdateAssetModelRequest {
5639
6354
  */
5640
6355
  assetModelProperties?: AssetModelProperty[];
5641
6356
  /**
6357
+ * @public
5642
6358
  * <p>The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset
5643
6359
  * model whose assets can be children of any other assets created from this asset model. For more
5644
6360
  * 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>
@@ -5647,6 +6363,7 @@ export interface UpdateAssetModelRequest {
5647
6363
  */
5648
6364
  assetModelHierarchies?: AssetModelHierarchy[];
5649
6365
  /**
6366
+ * @public
5650
6367
  * <p>The composite asset models that are part of this asset model.
5651
6368
  * Composite asset models are asset models that contain specific properties. Each composite model
5652
6369
  * has a type that defines the properties that the composite model supports. Use composite asset
@@ -5654,6 +6371,7 @@ export interface UpdateAssetModelRequest {
5654
6371
  */
5655
6372
  assetModelCompositeModels?: AssetModelCompositeModel[];
5656
6373
  /**
6374
+ * @public
5657
6375
  * <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>
5658
6376
  */
5659
6377
  clientToken?: string;
@@ -5663,6 +6381,7 @@ export interface UpdateAssetModelRequest {
5663
6381
  */
5664
6382
  export interface UpdateAssetModelResponse {
5665
6383
  /**
6384
+ * @public
5666
6385
  * <p>The status of the asset model, which contains a state (<code>UPDATING</code> after
5667
6386
  * successfully calling this operation) and any error message.</p>
5668
6387
  */
@@ -5673,14 +6392,17 @@ export interface UpdateAssetModelResponse {
5673
6392
  */
5674
6393
  export interface UpdateAssetPropertyRequest {
5675
6394
  /**
6395
+ * @public
5676
6396
  * <p>The ID of the asset to be updated.</p>
5677
6397
  */
5678
6398
  assetId: string | undefined;
5679
6399
  /**
6400
+ * @public
5680
6401
  * <p>The ID of the asset property to be updated.</p>
5681
6402
  */
5682
6403
  propertyId: string | undefined;
5683
6404
  /**
6405
+ * @public
5684
6406
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
5685
6407
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
5686
6408
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
@@ -5689,6 +6411,7 @@ export interface UpdateAssetPropertyRequest {
5689
6411
  */
5690
6412
  propertyAlias?: string;
5691
6413
  /**
6414
+ * @public
5692
6415
  * <p>The MQTT notification state (enabled or disabled) for this asset property.
5693
6416
  * When the notification state is enabled, IoT SiteWise publishes property value
5694
6417
  * 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>
@@ -5696,10 +6419,12 @@ export interface UpdateAssetPropertyRequest {
5696
6419
  */
5697
6420
  propertyNotificationState?: PropertyNotificationState | string;
5698
6421
  /**
6422
+ * @public
5699
6423
  * <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>
5700
6424
  */
5701
6425
  clientToken?: string;
5702
6426
  /**
6427
+ * @public
5703
6428
  * <p>The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a
5704
6429
  * value for this parameter, the service uses the value of the <code>assetModelProperty</code> in
5705
6430
  * the asset model.</p>
@@ -5711,23 +6436,28 @@ export interface UpdateAssetPropertyRequest {
5711
6436
  */
5712
6437
  export interface UpdateDashboardRequest {
5713
6438
  /**
6439
+ * @public
5714
6440
  * <p>The ID of the dashboard to update.</p>
5715
6441
  */
5716
6442
  dashboardId: string | undefined;
5717
6443
  /**
6444
+ * @public
5718
6445
  * <p>A new friendly name for the dashboard.</p>
5719
6446
  */
5720
6447
  dashboardName: string | undefined;
5721
6448
  /**
6449
+ * @public
5722
6450
  * <p>A new description for the dashboard.</p>
5723
6451
  */
5724
6452
  dashboardDescription?: string;
5725
6453
  /**
6454
+ * @public
5726
6455
  * <p>The new dashboard definition, as specified in a JSON literal. For detailed information,
5727
6456
  * see <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>
5728
6457
  */
5729
6458
  dashboardDefinition: string | undefined;
5730
6459
  /**
6460
+ * @public
5731
6461
  * <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>
5732
6462
  */
5733
6463
  clientToken?: string;
@@ -5742,10 +6472,12 @@ export interface UpdateDashboardResponse {
5742
6472
  */
5743
6473
  export interface UpdateGatewayRequest {
5744
6474
  /**
6475
+ * @public
5745
6476
  * <p>The ID of the gateway to update.</p>
5746
6477
  */
5747
6478
  gatewayId: string | undefined;
5748
6479
  /**
6480
+ * @public
5749
6481
  * <p>A unique, friendly name for the gateway.</p>
5750
6482
  */
5751
6483
  gatewayName: string | undefined;
@@ -5755,10 +6487,12 @@ export interface UpdateGatewayRequest {
5755
6487
  */
5756
6488
  export interface UpdateGatewayCapabilityConfigurationRequest {
5757
6489
  /**
6490
+ * @public
5758
6491
  * <p>The ID of the gateway to be updated.</p>
5759
6492
  */
5760
6493
  gatewayId: string | undefined;
5761
6494
  /**
6495
+ * @public
5762
6496
  * <p>The namespace of the gateway capability configuration to be updated.
5763
6497
  * For example, if you configure OPC-UA
5764
6498
  * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
@@ -5767,6 +6501,7 @@ export interface UpdateGatewayCapabilityConfigurationRequest {
5767
6501
  */
5768
6502
  capabilityNamespace: string | undefined;
5769
6503
  /**
6504
+ * @public
5770
6505
  * <p>The JSON document that defines the configuration for the gateway capability. For more
5771
6506
  * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
5772
6507
  */
@@ -5777,10 +6512,12 @@ export interface UpdateGatewayCapabilityConfigurationRequest {
5777
6512
  */
5778
6513
  export interface UpdateGatewayCapabilityConfigurationResponse {
5779
6514
  /**
6515
+ * @public
5780
6516
  * <p>The namespace of the gateway capability.</p>
5781
6517
  */
5782
6518
  capabilityNamespace: string | undefined;
5783
6519
  /**
6520
+ * @public
5784
6521
  * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
5785
6522
  * <ul>
5786
6523
  * <li>
@@ -5815,10 +6552,12 @@ export interface UpdateGatewayCapabilityConfigurationResponse {
5815
6552
  */
5816
6553
  export interface Image {
5817
6554
  /**
6555
+ * @public
5818
6556
  * <p>The ID of an existing image. Specify this parameter to keep an existing image.</p>
5819
6557
  */
5820
6558
  id?: string;
5821
6559
  /**
6560
+ * @public
5822
6561
  * <p>Contains an image file.</p>
5823
6562
  */
5824
6563
  file?: ImageFile;
@@ -5828,22 +6567,27 @@ export interface Image {
5828
6567
  */
5829
6568
  export interface UpdatePortalRequest {
5830
6569
  /**
6570
+ * @public
5831
6571
  * <p>The ID of the portal to update.</p>
5832
6572
  */
5833
6573
  portalId: string | undefined;
5834
6574
  /**
6575
+ * @public
5835
6576
  * <p>A new friendly name for the portal.</p>
5836
6577
  */
5837
6578
  portalName: string | undefined;
5838
6579
  /**
6580
+ * @public
5839
6581
  * <p>A new description for the portal.</p>
5840
6582
  */
5841
6583
  portalDescription?: string;
5842
6584
  /**
6585
+ * @public
5843
6586
  * <p>The Amazon Web Services administrator's contact email address.</p>
5844
6587
  */
5845
6588
  portalContactEmail: string | undefined;
5846
6589
  /**
6590
+ * @public
5847
6591
  * <p>Contains an image that is one of the following:</p>
5848
6592
  * <ul>
5849
6593
  * <li>
@@ -5856,20 +6600,24 @@ export interface UpdatePortalRequest {
5856
6600
  */
5857
6601
  portalLogoImage?: Image;
5858
6602
  /**
6603
+ * @public
5859
6604
  * <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
5860
6605
  * 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
5861
6606
  * <i>IoT SiteWise User Guide</i>.</p>
5862
6607
  */
5863
6608
  roleArn: string | undefined;
5864
6609
  /**
6610
+ * @public
5865
6611
  * <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>
5866
6612
  */
5867
6613
  clientToken?: string;
5868
6614
  /**
6615
+ * @public
5869
6616
  * <p>The email address that sends alarm notifications.</p>
5870
6617
  */
5871
6618
  notificationSenderEmail?: string;
5872
6619
  /**
6620
+ * @public
5873
6621
  * <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
5874
6622
  * You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
5875
6623
  * 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>
@@ -5881,6 +6629,7 @@ export interface UpdatePortalRequest {
5881
6629
  */
5882
6630
  export interface UpdatePortalResponse {
5883
6631
  /**
6632
+ * @public
5884
6633
  * <p>The status of the portal, which contains a state (<code>UPDATING</code> after successfully
5885
6634
  * calling this operation) and any error message.</p>
5886
6635
  */
@@ -5891,18 +6640,22 @@ export interface UpdatePortalResponse {
5891
6640
  */
5892
6641
  export interface UpdateProjectRequest {
5893
6642
  /**
6643
+ * @public
5894
6644
  * <p>The ID of the project to update.</p>
5895
6645
  */
5896
6646
  projectId: string | undefined;
5897
6647
  /**
6648
+ * @public
5898
6649
  * <p>A new friendly name for the project.</p>
5899
6650
  */
5900
6651
  projectName: string | undefined;
5901
6652
  /**
6653
+ * @public
5902
6654
  * <p>A new description for the project.</p>
5903
6655
  */
5904
6656
  projectDescription?: string;
5905
6657
  /**
6658
+ * @public
5906
6659
  * <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>
5907
6660
  */
5908
6661
  clientToken?: string;