@aws-sdk/client-iot-wireless 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 (3) hide show
  1. package/dist-types/models/models_0.d.ts +708 -0
  2. package/dist-types/models/models_1.d.ts +178 -0
  3. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,10 +6,12 @@ import { IoTWirelessServiceException as __BaseException } from "./IoTWirelessSer
6
6
  */
7
7
  export interface SessionKeysAbpV1_0_x {
8
8
  /**
9
+ * @public
9
10
  * <p>The NwkSKey value.</p>
10
11
  */
11
12
  NwkSKey?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>The AppSKey value.</p>
14
16
  */
15
17
  AppSKey?: string;
@@ -20,14 +22,17 @@ export interface SessionKeysAbpV1_0_x {
20
22
  */
21
23
  export interface AbpV1_0_x {
22
24
  /**
25
+ * @public
23
26
  * <p>The DevAddr value.</p>
24
27
  */
25
28
  DevAddr?: string;
26
29
  /**
30
+ * @public
27
31
  * <p>Session keys for ABP v1.0.x</p>
28
32
  */
29
33
  SessionKeys?: SessionKeysAbpV1_0_x;
30
34
  /**
35
+ * @public
31
36
  * <p>The FCnt init value.</p>
32
37
  */
33
38
  FCntStart?: number;
@@ -38,18 +43,22 @@ export interface AbpV1_0_x {
38
43
  */
39
44
  export interface SessionKeysAbpV1_1 {
40
45
  /**
46
+ * @public
41
47
  * <p>The FNwkSIntKey value.</p>
42
48
  */
43
49
  FNwkSIntKey?: string;
44
50
  /**
51
+ * @public
45
52
  * <p>The SNwkSIntKey value.</p>
46
53
  */
47
54
  SNwkSIntKey?: string;
48
55
  /**
56
+ * @public
49
57
  * <p>The NwkSEncKey value.</p>
50
58
  */
51
59
  NwkSEncKey?: string;
52
60
  /**
61
+ * @public
53
62
  * <p>The AppSKey value.</p>
54
63
  */
55
64
  AppSKey?: string;
@@ -60,14 +69,17 @@ export interface SessionKeysAbpV1_1 {
60
69
  */
61
70
  export interface AbpV1_1 {
62
71
  /**
72
+ * @public
63
73
  * <p>The DevAddr value.</p>
64
74
  */
65
75
  DevAddr?: string;
66
76
  /**
77
+ * @public
67
78
  * <p>Session keys for ABP v1.1</p>
68
79
  */
69
80
  SessionKeys?: SessionKeysAbpV1_1;
70
81
  /**
82
+ * @public
71
83
  * <p>The FCnt init value.</p>
72
84
  */
73
85
  FCntStart?: number;
@@ -94,11 +106,13 @@ export declare class AccessDeniedException extends __BaseException {
94
106
  */
95
107
  export interface Accuracy {
96
108
  /**
109
+ * @public
97
110
  * <p>The horizontal accuracy of the estimated position, which is the difference between the
98
111
  * estimated location and the actual device location.</p>
99
112
  */
100
113
  HorizontalAccuracy?: number;
101
114
  /**
115
+ * @public
102
116
  * <p>The vertical accuracy of the estimated position, which is the difference between the
103
117
  * estimated altitude and actual device latitude in meters.</p>
104
118
  */
@@ -121,14 +135,17 @@ export type ApplicationConfigType = (typeof ApplicationConfigType)[keyof typeof
121
135
  */
122
136
  export interface ApplicationConfig {
123
137
  /**
138
+ * @public
124
139
  * <p>The Fport value.</p>
125
140
  */
126
141
  FPort?: number;
127
142
  /**
143
+ * @public
128
144
  * <p>Application type, which can be specified to obtain real-time position information of your LoRaWAN device.</p>
129
145
  */
130
146
  Type?: ApplicationConfigType | string;
131
147
  /**
148
+ * @public
132
149
  * <p>The name of the position data destination that describes the AWS IoT rule that processes the device's position data
133
150
  * for use by AWS IoT Core for LoRaWAN.</p>
134
151
  */
@@ -140,10 +157,12 @@ export interface ApplicationConfig {
140
157
  */
141
158
  export interface SidewalkAccountInfo {
142
159
  /**
160
+ * @public
143
161
  * <p>The Sidewalk Amazon ID.</p>
144
162
  */
145
163
  AmazonId?: string;
146
164
  /**
165
+ * @public
147
166
  * <p>The Sidewalk application server private key.</p>
148
167
  */
149
168
  AppServerPrivateKey?: string;
@@ -154,10 +173,12 @@ export interface SidewalkAccountInfo {
154
173
  */
155
174
  export interface Tag {
156
175
  /**
176
+ * @public
157
177
  * <p>The tag's key value.</p>
158
178
  */
159
179
  Key: string | undefined;
160
180
  /**
181
+ * @public
161
182
  * <p>The tag's value.</p>
162
183
  */
163
184
  Value: string | undefined;
@@ -167,10 +188,12 @@ export interface Tag {
167
188
  */
168
189
  export interface AssociateAwsAccountWithPartnerAccountRequest {
169
190
  /**
191
+ * @public
170
192
  * <p>The Sidewalk account credentials.</p>
171
193
  */
172
194
  Sidewalk: SidewalkAccountInfo | undefined;
173
195
  /**
196
+ * @public
174
197
  * <p>Each resource must have a unique client request token. If you try to create a new
175
198
  * resource with the same token as a resource that already exists, an exception occurs. If
176
199
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -178,6 +201,7 @@ export interface AssociateAwsAccountWithPartnerAccountRequest {
178
201
  */
179
202
  ClientRequestToken?: string;
180
203
  /**
204
+ * @public
181
205
  * <p>The tags to attach to the specified resource. Tags are metadata that you can use to
182
206
  * manage a resource.</p>
183
207
  */
@@ -188,10 +212,12 @@ export interface AssociateAwsAccountWithPartnerAccountRequest {
188
212
  */
189
213
  export interface AssociateAwsAccountWithPartnerAccountResponse {
190
214
  /**
215
+ * @public
191
216
  * <p>The Sidewalk account credentials.</p>
192
217
  */
193
218
  Sidewalk?: SidewalkAccountInfo;
194
219
  /**
220
+ * @public
195
221
  * <p>The Amazon Resource Name of the resource.</p>
196
222
  */
197
223
  Arn?: string;
@@ -205,10 +231,12 @@ export declare class ConflictException extends __BaseException {
205
231
  readonly $fault: "client";
206
232
  Message?: string;
207
233
  /**
234
+ * @public
208
235
  * <p>Id of the resource in the conflicting operation.</p>
209
236
  */
210
237
  ResourceId?: string;
211
238
  /**
239
+ * @public
212
240
  * <p>Type of the resource in the conflicting operation.</p>
213
241
  */
214
242
  ResourceType?: string;
@@ -239,10 +267,12 @@ export declare class ResourceNotFoundException extends __BaseException {
239
267
  readonly $fault: "client";
240
268
  Message?: string;
241
269
  /**
270
+ * @public
242
271
  * <p>Id of the not found resource.</p>
243
272
  */
244
273
  ResourceId?: string;
245
274
  /**
275
+ * @public
246
276
  * <p>Type of the font found resource.</p>
247
277
  */
248
278
  ResourceType?: string;
@@ -282,10 +312,12 @@ export declare class ValidationException extends __BaseException {
282
312
  */
283
313
  export interface AssociateMulticastGroupWithFuotaTaskRequest {
284
314
  /**
315
+ * @public
285
316
  * <p>The ID of a FUOTA task.</p>
286
317
  */
287
318
  Id: string | undefined;
288
319
  /**
320
+ * @public
289
321
  * <p>The ID of the multicast group.</p>
290
322
  */
291
323
  MulticastGroupId: string | undefined;
@@ -300,10 +332,12 @@ export interface AssociateMulticastGroupWithFuotaTaskResponse {
300
332
  */
301
333
  export interface AssociateWirelessDeviceWithFuotaTaskRequest {
302
334
  /**
335
+ * @public
303
336
  * <p>The ID of a FUOTA task.</p>
304
337
  */
305
338
  Id: string | undefined;
306
339
  /**
340
+ * @public
307
341
  * <p>The ID of the wireless device.</p>
308
342
  */
309
343
  WirelessDeviceId: string | undefined;
@@ -318,10 +352,12 @@ export interface AssociateWirelessDeviceWithFuotaTaskResponse {
318
352
  */
319
353
  export interface AssociateWirelessDeviceWithMulticastGroupRequest {
320
354
  /**
355
+ * @public
321
356
  * <p>The ID of the multicast group.</p>
322
357
  */
323
358
  Id: string | undefined;
324
359
  /**
360
+ * @public
325
361
  * <p>The ID of the wireless device.</p>
326
362
  */
327
363
  WirelessDeviceId: string | undefined;
@@ -336,10 +372,12 @@ export interface AssociateWirelessDeviceWithMulticastGroupResponse {
336
372
  */
337
373
  export interface AssociateWirelessDeviceWithThingRequest {
338
374
  /**
375
+ * @public
339
376
  * <p>The ID of the resource to update.</p>
340
377
  */
341
378
  Id: string | undefined;
342
379
  /**
380
+ * @public
343
381
  * <p>The ARN of the thing to associate with the wireless device.</p>
344
382
  */
345
383
  ThingArn: string | undefined;
@@ -354,10 +392,12 @@ export interface AssociateWirelessDeviceWithThingResponse {
354
392
  */
355
393
  export interface AssociateWirelessGatewayWithCertificateRequest {
356
394
  /**
395
+ * @public
357
396
  * <p>The ID of the resource to update.</p>
358
397
  */
359
398
  Id: string | undefined;
360
399
  /**
400
+ * @public
361
401
  * <p>The ID of the certificate to associate with the wireless gateway.</p>
362
402
  */
363
403
  IotCertificateId: string | undefined;
@@ -367,6 +407,7 @@ export interface AssociateWirelessGatewayWithCertificateRequest {
367
407
  */
368
408
  export interface AssociateWirelessGatewayWithCertificateResponse {
369
409
  /**
410
+ * @public
370
411
  * <p>The ID of the certificate associated with the wireless gateway.</p>
371
412
  */
372
413
  IotCertificateId?: string;
@@ -376,10 +417,12 @@ export interface AssociateWirelessGatewayWithCertificateResponse {
376
417
  */
377
418
  export interface AssociateWirelessGatewayWithThingRequest {
378
419
  /**
420
+ * @public
379
421
  * <p>The ID of the resource to update.</p>
380
422
  */
381
423
  Id: string | undefined;
382
424
  /**
425
+ * @public
383
426
  * <p>The ARN of the thing to associate with the wireless gateway.</p>
384
427
  */
385
428
  ThingArn: string | undefined;
@@ -408,10 +451,12 @@ export type BatteryLevel = (typeof BatteryLevel)[keyof typeof BatteryLevel];
408
451
  */
409
452
  export interface Beaconing {
410
453
  /**
454
+ * @public
411
455
  * <p>The data rate for gateways that are sending the beacons.</p>
412
456
  */
413
457
  DataRate?: number;
414
458
  /**
459
+ * @public
415
460
  * <p>The frequency list for the gateways to send the beacons.</p>
416
461
  */
417
462
  Frequencies?: number[];
@@ -421,6 +466,7 @@ export interface Beaconing {
421
466
  */
422
467
  export interface CancelMulticastGroupSessionRequest {
423
468
  /**
469
+ * @public
424
470
  * <p>The ID of the multicast group.</p>
425
471
  */
426
472
  Id: string | undefined;
@@ -436,10 +482,12 @@ export interface CancelMulticastGroupSessionResponse {
436
482
  */
437
483
  export interface CdmaLocalId {
438
484
  /**
485
+ * @public
439
486
  * <p>Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.</p>
440
487
  */
441
488
  PnOffset: number | undefined;
442
489
  /**
490
+ * @public
443
491
  * <p>CDMA channel information.</p>
444
492
  */
445
493
  CdmaChannel: number | undefined;
@@ -450,18 +498,22 @@ export interface CdmaLocalId {
450
498
  */
451
499
  export interface CdmaNmrObj {
452
500
  /**
501
+ * @public
453
502
  * <p>Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.</p>
454
503
  */
455
504
  PnOffset: number | undefined;
456
505
  /**
506
+ * @public
457
507
  * <p>CDMA channel information.</p>
458
508
  */
459
509
  CdmaChannel: number | undefined;
460
510
  /**
511
+ * @public
461
512
  * <p>Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).</p>
462
513
  */
463
514
  PilotPower?: number;
464
515
  /**
516
+ * @public
465
517
  * <p>CDMA base station ID (BSID).</p>
466
518
  */
467
519
  BaseStationId?: number;
@@ -472,38 +524,47 @@ export interface CdmaNmrObj {
472
524
  */
473
525
  export interface CdmaObj {
474
526
  /**
527
+ * @public
475
528
  * <p>CDMA system ID (SID).</p>
476
529
  */
477
530
  SystemId: number | undefined;
478
531
  /**
532
+ * @public
479
533
  * <p>CDMA network ID (NID).</p>
480
534
  */
481
535
  NetworkId: number | undefined;
482
536
  /**
537
+ * @public
483
538
  * <p>CDMA base station ID (BSID).</p>
484
539
  */
485
540
  BaseStationId: number | undefined;
486
541
  /**
542
+ * @public
487
543
  * <p>CDMA registration zone (RZ).</p>
488
544
  */
489
545
  RegistrationZone?: number;
490
546
  /**
547
+ * @public
491
548
  * <p>CDMA local identification (local ID) parameters.</p>
492
549
  */
493
550
  CdmaLocalId?: CdmaLocalId;
494
551
  /**
552
+ * @public
495
553
  * <p>Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).</p>
496
554
  */
497
555
  PilotPower?: number;
498
556
  /**
557
+ * @public
499
558
  * <p>CDMA base station latitude in degrees.</p>
500
559
  */
501
560
  BaseLat?: number;
502
561
  /**
562
+ * @public
503
563
  * <p>CDMA base station longitude in degrees.</p>
504
564
  */
505
565
  BaseLng?: number;
506
566
  /**
567
+ * @public
507
568
  * <p>CDMA network measurement reports.</p>
508
569
  */
509
570
  CdmaNmr?: CdmaNmrObj[];
@@ -514,10 +575,12 @@ export interface CdmaObj {
514
575
  */
515
576
  export interface GsmLocalId {
516
577
  /**
578
+ * @public
517
579
  * <p>GSM base station identity code (BSIC).</p>
518
580
  */
519
581
  Bsic: number | undefined;
520
582
  /**
583
+ * @public
521
584
  * <p>GSM broadcast control channel.</p>
522
585
  */
523
586
  Bcch: number | undefined;
@@ -528,10 +591,12 @@ export interface GsmLocalId {
528
591
  */
529
592
  export interface GlobalIdentity {
530
593
  /**
594
+ * @public
531
595
  * <p>Location area code of the global identity.</p>
532
596
  */
533
597
  Lac: number | undefined;
534
598
  /**
599
+ * @public
535
600
  * <p>GERAN (GSM EDGE Radio Access Network) cell global identifier.</p>
536
601
  */
537
602
  GeranCid: number | undefined;
@@ -542,18 +607,22 @@ export interface GlobalIdentity {
542
607
  */
543
608
  export interface GsmNmrObj {
544
609
  /**
610
+ * @public
545
611
  * <p>GSM base station identity code (BSIC).</p>
546
612
  */
547
613
  Bsic: number | undefined;
548
614
  /**
615
+ * @public
549
616
  * <p>GSM broadcast control channel.</p>
550
617
  */
551
618
  Bcch: number | undefined;
552
619
  /**
620
+ * @public
553
621
  * <p>Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).</p>
554
622
  */
555
623
  RxLevel?: number;
556
624
  /**
625
+ * @public
557
626
  * <p>Global identity information of the GSM object.</p>
558
627
  */
559
628
  GlobalIdentity?: GlobalIdentity;
@@ -564,35 +633,43 @@ export interface GsmNmrObj {
564
633
  */
565
634
  export interface GsmObj {
566
635
  /**
636
+ * @public
567
637
  * <p>Mobile Country Code.</p>
568
638
  */
569
639
  Mcc: number | undefined;
570
640
  /**
641
+ * @public
571
642
  * <p>Mobile Network Code.</p>
572
643
  */
573
644
  Mnc: number | undefined;
574
645
  /**
646
+ * @public
575
647
  * <p>Location area code.</p>
576
648
  */
577
649
  Lac: number | undefined;
578
650
  /**
651
+ * @public
579
652
  * <p>GERAN (GSM EDGE Radio Access Network) Cell Global Identifier.</p>
580
653
  */
581
654
  GeranCid: number | undefined;
582
655
  /**
656
+ * @public
583
657
  * <p>GSM local identification (local ID) information.</p>
584
658
  */
585
659
  GsmLocalId?: GsmLocalId;
586
660
  /**
661
+ * @public
587
662
  * <p>Timing advance value, which corresponds to the length of time a signal takes to reach the
588
663
  * base station from a mobile phone.</p>
589
664
  */
590
665
  GsmTimingAdvance?: number;
591
666
  /**
667
+ * @public
592
668
  * <p>Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).</p>
593
669
  */
594
670
  RxLevel?: number;
595
671
  /**
672
+ * @public
596
673
  * <p>GSM object for network measurement reports.</p>
597
674
  */
598
675
  GsmNmr?: GsmNmrObj[];
@@ -603,10 +680,12 @@ export interface GsmObj {
603
680
  */
604
681
  export interface LteLocalId {
605
682
  /**
683
+ * @public
606
684
  * <p>Physical cell ID.</p>
607
685
  */
608
686
  Pci: number | undefined;
609
687
  /**
688
+ * @public
610
689
  * <p>Evolved universal terrestrial radio access (E-UTRA) absolute radio frequency channel number (FCN).</p>
611
690
  */
612
691
  Earfcn: number | undefined;
@@ -617,22 +696,27 @@ export interface LteLocalId {
617
696
  */
618
697
  export interface LteNmrObj {
619
698
  /**
699
+ * @public
620
700
  * <p>Physical cell ID.</p>
621
701
  */
622
702
  Pci: number | undefined;
623
703
  /**
704
+ * @public
624
705
  * <p>E-UTRA (Evolved universal terrestrial Radio Access) absolute radio frequency channel Number (EARFCN).</p>
625
706
  */
626
707
  Earfcn: number | undefined;
627
708
  /**
709
+ * @public
628
710
  * <p>E-UTRAN (Evolved Universal Terrestrial Radio Access Network) cell global identifier (EUTRANCID).</p>
629
711
  */
630
712
  EutranCid: number | undefined;
631
713
  /**
714
+ * @public
632
715
  * <p>Signal power of the reference signal received, measured in dBm (decibel-milliwatts).</p>
633
716
  */
634
717
  Rsrp?: number;
635
718
  /**
719
+ * @public
636
720
  * <p>Signal quality of the reference Signal received, measured in decibels (dB).</p>
637
721
  */
638
722
  Rsrq?: number;
@@ -643,42 +727,52 @@ export interface LteNmrObj {
643
727
  */
644
728
  export interface LteObj {
645
729
  /**
730
+ * @public
646
731
  * <p>Mobile Country Code.</p>
647
732
  */
648
733
  Mcc: number | undefined;
649
734
  /**
735
+ * @public
650
736
  * <p>Mobile Network Code.</p>
651
737
  */
652
738
  Mnc: number | undefined;
653
739
  /**
740
+ * @public
654
741
  * <p>E-UTRAN (Evolved Universal Terrestrial Radio Access Network) Cell Global Identifier.</p>
655
742
  */
656
743
  EutranCid: number | undefined;
657
744
  /**
745
+ * @public
658
746
  * <p>LTE tracking area code.</p>
659
747
  */
660
748
  Tac?: number;
661
749
  /**
750
+ * @public
662
751
  * <p>LTE local identification (local ID) information.</p>
663
752
  */
664
753
  LteLocalId?: LteLocalId;
665
754
  /**
755
+ * @public
666
756
  * <p>LTE timing advance.</p>
667
757
  */
668
758
  LteTimingAdvance?: number;
669
759
  /**
760
+ * @public
670
761
  * <p>Signal power of the reference signal received, measured in dBm (decibel-milliwatts).</p>
671
762
  */
672
763
  Rsrp?: number;
673
764
  /**
765
+ * @public
674
766
  * <p>Signal quality of the reference Signal received, measured in decibels (dB).</p>
675
767
  */
676
768
  Rsrq?: number;
677
769
  /**
770
+ * @public
678
771
  * <p>Parameter that determines whether the LTE object is capable of supporting NR (new radio).</p>
679
772
  */
680
773
  NrCapable?: boolean;
681
774
  /**
775
+ * @public
682
776
  * <p>LTE object for network measurement reports.</p>
683
777
  */
684
778
  LteNmr?: LteNmrObj[];
@@ -689,10 +783,12 @@ export interface LteObj {
689
783
  */
690
784
  export interface TdscdmaLocalId {
691
785
  /**
786
+ * @public
692
787
  * <p>TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number (UARFCN).</p>
693
788
  */
694
789
  Uarfcn: number | undefined;
695
790
  /**
791
+ * @public
696
792
  * <p>Cell parameters for TD-SCDMA.</p>
697
793
  */
698
794
  CellParams: number | undefined;
@@ -703,22 +799,27 @@ export interface TdscdmaLocalId {
703
799
  */
704
800
  export interface TdscdmaNmrObj {
705
801
  /**
802
+ * @public
706
803
  * <p>TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number.</p>
707
804
  */
708
805
  Uarfcn: number | undefined;
709
806
  /**
807
+ * @public
710
808
  * <p>Cell parameters for TD-SCDMA network measurement reports object.</p>
711
809
  */
712
810
  CellParams: number | undefined;
713
811
  /**
812
+ * @public
714
813
  * <p>UTRAN (UMTS Terrestrial Radio Access Network) cell global identifier.</p>
715
814
  */
716
815
  UtranCid?: number;
717
816
  /**
817
+ * @public
718
818
  * <p>Code power of the received signal, measured in decibel-milliwatts (dBm).</p>
719
819
  */
720
820
  Rscp?: number;
721
821
  /**
822
+ * @public
722
823
  * <p>Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it
723
824
  * propagates through space.</p>
724
825
  */
@@ -730,39 +831,48 @@ export interface TdscdmaNmrObj {
730
831
  */
731
832
  export interface TdscdmaObj {
732
833
  /**
834
+ * @public
733
835
  * <p>Mobile Country Code.</p>
734
836
  */
735
837
  Mcc: number | undefined;
736
838
  /**
839
+ * @public
737
840
  * <p>Mobile Network Code.</p>
738
841
  */
739
842
  Mnc: number | undefined;
740
843
  /**
844
+ * @public
741
845
  * <p>Location Area Code.</p>
742
846
  */
743
847
  Lac?: number;
744
848
  /**
849
+ * @public
745
850
  * <p>UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.</p>
746
851
  */
747
852
  UtranCid: number | undefined;
748
853
  /**
854
+ * @public
749
855
  * <p>TD-SCDMA local identification (local ID) information.</p>
750
856
  */
751
857
  TdscdmaLocalId?: TdscdmaLocalId;
752
858
  /**
859
+ * @public
753
860
  * <p>TD-SCDMA Timing advance.</p>
754
861
  */
755
862
  TdscdmaTimingAdvance?: number;
756
863
  /**
864
+ * @public
757
865
  * <p>Signal power of the received signal (Received Signal Code Power), measured in decibel-milliwatts (dBm).</p>
758
866
  */
759
867
  Rscp?: number;
760
868
  /**
869
+ * @public
761
870
  * <p>Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it
762
871
  * propagates through space.</p>
763
872
  */
764
873
  PathLoss?: number;
765
874
  /**
875
+ * @public
766
876
  * <p>TD-SCDMA object for network measurement reports.</p>
767
877
  */
768
878
  TdscdmaNmr?: TdscdmaNmrObj[];
@@ -773,10 +883,12 @@ export interface TdscdmaObj {
773
883
  */
774
884
  export interface WcdmaLocalId {
775
885
  /**
886
+ * @public
776
887
  * <p>WCDMA UTRA Absolute RF Channel Number downlink.</p>
777
888
  */
778
889
  Uarfcndl: number | undefined;
779
890
  /**
891
+ * @public
780
892
  * <p>Primary Scrambling Code.</p>
781
893
  */
782
894
  Psc: number | undefined;
@@ -787,22 +899,27 @@ export interface WcdmaLocalId {
787
899
  */
788
900
  export interface WcdmaNmrObj {
789
901
  /**
902
+ * @public
790
903
  * <p>WCDMA UTRA Absolute RF Channel Number downlink.</p>
791
904
  */
792
905
  Uarfcndl: number | undefined;
793
906
  /**
907
+ * @public
794
908
  * <p>Primary Scrambling Code.</p>
795
909
  */
796
910
  Psc: number | undefined;
797
911
  /**
912
+ * @public
798
913
  * <p>UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.</p>
799
914
  */
800
915
  UtranCid: number | undefined;
801
916
  /**
917
+ * @public
802
918
  * <p>Received Signal Code Power (signal power) (dBm)</p>
803
919
  */
804
920
  Rscp?: number;
805
921
  /**
922
+ * @public
806
923
  * <p>Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as
807
924
  * it propagates through space.</p>
808
925
  */
@@ -814,35 +931,43 @@ export interface WcdmaNmrObj {
814
931
  */
815
932
  export interface WcdmaObj {
816
933
  /**
934
+ * @public
817
935
  * <p>Mobile Country Code.</p>
818
936
  */
819
937
  Mcc: number | undefined;
820
938
  /**
939
+ * @public
821
940
  * <p>Mobile Network Code.</p>
822
941
  */
823
942
  Mnc: number | undefined;
824
943
  /**
944
+ * @public
825
945
  * <p>Location Area Code.</p>
826
946
  */
827
947
  Lac?: number;
828
948
  /**
949
+ * @public
829
950
  * <p>UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.</p>
830
951
  */
831
952
  UtranCid: number | undefined;
832
953
  /**
954
+ * @public
833
955
  * <p>WCDMA local ID information.</p>
834
956
  */
835
957
  WcdmaLocalId?: WcdmaLocalId;
836
958
  /**
959
+ * @public
837
960
  * <p>Received Signal Code Power (signal power) (dBm).</p>
838
961
  */
839
962
  Rscp?: number;
840
963
  /**
964
+ * @public
841
965
  * <p>Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as
842
966
  * it propagates through space.</p>
843
967
  */
844
968
  PathLoss?: number;
845
969
  /**
970
+ * @public
846
971
  * <p>WCDMA object for network measurement reports.</p>
847
972
  */
848
973
  WcdmaNmr?: WcdmaNmrObj[];
@@ -853,22 +978,27 @@ export interface WcdmaObj {
853
978
  */
854
979
  export interface CellTowers {
855
980
  /**
981
+ * @public
856
982
  * <p>GSM object information.</p>
857
983
  */
858
984
  Gsm?: GsmObj[];
859
985
  /**
986
+ * @public
860
987
  * <p>WCDMA object information.</p>
861
988
  */
862
989
  Wcdma?: WcdmaObj[];
863
990
  /**
991
+ * @public
864
992
  * <p>TD-SCDMA object information.</p>
865
993
  */
866
994
  Tdscdma?: TdscdmaObj[];
867
995
  /**
996
+ * @public
868
997
  * <p>LTE object information.</p>
869
998
  */
870
999
  Lte?: LteObj[];
871
1000
  /**
1001
+ * @public
872
1002
  * <p>CDMA object information.</p>
873
1003
  */
874
1004
  Cdma?: CdmaObj[];
@@ -891,10 +1021,12 @@ export type SigningAlg = (typeof SigningAlg)[keyof typeof SigningAlg];
891
1021
  */
892
1022
  export interface CertificateList {
893
1023
  /**
1024
+ * @public
894
1025
  * <p>The certificate chain algorithm provided by sidewalk.</p>
895
1026
  */
896
1027
  SigningAlg: SigningAlg | string | undefined;
897
1028
  /**
1029
+ * @public
898
1030
  * <p>The value of the chosen sidewalk certificate.</p>
899
1031
  */
900
1032
  Value: string | undefined;
@@ -929,6 +1061,7 @@ export type EventNotificationTopicStatus = (typeof EventNotificationTopicStatus)
929
1061
  */
930
1062
  export interface LoRaWANConnectionStatusEventNotificationConfigurations {
931
1063
  /**
1064
+ * @public
932
1065
  * <p>Denotes whether the gateway EUI connection status event topic is enabled or
933
1066
  * disabled.</p>
934
1067
  */
@@ -940,11 +1073,13 @@ export interface LoRaWANConnectionStatusEventNotificationConfigurations {
940
1073
  */
941
1074
  export interface ConnectionStatusEventConfiguration {
942
1075
  /**
1076
+ * @public
943
1077
  * <p>Connection status event configuration object for enabling or disabling LoRaWAN related
944
1078
  * event topics.</p>
945
1079
  */
946
1080
  LoRaWAN?: LoRaWANConnectionStatusEventNotificationConfigurations;
947
1081
  /**
1082
+ * @public
948
1083
  * <p>Denotes whether the wireless gateway ID connection status event topic is enabled or
949
1084
  * disabled.</p>
950
1085
  */
@@ -956,6 +1091,7 @@ export interface ConnectionStatusEventConfiguration {
956
1091
  */
957
1092
  export interface LoRaWANConnectionStatusResourceTypeEventConfiguration {
958
1093
  /**
1094
+ * @public
959
1095
  * <p>Denotes whether the wireless gateway connection status event topic is enabled or
960
1096
  * disabled.</p>
961
1097
  */
@@ -968,6 +1104,7 @@ export interface LoRaWANConnectionStatusResourceTypeEventConfiguration {
968
1104
  */
969
1105
  export interface ConnectionStatusResourceTypeEventConfiguration {
970
1106
  /**
1107
+ * @public
971
1108
  * <p>Connection status resource type event configuration object for enabling or disabling
972
1109
  * LoRaWAN related event topics.</p>
973
1110
  */
@@ -990,31 +1127,38 @@ export type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType
990
1127
  */
991
1128
  export interface CreateDestinationRequest {
992
1129
  /**
1130
+ * @public
993
1131
  * <p>The name of the new resource.</p>
994
1132
  */
995
1133
  Name: string | undefined;
996
1134
  /**
1135
+ * @public
997
1136
  * <p>The type of value in <code>Expression</code>.</p>
998
1137
  */
999
1138
  ExpressionType: ExpressionType | string | undefined;
1000
1139
  /**
1140
+ * @public
1001
1141
  * <p>The rule name or topic rule to send messages to.</p>
1002
1142
  */
1003
1143
  Expression: string | undefined;
1004
1144
  /**
1145
+ * @public
1005
1146
  * <p>The description of the new resource.</p>
1006
1147
  */
1007
1148
  Description?: string;
1008
1149
  /**
1150
+ * @public
1009
1151
  * <p>The ARN of the IAM Role that authorizes the destination.</p>
1010
1152
  */
1011
1153
  RoleArn: string | undefined;
1012
1154
  /**
1155
+ * @public
1013
1156
  * <p>The tags to attach to the new destination. Tags are metadata that you can use to
1014
1157
  * manage a resource.</p>
1015
1158
  */
1016
1159
  Tags?: Tag[];
1017
1160
  /**
1161
+ * @public
1018
1162
  * <p>Each resource must have a unique client request token. If you try to create a new
1019
1163
  * resource with the same token as a resource that already exists, an exception occurs. If
1020
1164
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1027,10 +1171,12 @@ export interface CreateDestinationRequest {
1027
1171
  */
1028
1172
  export interface CreateDestinationResponse {
1029
1173
  /**
1174
+ * @public
1030
1175
  * <p>The Amazon Resource Name of the new resource.</p>
1031
1176
  */
1032
1177
  Arn?: string;
1033
1178
  /**
1179
+ * @public
1034
1180
  * <p>The name of the new resource.</p>
1035
1181
  */
1036
1182
  Name?: string;
@@ -1041,79 +1187,98 @@ export interface CreateDestinationResponse {
1041
1187
  */
1042
1188
  export interface LoRaWANDeviceProfile {
1043
1189
  /**
1190
+ * @public
1044
1191
  * <p>The SupportsClassB value.</p>
1045
1192
  */
1046
1193
  SupportsClassB?: boolean;
1047
1194
  /**
1195
+ * @public
1048
1196
  * <p>The ClassBTimeout value.</p>
1049
1197
  */
1050
1198
  ClassBTimeout?: number;
1051
1199
  /**
1200
+ * @public
1052
1201
  * <p>The PingSlotPeriod value.</p>
1053
1202
  */
1054
1203
  PingSlotPeriod?: number;
1055
1204
  /**
1205
+ * @public
1056
1206
  * <p>The PingSlotDR value.</p>
1057
1207
  */
1058
1208
  PingSlotDr?: number;
1059
1209
  /**
1210
+ * @public
1060
1211
  * <p>The PingSlotFreq value.</p>
1061
1212
  */
1062
1213
  PingSlotFreq?: number;
1063
1214
  /**
1215
+ * @public
1064
1216
  * <p>The SupportsClassC value.</p>
1065
1217
  */
1066
1218
  SupportsClassC?: boolean;
1067
1219
  /**
1220
+ * @public
1068
1221
  * <p>The ClassCTimeout value.</p>
1069
1222
  */
1070
1223
  ClassCTimeout?: number;
1071
1224
  /**
1225
+ * @public
1072
1226
  * <p>The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device
1073
1227
  * profile.</p>
1074
1228
  */
1075
1229
  MacVersion?: string;
1076
1230
  /**
1231
+ * @public
1077
1232
  * <p>The version of regional parameters.</p>
1078
1233
  */
1079
1234
  RegParamsRevision?: string;
1080
1235
  /**
1236
+ * @public
1081
1237
  * <p>The RXDelay1 value.</p>
1082
1238
  */
1083
1239
  RxDelay1?: number;
1084
1240
  /**
1241
+ * @public
1085
1242
  * <p>The RXDROffset1 value.</p>
1086
1243
  */
1087
1244
  RxDrOffset1?: number;
1088
1245
  /**
1246
+ * @public
1089
1247
  * <p>The RXDataRate2 value.</p>
1090
1248
  */
1091
1249
  RxDataRate2?: number;
1092
1250
  /**
1251
+ * @public
1093
1252
  * <p>The RXFreq2 value.</p>
1094
1253
  */
1095
1254
  RxFreq2?: number;
1096
1255
  /**
1256
+ * @public
1097
1257
  * <p>The list of values that make up the FactoryPresetFreqs value.</p>
1098
1258
  */
1099
1259
  FactoryPresetFreqsList?: number[];
1100
1260
  /**
1261
+ * @public
1101
1262
  * <p>The MaxEIRP value.</p>
1102
1263
  */
1103
1264
  MaxEirp?: number;
1104
1265
  /**
1266
+ * @public
1105
1267
  * <p>The MaxDutyCycle value.</p>
1106
1268
  */
1107
1269
  MaxDutyCycle?: number;
1108
1270
  /**
1271
+ * @public
1109
1272
  * <p>The frequency band (RFRegion) value.</p>
1110
1273
  */
1111
1274
  RfRegion?: string;
1112
1275
  /**
1276
+ * @public
1113
1277
  * <p>The SupportsJoin value.</p>
1114
1278
  */
1115
1279
  SupportsJoin?: boolean;
1116
1280
  /**
1281
+ * @public
1117
1282
  * <p>The Supports32BitFCnt value.</p>
1118
1283
  */
1119
1284
  Supports32BitFCnt?: boolean;
@@ -1129,19 +1294,23 @@ export interface SidewalkCreateDeviceProfile {
1129
1294
  */
1130
1295
  export interface CreateDeviceProfileRequest {
1131
1296
  /**
1297
+ * @public
1132
1298
  * <p>The name of the new resource.</p>
1133
1299
  */
1134
1300
  Name?: string;
1135
1301
  /**
1302
+ * @public
1136
1303
  * <p>The device profile information to use to create the device profile.</p>
1137
1304
  */
1138
1305
  LoRaWAN?: LoRaWANDeviceProfile;
1139
1306
  /**
1307
+ * @public
1140
1308
  * <p>The tags to attach to the new device profile. Tags are metadata that you can use to
1141
1309
  * manage a resource.</p>
1142
1310
  */
1143
1311
  Tags?: Tag[];
1144
1312
  /**
1313
+ * @public
1145
1314
  * <p>Each resource must have a unique client request token. If you try to create a new
1146
1315
  * resource with the same token as a resource that already exists, an exception occurs. If
1147
1316
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1149,6 +1318,7 @@ export interface CreateDeviceProfileRequest {
1149
1318
  */
1150
1319
  ClientRequestToken?: string;
1151
1320
  /**
1321
+ * @public
1152
1322
  * <p>The Sidewalk-related information for creating the Sidewalk device profile.</p>
1153
1323
  */
1154
1324
  Sidewalk?: SidewalkCreateDeviceProfile;
@@ -1158,10 +1328,12 @@ export interface CreateDeviceProfileRequest {
1158
1328
  */
1159
1329
  export interface CreateDeviceProfileResponse {
1160
1330
  /**
1331
+ * @public
1161
1332
  * <p>The Amazon Resource Name of the new resource.</p>
1162
1333
  */
1163
1334
  Arn?: string;
1164
1335
  /**
1336
+ * @public
1165
1337
  * <p>The ID of the new device profile.</p>
1166
1338
  */
1167
1339
  Id?: string;
@@ -1195,6 +1367,7 @@ export type SupportedRfRegion = (typeof SupportedRfRegion)[keyof typeof Supporte
1195
1367
  */
1196
1368
  export interface LoRaWANFuotaTask {
1197
1369
  /**
1370
+ * @public
1198
1371
  * <p>Supported RfRegions</p>
1199
1372
  */
1200
1373
  RfRegion?: SupportedRfRegion | string;
@@ -1204,14 +1377,17 @@ export interface LoRaWANFuotaTask {
1204
1377
  */
1205
1378
  export interface CreateFuotaTaskRequest {
1206
1379
  /**
1380
+ * @public
1207
1381
  * <p>The name of a FUOTA task.</p>
1208
1382
  */
1209
1383
  Name?: string;
1210
1384
  /**
1385
+ * @public
1211
1386
  * <p>The description of the new resource.</p>
1212
1387
  */
1213
1388
  Description?: string;
1214
1389
  /**
1390
+ * @public
1215
1391
  * <p>Each resource must have a unique client request token. If you try to create a new
1216
1392
  * resource with the same token as a resource that already exists, an exception occurs. If
1217
1393
  * you omit this value, AWS SDKs will automatically generate a unique client
@@ -1219,24 +1395,29 @@ export interface CreateFuotaTaskRequest {
1219
1395
  */
1220
1396
  ClientRequestToken?: string;
1221
1397
  /**
1398
+ * @public
1222
1399
  * <p>The LoRaWAN information used with a FUOTA task.</p>
1223
1400
  */
1224
1401
  LoRaWAN?: LoRaWANFuotaTask;
1225
1402
  /**
1403
+ * @public
1226
1404
  * <p>The S3 URI points to a firmware update image that is to be used with a FUOTA
1227
1405
  * task.</p>
1228
1406
  */
1229
1407
  FirmwareUpdateImage: string | undefined;
1230
1408
  /**
1409
+ * @public
1231
1410
  * <p>The firmware update role that is to be used with a FUOTA task.</p>
1232
1411
  */
1233
1412
  FirmwareUpdateRole: string | undefined;
1234
1413
  /**
1414
+ * @public
1235
1415
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
1236
1416
  * manage a resource.</p>
1237
1417
  */
1238
1418
  Tags?: Tag[];
1239
1419
  /**
1420
+ * @public
1240
1421
  * <p>The percentage of the added fragments that are redundant. For example, if the size of
1241
1422
  * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
1242
1423
  * <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments
@@ -1244,11 +1425,13 @@ export interface CreateFuotaTaskRequest {
1244
1425
  */
1245
1426
  RedundancyPercent?: number;
1246
1427
  /**
1428
+ * @public
1247
1429
  * <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks
1248
1430
  * with multicast groups.</p>
1249
1431
  */
1250
1432
  FragmentSizeBytes?: number;
1251
1433
  /**
1434
+ * @public
1252
1435
  * <p>The interval for sending fragments in milliseconds, rounded to the nearest
1253
1436
  * second.</p>
1254
1437
  * <note>
@@ -1265,10 +1448,12 @@ export interface CreateFuotaTaskRequest {
1265
1448
  */
1266
1449
  export interface CreateFuotaTaskResponse {
1267
1450
  /**
1451
+ * @public
1268
1452
  * <p>The arn of a FUOTA task.</p>
1269
1453
  */
1270
1454
  Arn?: string;
1271
1455
  /**
1456
+ * @public
1272
1457
  * <p>The ID of a FUOTA task.</p>
1273
1458
  */
1274
1459
  Id?: string;
@@ -1291,10 +1476,12 @@ export type DlClass = (typeof DlClass)[keyof typeof DlClass];
1291
1476
  */
1292
1477
  export interface LoRaWANMulticast {
1293
1478
  /**
1479
+ * @public
1294
1480
  * <p>Supported RfRegions</p>
1295
1481
  */
1296
1482
  RfRegion?: SupportedRfRegion | string;
1297
1483
  /**
1484
+ * @public
1298
1485
  * <p>DlClass for LoRaWAM, valid values are ClassB and ClassC.</p>
1299
1486
  */
1300
1487
  DlClass?: DlClass | string;
@@ -1304,14 +1491,17 @@ export interface LoRaWANMulticast {
1304
1491
  */
1305
1492
  export interface CreateMulticastGroupRequest {
1306
1493
  /**
1494
+ * @public
1307
1495
  * <p>The name of the multicast group.</p>
1308
1496
  */
1309
1497
  Name?: string;
1310
1498
  /**
1499
+ * @public
1311
1500
  * <p>The description of the multicast group.</p>
1312
1501
  */
1313
1502
  Description?: string;
1314
1503
  /**
1504
+ * @public
1315
1505
  * <p>Each resource must have a unique client request token. If you try to create a new
1316
1506
  * resource with the same token as a resource that already exists, an exception occurs. If
1317
1507
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1319,10 +1509,12 @@ export interface CreateMulticastGroupRequest {
1319
1509
  */
1320
1510
  ClientRequestToken?: string;
1321
1511
  /**
1512
+ * @public
1322
1513
  * <p>The LoRaWAN information that is to be used with the multicast group.</p>
1323
1514
  */
1324
1515
  LoRaWAN: LoRaWANMulticast | undefined;
1325
1516
  /**
1517
+ * @public
1326
1518
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
1327
1519
  * manage a resource.</p>
1328
1520
  */
@@ -1333,10 +1525,12 @@ export interface CreateMulticastGroupRequest {
1333
1525
  */
1334
1526
  export interface CreateMulticastGroupResponse {
1335
1527
  /**
1528
+ * @public
1336
1529
  * <p>The arn of the multicast group.</p>
1337
1530
  */
1338
1531
  Arn?: string;
1339
1532
  /**
1533
+ * @public
1340
1534
  * <p>The ID of the multicast group.</p>
1341
1535
  */
1342
1536
  Id?: string;
@@ -1384,6 +1578,7 @@ export type WirelessDeviceFrameInfo = (typeof WirelessDeviceFrameInfo)[keyof typ
1384
1578
  */
1385
1579
  export interface TraceContent {
1386
1580
  /**
1581
+ * @public
1387
1582
  * <p>
1388
1583
  * <code>FrameInfo</code> of your wireless device resources for the trace content. Use
1389
1584
  * FrameInfo to debug the communication between your LoRaWAN end devices and the network
@@ -1391,12 +1586,14 @@ export interface TraceContent {
1391
1586
  */
1392
1587
  WirelessDeviceFrameInfo?: WirelessDeviceFrameInfo | string;
1393
1588
  /**
1589
+ * @public
1394
1590
  * <p>The log level for a log message. The log levels can be disabled, or set to
1395
1591
  * <code>ERROR</code> to display less verbose logs containing only error information,
1396
1592
  * or to <code>INFO</code> for more detailed logs.</p>
1397
1593
  */
1398
1594
  LogLevel?: LogLevel | string;
1399
1595
  /**
1596
+ * @public
1400
1597
  * <p>
1401
1598
  * <code>FrameInfo</code> of your multicast group resources for the trace content. Use
1402
1599
  * FrameInfo to debug the multicast communication between your LoRaWAN end devices and the network server.</p>
@@ -1408,33 +1605,40 @@ export interface TraceContent {
1408
1605
  */
1409
1606
  export interface CreateNetworkAnalyzerConfigurationRequest {
1410
1607
  /**
1608
+ * @public
1411
1609
  * <p>Name of the network analyzer configuration.</p>
1412
1610
  */
1413
1611
  Name: string | undefined;
1414
1612
  /**
1613
+ * @public
1415
1614
  * <p>Trace content for your wireless gateway and wireless device resources.</p>
1416
1615
  */
1417
1616
  TraceContent?: TraceContent;
1418
1617
  /**
1618
+ * @public
1419
1619
  * <p>Wireless device resources to add to the network analyzer configuration. Provide the
1420
1620
  * <code>WirelessDeviceId</code> of the resource to add in the input array.</p>
1421
1621
  */
1422
1622
  WirelessDevices?: string[];
1423
1623
  /**
1624
+ * @public
1424
1625
  * <p>Wireless gateway resources to add to the network analyzer configuration. Provide the
1425
1626
  * <code>WirelessGatewayId</code> of the resource to add in the input array.</p>
1426
1627
  */
1427
1628
  WirelessGateways?: string[];
1428
1629
  /**
1630
+ * @public
1429
1631
  * <p>The description of the new resource.</p>
1430
1632
  */
1431
1633
  Description?: string;
1432
1634
  /**
1635
+ * @public
1433
1636
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
1434
1637
  * manage a resource.</p>
1435
1638
  */
1436
1639
  Tags?: Tag[];
1437
1640
  /**
1641
+ * @public
1438
1642
  * <p>Each resource must have a unique client request token. If you try to create a new
1439
1643
  * resource with the same token as a resource that already exists, an exception occurs. If
1440
1644
  * you omit this value, AWS SDKs will automatically generate a unique client
@@ -1442,6 +1646,7 @@ export interface CreateNetworkAnalyzerConfigurationRequest {
1442
1646
  */
1443
1647
  ClientRequestToken?: string;
1444
1648
  /**
1649
+ * @public
1445
1650
  * <p>Multicast Group resources to add to the network analyzer configruation. Provide the
1446
1651
  * <code>MulticastGroupId</code> of the resource to add in the input array.</p>
1447
1652
  */
@@ -1452,10 +1657,12 @@ export interface CreateNetworkAnalyzerConfigurationRequest {
1452
1657
  */
1453
1658
  export interface CreateNetworkAnalyzerConfigurationResponse {
1454
1659
  /**
1660
+ * @public
1455
1661
  * <p>The Amazon Resource Name of the new resource.</p>
1456
1662
  */
1457
1663
  Arn?: string;
1458
1664
  /**
1665
+ * @public
1459
1666
  * <p>Name of the network analyzer configuration.</p>
1460
1667
  */
1461
1668
  Name?: string;
@@ -1466,22 +1673,27 @@ export interface CreateNetworkAnalyzerConfigurationResponse {
1466
1673
  */
1467
1674
  export interface LoRaWANServiceProfile {
1468
1675
  /**
1676
+ * @public
1469
1677
  * <p>The AddGWMetaData value.</p>
1470
1678
  */
1471
1679
  AddGwMetadata?: boolean;
1472
1680
  /**
1681
+ * @public
1473
1682
  * <p>The DrMin value.</p>
1474
1683
  */
1475
1684
  DrMin?: number;
1476
1685
  /**
1686
+ * @public
1477
1687
  * <p>The DrMax value.</p>
1478
1688
  */
1479
1689
  DrMax?: number;
1480
1690
  /**
1691
+ * @public
1481
1692
  * <p>The PRAllowed value that describes whether passive roaming is allowed.</p>
1482
1693
  */
1483
1694
  PrAllowed?: boolean;
1484
1695
  /**
1696
+ * @public
1485
1697
  * <p>The RAAllowed value that describes whether roaming activation is allowed.</p>
1486
1698
  */
1487
1699
  RaAllowed?: boolean;
@@ -1491,19 +1703,23 @@ export interface LoRaWANServiceProfile {
1491
1703
  */
1492
1704
  export interface CreateServiceProfileRequest {
1493
1705
  /**
1706
+ * @public
1494
1707
  * <p>The name of the new resource.</p>
1495
1708
  */
1496
1709
  Name?: string;
1497
1710
  /**
1711
+ * @public
1498
1712
  * <p>The service profile information to use to create the service profile.</p>
1499
1713
  */
1500
1714
  LoRaWAN?: LoRaWANServiceProfile;
1501
1715
  /**
1716
+ * @public
1502
1717
  * <p>The tags to attach to the new service profile. Tags are metadata that you can use to
1503
1718
  * manage a resource.</p>
1504
1719
  */
1505
1720
  Tags?: Tag[];
1506
1721
  /**
1722
+ * @public
1507
1723
  * <p>Each resource must have a unique client request token. If you try to create a new
1508
1724
  * resource with the same token as a resource that already exists, an exception occurs. If
1509
1725
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1516,10 +1732,12 @@ export interface CreateServiceProfileRequest {
1516
1732
  */
1517
1733
  export interface CreateServiceProfileResponse {
1518
1734
  /**
1735
+ * @public
1519
1736
  * <p>The Amazon Resource Name of the new resource.</p>
1520
1737
  */
1521
1738
  Arn?: string;
1522
1739
  /**
1740
+ * @public
1523
1741
  * <p>The ID of the new service profile.</p>
1524
1742
  */
1525
1743
  Id?: string;
@@ -1530,14 +1748,17 @@ export interface CreateServiceProfileResponse {
1530
1748
  */
1531
1749
  export interface Positioning {
1532
1750
  /**
1751
+ * @public
1533
1752
  * <p>The Fport value.</p>
1534
1753
  */
1535
1754
  ClockSync?: number;
1536
1755
  /**
1756
+ * @public
1537
1757
  * <p>The Fport value.</p>
1538
1758
  */
1539
1759
  Stream?: number;
1540
1760
  /**
1761
+ * @public
1541
1762
  * <p>The Fport value.</p>
1542
1763
  */
1543
1764
  Gnss?: number;
@@ -1548,23 +1769,28 @@ export interface Positioning {
1548
1769
  */
1549
1770
  export interface FPorts {
1550
1771
  /**
1772
+ * @public
1551
1773
  * <p>The Fport value.</p>
1552
1774
  */
1553
1775
  Fuota?: number;
1554
1776
  /**
1777
+ * @public
1555
1778
  * <p>The Fport value.</p>
1556
1779
  */
1557
1780
  Multicast?: number;
1558
1781
  /**
1782
+ * @public
1559
1783
  * <p>The Fport value.</p>
1560
1784
  */
1561
1785
  ClockSync?: number;
1562
1786
  /**
1787
+ * @public
1563
1788
  * <p>FPort values for the GNSS, stream, and ClockSync functions of the positioning
1564
1789
  * information.</p>
1565
1790
  */
1566
1791
  Positioning?: Positioning;
1567
1792
  /**
1793
+ * @public
1568
1794
  * <p>Optional LoRaWAN application information, which can be used for geolocation.</p>
1569
1795
  */
1570
1796
  Applications?: ApplicationConfig[];
@@ -1575,14 +1801,17 @@ export interface FPorts {
1575
1801
  */
1576
1802
  export interface OtaaV1_0_x {
1577
1803
  /**
1804
+ * @public
1578
1805
  * <p>The AppKey value.</p>
1579
1806
  */
1580
1807
  AppKey?: string;
1581
1808
  /**
1809
+ * @public
1582
1810
  * <p>The AppEUI value.</p>
1583
1811
  */
1584
1812
  AppEui?: string;
1585
1813
  /**
1814
+ * @public
1586
1815
  * <p>The GenAppKey value.</p>
1587
1816
  */
1588
1817
  GenAppKey?: string;
@@ -1593,14 +1822,17 @@ export interface OtaaV1_0_x {
1593
1822
  */
1594
1823
  export interface OtaaV1_1 {
1595
1824
  /**
1825
+ * @public
1596
1826
  * <p>The AppKey value.</p>
1597
1827
  */
1598
1828
  AppKey?: string;
1599
1829
  /**
1830
+ * @public
1600
1831
  * <p>The NwkKey value.</p>
1601
1832
  */
1602
1833
  NwkKey?: string;
1603
1834
  /**
1835
+ * @public
1604
1836
  * <p>The JoinEUI value.</p>
1605
1837
  */
1606
1838
  JoinEui?: string;
@@ -1611,34 +1843,42 @@ export interface OtaaV1_1 {
1611
1843
  */
1612
1844
  export interface LoRaWANDevice {
1613
1845
  /**
1846
+ * @public
1614
1847
  * <p>The DevEUI value.</p>
1615
1848
  */
1616
1849
  DevEui?: string;
1617
1850
  /**
1851
+ * @public
1618
1852
  * <p>The ID of the device profile for the new wireless device.</p>
1619
1853
  */
1620
1854
  DeviceProfileId?: string;
1621
1855
  /**
1856
+ * @public
1622
1857
  * <p>The ID of the service profile.</p>
1623
1858
  */
1624
1859
  ServiceProfileId?: string;
1625
1860
  /**
1861
+ * @public
1626
1862
  * <p>OTAA device object for v1.1 for create APIs</p>
1627
1863
  */
1628
1864
  OtaaV1_1?: OtaaV1_1;
1629
1865
  /**
1866
+ * @public
1630
1867
  * <p>OTAA device object for create APIs for v1.0.x</p>
1631
1868
  */
1632
1869
  OtaaV1_0_x?: OtaaV1_0_x;
1633
1870
  /**
1871
+ * @public
1634
1872
  * <p>ABP device object for create APIs for v1.1</p>
1635
1873
  */
1636
1874
  AbpV1_1?: AbpV1_1;
1637
1875
  /**
1876
+ * @public
1638
1877
  * <p>LoRaWAN object for create APIs</p>
1639
1878
  */
1640
1879
  AbpV1_0_x?: AbpV1_0_x;
1641
1880
  /**
1881
+ * @public
1642
1882
  * <p>List of FPort assigned for different LoRaWAN application packages to use</p>
1643
1883
  */
1644
1884
  FPorts?: FPorts;
@@ -1661,6 +1901,7 @@ export type PositioningConfigStatus = (typeof PositioningConfigStatus)[keyof typ
1661
1901
  */
1662
1902
  export interface SidewalkCreateWirelessDevice {
1663
1903
  /**
1904
+ * @public
1664
1905
  * <p>The ID of the Sidewalk device profile.</p>
1665
1906
  */
1666
1907
  DeviceProfileId?: string;
@@ -1682,22 +1923,27 @@ export type WirelessDeviceType = (typeof WirelessDeviceType)[keyof typeof Wirele
1682
1923
  */
1683
1924
  export interface CreateWirelessDeviceRequest {
1684
1925
  /**
1926
+ * @public
1685
1927
  * <p>The wireless device type.</p>
1686
1928
  */
1687
1929
  Type: WirelessDeviceType | string | undefined;
1688
1930
  /**
1931
+ * @public
1689
1932
  * <p>The name of the new resource.</p>
1690
1933
  */
1691
1934
  Name?: string;
1692
1935
  /**
1936
+ * @public
1693
1937
  * <p>The description of the new resource.</p>
1694
1938
  */
1695
1939
  Description?: string;
1696
1940
  /**
1941
+ * @public
1697
1942
  * <p>The name of the destination to assign to the new wireless device.</p>
1698
1943
  */
1699
1944
  DestinationName: string | undefined;
1700
1945
  /**
1946
+ * @public
1701
1947
  * <p>Each resource must have a unique client request token. If you try to create a new
1702
1948
  * resource with the same token as a resource that already exists, an exception occurs. If
1703
1949
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1705,20 +1951,24 @@ export interface CreateWirelessDeviceRequest {
1705
1951
  */
1706
1952
  ClientRequestToken?: string;
1707
1953
  /**
1954
+ * @public
1708
1955
  * <p>The device configuration information to use to create the wireless device.</p>
1709
1956
  */
1710
1957
  LoRaWAN?: LoRaWANDevice;
1711
1958
  /**
1959
+ * @public
1712
1960
  * <p>The tags to attach to the new wireless device. Tags are metadata that you can use to
1713
1961
  * manage a resource.</p>
1714
1962
  */
1715
1963
  Tags?: Tag[];
1716
1964
  /**
1965
+ * @public
1717
1966
  * <p>FPort values for the GNSS, stream, and ClockSync functions of the positioning
1718
1967
  * information.</p>
1719
1968
  */
1720
1969
  Positioning?: PositioningConfigStatus | string;
1721
1970
  /**
1971
+ * @public
1722
1972
  * <p>The device configuration information to use to create the Sidewalk device.</p>
1723
1973
  */
1724
1974
  Sidewalk?: SidewalkCreateWirelessDevice;
@@ -1728,10 +1978,12 @@ export interface CreateWirelessDeviceRequest {
1728
1978
  */
1729
1979
  export interface CreateWirelessDeviceResponse {
1730
1980
  /**
1981
+ * @public
1731
1982
  * <p>The Amazon Resource Name of the new resource.</p>
1732
1983
  */
1733
1984
  Arn?: string;
1734
1985
  /**
1986
+ * @public
1735
1987
  * <p>The ID of the new wireless device.</p>
1736
1988
  */
1737
1989
  Id?: string;
@@ -1742,32 +1994,39 @@ export interface CreateWirelessDeviceResponse {
1742
1994
  */
1743
1995
  export interface LoRaWANGateway {
1744
1996
  /**
1997
+ * @public
1745
1998
  * <p>The gateway's EUI value.</p>
1746
1999
  */
1747
2000
  GatewayEui?: string;
1748
2001
  /**
2002
+ * @public
1749
2003
  * <p>The frequency band (RFRegion) value.</p>
1750
2004
  */
1751
2005
  RfRegion?: string;
1752
2006
  /**
2007
+ * @public
1753
2008
  * <p>A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.</p>
1754
2009
  */
1755
2010
  JoinEuiFilters?: string[][];
1756
2011
  /**
2012
+ * @public
1757
2013
  * <p>A list of NetId values that are used by LoRa gateways to filter the uplink
1758
2014
  * frames.</p>
1759
2015
  */
1760
2016
  NetIdFilters?: string[];
1761
2017
  /**
2018
+ * @public
1762
2019
  * <p>A list of integer indicating which sub bands are supported by LoRa gateway.</p>
1763
2020
  */
1764
2021
  SubBands?: number[];
1765
2022
  /**
2023
+ * @public
1766
2024
  * <p>Beaconing object information, which consists of the data rate and frequency
1767
2025
  * parameters.</p>
1768
2026
  */
1769
2027
  Beaconing?: Beaconing;
1770
2028
  /**
2029
+ * @public
1771
2030
  * <p>The MaxEIRP value.</p>
1772
2031
  */
1773
2032
  MaxEirp?: number;
@@ -1777,23 +2036,28 @@ export interface LoRaWANGateway {
1777
2036
  */
1778
2037
  export interface CreateWirelessGatewayRequest {
1779
2038
  /**
2039
+ * @public
1780
2040
  * <p>The name of the new resource.</p>
1781
2041
  */
1782
2042
  Name?: string;
1783
2043
  /**
2044
+ * @public
1784
2045
  * <p>The description of the new resource.</p>
1785
2046
  */
1786
2047
  Description?: string;
1787
2048
  /**
2049
+ * @public
1788
2050
  * <p>The gateway configuration information to use to create the wireless gateway.</p>
1789
2051
  */
1790
2052
  LoRaWAN: LoRaWANGateway | undefined;
1791
2053
  /**
2054
+ * @public
1792
2055
  * <p>The tags to attach to the new wireless gateway. Tags are metadata that you can use to
1793
2056
  * manage a resource.</p>
1794
2057
  */
1795
2058
  Tags?: Tag[];
1796
2059
  /**
2060
+ * @public
1797
2061
  * <p>Each resource must have a unique client request token. If you try to create a new
1798
2062
  * resource with the same token as a resource that already exists, an exception occurs. If
1799
2063
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1806,10 +2070,12 @@ export interface CreateWirelessGatewayRequest {
1806
2070
  */
1807
2071
  export interface CreateWirelessGatewayResponse {
1808
2072
  /**
2073
+ * @public
1809
2074
  * <p>The Amazon Resource Name of the new resource.</p>
1810
2075
  */
1811
2076
  Arn?: string;
1812
2077
  /**
2078
+ * @public
1813
2079
  * <p>The ID of the new wireless gateway.</p>
1814
2080
  */
1815
2081
  Id?: string;
@@ -1819,10 +2085,12 @@ export interface CreateWirelessGatewayResponse {
1819
2085
  */
1820
2086
  export interface CreateWirelessGatewayTaskRequest {
1821
2087
  /**
2088
+ * @public
1822
2089
  * <p>The ID of the resource to update.</p>
1823
2090
  */
1824
2091
  Id: string | undefined;
1825
2092
  /**
2093
+ * @public
1826
2094
  * <p>The ID of the WirelessGatewayTaskDefinition.</p>
1827
2095
  */
1828
2096
  WirelessGatewayTaskDefinitionId: string | undefined;
@@ -1848,10 +2116,12 @@ export type WirelessGatewayTaskStatus = (typeof WirelessGatewayTaskStatus)[keyof
1848
2116
  */
1849
2117
  export interface CreateWirelessGatewayTaskResponse {
1850
2118
  /**
2119
+ * @public
1851
2120
  * <p>The ID of the WirelessGatewayTaskDefinition.</p>
1852
2121
  */
1853
2122
  WirelessGatewayTaskDefinitionId?: string;
1854
2123
  /**
2124
+ * @public
1855
2125
  * <p>The status of the request.</p>
1856
2126
  */
1857
2127
  Status?: WirelessGatewayTaskStatus | string;
@@ -1862,14 +2132,17 @@ export interface CreateWirelessGatewayTaskResponse {
1862
2132
  */
1863
2133
  export interface LoRaWANGatewayVersion {
1864
2134
  /**
2135
+ * @public
1865
2136
  * <p>The version of the wireless gateway firmware.</p>
1866
2137
  */
1867
2138
  PackageVersion?: string;
1868
2139
  /**
2140
+ * @public
1869
2141
  * <p>The model number of the wireless gateway.</p>
1870
2142
  */
1871
2143
  Model?: string;
1872
2144
  /**
2145
+ * @public
1873
2146
  * <p>The basic station version of the wireless gateway.</p>
1874
2147
  */
1875
2148
  Station?: string;
@@ -1880,18 +2153,22 @@ export interface LoRaWANGatewayVersion {
1880
2153
  */
1881
2154
  export interface LoRaWANUpdateGatewayTaskCreate {
1882
2155
  /**
2156
+ * @public
1883
2157
  * <p>The signature used to verify the update firmware.</p>
1884
2158
  */
1885
2159
  UpdateSignature?: string;
1886
2160
  /**
2161
+ * @public
1887
2162
  * <p>The CRC of the signature private key to check.</p>
1888
2163
  */
1889
2164
  SigKeyCrc?: number;
1890
2165
  /**
2166
+ * @public
1891
2167
  * <p>The version of the gateways that should receive the update.</p>
1892
2168
  */
1893
2169
  CurrentVersion?: LoRaWANGatewayVersion;
1894
2170
  /**
2171
+ * @public
1895
2172
  * <p>The firmware version to update the gateway to.</p>
1896
2173
  */
1897
2174
  UpdateVersion?: LoRaWANGatewayVersion;
@@ -1902,14 +2179,17 @@ export interface LoRaWANUpdateGatewayTaskCreate {
1902
2179
  */
1903
2180
  export interface UpdateWirelessGatewayTaskCreate {
1904
2181
  /**
2182
+ * @public
1905
2183
  * <p>The link to the S3 bucket.</p>
1906
2184
  */
1907
2185
  UpdateDataSource?: string;
1908
2186
  /**
2187
+ * @public
1909
2188
  * <p>The IAM role used to read data from the S3 bucket.</p>
1910
2189
  */
1911
2190
  UpdateDataRole?: string;
1912
2191
  /**
2192
+ * @public
1913
2193
  * <p>The properties that relate to the LoRaWAN wireless gateway.</p>
1914
2194
  */
1915
2195
  LoRaWAN?: LoRaWANUpdateGatewayTaskCreate;
@@ -1919,20 +2199,24 @@ export interface UpdateWirelessGatewayTaskCreate {
1919
2199
  */
1920
2200
  export interface CreateWirelessGatewayTaskDefinitionRequest {
1921
2201
  /**
2202
+ * @public
1922
2203
  * <p>Whether to automatically create tasks using this task definition for all gateways with
1923
2204
  * the specified current version. If <code>false</code>, the task must me created by
1924
2205
  * calling <code>CreateWirelessGatewayTask</code>.</p>
1925
2206
  */
1926
2207
  AutoCreateTasks: boolean | undefined;
1927
2208
  /**
2209
+ * @public
1928
2210
  * <p>The name of the new resource.</p>
1929
2211
  */
1930
2212
  Name?: string;
1931
2213
  /**
2214
+ * @public
1932
2215
  * <p>Information about the gateways to update.</p>
1933
2216
  */
1934
2217
  Update?: UpdateWirelessGatewayTaskCreate;
1935
2218
  /**
2219
+ * @public
1936
2220
  * <p>Each resource must have a unique client request token. If you try to create a new
1937
2221
  * resource with the same token as a resource that already exists, an exception occurs. If
1938
2222
  * you omit this value, AWS SDKs will automatically generate a unique client request.
@@ -1940,6 +2224,7 @@ export interface CreateWirelessGatewayTaskDefinitionRequest {
1940
2224
  */
1941
2225
  ClientRequestToken?: string;
1942
2226
  /**
2227
+ * @public
1943
2228
  * <p>The tags to attach to the specified resource. Tags are metadata that you can use to
1944
2229
  * manage a resource.</p>
1945
2230
  */
@@ -1950,10 +2235,12 @@ export interface CreateWirelessGatewayTaskDefinitionRequest {
1950
2235
  */
1951
2236
  export interface CreateWirelessGatewayTaskDefinitionResponse {
1952
2237
  /**
2238
+ * @public
1953
2239
  * <p>The ID of the new wireless gateway task definition.</p>
1954
2240
  */
1955
2241
  Id?: string;
1956
2242
  /**
2243
+ * @public
1957
2244
  * <p>The Amazon Resource Name of the resource.</p>
1958
2245
  */
1959
2246
  Arn?: string;
@@ -1964,23 +2251,28 @@ export interface CreateWirelessGatewayTaskDefinitionResponse {
1964
2251
  */
1965
2252
  export interface DakCertificateMetadata {
1966
2253
  /**
2254
+ * @public
1967
2255
  * <p>The certificate ID for the DAK.</p>
1968
2256
  */
1969
2257
  CertificateId: string | undefined;
1970
2258
  /**
2259
+ * @public
1971
2260
  * <p>The maximum number of signatures that the DAK can sign. A value of <code>-1</code> indicates
1972
2261
  * that there's no device limit.</p>
1973
2262
  */
1974
2263
  MaxAllowedSignature?: number;
1975
2264
  /**
2265
+ * @public
1976
2266
  * <p>Whether factory support has been enabled.</p>
1977
2267
  */
1978
2268
  FactorySupport?: boolean;
1979
2269
  /**
2270
+ * @public
1980
2271
  * <p>The advertised product ID (APID) that's used for pre-production and production applications.</p>
1981
2272
  */
1982
2273
  ApId?: string;
1983
2274
  /**
2275
+ * @public
1984
2276
  * <p>The device type ID that's used for prototyping applications.</p>
1985
2277
  */
1986
2278
  DeviceTypeId?: string;
@@ -1990,6 +2282,7 @@ export interface DakCertificateMetadata {
1990
2282
  */
1991
2283
  export interface DeleteDestinationRequest {
1992
2284
  /**
2285
+ * @public
1993
2286
  * <p>The name of the resource to delete.</p>
1994
2287
  */
1995
2288
  Name: string | undefined;
@@ -2004,6 +2297,7 @@ export interface DeleteDestinationResponse {
2004
2297
  */
2005
2298
  export interface DeleteDeviceProfileRequest {
2006
2299
  /**
2300
+ * @public
2007
2301
  * <p>The ID of the resource to delete.</p>
2008
2302
  */
2009
2303
  Id: string | undefined;
@@ -2018,6 +2312,7 @@ export interface DeleteDeviceProfileResponse {
2018
2312
  */
2019
2313
  export interface DeleteFuotaTaskRequest {
2020
2314
  /**
2315
+ * @public
2021
2316
  * <p>The ID of a FUOTA task.</p>
2022
2317
  */
2023
2318
  Id: string | undefined;
@@ -2032,6 +2327,7 @@ export interface DeleteFuotaTaskResponse {
2032
2327
  */
2033
2328
  export interface DeleteMulticastGroupRequest {
2034
2329
  /**
2330
+ * @public
2035
2331
  * <p>The ID of the multicast group.</p>
2036
2332
  */
2037
2333
  Id: string | undefined;
@@ -2046,6 +2342,7 @@ export interface DeleteMulticastGroupResponse {
2046
2342
  */
2047
2343
  export interface DeleteNetworkAnalyzerConfigurationRequest {
2048
2344
  /**
2345
+ * @public
2049
2346
  * <p>Name of the network analyzer configuration.</p>
2050
2347
  */
2051
2348
  ConfigurationName: string | undefined;
@@ -2060,16 +2357,19 @@ export interface DeleteNetworkAnalyzerConfigurationResponse {
2060
2357
  */
2061
2358
  export interface DeleteQueuedMessagesRequest {
2062
2359
  /**
2360
+ * @public
2063
2361
  * <p>The ID of a given wireless device for which downlink messages will be deleted.</p>
2064
2362
  */
2065
2363
  Id: string | undefined;
2066
2364
  /**
2365
+ * @public
2067
2366
  * <p>If message ID is <code>"*"</code>, it cleares the entire downlink queue for a given
2068
2367
  * device, specified by the wireless device ID. Otherwise, the downlink message with the
2069
2368
  * specified message ID will be deleted.</p>
2070
2369
  */
2071
2370
  MessageId: string | undefined;
2072
2371
  /**
2372
+ * @public
2073
2373
  * <p>The wireless device type, which can be either Sidewalk or LoRaWAN.</p>
2074
2374
  */
2075
2375
  WirelessDeviceType?: WirelessDeviceType | string;
@@ -2084,6 +2384,7 @@ export interface DeleteQueuedMessagesResponse {
2084
2384
  */
2085
2385
  export interface DeleteServiceProfileRequest {
2086
2386
  /**
2387
+ * @public
2087
2388
  * <p>The ID of the resource to delete.</p>
2088
2389
  */
2089
2390
  Id: string | undefined;
@@ -2098,6 +2399,7 @@ export interface DeleteServiceProfileResponse {
2098
2399
  */
2099
2400
  export interface DeleteWirelessDeviceRequest {
2100
2401
  /**
2402
+ * @public
2101
2403
  * <p>The ID of the resource to delete.</p>
2102
2404
  */
2103
2405
  Id: string | undefined;
@@ -2112,6 +2414,7 @@ export interface DeleteWirelessDeviceResponse {
2112
2414
  */
2113
2415
  export interface DeleteWirelessDeviceImportTaskRequest {
2114
2416
  /**
2417
+ * @public
2115
2418
  * <p>The unique identifier of the import task to be deleted.</p>
2116
2419
  */
2117
2420
  Id: string | undefined;
@@ -2126,6 +2429,7 @@ export interface DeleteWirelessDeviceImportTaskResponse {
2126
2429
  */
2127
2430
  export interface DeleteWirelessGatewayRequest {
2128
2431
  /**
2432
+ * @public
2129
2433
  * <p>The ID of the resource to delete.</p>
2130
2434
  */
2131
2435
  Id: string | undefined;
@@ -2140,6 +2444,7 @@ export interface DeleteWirelessGatewayResponse {
2140
2444
  */
2141
2445
  export interface DeleteWirelessGatewayTaskRequest {
2142
2446
  /**
2447
+ * @public
2143
2448
  * <p>The ID of the resource to delete.</p>
2144
2449
  */
2145
2450
  Id: string | undefined;
@@ -2154,6 +2459,7 @@ export interface DeleteWirelessGatewayTaskResponse {
2154
2459
  */
2155
2460
  export interface DeleteWirelessGatewayTaskDefinitionRequest {
2156
2461
  /**
2462
+ * @public
2157
2463
  * <p>The ID of the resource to delete.</p>
2158
2464
  */
2159
2465
  Id: string | undefined;
@@ -2168,10 +2474,12 @@ export interface DeleteWirelessGatewayTaskDefinitionResponse {
2168
2474
  */
2169
2475
  export interface DeregisterWirelessDeviceRequest {
2170
2476
  /**
2477
+ * @public
2171
2478
  * <p>The identifier of the wireless device to deregister from AWS IoT Wireless.</p>
2172
2479
  */
2173
2480
  Identifier: string | undefined;
2174
2481
  /**
2482
+ * @public
2175
2483
  * <p>The type of wireless device to deregister from AWS IoT Wireless, which can be <code>LoRaWAN</code>
2176
2484
  * or <code>Sidewalk</code>.</p>
2177
2485
  */
@@ -2188,26 +2496,32 @@ export interface DeregisterWirelessDeviceResponse {
2188
2496
  */
2189
2497
  export interface Destinations {
2190
2498
  /**
2499
+ * @public
2191
2500
  * <p>The Amazon Resource Name of the resource.</p>
2192
2501
  */
2193
2502
  Arn?: string;
2194
2503
  /**
2504
+ * @public
2195
2505
  * <p>The name of the resource.</p>
2196
2506
  */
2197
2507
  Name?: string;
2198
2508
  /**
2509
+ * @public
2199
2510
  * <p>The type of value in <code>Expression</code>.</p>
2200
2511
  */
2201
2512
  ExpressionType?: ExpressionType | string;
2202
2513
  /**
2514
+ * @public
2203
2515
  * <p>The rule name or topic rule to send messages to.</p>
2204
2516
  */
2205
2517
  Expression?: string;
2206
2518
  /**
2519
+ * @public
2207
2520
  * <p>The description of the resource.</p>
2208
2521
  */
2209
2522
  Description?: string;
2210
2523
  /**
2524
+ * @public
2211
2525
  * <p>The ARN of the IAM Role that authorizes the destination.</p>
2212
2526
  */
2213
2527
  RoleArn?: string;
@@ -2218,14 +2532,17 @@ export interface Destinations {
2218
2532
  */
2219
2533
  export interface DeviceProfile {
2220
2534
  /**
2535
+ * @public
2221
2536
  * <p>The Amazon Resource Name of the resource.</p>
2222
2537
  */
2223
2538
  Arn?: string;
2224
2539
  /**
2540
+ * @public
2225
2541
  * <p>The name of the resource.</p>
2226
2542
  */
2227
2543
  Name?: string;
2228
2544
  /**
2545
+ * @public
2229
2546
  * <p>The ID of the device profile.</p>
2230
2547
  */
2231
2548
  Id?: string;
@@ -2250,6 +2567,7 @@ export type DeviceProfileType = (typeof DeviceProfileType)[keyof typeof DevicePr
2250
2567
  */
2251
2568
  export interface SidewalkEventNotificationConfigurations {
2252
2569
  /**
2570
+ * @public
2253
2571
  * <p>Denotes whether the Amazon ID event topic is enabled or disabled.</p>
2254
2572
  */
2255
2573
  AmazonIdEventTopic?: EventNotificationTopicStatus | string;
@@ -2261,11 +2579,13 @@ export interface SidewalkEventNotificationConfigurations {
2261
2579
  */
2262
2580
  export interface DeviceRegistrationStateEventConfiguration {
2263
2581
  /**
2582
+ * @public
2264
2583
  * <p>Device registration state event configuration object for enabling or disabling
2265
2584
  * Sidewalk related event topics.</p>
2266
2585
  */
2267
2586
  Sidewalk?: SidewalkEventNotificationConfigurations;
2268
2587
  /**
2588
+ * @public
2269
2589
  * <p>Denotes whether the wireless device ID device registration state event topic is
2270
2590
  * enabled or disabled.</p>
2271
2591
  */
@@ -2278,6 +2598,7 @@ export interface DeviceRegistrationStateEventConfiguration {
2278
2598
  */
2279
2599
  export interface SidewalkResourceTypeEventConfiguration {
2280
2600
  /**
2601
+ * @public
2281
2602
  * <p>Denotes whether the wireless device join event topic is enabled or disabled.</p>
2282
2603
  */
2283
2604
  WirelessDeviceEventTopic?: EventNotificationTopicStatus | string;
@@ -2289,6 +2610,7 @@ export interface SidewalkResourceTypeEventConfiguration {
2289
2610
  */
2290
2611
  export interface DeviceRegistrationStateResourceTypeEventConfiguration {
2291
2612
  /**
2613
+ * @public
2292
2614
  * <p>Device registration resource type state event configuration object for enabling or
2293
2615
  * disabling Sidewalk related event topics.</p>
2294
2616
  */
@@ -2324,10 +2646,12 @@ export type PartnerType = (typeof PartnerType)[keyof typeof PartnerType];
2324
2646
  */
2325
2647
  export interface DisassociateAwsAccountFromPartnerAccountRequest {
2326
2648
  /**
2649
+ * @public
2327
2650
  * <p>The partner account ID to disassociate from the AWS account.</p>
2328
2651
  */
2329
2652
  PartnerAccountId: string | undefined;
2330
2653
  /**
2654
+ * @public
2331
2655
  * <p>The partner type.</p>
2332
2656
  */
2333
2657
  PartnerType: PartnerType | string | undefined;
@@ -2342,10 +2666,12 @@ export interface DisassociateAwsAccountFromPartnerAccountResponse {
2342
2666
  */
2343
2667
  export interface DisassociateMulticastGroupFromFuotaTaskRequest {
2344
2668
  /**
2669
+ * @public
2345
2670
  * <p>The ID of a FUOTA task.</p>
2346
2671
  */
2347
2672
  Id: string | undefined;
2348
2673
  /**
2674
+ * @public
2349
2675
  * <p>The ID of the multicast group.</p>
2350
2676
  */
2351
2677
  MulticastGroupId: string | undefined;
@@ -2360,10 +2686,12 @@ export interface DisassociateMulticastGroupFromFuotaTaskResponse {
2360
2686
  */
2361
2687
  export interface DisassociateWirelessDeviceFromFuotaTaskRequest {
2362
2688
  /**
2689
+ * @public
2363
2690
  * <p>The ID of a FUOTA task.</p>
2364
2691
  */
2365
2692
  Id: string | undefined;
2366
2693
  /**
2694
+ * @public
2367
2695
  * <p>The ID of the wireless device.</p>
2368
2696
  */
2369
2697
  WirelessDeviceId: string | undefined;
@@ -2378,10 +2706,12 @@ export interface DisassociateWirelessDeviceFromFuotaTaskResponse {
2378
2706
  */
2379
2707
  export interface DisassociateWirelessDeviceFromMulticastGroupRequest {
2380
2708
  /**
2709
+ * @public
2381
2710
  * <p>The ID of the multicast group.</p>
2382
2711
  */
2383
2712
  Id: string | undefined;
2384
2713
  /**
2714
+ * @public
2385
2715
  * <p>The ID of the wireless device.</p>
2386
2716
  */
2387
2717
  WirelessDeviceId: string | undefined;
@@ -2396,6 +2726,7 @@ export interface DisassociateWirelessDeviceFromMulticastGroupResponse {
2396
2726
  */
2397
2727
  export interface DisassociateWirelessDeviceFromThingRequest {
2398
2728
  /**
2729
+ * @public
2399
2730
  * <p>The ID of the resource to update.</p>
2400
2731
  */
2401
2732
  Id: string | undefined;
@@ -2410,6 +2741,7 @@ export interface DisassociateWirelessDeviceFromThingResponse {
2410
2741
  */
2411
2742
  export interface DisassociateWirelessGatewayFromCertificateRequest {
2412
2743
  /**
2744
+ * @public
2413
2745
  * <p>The ID of the resource to update.</p>
2414
2746
  */
2415
2747
  Id: string | undefined;
@@ -2424,6 +2756,7 @@ export interface DisassociateWirelessGatewayFromCertificateResponse {
2424
2756
  */
2425
2757
  export interface DisassociateWirelessGatewayFromThingRequest {
2426
2758
  /**
2759
+ * @public
2427
2760
  * <p>The ID of the resource to update.</p>
2428
2761
  */
2429
2762
  Id: string | undefined;
@@ -2453,11 +2786,13 @@ export type DownlinkMode = (typeof DownlinkMode)[keyof typeof DownlinkMode];
2453
2786
  */
2454
2787
  export interface GatewayListItem {
2455
2788
  /**
2789
+ * @public
2456
2790
  * <p>The ID of the wireless gateways that you want to add to the list of gateways when
2457
2791
  * sending downlink messages.</p>
2458
2792
  */
2459
2793
  GatewayId: string | undefined;
2460
2794
  /**
2795
+ * @public
2461
2796
  * <p>The frequency to use for the gateways when sending a downlink message to the wireless
2462
2797
  * device.</p>
2463
2798
  */
@@ -2470,16 +2805,19 @@ export interface GatewayListItem {
2470
2805
  */
2471
2806
  export interface ParticipatingGateways {
2472
2807
  /**
2808
+ * @public
2473
2809
  * <p>Indicates whether to send the downlink message in sequential mode or concurrent mode,
2474
2810
  * or to use only the chosen gateways from the previous uplink message transmission.</p>
2475
2811
  */
2476
2812
  DownlinkMode: DownlinkMode | string | undefined;
2477
2813
  /**
2814
+ * @public
2478
2815
  * <p>The list of gateways that you want to use for sending the downlink data
2479
2816
  * traffic.</p>
2480
2817
  */
2481
2818
  GatewayList: GatewayListItem[] | undefined;
2482
2819
  /**
2820
+ * @public
2483
2821
  * <p>The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting
2484
2822
  * the payload to the next gateway.</p>
2485
2823
  */
@@ -2491,10 +2829,12 @@ export interface ParticipatingGateways {
2491
2829
  */
2492
2830
  export interface LoRaWANSendDataToDevice {
2493
2831
  /**
2832
+ * @public
2494
2833
  * <p>The Fport value.</p>
2495
2834
  */
2496
2835
  FPort?: number;
2497
2836
  /**
2837
+ * @public
2498
2838
  * <p>Choose the gateways that you want to use for the downlink data traffic when the
2499
2839
  * wireless device is running in class B or class C mode.</p>
2500
2840
  */
@@ -2506,21 +2846,25 @@ export interface LoRaWANSendDataToDevice {
2506
2846
  */
2507
2847
  export interface DownlinkQueueMessage {
2508
2848
  /**
2849
+ * @public
2509
2850
  * <p> The message ID assigned by IoT Wireless to each downlink message, which helps
2510
2851
  * identify the message.</p>
2511
2852
  */
2512
2853
  MessageId?: string;
2513
2854
  /**
2855
+ * @public
2514
2856
  * <p>The transmit mode to use for sending data to the wireless device. This can be
2515
2857
  * <code>0</code> for UM (unacknowledge mode) or <code>1</code> for AM (acknowledge
2516
2858
  * mode).</p>
2517
2859
  */
2518
2860
  TransmitMode?: number;
2519
2861
  /**
2862
+ * @public
2520
2863
  * <p>The time at which Iot Wireless received the downlink message.</p>
2521
2864
  */
2522
2865
  ReceivedAt?: string;
2523
2866
  /**
2867
+ * @public
2524
2868
  * <p>LoRaWAN router info.</p>
2525
2869
  */
2526
2870
  LoRaWAN?: LoRaWANSendDataToDevice;
@@ -2546,6 +2890,7 @@ export type Event = (typeof Event)[keyof typeof Event];
2546
2890
  */
2547
2891
  export interface LoRaWANJoinEventNotificationConfigurations {
2548
2892
  /**
2893
+ * @public
2549
2894
  * <p>Denotes whether the Dev EUI join event topic is enabled or disabled.</p>
2550
2895
  */
2551
2896
  DevEuiEventTopic?: EventNotificationTopicStatus | string;
@@ -2556,11 +2901,13 @@ export interface LoRaWANJoinEventNotificationConfigurations {
2556
2901
  */
2557
2902
  export interface JoinEventConfiguration {
2558
2903
  /**
2904
+ * @public
2559
2905
  * <p>Join event configuration object for enabling or disabling LoRaWAN related event
2560
2906
  * topics.</p>
2561
2907
  */
2562
2908
  LoRaWAN?: LoRaWANJoinEventNotificationConfigurations;
2563
2909
  /**
2910
+ * @public
2564
2911
  * <p>Denotes whether the wireless device ID join event topic is enabled or disabled.</p>
2565
2912
  */
2566
2913
  WirelessDeviceIdEventTopic?: EventNotificationTopicStatus | string;
@@ -2572,12 +2919,14 @@ export interface JoinEventConfiguration {
2572
2919
  */
2573
2920
  export interface MessageDeliveryStatusEventConfiguration {
2574
2921
  /**
2922
+ * @public
2575
2923
  * <p>
2576
2924
  * <code>SidewalkEventNotificationConfigurations</code> object, which is the event
2577
2925
  * configuration object for Sidewalk-related event topics.</p>
2578
2926
  */
2579
2927
  Sidewalk?: SidewalkEventNotificationConfigurations;
2580
2928
  /**
2929
+ * @public
2581
2930
  * <p>Denotes whether the wireless device ID message delivery status event topic is enabled
2582
2931
  * or disabled.</p>
2583
2932
  */
@@ -2590,11 +2939,13 @@ export interface MessageDeliveryStatusEventConfiguration {
2590
2939
  */
2591
2940
  export interface ProximityEventConfiguration {
2592
2941
  /**
2942
+ * @public
2593
2943
  * <p>Proximity event configuration object for enabling or disabling Sidewalk related event
2594
2944
  * topics.</p>
2595
2945
  */
2596
2946
  Sidewalk?: SidewalkEventNotificationConfigurations;
2597
2947
  /**
2948
+ * @public
2598
2949
  * <p>Denotes whether the wireless device ID proximity event topic is enabled or
2599
2950
  * disabled.</p>
2600
2951
  */
@@ -2606,22 +2957,27 @@ export interface ProximityEventConfiguration {
2606
2957
  */
2607
2958
  export interface EventNotificationItemConfigurations {
2608
2959
  /**
2960
+ * @public
2609
2961
  * <p>Device registration state event configuration for an event configuration item.</p>
2610
2962
  */
2611
2963
  DeviceRegistrationState?: DeviceRegistrationStateEventConfiguration;
2612
2964
  /**
2965
+ * @public
2613
2966
  * <p>Proximity event configuration for an event configuration item.</p>
2614
2967
  */
2615
2968
  Proximity?: ProximityEventConfiguration;
2616
2969
  /**
2970
+ * @public
2617
2971
  * <p>Join event configuration for an event configuration item.</p>
2618
2972
  */
2619
2973
  Join?: JoinEventConfiguration;
2620
2974
  /**
2975
+ * @public
2621
2976
  * <p>Connection status event configuration for an event configuration item.</p>
2622
2977
  */
2623
2978
  ConnectionStatus?: ConnectionStatusEventConfiguration;
2624
2979
  /**
2980
+ * @public
2625
2981
  * <p>Message delivery status event configuration for an event configuration item.</p>
2626
2982
  */
2627
2983
  MessageDeliveryStatus?: MessageDeliveryStatusEventConfiguration;
@@ -2658,18 +3014,22 @@ export type EventNotificationPartnerType = (typeof EventNotificationPartnerType)
2658
3014
  */
2659
3015
  export interface EventConfigurationItem {
2660
3016
  /**
3017
+ * @public
2661
3018
  * <p>Resource identifier opted in for event messaging.</p>
2662
3019
  */
2663
3020
  Identifier?: string;
2664
3021
  /**
3022
+ * @public
2665
3023
  * <p>Identifier type of the particular resource identifier for event configuration.</p>
2666
3024
  */
2667
3025
  IdentifierType?: IdentifierType | string;
2668
3026
  /**
3027
+ * @public
2669
3028
  * <p>Partner type of the resource if the identifier type is PartnerAccountId.</p>
2670
3029
  */
2671
3030
  PartnerType?: EventNotificationPartnerType | string;
2672
3031
  /**
3032
+ * @public
2673
3033
  * <p>Object of all event configurations and the status of the event topics.</p>
2674
3034
  */
2675
3035
  Events?: EventNotificationItemConfigurations;
@@ -2714,14 +3074,17 @@ export type FuotaDeviceStatus = (typeof FuotaDeviceStatus)[keyof typeof FuotaDev
2714
3074
  */
2715
3075
  export interface FuotaTask {
2716
3076
  /**
3077
+ * @public
2717
3078
  * <p>The ID of a FUOTA task.</p>
2718
3079
  */
2719
3080
  Id?: string;
2720
3081
  /**
3082
+ * @public
2721
3083
  * <p>The arn of a FUOTA task.</p>
2722
3084
  */
2723
3085
  Arn?: string;
2724
3086
  /**
3087
+ * @public
2725
3088
  * <p>The name of a FUOTA task.</p>
2726
3089
  */
2727
3090
  Name?: string;
@@ -2746,6 +3109,7 @@ export type FuotaTaskStatus = (typeof FuotaTaskStatus)[keyof typeof FuotaTaskSta
2746
3109
  */
2747
3110
  export interface GetDestinationRequest {
2748
3111
  /**
3112
+ * @public
2749
3113
  * <p>The name of the resource to get.</p>
2750
3114
  */
2751
3115
  Name: string | undefined;
@@ -2755,26 +3119,32 @@ export interface GetDestinationRequest {
2755
3119
  */
2756
3120
  export interface GetDestinationResponse {
2757
3121
  /**
3122
+ * @public
2758
3123
  * <p>The Amazon Resource Name of the resource.</p>
2759
3124
  */
2760
3125
  Arn?: string;
2761
3126
  /**
3127
+ * @public
2762
3128
  * <p>The name of the resource.</p>
2763
3129
  */
2764
3130
  Name?: string;
2765
3131
  /**
3132
+ * @public
2766
3133
  * <p>The rule name or topic rule to send messages to.</p>
2767
3134
  */
2768
3135
  Expression?: string;
2769
3136
  /**
3137
+ * @public
2770
3138
  * <p>The type of value in <code>Expression</code>.</p>
2771
3139
  */
2772
3140
  ExpressionType?: ExpressionType | string;
2773
3141
  /**
3142
+ * @public
2774
3143
  * <p>The description of the resource.</p>
2775
3144
  */
2776
3145
  Description?: string;
2777
3146
  /**
3147
+ * @public
2778
3148
  * <p>The ARN of the IAM Role that authorizes the destination.</p>
2779
3149
  */
2780
3150
  RoleArn?: string;
@@ -2784,6 +3154,7 @@ export interface GetDestinationResponse {
2784
3154
  */
2785
3155
  export interface GetDeviceProfileRequest {
2786
3156
  /**
3157
+ * @public
2787
3158
  * <p>The ID of the resource to get.</p>
2788
3159
  */
2789
3160
  Id: string | undefined;
@@ -2794,14 +3165,17 @@ export interface GetDeviceProfileRequest {
2794
3165
  */
2795
3166
  export interface SidewalkGetDeviceProfile {
2796
3167
  /**
3168
+ * @public
2797
3169
  * <p>The Sidewalk application server public key.</p>
2798
3170
  */
2799
3171
  ApplicationServerPublicKey?: string;
2800
3172
  /**
3173
+ * @public
2801
3174
  * <p>Gets information about the certification status of a Sidewalk device profile.</p>
2802
3175
  */
2803
3176
  QualificationStatus?: boolean;
2804
3177
  /**
3178
+ * @public
2805
3179
  * <p>The DAK certificate information of the Sidewalk device profile.</p>
2806
3180
  */
2807
3181
  DakCertificateMetadata?: DakCertificateMetadata[];
@@ -2811,22 +3185,27 @@ export interface SidewalkGetDeviceProfile {
2811
3185
  */
2812
3186
  export interface GetDeviceProfileResponse {
2813
3187
  /**
3188
+ * @public
2814
3189
  * <p>The Amazon Resource Name of the resource.</p>
2815
3190
  */
2816
3191
  Arn?: string;
2817
3192
  /**
3193
+ * @public
2818
3194
  * <p>The name of the resource.</p>
2819
3195
  */
2820
3196
  Name?: string;
2821
3197
  /**
3198
+ * @public
2822
3199
  * <p>The ID of the device profile.</p>
2823
3200
  */
2824
3201
  Id?: string;
2825
3202
  /**
3203
+ * @public
2826
3204
  * <p>Information about the device profile.</p>
2827
3205
  */
2828
3206
  LoRaWAN?: LoRaWANDeviceProfile;
2829
3207
  /**
3208
+ * @public
2830
3209
  * <p>Information about the Sidewalk parameters in the device profile.</p>
2831
3210
  */
2832
3211
  Sidewalk?: SidewalkGetDeviceProfile;
@@ -2842,6 +3221,7 @@ export interface GetEventConfigurationByResourceTypesRequest {
2842
3221
  */
2843
3222
  export interface LoRaWANJoinResourceTypeEventConfiguration {
2844
3223
  /**
3224
+ * @public
2845
3225
  * <p>Denotes whether the wireless device join event topic is enabled or disabled.</p>
2846
3226
  */
2847
3227
  WirelessDeviceEventTopic?: EventNotificationTopicStatus | string;
@@ -2852,6 +3232,7 @@ export interface LoRaWANJoinResourceTypeEventConfiguration {
2852
3232
  */
2853
3233
  export interface JoinResourceTypeEventConfiguration {
2854
3234
  /**
3235
+ * @public
2855
3236
  * <p>Join resource type event configuration object for enabling or disabling LoRaWAN
2856
3237
  * related event topics.</p>
2857
3238
  */
@@ -2864,6 +3245,7 @@ export interface JoinResourceTypeEventConfiguration {
2864
3245
  */
2865
3246
  export interface MessageDeliveryStatusResourceTypeEventConfiguration {
2866
3247
  /**
3248
+ * @public
2867
3249
  * <p>Sidewalk resource type event configuration object for enabling or disabling
2868
3250
  * topic.</p>
2869
3251
  */
@@ -2876,6 +3258,7 @@ export interface MessageDeliveryStatusResourceTypeEventConfiguration {
2876
3258
  */
2877
3259
  export interface ProximityResourceTypeEventConfiguration {
2878
3260
  /**
3261
+ * @public
2879
3262
  * <p>Proximity resource type event configuration object for enabling and disabling wireless
2880
3263
  * device topic.</p>
2881
3264
  */
@@ -2886,22 +3269,27 @@ export interface ProximityResourceTypeEventConfiguration {
2886
3269
  */
2887
3270
  export interface GetEventConfigurationByResourceTypesResponse {
2888
3271
  /**
3272
+ * @public
2889
3273
  * <p>Resource type event configuration for the device registration state event.</p>
2890
3274
  */
2891
3275
  DeviceRegistrationState?: DeviceRegistrationStateResourceTypeEventConfiguration;
2892
3276
  /**
3277
+ * @public
2893
3278
  * <p>Resource type event configuration for the proximity event.</p>
2894
3279
  */
2895
3280
  Proximity?: ProximityResourceTypeEventConfiguration;
2896
3281
  /**
3282
+ * @public
2897
3283
  * <p>Resource type event configuration for the join event.</p>
2898
3284
  */
2899
3285
  Join?: JoinResourceTypeEventConfiguration;
2900
3286
  /**
3287
+ * @public
2901
3288
  * <p>Resource type event configuration for the connection status event.</p>
2902
3289
  */
2903
3290
  ConnectionStatus?: ConnectionStatusResourceTypeEventConfiguration;
2904
3291
  /**
3292
+ * @public
2905
3293
  * <p>Resource type event configuration object for the message delivery status event.</p>
2906
3294
  */
2907
3295
  MessageDeliveryStatus?: MessageDeliveryStatusResourceTypeEventConfiguration;
@@ -2911,6 +3299,7 @@ export interface GetEventConfigurationByResourceTypesResponse {
2911
3299
  */
2912
3300
  export interface GetFuotaTaskRequest {
2913
3301
  /**
3302
+ * @public
2914
3303
  * <p>The ID of a FUOTA task.</p>
2915
3304
  */
2916
3305
  Id: string | undefined;
@@ -2921,10 +3310,12 @@ export interface GetFuotaTaskRequest {
2921
3310
  */
2922
3311
  export interface LoRaWANFuotaTaskGetInfo {
2923
3312
  /**
3313
+ * @public
2924
3314
  * <p>The frequency band (RFRegion) value.</p>
2925
3315
  */
2926
3316
  RfRegion?: string;
2927
3317
  /**
3318
+ * @public
2928
3319
  * <p>Start time of a FUOTA task.</p>
2929
3320
  */
2930
3321
  StartTime?: Date;
@@ -2934,43 +3325,53 @@ export interface LoRaWANFuotaTaskGetInfo {
2934
3325
  */
2935
3326
  export interface GetFuotaTaskResponse {
2936
3327
  /**
3328
+ * @public
2937
3329
  * <p>The arn of a FUOTA task.</p>
2938
3330
  */
2939
3331
  Arn?: string;
2940
3332
  /**
3333
+ * @public
2941
3334
  * <p>The ID of a FUOTA task.</p>
2942
3335
  */
2943
3336
  Id?: string;
2944
3337
  /**
3338
+ * @public
2945
3339
  * <p>The status of a FUOTA task.</p>
2946
3340
  */
2947
3341
  Status?: FuotaTaskStatus | string;
2948
3342
  /**
3343
+ * @public
2949
3344
  * <p>The name of a FUOTA task.</p>
2950
3345
  */
2951
3346
  Name?: string;
2952
3347
  /**
3348
+ * @public
2953
3349
  * <p>The description of the new resource.</p>
2954
3350
  */
2955
3351
  Description?: string;
2956
3352
  /**
3353
+ * @public
2957
3354
  * <p>The LoRaWAN information returned from getting a FUOTA task.</p>
2958
3355
  */
2959
3356
  LoRaWAN?: LoRaWANFuotaTaskGetInfo;
2960
3357
  /**
3358
+ * @public
2961
3359
  * <p>The S3 URI points to a firmware update image that is to be used with a FUOTA
2962
3360
  * task.</p>
2963
3361
  */
2964
3362
  FirmwareUpdateImage?: string;
2965
3363
  /**
3364
+ * @public
2966
3365
  * <p>The firmware update role that is to be used with a FUOTA task.</p>
2967
3366
  */
2968
3367
  FirmwareUpdateRole?: string;
2969
3368
  /**
3369
+ * @public
2970
3370
  * <p>Created at timestamp for the resource.</p>
2971
3371
  */
2972
3372
  CreatedAt?: Date;
2973
3373
  /**
3374
+ * @public
2974
3375
  * <p>The percentage of the added fragments that are redundant. For example, if the size of
2975
3376
  * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
2976
3377
  * <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments
@@ -2978,11 +3379,13 @@ export interface GetFuotaTaskResponse {
2978
3379
  */
2979
3380
  RedundancyPercent?: number;
2980
3381
  /**
3382
+ * @public
2981
3383
  * <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks
2982
3384
  * with multicast groups.</p>
2983
3385
  */
2984
3386
  FragmentSizeBytes?: number;
2985
3387
  /**
3388
+ * @public
2986
3389
  * <p>The interval for sending fragments in milliseconds, rounded to the nearest
2987
3390
  * second.</p>
2988
3391
  * <note>
@@ -3025,10 +3428,12 @@ export type WirelessDeviceEvent = (typeof WirelessDeviceEvent)[keyof typeof Wire
3025
3428
  */
3026
3429
  export interface WirelessDeviceEventLogOption {
3027
3430
  /**
3431
+ * @public
3028
3432
  * <p>The event for a log message, if the log message is tied to a wireless device.</p>
3029
3433
  */
3030
3434
  Event: WirelessDeviceEvent | string | undefined;
3031
3435
  /**
3436
+ * @public
3032
3437
  * <p>The log level for a log message. The log levels can be disabled, or set to
3033
3438
  * <code>ERROR</code> to display less verbose logs containing only error information,
3034
3439
  * or to <code>INFO</code> for more detailed logs.</p>
@@ -3042,16 +3447,19 @@ export interface WirelessDeviceEventLogOption {
3042
3447
  */
3043
3448
  export interface WirelessDeviceLogOption {
3044
3449
  /**
3450
+ * @public
3045
3451
  * <p>The wireless device type.</p>
3046
3452
  */
3047
3453
  Type: WirelessDeviceType | string | undefined;
3048
3454
  /**
3455
+ * @public
3049
3456
  * <p>The log level for a log message. The log levels can be disabled, or set to
3050
3457
  * <code>ERROR</code> to display less verbose logs containing only error information,
3051
3458
  * or to <code>INFO</code> for more detailed logs.</p>
3052
3459
  */
3053
3460
  LogLevel: LogLevel | string | undefined;
3054
3461
  /**
3462
+ * @public
3055
3463
  * <p>The list of wireless device event log options.</p>
3056
3464
  */
3057
3465
  Events?: WirelessDeviceEventLogOption[];
@@ -3077,10 +3485,12 @@ export type WirelessGatewayEvent = (typeof WirelessGatewayEvent)[keyof typeof Wi
3077
3485
  */
3078
3486
  export interface WirelessGatewayEventLogOption {
3079
3487
  /**
3488
+ * @public
3080
3489
  * <p>The event for a log message, if the log message is tied to a wireless gateway.</p>
3081
3490
  */
3082
3491
  Event: WirelessGatewayEvent | string | undefined;
3083
3492
  /**
3493
+ * @public
3084
3494
  * <p>The log level for a log message. The log levels can be disabled, or set to
3085
3495
  * <code>ERROR</code> to display less verbose logs containing only error information,
3086
3496
  * or to <code>INFO</code> for more detailed logs.</p>
@@ -3105,16 +3515,19 @@ export type WirelessGatewayType = (typeof WirelessGatewayType)[keyof typeof Wire
3105
3515
  */
3106
3516
  export interface WirelessGatewayLogOption {
3107
3517
  /**
3518
+ * @public
3108
3519
  * <p>The wireless gateway type.</p>
3109
3520
  */
3110
3521
  Type: WirelessGatewayType | string | undefined;
3111
3522
  /**
3523
+ * @public
3112
3524
  * <p>The log level for a log message. The log levels can be disabled, or set to
3113
3525
  * <code>ERROR</code> to display less verbose logs containing only error information,
3114
3526
  * or to <code>INFO</code> for more detailed logs.</p>
3115
3527
  */
3116
3528
  LogLevel: LogLevel | string | undefined;
3117
3529
  /**
3530
+ * @public
3118
3531
  * <p>The list of wireless gateway event log options.</p>
3119
3532
  */
3120
3533
  Events?: WirelessGatewayEventLogOption[];
@@ -3124,16 +3537,19 @@ export interface WirelessGatewayLogOption {
3124
3537
  */
3125
3538
  export interface GetLogLevelsByResourceTypesResponse {
3126
3539
  /**
3540
+ * @public
3127
3541
  * <p>The log level for a log message. The log levels can be disabled, or set to
3128
3542
  * <code>ERROR</code> to display less verbose logs containing only error information,
3129
3543
  * or to <code>INFO</code> for more detailed logs.</p>
3130
3544
  */
3131
3545
  DefaultLogLevel?: LogLevel | string;
3132
3546
  /**
3547
+ * @public
3133
3548
  * <p>The list of wireless gateway log options.</p>
3134
3549
  */
3135
3550
  WirelessGatewayLogOptions?: WirelessGatewayLogOption[];
3136
3551
  /**
3552
+ * @public
3137
3553
  * <p>The list of wireless device log options.</p>
3138
3554
  */
3139
3555
  WirelessDeviceLogOptions?: WirelessDeviceLogOption[];
@@ -3143,6 +3559,7 @@ export interface GetLogLevelsByResourceTypesResponse {
3143
3559
  */
3144
3560
  export interface GetMulticastGroupRequest {
3145
3561
  /**
3562
+ * @public
3146
3563
  * <p>The ID of the multicast group.</p>
3147
3564
  */
3148
3565
  Id: string | undefined;
@@ -3154,18 +3571,22 @@ export interface GetMulticastGroupRequest {
3154
3571
  */
3155
3572
  export interface LoRaWANMulticastGet {
3156
3573
  /**
3574
+ * @public
3157
3575
  * <p>Supported RfRegions</p>
3158
3576
  */
3159
3577
  RfRegion?: SupportedRfRegion | string;
3160
3578
  /**
3579
+ * @public
3161
3580
  * <p>DlClass for LoRaWAM, valid values are ClassB and ClassC.</p>
3162
3581
  */
3163
3582
  DlClass?: DlClass | string;
3164
3583
  /**
3584
+ * @public
3165
3585
  * <p>Number of devices that are requested to be associated with the multicast group.</p>
3166
3586
  */
3167
3587
  NumberOfDevicesRequested?: number;
3168
3588
  /**
3589
+ * @public
3169
3590
  * <p>Number of devices that are associated to the multicast group.</p>
3170
3591
  */
3171
3592
  NumberOfDevicesInGroup?: number;
@@ -3175,31 +3596,38 @@ export interface LoRaWANMulticastGet {
3175
3596
  */
3176
3597
  export interface GetMulticastGroupResponse {
3177
3598
  /**
3599
+ * @public
3178
3600
  * <p>The arn of the multicast group.</p>
3179
3601
  */
3180
3602
  Arn?: string;
3181
3603
  /**
3604
+ * @public
3182
3605
  * <p>The ID of the multicast group.</p>
3183
3606
  */
3184
3607
  Id?: string;
3185
3608
  /**
3609
+ * @public
3186
3610
  * <p>The name of the multicast group.</p>
3187
3611
  */
3188
3612
  Name?: string;
3189
3613
  /**
3614
+ * @public
3190
3615
  * <p>The description of the new resource.</p>
3191
3616
  */
3192
3617
  Description?: string;
3193
3618
  /**
3619
+ * @public
3194
3620
  * <p>The status of the multicast group.</p>
3195
3621
  */
3196
3622
  Status?: string;
3197
3623
  /**
3624
+ * @public
3198
3625
  * <p>The LoRaWAN information that is to be returned from getting multicast group
3199
3626
  * information.</p>
3200
3627
  */
3201
3628
  LoRaWAN?: LoRaWANMulticastGet;
3202
3629
  /**
3630
+ * @public
3203
3631
  * <p>Created at timestamp for the resource.</p>
3204
3632
  */
3205
3633
  CreatedAt?: Date;
@@ -3209,6 +3637,7 @@ export interface GetMulticastGroupResponse {
3209
3637
  */
3210
3638
  export interface GetMulticastGroupSessionRequest {
3211
3639
  /**
3640
+ * @public
3212
3641
  * <p>The ID of the multicast group.</p>
3213
3642
  */
3214
3643
  Id: string | undefined;
@@ -3219,22 +3648,27 @@ export interface GetMulticastGroupSessionRequest {
3219
3648
  */
3220
3649
  export interface LoRaWANMulticastSession {
3221
3650
  /**
3651
+ * @public
3222
3652
  * <p>Downlink data rate.</p>
3223
3653
  */
3224
3654
  DlDr?: number;
3225
3655
  /**
3656
+ * @public
3226
3657
  * <p>Downlink frequency.</p>
3227
3658
  */
3228
3659
  DlFreq?: number;
3229
3660
  /**
3661
+ * @public
3230
3662
  * <p>Timestamp of when the multicast group session is to start.</p>
3231
3663
  */
3232
3664
  SessionStartTime?: Date;
3233
3665
  /**
3666
+ * @public
3234
3667
  * <p>How long before a multicast group session is to timeout.</p>
3235
3668
  */
3236
3669
  SessionTimeout?: number;
3237
3670
  /**
3671
+ * @public
3238
3672
  * <p>The PingSlotPeriod value.</p>
3239
3673
  */
3240
3674
  PingSlotPeriod?: number;
@@ -3244,6 +3678,7 @@ export interface LoRaWANMulticastSession {
3244
3678
  */
3245
3679
  export interface GetMulticastGroupSessionResponse {
3246
3680
  /**
3681
+ * @public
3247
3682
  * <p>The LoRaWAN information used with the multicast session.</p>
3248
3683
  */
3249
3684
  LoRaWAN?: LoRaWANMulticastSession;
@@ -3253,6 +3688,7 @@ export interface GetMulticastGroupSessionResponse {
3253
3688
  */
3254
3689
  export interface GetNetworkAnalyzerConfigurationRequest {
3255
3690
  /**
3691
+ * @public
3256
3692
  * <p>Name of the network analyzer configuration.</p>
3257
3693
  */
3258
3694
  ConfigurationName: string | undefined;
@@ -3262,32 +3698,39 @@ export interface GetNetworkAnalyzerConfigurationRequest {
3262
3698
  */
3263
3699
  export interface GetNetworkAnalyzerConfigurationResponse {
3264
3700
  /**
3701
+ * @public
3265
3702
  * <p>Trace content for your wireless gateway and wireless device resources.</p>
3266
3703
  */
3267
3704
  TraceContent?: TraceContent;
3268
3705
  /**
3706
+ * @public
3269
3707
  * <p>List of wireless gateway resources that have been added to the network analyzer
3270
3708
  * configuration.</p>
3271
3709
  */
3272
3710
  WirelessDevices?: string[];
3273
3711
  /**
3712
+ * @public
3274
3713
  * <p>List of wireless gateway resources that have been added to the network analyzer
3275
3714
  * configuration.</p>
3276
3715
  */
3277
3716
  WirelessGateways?: string[];
3278
3717
  /**
3718
+ * @public
3279
3719
  * <p>The description of the new resource.</p>
3280
3720
  */
3281
3721
  Description?: string;
3282
3722
  /**
3723
+ * @public
3283
3724
  * <p>The Amazon Resource Name of the new resource.</p>
3284
3725
  */
3285
3726
  Arn?: string;
3286
3727
  /**
3728
+ * @public
3287
3729
  * <p>Name of the network analyzer configuration.</p>
3288
3730
  */
3289
3731
  Name?: string;
3290
3732
  /**
3733
+ * @public
3291
3734
  * <p>List of multicast group resources that have been added to the network analyzer
3292
3735
  * configuration.</p>
3293
3736
  */
@@ -3298,10 +3741,12 @@ export interface GetNetworkAnalyzerConfigurationResponse {
3298
3741
  */
3299
3742
  export interface GetPartnerAccountRequest {
3300
3743
  /**
3744
+ * @public
3301
3745
  * <p>The partner account ID to disassociate from the AWS account.</p>
3302
3746
  */
3303
3747
  PartnerAccountId: string | undefined;
3304
3748
  /**
3749
+ * @public
3305
3750
  * <p>The partner type.</p>
3306
3751
  */
3307
3752
  PartnerType: PartnerType | string | undefined;
@@ -3312,14 +3757,17 @@ export interface GetPartnerAccountRequest {
3312
3757
  */
3313
3758
  export interface SidewalkAccountInfoWithFingerprint {
3314
3759
  /**
3760
+ * @public
3315
3761
  * <p>The Sidewalk Amazon ID.</p>
3316
3762
  */
3317
3763
  AmazonId?: string;
3318
3764
  /**
3765
+ * @public
3319
3766
  * <p>The fingerprint of the Sidewalk application server private key.</p>
3320
3767
  */
3321
3768
  Fingerprint?: string;
3322
3769
  /**
3770
+ * @public
3323
3771
  * <p>The Amazon Resource Name of the resource.</p>
3324
3772
  */
3325
3773
  Arn?: string;
@@ -3329,10 +3777,12 @@ export interface SidewalkAccountInfoWithFingerprint {
3329
3777
  */
3330
3778
  export interface GetPartnerAccountResponse {
3331
3779
  /**
3780
+ * @public
3332
3781
  * <p>The Sidewalk account credentials.</p>
3333
3782
  */
3334
3783
  Sidewalk?: SidewalkAccountInfoWithFingerprint;
3335
3784
  /**
3785
+ * @public
3336
3786
  * <p>Whether the partner account is linked to the AWS account.</p>
3337
3787
  */
3338
3788
  AccountLinked?: boolean;
@@ -3354,10 +3804,12 @@ export type PositionResourceType = (typeof PositionResourceType)[keyof typeof Po
3354
3804
  */
3355
3805
  export interface GetPositionRequest {
3356
3806
  /**
3807
+ * @public
3357
3808
  * <p>Resource identifier used to retrieve the position information.</p>
3358
3809
  */
3359
3810
  ResourceIdentifier: string | undefined;
3360
3811
  /**
3812
+ * @public
3361
3813
  * <p>Resource type of the resource for which position information is retrieved.</p>
3362
3814
  */
3363
3815
  ResourceType: PositionResourceType | string | undefined;
@@ -3389,10 +3841,12 @@ export type PositionSolverType = (typeof PositionSolverType)[keyof typeof Positi
3389
3841
  */
3390
3842
  export interface GetPositionResponse {
3391
3843
  /**
3844
+ * @public
3392
3845
  * <p>The position information of the resource.</p>
3393
3846
  */
3394
3847
  Position?: number[];
3395
3848
  /**
3849
+ * @public
3396
3850
  * <p>The accuracy of the estimated position in meters. An empty value indicates that no
3397
3851
  * position data is available. A value of ‘0.0’ value indicates that position data is
3398
3852
  * available. This data corresponds to the position information that you specified instead
@@ -3400,18 +3854,22 @@ export interface GetPositionResponse {
3400
3854
  */
3401
3855
  Accuracy?: Accuracy;
3402
3856
  /**
3857
+ * @public
3403
3858
  * <p>The type of solver used to identify the position of the resource.</p>
3404
3859
  */
3405
3860
  SolverType?: PositionSolverType | string;
3406
3861
  /**
3862
+ * @public
3407
3863
  * <p>The vendor of the positioning solver.</p>
3408
3864
  */
3409
3865
  SolverProvider?: PositionSolverProvider | string;
3410
3866
  /**
3867
+ * @public
3411
3868
  * <p>The version of the positioning solver.</p>
3412
3869
  */
3413
3870
  SolverVersion?: string;
3414
3871
  /**
3872
+ * @public
3415
3873
  * <p>The timestamp at which the device's position was determined.</p>
3416
3874
  */
3417
3875
  Timestamp?: string;
@@ -3421,10 +3879,12 @@ export interface GetPositionResponse {
3421
3879
  */
3422
3880
  export interface GetPositionConfigurationRequest {
3423
3881
  /**
3882
+ * @public
3424
3883
  * <p>Resource identifier used in a position configuration.</p>
3425
3884
  */
3426
3885
  ResourceIdentifier: string | undefined;
3427
3886
  /**
3887
+ * @public
3428
3888
  * <p>Resource type of the resource for which position configuration is retrieved.</p>
3429
3889
  */
3430
3890
  ResourceType: PositionResourceType | string | undefined;
@@ -3459,18 +3919,22 @@ export type PositionConfigurationStatus = (typeof PositionConfigurationStatus)[k
3459
3919
  */
3460
3920
  export interface SemtechGnssDetail {
3461
3921
  /**
3922
+ * @public
3462
3923
  * <p>The vendor of the solver object.</p>
3463
3924
  */
3464
3925
  Provider?: PositionSolverProvider | string;
3465
3926
  /**
3927
+ * @public
3466
3928
  * <p>The type of positioning solver used.</p>
3467
3929
  */
3468
3930
  Type?: PositionSolverType | string;
3469
3931
  /**
3932
+ * @public
3470
3933
  * <p>The status indicating whether the solver is enabled.</p>
3471
3934
  */
3472
3935
  Status?: PositionConfigurationStatus | string;
3473
3936
  /**
3937
+ * @public
3474
3938
  * <p>Whether forward error correction is enabled.</p>
3475
3939
  */
3476
3940
  Fec?: PositionConfigurationFec | string;
@@ -3481,6 +3945,7 @@ export interface SemtechGnssDetail {
3481
3945
  */
3482
3946
  export interface PositionSolverDetails {
3483
3947
  /**
3948
+ * @public
3484
3949
  * <p>The Semtech GNSS solver object details.</p>
3485
3950
  */
3486
3951
  SemtechGnss?: SemtechGnssDetail;
@@ -3490,10 +3955,12 @@ export interface PositionSolverDetails {
3490
3955
  */
3491
3956
  export interface GetPositionConfigurationResponse {
3492
3957
  /**
3958
+ * @public
3493
3959
  * <p>The wrapper for the solver configuration details object.</p>
3494
3960
  */
3495
3961
  Solvers?: PositionSolverDetails;
3496
3962
  /**
3963
+ * @public
3497
3964
  * <p>The position data destination that describes the AWS IoT rule that processes the
3498
3965
  * device's position data for use by AWS IoT Core for LoRaWAN.</p>
3499
3966
  */
@@ -3505,30 +3972,36 @@ export interface GetPositionConfigurationResponse {
3505
3972
  */
3506
3973
  export interface Gnss {
3507
3974
  /**
3975
+ * @public
3508
3976
  * <p>Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.</p>
3509
3977
  */
3510
3978
  Payload: string | undefined;
3511
3979
  /**
3980
+ * @public
3512
3981
  * <p>Optional parameter that gives an estimate of the time when the GNSS scan information is
3513
3982
  * taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.</p>
3514
3983
  */
3515
3984
  CaptureTime?: number;
3516
3985
  /**
3986
+ * @public
3517
3987
  * <p>Optional value that gives the capture time estimate accuracy, in seconds. If capture time
3518
3988
  * accuracy is not specified, default value of 300 is used.</p>
3519
3989
  */
3520
3990
  CaptureTimeAccuracy?: number;
3521
3991
  /**
3992
+ * @public
3522
3993
  * <p>Optional assistance position information, specified using latitude and longitude values
3523
3994
  * in degrees. The coordinates are inside the WGS84 reference frame.</p>
3524
3995
  */
3525
3996
  AssistPosition?: number[];
3526
3997
  /**
3998
+ * @public
3527
3999
  * <p>Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above
3528
4000
  * the WGS84 reference ellipsoid.</p>
3529
4001
  */
3530
4002
  AssistAltitude?: number;
3531
4003
  /**
4004
+ * @public
3532
4005
  * <p>Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution
3533
4006
  * problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.</p>
3534
4007
  */
@@ -3540,6 +4013,7 @@ export interface Gnss {
3540
4013
  */
3541
4014
  export interface Ip {
3542
4015
  /**
4016
+ * @public
3543
4017
  * <p>IP address information.</p>
3544
4018
  */
3545
4019
  IpAddress: string | undefined;
@@ -3550,10 +4024,12 @@ export interface Ip {
3550
4024
  */
3551
4025
  export interface WiFiAccessPoint {
3552
4026
  /**
4027
+ * @public
3553
4028
  * <p>Wi-Fi MAC Address.</p>
3554
4029
  */
3555
4030
  MacAddress: string | undefined;
3556
4031
  /**
4032
+ * @public
3557
4033
  * <p>Received signal strength (dBm) of the WLAN measurement data.</p>
3558
4034
  */
3559
4035
  Rss: number | undefined;
@@ -3563,27 +4039,32 @@ export interface WiFiAccessPoint {
3563
4039
  */
3564
4040
  export interface GetPositionEstimateRequest {
3565
4041
  /**
4042
+ * @public
3566
4043
  * <p>Retrieves an estimated device position by resolving WLAN measurement data. The
3567
4044
  * position is resolved using HERE's Wi-Fi based solver.</p>
3568
4045
  */
3569
4046
  WiFiAccessPoints?: WiFiAccessPoint[];
3570
4047
  /**
4048
+ * @public
3571
4049
  * <p>Retrieves an estimated device position by resolving measurement data from cellular
3572
4050
  * radio towers. The position is resolved using HERE's cellular-based solver.</p>
3573
4051
  */
3574
4052
  CellTowers?: CellTowers;
3575
4053
  /**
4054
+ * @public
3576
4055
  * <p>Retrieves an estimated device position by resolving the IP address information from
3577
4056
  * the device. The position is resolved using MaxMind's IP-based solver.</p>
3578
4057
  */
3579
4058
  Ip?: Ip;
3580
4059
  /**
4060
+ * @public
3581
4061
  * <p>Retrieves an estimated device position by resolving the global navigation satellite
3582
4062
  * system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa
3583
4063
  * Cloud.</p>
3584
4064
  */
3585
4065
  Gnss?: Gnss;
3586
4066
  /**
4067
+ * @public
3587
4068
  * <p>Optional information that specifies the time when the position information will be
3588
4069
  * resolved. It uses the Unix timestamp format. If not specified, the time at which the
3589
4070
  * request was received will be used.</p>
@@ -3595,6 +4076,7 @@ export interface GetPositionEstimateRequest {
3595
4076
  */
3596
4077
  export interface GetPositionEstimateResponse {
3597
4078
  /**
4079
+ * @public
3598
4080
  * <p>The position information of the resource, displayed as a JSON payload. The payload
3599
4081
  * uses the GeoJSON format, which a format that's used to encode geographic data
3600
4082
  * structures. For more information, see <a href="https://geojson.org/">GeoJSON</a>.</p>
@@ -3606,14 +4088,17 @@ export interface GetPositionEstimateResponse {
3606
4088
  */
3607
4089
  export interface GetResourceEventConfigurationRequest {
3608
4090
  /**
4091
+ * @public
3609
4092
  * <p>Resource identifier to opt in for event messaging.</p>
3610
4093
  */
3611
4094
  Identifier: string | undefined;
3612
4095
  /**
4096
+ * @public
3613
4097
  * <p>Identifier type of the particular resource identifier for event configuration.</p>
3614
4098
  */
3615
4099
  IdentifierType: IdentifierType | string | undefined;
3616
4100
  /**
4101
+ * @public
3617
4102
  * <p>Partner type of the resource if the identifier type is
3618
4103
  * <code>PartnerAccountId</code>.</p>
3619
4104
  */
@@ -3624,22 +4109,27 @@ export interface GetResourceEventConfigurationRequest {
3624
4109
  */
3625
4110
  export interface GetResourceEventConfigurationResponse {
3626
4111
  /**
4112
+ * @public
3627
4113
  * <p>Event configuration for the device registration state event.</p>
3628
4114
  */
3629
4115
  DeviceRegistrationState?: DeviceRegistrationStateEventConfiguration;
3630
4116
  /**
4117
+ * @public
3631
4118
  * <p>Event configuration for the proximity event.</p>
3632
4119
  */
3633
4120
  Proximity?: ProximityEventConfiguration;
3634
4121
  /**
4122
+ * @public
3635
4123
  * <p>Event configuration for the join event.</p>
3636
4124
  */
3637
4125
  Join?: JoinEventConfiguration;
3638
4126
  /**
4127
+ * @public
3639
4128
  * <p>Event configuration for the connection status event.</p>
3640
4129
  */
3641
4130
  ConnectionStatus?: ConnectionStatusEventConfiguration;
3642
4131
  /**
4132
+ * @public
3643
4133
  * <p>Event configuration for the message delivery status event.</p>
3644
4134
  */
3645
4135
  MessageDeliveryStatus?: MessageDeliveryStatusEventConfiguration;
@@ -3649,11 +4139,13 @@ export interface GetResourceEventConfigurationResponse {
3649
4139
  */
3650
4140
  export interface GetResourceLogLevelRequest {
3651
4141
  /**
4142
+ * @public
3652
4143
  * <p>The identifier of the resource. For a Wireless Device, it is the wireless device ID.
3653
4144
  * For a wireless gateway, it is the wireless gateway ID.</p>
3654
4145
  */
3655
4146
  ResourceIdentifier: string | undefined;
3656
4147
  /**
4148
+ * @public
3657
4149
  * <p>The type of the resource, which can be <code>WirelessDevice</code> or
3658
4150
  * <code>WirelessGateway</code>.</p>
3659
4151
  */
@@ -3664,6 +4156,7 @@ export interface GetResourceLogLevelRequest {
3664
4156
  */
3665
4157
  export interface GetResourceLogLevelResponse {
3666
4158
  /**
4159
+ * @public
3667
4160
  * <p>The log level for a log message. The log levels can be disabled, or set to
3668
4161
  * <code>ERROR</code> to display less verbose logs containing only error information,
3669
4162
  * or to <code>INFO</code> for more detailed logs.</p>
@@ -3675,12 +4168,14 @@ export interface GetResourceLogLevelResponse {
3675
4168
  */
3676
4169
  export interface GetResourcePositionRequest {
3677
4170
  /**
4171
+ * @public
3678
4172
  * <p>The identifier of the resource for which position information is retrieved. It can be
3679
4173
  * the wireless device ID or the wireless gateway ID, depending on the resource
3680
4174
  * type.</p>
3681
4175
  */
3682
4176
  ResourceIdentifier: string | undefined;
3683
4177
  /**
4178
+ * @public
3684
4179
  * <p>The type of resource for which position information is retrieved, which can be a
3685
4180
  * wireless device or a wireless gateway.</p>
3686
4181
  */
@@ -3691,6 +4186,7 @@ export interface GetResourcePositionRequest {
3691
4186
  */
3692
4187
  export interface GetResourcePositionResponse {
3693
4188
  /**
4189
+ * @public
3694
4190
  * <p>The position information of the resource, displayed as a JSON payload. The payload
3695
4191
  * uses the GeoJSON format, which a format that's used to encode geographic data
3696
4192
  * structures. For more information, see <a href="https://geojson.org/">GeoJSON</a>.</p>
@@ -3714,6 +4210,7 @@ export type WirelessGatewayServiceType = (typeof WirelessGatewayServiceType)[key
3714
4210
  */
3715
4211
  export interface GetServiceEndpointRequest {
3716
4212
  /**
4213
+ * @public
3717
4214
  * <p>The service type for which to get endpoint information about. Can be <code>CUPS</code>
3718
4215
  * for the Configuration and Update Server endpoint, or <code>LNS</code> for the LoRaWAN
3719
4216
  * Network Server endpoint or <code>CLAIM</code> for the global endpoint.</p>
@@ -3725,14 +4222,17 @@ export interface GetServiceEndpointRequest {
3725
4222
  */
3726
4223
  export interface GetServiceEndpointResponse {
3727
4224
  /**
4225
+ * @public
3728
4226
  * <p>The endpoint's service type.</p>
3729
4227
  */
3730
4228
  ServiceType?: WirelessGatewayServiceType | string;
3731
4229
  /**
4230
+ * @public
3732
4231
  * <p>The service endpoint value.</p>
3733
4232
  */
3734
4233
  ServiceEndpoint?: string;
3735
4234
  /**
4235
+ * @public
3736
4236
  * <p>The Root CA of the server trust certificate.</p>
3737
4237
  */
3738
4238
  ServerTrust?: string;
@@ -3742,6 +4242,7 @@ export interface GetServiceEndpointResponse {
3742
4242
  */
3743
4243
  export interface GetServiceProfileRequest {
3744
4244
  /**
4245
+ * @public
3745
4246
  * <p>The ID of the resource to get.</p>
3746
4247
  */
3747
4248
  Id: string | undefined;
@@ -3752,78 +4253,97 @@ export interface GetServiceProfileRequest {
3752
4253
  */
3753
4254
  export interface LoRaWANGetServiceProfileInfo {
3754
4255
  /**
4256
+ * @public
3755
4257
  * <p>The ULRate value.</p>
3756
4258
  */
3757
4259
  UlRate?: number;
3758
4260
  /**
4261
+ * @public
3759
4262
  * <p>The ULBucketSize value.</p>
3760
4263
  */
3761
4264
  UlBucketSize?: number;
3762
4265
  /**
4266
+ * @public
3763
4267
  * <p>The ULRatePolicy value.</p>
3764
4268
  */
3765
4269
  UlRatePolicy?: string;
3766
4270
  /**
4271
+ * @public
3767
4272
  * <p>The DLRate value.</p>
3768
4273
  */
3769
4274
  DlRate?: number;
3770
4275
  /**
4276
+ * @public
3771
4277
  * <p>The DLBucketSize value.</p>
3772
4278
  */
3773
4279
  DlBucketSize?: number;
3774
4280
  /**
4281
+ * @public
3775
4282
  * <p>The DLRatePolicy value.</p>
3776
4283
  */
3777
4284
  DlRatePolicy?: string;
3778
4285
  /**
4286
+ * @public
3779
4287
  * <p>The AddGWMetaData value.</p>
3780
4288
  */
3781
4289
  AddGwMetadata?: boolean;
3782
4290
  /**
4291
+ * @public
3783
4292
  * <p>The DevStatusReqFreq value.</p>
3784
4293
  */
3785
4294
  DevStatusReqFreq?: number;
3786
4295
  /**
4296
+ * @public
3787
4297
  * <p>The ReportDevStatusBattery value.</p>
3788
4298
  */
3789
4299
  ReportDevStatusBattery?: boolean;
3790
4300
  /**
4301
+ * @public
3791
4302
  * <p>The ReportDevStatusMargin value.</p>
3792
4303
  */
3793
4304
  ReportDevStatusMargin?: boolean;
3794
4305
  /**
4306
+ * @public
3795
4307
  * <p>The DRMin value.</p>
3796
4308
  */
3797
4309
  DrMin?: number;
3798
4310
  /**
4311
+ * @public
3799
4312
  * <p>The DRMax value.</p>
3800
4313
  */
3801
4314
  DrMax?: number;
3802
4315
  /**
4316
+ * @public
3803
4317
  * <p>The ChannelMask value.</p>
3804
4318
  */
3805
4319
  ChannelMask?: string;
3806
4320
  /**
4321
+ * @public
3807
4322
  * <p>The PRAllowed value that describes whether passive roaming is allowed.</p>
3808
4323
  */
3809
4324
  PrAllowed?: boolean;
3810
4325
  /**
4326
+ * @public
3811
4327
  * <p>The HRAllowed value that describes whether handover roaming is allowed.</p>
3812
4328
  */
3813
4329
  HrAllowed?: boolean;
3814
4330
  /**
4331
+ * @public
3815
4332
  * <p>The RAAllowed value that describes whether roaming activation is allowed.</p>
3816
4333
  */
3817
4334
  RaAllowed?: boolean;
3818
4335
  /**
4336
+ * @public
3819
4337
  * <p>The NwkGeoLoc value.</p>
3820
4338
  */
3821
4339
  NwkGeoLoc?: boolean;
3822
4340
  /**
4341
+ * @public
3823
4342
  * <p>The TargetPER value.</p>
3824
4343
  */
3825
4344
  TargetPer?: number;
3826
4345
  /**
4346
+ * @public
3827
4347
  * <p>The MinGwDiversity value.</p>
3828
4348
  */
3829
4349
  MinGwDiversity?: number;
@@ -3833,18 +4353,22 @@ export interface LoRaWANGetServiceProfileInfo {
3833
4353
  */
3834
4354
  export interface GetServiceProfileResponse {
3835
4355
  /**
4356
+ * @public
3836
4357
  * <p>The Amazon Resource Name of the resource.</p>
3837
4358
  */
3838
4359
  Arn?: string;
3839
4360
  /**
4361
+ * @public
3840
4362
  * <p>The name of the resource.</p>
3841
4363
  */
3842
4364
  Name?: string;
3843
4365
  /**
4366
+ * @public
3844
4367
  * <p>The ID of the service profile.</p>
3845
4368
  */
3846
4369
  Id?: string;
3847
4370
  /**
4371
+ * @public
3848
4372
  * <p>Information about the service profile.</p>
3849
4373
  */
3850
4374
  LoRaWAN?: LoRaWANGetServiceProfileInfo;
@@ -3868,10 +4392,12 @@ export type WirelessDeviceIdType = (typeof WirelessDeviceIdType)[keyof typeof Wi
3868
4392
  */
3869
4393
  export interface GetWirelessDeviceRequest {
3870
4394
  /**
4395
+ * @public
3871
4396
  * <p>The identifier of the wireless device to get.</p>
3872
4397
  */
3873
4398
  Identifier: string | undefined;
3874
4399
  /**
4400
+ * @public
3875
4401
  * <p>The type of identifier used in <code>identifier</code>.</p>
3876
4402
  */
3877
4403
  IdentifierType: WirelessDeviceIdType | string | undefined;
@@ -3896,34 +4422,42 @@ export type WirelessDeviceSidewalkStatus = (typeof WirelessDeviceSidewalkStatus)
3896
4422
  */
3897
4423
  export interface SidewalkDevice {
3898
4424
  /**
4425
+ * @public
3899
4426
  * <p>The Sidewalk Amazon ID.</p>
3900
4427
  */
3901
4428
  AmazonId?: string;
3902
4429
  /**
4430
+ * @public
3903
4431
  * <p>The sidewalk device identification.</p>
3904
4432
  */
3905
4433
  SidewalkId?: string;
3906
4434
  /**
4435
+ * @public
3907
4436
  * <p>The Sidewalk manufacturing series number.</p>
3908
4437
  */
3909
4438
  SidewalkManufacturingSn?: string;
3910
4439
  /**
4440
+ * @public
3911
4441
  * <p>The sidewalk device certificates for Ed25519 and P256r1.</p>
3912
4442
  */
3913
4443
  DeviceCertificates?: CertificateList[];
3914
4444
  /**
4445
+ * @public
3915
4446
  * <p>The Sidewalk device private keys that will be used for onboarding the device.</p>
3916
4447
  */
3917
4448
  PrivateKeys?: CertificateList[];
3918
4449
  /**
4450
+ * @public
3919
4451
  * <p>The ID of the Sidewalk device profile.</p>
3920
4452
  */
3921
4453
  DeviceProfileId?: string;
3922
4454
  /**
4455
+ * @public
3923
4456
  * <p>The ID of the Sidewalk device profile.</p>
3924
4457
  */
3925
4458
  CertificateId?: string;
3926
4459
  /**
4460
+ * @public
3927
4461
  * <p>The Sidewalk device status, such as provisioned or registered.</p>
3928
4462
  */
3929
4463
  Status?: WirelessDeviceSidewalkStatus | string;
@@ -3933,47 +4467,58 @@ export interface SidewalkDevice {
3933
4467
  */
3934
4468
  export interface GetWirelessDeviceResponse {
3935
4469
  /**
4470
+ * @public
3936
4471
  * <p>The wireless device type.</p>
3937
4472
  */
3938
4473
  Type?: WirelessDeviceType | string;
3939
4474
  /**
4475
+ * @public
3940
4476
  * <p>The name of the resource.</p>
3941
4477
  */
3942
4478
  Name?: string;
3943
4479
  /**
4480
+ * @public
3944
4481
  * <p>The description of the resource.</p>
3945
4482
  */
3946
4483
  Description?: string;
3947
4484
  /**
4485
+ * @public
3948
4486
  * <p>The name of the destination to which the device is assigned.</p>
3949
4487
  */
3950
4488
  DestinationName?: string;
3951
4489
  /**
4490
+ * @public
3952
4491
  * <p>The ID of the wireless device.</p>
3953
4492
  */
3954
4493
  Id?: string;
3955
4494
  /**
4495
+ * @public
3956
4496
  * <p>The Amazon Resource Name of the resource.</p>
3957
4497
  */
3958
4498
  Arn?: string;
3959
4499
  /**
4500
+ * @public
3960
4501
  * <p>The name of the thing associated with the wireless device. The value is empty if a
3961
4502
  * thing isn't associated with the device.</p>
3962
4503
  */
3963
4504
  ThingName?: string;
3964
4505
  /**
4506
+ * @public
3965
4507
  * <p>The ARN of the thing associated with the wireless device.</p>
3966
4508
  */
3967
4509
  ThingArn?: string;
3968
4510
  /**
4511
+ * @public
3969
4512
  * <p>Information about the wireless device.</p>
3970
4513
  */
3971
4514
  LoRaWAN?: LoRaWANDevice;
3972
4515
  /**
4516
+ * @public
3973
4517
  * <p>Sidewalk device object.</p>
3974
4518
  */
3975
4519
  Sidewalk?: SidewalkDevice;
3976
4520
  /**
4521
+ * @public
3977
4522
  * <p>FPort values for the GNSS, stream, and ClockSync functions of the positioning
3978
4523
  * information.</p>
3979
4524
  */
@@ -3984,6 +4529,7 @@ export interface GetWirelessDeviceResponse {
3984
4529
  */
3985
4530
  export interface GetWirelessDeviceImportTaskRequest {
3986
4531
  /**
4532
+ * @public
3987
4533
  * <p>The identifier of the import task for which information is requested.</p>
3988
4534
  */
3989
4535
  Id: string | undefined;
@@ -3994,10 +4540,12 @@ export interface GetWirelessDeviceImportTaskRequest {
3994
4540
  */
3995
4541
  export interface SidewalkGetStartImportInfo {
3996
4542
  /**
4543
+ * @public
3997
4544
  * <p>List of Sidewalk devices that are added to the import task.</p>
3998
4545
  */
3999
4546
  DeviceCreationFileList?: string[];
4000
4547
  /**
4548
+ * @public
4001
4549
  * <p>The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.</p>
4002
4550
  */
4003
4551
  Role?: string;
@@ -4023,47 +4571,58 @@ export type ImportTaskStatus = (typeof ImportTaskStatus)[keyof typeof ImportTask
4023
4571
  */
4024
4572
  export interface GetWirelessDeviceImportTaskResponse {
4025
4573
  /**
4574
+ * @public
4026
4575
  * <p>The identifier of the import task for which information is retrieved.</p>
4027
4576
  */
4028
4577
  Id?: string;
4029
4578
  /**
4579
+ * @public
4030
4580
  * <p>The ARN (Amazon Resource Name) of the import task.</p>
4031
4581
  */
4032
4582
  Arn?: string;
4033
4583
  /**
4584
+ * @public
4034
4585
  * <p>The name of the destination that's assigned to the wireless devices in the import task.</p>
4035
4586
  */
4036
4587
  DestinationName?: string;
4037
4588
  /**
4589
+ * @public
4038
4590
  * <p>The Sidewalk-related information about an import task.</p>
4039
4591
  */
4040
4592
  Sidewalk?: SidewalkGetStartImportInfo;
4041
4593
  /**
4594
+ * @public
4042
4595
  * <p>The time at which the import task was created.</p>
4043
4596
  */
4044
4597
  CreationTime?: Date;
4045
4598
  /**
4599
+ * @public
4046
4600
  * <p>The import task status.</p>
4047
4601
  */
4048
4602
  Status?: ImportTaskStatus | string;
4049
4603
  /**
4604
+ * @public
4050
4605
  * <p>The reason for the provided status information, such as a validation error that causes the import
4051
4606
  * task to fail.</p>
4052
4607
  */
4053
4608
  StatusReason?: string;
4054
4609
  /**
4610
+ * @public
4055
4611
  * <p>The number of devices in the import task that are waiting for the control log to start processing.</p>
4056
4612
  */
4057
4613
  InitializedImportedDeviceCount?: number;
4058
4614
  /**
4615
+ * @public
4059
4616
  * <p>The number of devices in the import task that are waiting in the import task queue to be onboarded.</p>
4060
4617
  */
4061
4618
  PendingImportedDeviceCount?: number;
4062
4619
  /**
4620
+ * @public
4063
4621
  * <p>The number of devices in the import task that have been onboarded to the import task.</p>
4064
4622
  */
4065
4623
  OnboardedImportedDeviceCount?: number;
4066
4624
  /**
4625
+ * @public
4067
4626
  * <p>The number of devices in the import task that failed to onboard to the import task.</p>
4068
4627
  */
4069
4628
  FailedImportedDeviceCount?: number;
@@ -4073,6 +4632,7 @@ export interface GetWirelessDeviceImportTaskResponse {
4073
4632
  */
4074
4633
  export interface GetWirelessDeviceStatisticsRequest {
4075
4634
  /**
4635
+ * @public
4076
4636
  * <p>The ID of the wireless device for which to get the data.</p>
4077
4637
  */
4078
4638
  WirelessDeviceId: string | undefined;
@@ -4083,14 +4643,17 @@ export interface GetWirelessDeviceStatisticsRequest {
4083
4643
  */
4084
4644
  export interface LoRaWANGatewayMetadata {
4085
4645
  /**
4646
+ * @public
4086
4647
  * <p>The gateway's EUI value.</p>
4087
4648
  */
4088
4649
  GatewayEui?: string;
4089
4650
  /**
4651
+ * @public
4090
4652
  * <p>The SNR value.</p>
4091
4653
  */
4092
4654
  Snr?: number;
4093
4655
  /**
4656
+ * @public
4094
4657
  * <p>The RSSI value.</p>
4095
4658
  */
4096
4659
  Rssi?: number;
@@ -4101,26 +4664,32 @@ export interface LoRaWANGatewayMetadata {
4101
4664
  */
4102
4665
  export interface LoRaWANDeviceMetadata {
4103
4666
  /**
4667
+ * @public
4104
4668
  * <p>The DevEUI value.</p>
4105
4669
  */
4106
4670
  DevEui?: string;
4107
4671
  /**
4672
+ * @public
4108
4673
  * <p>The FPort value.</p>
4109
4674
  */
4110
4675
  FPort?: number;
4111
4676
  /**
4677
+ * @public
4112
4678
  * <p>The DataRate value.</p>
4113
4679
  */
4114
4680
  DataRate?: number;
4115
4681
  /**
4682
+ * @public
4116
4683
  * <p>The device's channel frequency in Hz.</p>
4117
4684
  */
4118
4685
  Frequency?: number;
4119
4686
  /**
4687
+ * @public
4120
4688
  * <p>The date and time of the metadata.</p>
4121
4689
  */
4122
4690
  Timestamp?: string;
4123
4691
  /**
4692
+ * @public
4124
4693
  * <p>Information about the gateways accessed by the device.</p>
4125
4694
  */
4126
4695
  Gateways?: LoRaWANGatewayMetadata[];
@@ -4131,18 +4700,22 @@ export interface LoRaWANDeviceMetadata {
4131
4700
  */
4132
4701
  export interface SidewalkDeviceMetadata {
4133
4702
  /**
4703
+ * @public
4134
4704
  * <p>The RSSI value.</p>
4135
4705
  */
4136
4706
  Rssi?: number;
4137
4707
  /**
4708
+ * @public
4138
4709
  * <p>Sidewalk device battery level.</p>
4139
4710
  */
4140
4711
  BatteryLevel?: BatteryLevel | string;
4141
4712
  /**
4713
+ * @public
4142
4714
  * <p>Sidewalk device status notification.</p>
4143
4715
  */
4144
4716
  Event?: Event | string;
4145
4717
  /**
4718
+ * @public
4146
4719
  * <p>Device state defines the device status of sidewalk device.</p>
4147
4720
  */
4148
4721
  DeviceState?: DeviceState | string;
@@ -4152,10 +4725,12 @@ export interface SidewalkDeviceMetadata {
4152
4725
  */
4153
4726
  export interface GetWirelessDeviceStatisticsResponse {
4154
4727
  /**
4728
+ * @public
4155
4729
  * <p>The ID of the wireless device.</p>
4156
4730
  */
4157
4731
  WirelessDeviceId?: string;
4158
4732
  /**
4733
+ * @public
4159
4734
  * <p>The date and time when the most recent uplink was received.</p>
4160
4735
  * <note>
4161
4736
  * <p>This value is only valid for 3 months.</p>
@@ -4163,10 +4738,12 @@ export interface GetWirelessDeviceStatisticsResponse {
4163
4738
  */
4164
4739
  LastUplinkReceivedAt?: string;
4165
4740
  /**
4741
+ * @public
4166
4742
  * <p>Information about the wireless device's operations.</p>
4167
4743
  */
4168
4744
  LoRaWAN?: LoRaWANDeviceMetadata;
4169
4745
  /**
4746
+ * @public
4170
4747
  * <p>MetaData for Sidewalk device.</p>
4171
4748
  */
4172
4749
  Sidewalk?: SidewalkDeviceMetadata;
@@ -4189,10 +4766,12 @@ export type WirelessGatewayIdType = (typeof WirelessGatewayIdType)[keyof typeof
4189
4766
  */
4190
4767
  export interface GetWirelessGatewayRequest {
4191
4768
  /**
4769
+ * @public
4192
4770
  * <p>The identifier of the wireless gateway to get.</p>
4193
4771
  */
4194
4772
  Identifier: string | undefined;
4195
4773
  /**
4774
+ * @public
4196
4775
  * <p>The type of identifier used in <code>identifier</code>.</p>
4197
4776
  */
4198
4777
  IdentifierType: WirelessGatewayIdType | string | undefined;
@@ -4202,31 +4781,38 @@ export interface GetWirelessGatewayRequest {
4202
4781
  */
4203
4782
  export interface GetWirelessGatewayResponse {
4204
4783
  /**
4784
+ * @public
4205
4785
  * <p>The name of the resource.</p>
4206
4786
  */
4207
4787
  Name?: string;
4208
4788
  /**
4789
+ * @public
4209
4790
  * <p>The ID of the wireless gateway.</p>
4210
4791
  */
4211
4792
  Id?: string;
4212
4793
  /**
4794
+ * @public
4213
4795
  * <p>The description of the resource.</p>
4214
4796
  */
4215
4797
  Description?: string;
4216
4798
  /**
4799
+ * @public
4217
4800
  * <p>Information about the wireless gateway.</p>
4218
4801
  */
4219
4802
  LoRaWAN?: LoRaWANGateway;
4220
4803
  /**
4804
+ * @public
4221
4805
  * <p>The Amazon Resource Name of the resource.</p>
4222
4806
  */
4223
4807
  Arn?: string;
4224
4808
  /**
4809
+ * @public
4225
4810
  * <p>The name of the thing associated with the wireless gateway. The value is empty if a
4226
4811
  * thing isn't associated with the gateway.</p>
4227
4812
  */
4228
4813
  ThingName?: string;
4229
4814
  /**
4815
+ * @public
4230
4816
  * <p>The ARN of the thing associated with the wireless gateway.</p>
4231
4817
  */
4232
4818
  ThingArn?: string;
@@ -4236,6 +4822,7 @@ export interface GetWirelessGatewayResponse {
4236
4822
  */
4237
4823
  export interface GetWirelessGatewayCertificateRequest {
4238
4824
  /**
4825
+ * @public
4239
4826
  * <p>The ID of the resource to get.</p>
4240
4827
  */
4241
4828
  Id: string | undefined;
@@ -4245,10 +4832,12 @@ export interface GetWirelessGatewayCertificateRequest {
4245
4832
  */
4246
4833
  export interface GetWirelessGatewayCertificateResponse {
4247
4834
  /**
4835
+ * @public
4248
4836
  * <p>The ID of the certificate associated with the wireless gateway.</p>
4249
4837
  */
4250
4838
  IotCertificateId?: string;
4251
4839
  /**
4840
+ * @public
4252
4841
  * <p>The ID of the certificate that is associated with the wireless gateway and used for
4253
4842
  * the LoRaWANNetworkServer endpoint.</p>
4254
4843
  */
@@ -4259,6 +4848,7 @@ export interface GetWirelessGatewayCertificateResponse {
4259
4848
  */
4260
4849
  export interface GetWirelessGatewayFirmwareInformationRequest {
4261
4850
  /**
4851
+ * @public
4262
4852
  * <p>The ID of the resource to get.</p>
4263
4853
  */
4264
4854
  Id: string | undefined;
@@ -4269,6 +4859,7 @@ export interface GetWirelessGatewayFirmwareInformationRequest {
4269
4859
  */
4270
4860
  export interface LoRaWANGatewayCurrentVersion {
4271
4861
  /**
4862
+ * @public
4272
4863
  * <p>The version of the gateways that should receive the update.</p>
4273
4864
  */
4274
4865
  CurrentVersion?: LoRaWANGatewayVersion;
@@ -4278,6 +4869,7 @@ export interface LoRaWANGatewayCurrentVersion {
4278
4869
  */
4279
4870
  export interface GetWirelessGatewayFirmwareInformationResponse {
4280
4871
  /**
4872
+ * @public
4281
4873
  * <p>Information about the wireless gateway's firmware.</p>
4282
4874
  */
4283
4875
  LoRaWAN?: LoRaWANGatewayCurrentVersion;
@@ -4287,6 +4879,7 @@ export interface GetWirelessGatewayFirmwareInformationResponse {
4287
4879
  */
4288
4880
  export interface GetWirelessGatewayStatisticsRequest {
4289
4881
  /**
4882
+ * @public
4290
4883
  * <p>The ID of the wireless gateway for which to get the data.</p>
4291
4884
  */
4292
4885
  WirelessGatewayId: string | undefined;
@@ -4296,10 +4889,12 @@ export interface GetWirelessGatewayStatisticsRequest {
4296
4889
  */
4297
4890
  export interface GetWirelessGatewayStatisticsResponse {
4298
4891
  /**
4892
+ * @public
4299
4893
  * <p>The ID of the wireless gateway.</p>
4300
4894
  */
4301
4895
  WirelessGatewayId?: string;
4302
4896
  /**
4897
+ * @public
4303
4898
  * <p>The date and time when the most recent uplink was received.</p>
4304
4899
  * <note>
4305
4900
  * <p>This value is only valid for 3 months.</p>
@@ -4307,6 +4902,7 @@ export interface GetWirelessGatewayStatisticsResponse {
4307
4902
  */
4308
4903
  LastUplinkReceivedAt?: string;
4309
4904
  /**
4905
+ * @public
4310
4906
  * <p>The connection status of the wireless gateway.</p>
4311
4907
  */
4312
4908
  ConnectionStatus?: ConnectionStatus | string;
@@ -4316,6 +4912,7 @@ export interface GetWirelessGatewayStatisticsResponse {
4316
4912
  */
4317
4913
  export interface GetWirelessGatewayTaskRequest {
4318
4914
  /**
4915
+ * @public
4319
4916
  * <p>The ID of the resource to get.</p>
4320
4917
  */
4321
4918
  Id: string | undefined;
@@ -4325,14 +4922,17 @@ export interface GetWirelessGatewayTaskRequest {
4325
4922
  */
4326
4923
  export interface GetWirelessGatewayTaskResponse {
4327
4924
  /**
4925
+ * @public
4328
4926
  * <p>The ID of the wireless gateway.</p>
4329
4927
  */
4330
4928
  WirelessGatewayId?: string;
4331
4929
  /**
4930
+ * @public
4332
4931
  * <p>The ID of the WirelessGatewayTask.</p>
4333
4932
  */
4334
4933
  WirelessGatewayTaskDefinitionId?: string;
4335
4934
  /**
4935
+ * @public
4336
4936
  * <p>The date and time when the most recent uplink was received.</p>
4337
4937
  * <note>
4338
4938
  * <p>This value is only valid for 3 months.</p>
@@ -4340,10 +4940,12 @@ export interface GetWirelessGatewayTaskResponse {
4340
4940
  */
4341
4941
  LastUplinkReceivedAt?: string;
4342
4942
  /**
4943
+ * @public
4343
4944
  * <p>The date and time when the task was created.</p>
4344
4945
  */
4345
4946
  TaskCreatedAt?: string;
4346
4947
  /**
4948
+ * @public
4347
4949
  * <p>The status of the request.</p>
4348
4950
  */
4349
4951
  Status?: WirelessGatewayTaskStatus | string;
@@ -4353,6 +4955,7 @@ export interface GetWirelessGatewayTaskResponse {
4353
4955
  */
4354
4956
  export interface GetWirelessGatewayTaskDefinitionRequest {
4355
4957
  /**
4958
+ * @public
4356
4959
  * <p>The ID of the resource to get.</p>
4357
4960
  */
4358
4961
  Id: string | undefined;
@@ -4362,20 +4965,24 @@ export interface GetWirelessGatewayTaskDefinitionRequest {
4362
4965
  */
4363
4966
  export interface GetWirelessGatewayTaskDefinitionResponse {
4364
4967
  /**
4968
+ * @public
4365
4969
  * <p>Whether to automatically create tasks using this task definition for all gateways with
4366
4970
  * the specified current version. If <code>false</code>, the task must me created by
4367
4971
  * calling <code>CreateWirelessGatewayTask</code>.</p>
4368
4972
  */
4369
4973
  AutoCreateTasks?: boolean;
4370
4974
  /**
4975
+ * @public
4371
4976
  * <p>The name of the resource.</p>
4372
4977
  */
4373
4978
  Name?: string;
4374
4979
  /**
4980
+ * @public
4375
4981
  * <p>Information about the gateways to update.</p>
4376
4982
  */
4377
4983
  Update?: UpdateWirelessGatewayTaskCreate;
4378
4984
  /**
4985
+ * @public
4379
4986
  * <p>The Amazon Resource Name of the resource.</p>
4380
4987
  */
4381
4988
  Arn?: string;
@@ -4400,18 +5007,22 @@ export type OnboardStatus = (typeof OnboardStatus)[keyof typeof OnboardStatus];
4400
5007
  */
4401
5008
  export interface ImportedSidewalkDevice {
4402
5009
  /**
5010
+ * @public
4403
5011
  * <p>The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.</p>
4404
5012
  */
4405
5013
  SidewalkManufacturingSn?: string;
4406
5014
  /**
5015
+ * @public
4407
5016
  * <p>The onboarding status of the Sidewalk device in the import task.</p>
4408
5017
  */
4409
5018
  OnboardingStatus?: OnboardStatus | string;
4410
5019
  /**
5020
+ * @public
4411
5021
  * <p>The reason for the onboarding status information for the Sidewalk device.</p>
4412
5022
  */
4413
5023
  OnboardingStatusReason?: string;
4414
5024
  /**
5025
+ * @public
4415
5026
  * <p>The time at which the status information was last updated.</p>
4416
5027
  */
4417
5028
  LastUpdateTime?: Date;
@@ -4422,6 +5033,7 @@ export interface ImportedSidewalkDevice {
4422
5033
  */
4423
5034
  export interface ImportedWirelessDevice {
4424
5035
  /**
5036
+ * @public
4425
5037
  * <p>The Sidewalk-related information about a device that has been added to an import task.</p>
4426
5038
  */
4427
5039
  Sidewalk?: ImportedSidewalkDevice;
@@ -4431,10 +5043,12 @@ export interface ImportedWirelessDevice {
4431
5043
  */
4432
5044
  export interface ListDestinationsRequest {
4433
5045
  /**
5046
+ * @public
4434
5047
  * <p>The maximum number of results to return in this operation.</p>
4435
5048
  */
4436
5049
  MaxResults?: number;
4437
5050
  /**
5051
+ * @public
4438
5052
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4439
5053
  * response; otherwise <b>null</b> to receive the first set of
4440
5054
  * results.</p>
@@ -4446,10 +5060,12 @@ export interface ListDestinationsRequest {
4446
5060
  */
4447
5061
  export interface ListDestinationsResponse {
4448
5062
  /**
5063
+ * @public
4449
5064
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4450
5065
  */
4451
5066
  NextToken?: string;
4452
5067
  /**
5068
+ * @public
4453
5069
  * <p>The list of destinations.</p>
4454
5070
  */
4455
5071
  DestinationList?: Destinations[];
@@ -4459,16 +5075,19 @@ export interface ListDestinationsResponse {
4459
5075
  */
4460
5076
  export interface ListDeviceProfilesRequest {
4461
5077
  /**
5078
+ * @public
4462
5079
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4463
5080
  * response; otherwise <b>null</b> to receive the first set of
4464
5081
  * results.</p>
4465
5082
  */
4466
5083
  NextToken?: string;
4467
5084
  /**
5085
+ * @public
4468
5086
  * <p>The maximum number of results to return in this operation.</p>
4469
5087
  */
4470
5088
  MaxResults?: number;
4471
5089
  /**
5090
+ * @public
4472
5091
  * <p>A filter to list only device profiles that use this type, which can be <code>LoRaWAN</code>
4473
5092
  * or <code>Sidewalk</code>.</p>
4474
5093
  */
@@ -4479,10 +5098,12 @@ export interface ListDeviceProfilesRequest {
4479
5098
  */
4480
5099
  export interface ListDeviceProfilesResponse {
4481
5100
  /**
5101
+ * @public
4482
5102
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4483
5103
  */
4484
5104
  NextToken?: string;
4485
5105
  /**
5106
+ * @public
4486
5107
  * <p>The list of device profiles.</p>
4487
5108
  */
4488
5109
  DeviceProfileList?: DeviceProfile[];
@@ -4492,19 +5113,23 @@ export interface ListDeviceProfilesResponse {
4492
5113
  */
4493
5114
  export interface ListDevicesForWirelessDeviceImportTaskRequest {
4494
5115
  /**
5116
+ * @public
4495
5117
  * <p>The identifier of the import task for which wireless devices are listed.</p>
4496
5118
  */
4497
5119
  Id: string | undefined;
4498
5120
  /**
5121
+ * @public
4499
5122
  * <p>The maximum number of results to return in this operation.</p>
4500
5123
  */
4501
5124
  MaxResults?: number;
4502
5125
  /**
5126
+ * @public
4503
5127
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise
4504
5128
  * <code>null</code> to receive the first set of results.</p>
4505
5129
  */
4506
5130
  NextToken?: string;
4507
5131
  /**
5132
+ * @public
4508
5133
  * <p>The status of the devices in the import task.</p>
4509
5134
  */
4510
5135
  Status?: OnboardStatus | string;
@@ -4514,16 +5139,19 @@ export interface ListDevicesForWirelessDeviceImportTaskRequest {
4514
5139
  */
4515
5140
  export interface ListDevicesForWirelessDeviceImportTaskResponse {
4516
5141
  /**
5142
+ * @public
4517
5143
  * <p>The token to use to get the next set of results, or <code>null</code> if there are no additional
4518
5144
  * results.</p>
4519
5145
  */
4520
5146
  NextToken?: string;
4521
5147
  /**
5148
+ * @public
4522
5149
  * <p>The name of the Sidewalk destination that describes the IoT rule to route messages received from
4523
5150
  * devices in an import task that are onboarded to AWS IoT Wireless.</p>
4524
5151
  */
4525
5152
  DestinationName?: string;
4526
5153
  /**
5154
+ * @public
4527
5155
  * <p>List of wireless devices in an import task and their onboarding status.</p>
4528
5156
  */
4529
5157
  ImportedWirelessDeviceList?: ImportedWirelessDevice[];
@@ -4533,14 +5161,17 @@ export interface ListDevicesForWirelessDeviceImportTaskResponse {
4533
5161
  */
4534
5162
  export interface ListEventConfigurationsRequest {
4535
5163
  /**
5164
+ * @public
4536
5165
  * <p>Resource type to filter event configurations.</p>
4537
5166
  */
4538
5167
  ResourceType: EventNotificationResourceType | string | undefined;
4539
5168
  /**
5169
+ * @public
4540
5170
  * <p>The maximum number of results to return in this operation.</p>
4541
5171
  */
4542
5172
  MaxResults?: number;
4543
5173
  /**
5174
+ * @public
4544
5175
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4545
5176
  * response; otherwise <b>null</b> to receive the first set of
4546
5177
  * results.</p>
@@ -4552,12 +5183,14 @@ export interface ListEventConfigurationsRequest {
4552
5183
  */
4553
5184
  export interface ListEventConfigurationsResponse {
4554
5185
  /**
5186
+ * @public
4555
5187
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4556
5188
  * response; otherwise <b>null</b> to receive the first set of
4557
5189
  * results.</p>
4558
5190
  */
4559
5191
  NextToken?: string;
4560
5192
  /**
5193
+ * @public
4561
5194
  * <p>Event configurations of all events for a single resource.</p>
4562
5195
  */
4563
5196
  EventConfigurationsList?: EventConfigurationItem[];
@@ -4567,12 +5200,14 @@ export interface ListEventConfigurationsResponse {
4567
5200
  */
4568
5201
  export interface ListFuotaTasksRequest {
4569
5202
  /**
5203
+ * @public
4570
5204
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4571
5205
  * response; otherwise <b>null</b> to receive the first set of
4572
5206
  * results.</p>
4573
5207
  */
4574
5208
  NextToken?: string;
4575
5209
  /**
5210
+ * @public
4576
5211
  * <p>The maximum number of results to return in this operation.</p>
4577
5212
  */
4578
5213
  MaxResults?: number;
@@ -4582,12 +5217,14 @@ export interface ListFuotaTasksRequest {
4582
5217
  */
4583
5218
  export interface ListFuotaTasksResponse {
4584
5219
  /**
5220
+ * @public
4585
5221
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4586
5222
  * response; otherwise <b>null</b> to receive the first set of
4587
5223
  * results.</p>
4588
5224
  */
4589
5225
  NextToken?: string;
4590
5226
  /**
5227
+ * @public
4591
5228
  * <p>Lists the FUOTA tasks registered to your AWS account.</p>
4592
5229
  */
4593
5230
  FuotaTaskList?: FuotaTask[];
@@ -4597,12 +5234,14 @@ export interface ListFuotaTasksResponse {
4597
5234
  */
4598
5235
  export interface ListMulticastGroupsRequest {
4599
5236
  /**
5237
+ * @public
4600
5238
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4601
5239
  * response; otherwise <b>null</b> to receive the first set of
4602
5240
  * results.</p>
4603
5241
  */
4604
5242
  NextToken?: string;
4605
5243
  /**
5244
+ * @public
4606
5245
  * <p>The maximum number of results to return in this operation.</p>
4607
5246
  */
4608
5247
  MaxResults?: number;
@@ -4613,14 +5252,17 @@ export interface ListMulticastGroupsRequest {
4613
5252
  */
4614
5253
  export interface MulticastGroup {
4615
5254
  /**
5255
+ * @public
4616
5256
  * <p>The ID of the multicast group.</p>
4617
5257
  */
4618
5258
  Id?: string;
4619
5259
  /**
5260
+ * @public
4620
5261
  * <p>The arn of the multicast group.</p>
4621
5262
  */
4622
5263
  Arn?: string;
4623
5264
  /**
5265
+ * @public
4624
5266
  * <p>The name of the multicast group.</p>
4625
5267
  */
4626
5268
  Name?: string;
@@ -4630,12 +5272,14 @@ export interface MulticastGroup {
4630
5272
  */
4631
5273
  export interface ListMulticastGroupsResponse {
4632
5274
  /**
5275
+ * @public
4633
5276
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4634
5277
  * response; otherwise <b>null</b> to receive the first set of
4635
5278
  * results.</p>
4636
5279
  */
4637
5280
  NextToken?: string;
4638
5281
  /**
5282
+ * @public
4639
5283
  * <p>List of multicast groups.</p>
4640
5284
  */
4641
5285
  MulticastGroupList?: MulticastGroup[];
@@ -4645,16 +5289,19 @@ export interface ListMulticastGroupsResponse {
4645
5289
  */
4646
5290
  export interface ListMulticastGroupsByFuotaTaskRequest {
4647
5291
  /**
5292
+ * @public
4648
5293
  * <p>The ID of a FUOTA task.</p>
4649
5294
  */
4650
5295
  Id: string | undefined;
4651
5296
  /**
5297
+ * @public
4652
5298
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4653
5299
  * response; otherwise <b>null</b> to receive the first set of
4654
5300
  * results.</p>
4655
5301
  */
4656
5302
  NextToken?: string;
4657
5303
  /**
5304
+ * @public
4658
5305
  * <p>The maximum number of results to return in this operation.</p>
4659
5306
  */
4660
5307
  MaxResults?: number;
@@ -4665,6 +5312,7 @@ export interface ListMulticastGroupsByFuotaTaskRequest {
4665
5312
  */
4666
5313
  export interface MulticastGroupByFuotaTask {
4667
5314
  /**
5315
+ * @public
4668
5316
  * <p>The ID of the multicast group.</p>
4669
5317
  */
4670
5318
  Id?: string;
@@ -4674,12 +5322,14 @@ export interface MulticastGroupByFuotaTask {
4674
5322
  */
4675
5323
  export interface ListMulticastGroupsByFuotaTaskResponse {
4676
5324
  /**
5325
+ * @public
4677
5326
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4678
5327
  * response; otherwise <b>null</b> to receive the first set of
4679
5328
  * results.</p>
4680
5329
  */
4681
5330
  NextToken?: string;
4682
5331
  /**
5332
+ * @public
4683
5333
  * <p>List of multicast groups associated with a FUOTA task.</p>
4684
5334
  */
4685
5335
  MulticastGroupList?: MulticastGroupByFuotaTask[];
@@ -4689,10 +5339,12 @@ export interface ListMulticastGroupsByFuotaTaskResponse {
4689
5339
  */
4690
5340
  export interface ListNetworkAnalyzerConfigurationsRequest {
4691
5341
  /**
5342
+ * @public
4692
5343
  * <p>The maximum number of results to return in this operation.</p>
4693
5344
  */
4694
5345
  MaxResults?: number;
4695
5346
  /**
5347
+ * @public
4696
5348
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4697
5349
  * response; otherwise <b>null</b> to receive the first set of
4698
5350
  * results.</p>
@@ -4705,10 +5357,12 @@ export interface ListNetworkAnalyzerConfigurationsRequest {
4705
5357
  */
4706
5358
  export interface NetworkAnalyzerConfigurations {
4707
5359
  /**
5360
+ * @public
4708
5361
  * <p>The Amazon Resource Name of the new resource.</p>
4709
5362
  */
4710
5363
  Arn?: string;
4711
5364
  /**
5365
+ * @public
4712
5366
  * <p>Name of the network analyzer configuration.</p>
4713
5367
  */
4714
5368
  Name?: string;
@@ -4718,10 +5372,12 @@ export interface NetworkAnalyzerConfigurations {
4718
5372
  */
4719
5373
  export interface ListNetworkAnalyzerConfigurationsResponse {
4720
5374
  /**
5375
+ * @public
4721
5376
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4722
5377
  */
4723
5378
  NextToken?: string;
4724
5379
  /**
5380
+ * @public
4725
5381
  * <p>The list of network analyzer configurations.</p>
4726
5382
  */
4727
5383
  NetworkAnalyzerConfigurationList?: NetworkAnalyzerConfigurations[];
@@ -4731,12 +5387,14 @@ export interface ListNetworkAnalyzerConfigurationsResponse {
4731
5387
  */
4732
5388
  export interface ListPartnerAccountsRequest {
4733
5389
  /**
5390
+ * @public
4734
5391
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4735
5392
  * response; otherwise <b>null</b> to receive the first set of
4736
5393
  * results.</p>
4737
5394
  */
4738
5395
  NextToken?: string;
4739
5396
  /**
5397
+ * @public
4740
5398
  * <p>The maximum number of results to return in this operation.</p>
4741
5399
  */
4742
5400
  MaxResults?: number;
@@ -4746,10 +5404,12 @@ export interface ListPartnerAccountsRequest {
4746
5404
  */
4747
5405
  export interface ListPartnerAccountsResponse {
4748
5406
  /**
5407
+ * @public
4749
5408
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4750
5409
  */
4751
5410
  NextToken?: string;
4752
5411
  /**
5412
+ * @public
4753
5413
  * <p>The Sidewalk account credentials.</p>
4754
5414
  */
4755
5415
  Sidewalk?: SidewalkAccountInfoWithFingerprint[];
@@ -4759,14 +5419,17 @@ export interface ListPartnerAccountsResponse {
4759
5419
  */
4760
5420
  export interface ListPositionConfigurationsRequest {
4761
5421
  /**
5422
+ * @public
4762
5423
  * <p>Resource type for which position configurations are listed.</p>
4763
5424
  */
4764
5425
  ResourceType?: PositionResourceType | string;
4765
5426
  /**
5427
+ * @public
4766
5428
  * <p>The maximum number of results to return in this operation.</p>
4767
5429
  */
4768
5430
  MaxResults?: number;
4769
5431
  /**
5432
+ * @public
4770
5433
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4771
5434
  * response; otherwise <b>null</b> to receive the first set of
4772
5435
  * results.</p>
@@ -4779,18 +5442,22 @@ export interface ListPositionConfigurationsRequest {
4779
5442
  */
4780
5443
  export interface PositionConfigurationItem {
4781
5444
  /**
5445
+ * @public
4782
5446
  * <p>Resource identifier for the position configuration.</p>
4783
5447
  */
4784
5448
  ResourceIdentifier?: string;
4785
5449
  /**
5450
+ * @public
4786
5451
  * <p>Resource type of the resource for the position configuration.</p>
4787
5452
  */
4788
5453
  ResourceType?: PositionResourceType | string;
4789
5454
  /**
5455
+ * @public
4790
5456
  * <p>The details of the positioning solver object used to compute the location.</p>
4791
5457
  */
4792
5458
  Solvers?: PositionSolverDetails;
4793
5459
  /**
5460
+ * @public
4794
5461
  * <p>The position data destination that describes the AWS IoT rule that processes the
4795
5462
  * device's position data for use by AWS IoT Core for LoRaWAN.</p>
4796
5463
  */
@@ -4801,10 +5468,12 @@ export interface PositionConfigurationItem {
4801
5468
  */
4802
5469
  export interface ListPositionConfigurationsResponse {
4803
5470
  /**
5471
+ * @public
4804
5472
  * <p>A list of position configurations.</p>
4805
5473
  */
4806
5474
  PositionConfigurationList?: PositionConfigurationItem[];
4807
5475
  /**
5476
+ * @public
4808
5477
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4809
5478
  */
4810
5479
  NextToken?: string;
@@ -4814,21 +5483,25 @@ export interface ListPositionConfigurationsResponse {
4814
5483
  */
4815
5484
  export interface ListQueuedMessagesRequest {
4816
5485
  /**
5486
+ * @public
4817
5487
  * <p>The ID of a given wireless device which the downlink message packets are being
4818
5488
  * sent.</p>
4819
5489
  */
4820
5490
  Id: string | undefined;
4821
5491
  /**
5492
+ * @public
4822
5493
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4823
5494
  * response; otherwise <b>null</b> to receive the first set of
4824
5495
  * results.</p>
4825
5496
  */
4826
5497
  NextToken?: string;
4827
5498
  /**
5499
+ * @public
4828
5500
  * <p>The maximum number of results to return in this operation.</p>
4829
5501
  */
4830
5502
  MaxResults?: number;
4831
5503
  /**
5504
+ * @public
4832
5505
  * <p>The wireless device type, whic can be either Sidewalk or LoRaWAN.</p>
4833
5506
  */
4834
5507
  WirelessDeviceType?: WirelessDeviceType | string;
@@ -4838,12 +5511,14 @@ export interface ListQueuedMessagesRequest {
4838
5511
  */
4839
5512
  export interface ListQueuedMessagesResponse {
4840
5513
  /**
5514
+ * @public
4841
5515
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4842
5516
  * response; otherwise <b>null</b> to receive the first set of
4843
5517
  * results.</p>
4844
5518
  */
4845
5519
  NextToken?: string;
4846
5520
  /**
5521
+ * @public
4847
5522
  * <p>The messages in the downlink queue.</p>
4848
5523
  */
4849
5524
  DownlinkQueueMessagesList?: DownlinkQueueMessage[];
@@ -4853,12 +5528,14 @@ export interface ListQueuedMessagesResponse {
4853
5528
  */
4854
5529
  export interface ListServiceProfilesRequest {
4855
5530
  /**
5531
+ * @public
4856
5532
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
4857
5533
  * response; otherwise <b>null</b> to receive the first set of
4858
5534
  * results.</p>
4859
5535
  */
4860
5536
  NextToken?: string;
4861
5537
  /**
5538
+ * @public
4862
5539
  * <p>The maximum number of results to return in this operation.</p>
4863
5540
  */
4864
5541
  MaxResults?: number;
@@ -4869,14 +5546,17 @@ export interface ListServiceProfilesRequest {
4869
5546
  */
4870
5547
  export interface ServiceProfile {
4871
5548
  /**
5549
+ * @public
4872
5550
  * <p>The Amazon Resource Name of the resource.</p>
4873
5551
  */
4874
5552
  Arn?: string;
4875
5553
  /**
5554
+ * @public
4876
5555
  * <p>The name of the resource.</p>
4877
5556
  */
4878
5557
  Name?: string;
4879
5558
  /**
5559
+ * @public
4880
5560
  * <p>The ID of the service profile.</p>
4881
5561
  */
4882
5562
  Id?: string;
@@ -4886,10 +5566,12 @@ export interface ServiceProfile {
4886
5566
  */
4887
5567
  export interface ListServiceProfilesResponse {
4888
5568
  /**
5569
+ * @public
4889
5570
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
4890
5571
  */
4891
5572
  NextToken?: string;
4892
5573
  /**
5574
+ * @public
4893
5575
  * <p>The list of service profiles.</p>
4894
5576
  */
4895
5577
  ServiceProfileList?: ServiceProfile[];
@@ -4899,6 +5581,7 @@ export interface ListServiceProfilesResponse {
4899
5581
  */
4900
5582
  export interface ListTagsForResourceRequest {
4901
5583
  /**
5584
+ * @public
4902
5585
  * <p>The ARN of the resource for which you want to list tags.</p>
4903
5586
  */
4904
5587
  ResourceArn: string | undefined;
@@ -4908,6 +5591,7 @@ export interface ListTagsForResourceRequest {
4908
5591
  */
4909
5592
  export interface ListTagsForResourceResponse {
4910
5593
  /**
5594
+ * @public
4911
5595
  * <p>The tags to attach to the specified resource. Tags are metadata that you can use to
4912
5596
  * manage a resource.</p>
4913
5597
  */
@@ -4918,10 +5602,12 @@ export interface ListTagsForResourceResponse {
4918
5602
  */
4919
5603
  export interface ListWirelessDeviceImportTasksRequest {
4920
5604
  /**
5605
+ * @public
4921
5606
  * <p>The maximum number of results to return in this operation.</p>
4922
5607
  */
4923
5608
  MaxResults?: number;
4924
5609
  /**
5610
+ * @public
4925
5611
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise
4926
5612
  * <code>null</code> to receive the first set of results.</p>
4927
5613
  */
@@ -4933,50 +5619,61 @@ export interface ListWirelessDeviceImportTasksRequest {
4933
5619
  */
4934
5620
  export interface WirelessDeviceImportTask {
4935
5621
  /**
5622
+ * @public
4936
5623
  * <p>The ID of the wireless device import task.</p>
4937
5624
  */
4938
5625
  Id?: string;
4939
5626
  /**
5627
+ * @public
4940
5628
  * <p>The ARN (Amazon Resource Name) of the wireless device import task.</p>
4941
5629
  */
4942
5630
  Arn?: string;
4943
5631
  /**
5632
+ * @public
4944
5633
  * <p>The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in
4945
5634
  * the import task that will be onboarded to AWS IoT Wireless</p>
4946
5635
  */
4947
5636
  DestinationName?: string;
4948
5637
  /**
5638
+ * @public
4949
5639
  * <p>The Sidewalk-related information of the wireless device import task.</p>
4950
5640
  */
4951
5641
  Sidewalk?: SidewalkGetStartImportInfo;
4952
5642
  /**
5643
+ * @public
4953
5644
  * <p>The time at which the import task was created.</p>
4954
5645
  */
4955
5646
  CreationTime?: Date;
4956
5647
  /**
5648
+ * @public
4957
5649
  * <p>The status information of the wireless device import task.</p>
4958
5650
  */
4959
5651
  Status?: ImportTaskStatus | string;
4960
5652
  /**
5653
+ * @public
4961
5654
  * <p>The reason that provides additional information about the import task status.</p>
4962
5655
  */
4963
5656
  StatusReason?: string;
4964
5657
  /**
5658
+ * @public
4965
5659
  * <p>The summary information of count of wireless devices that are waiting for the control log to be
4966
5660
  * added to an import task.</p>
4967
5661
  */
4968
5662
  InitializedImportedDeviceCount?: number;
4969
5663
  /**
5664
+ * @public
4970
5665
  * <p>The summary information of count of wireless devices in an import task that are waiting in the queue
4971
5666
  * to be onboarded.</p>
4972
5667
  */
4973
5668
  PendingImportedDeviceCount?: number;
4974
5669
  /**
5670
+ * @public
4975
5671
  * <p>The summary information of count of wireless devices in an import task that have been onboarded to the
4976
5672
  * import task.</p>
4977
5673
  */
4978
5674
  OnboardedImportedDeviceCount?: number;
4979
5675
  /**
5676
+ * @public
4980
5677
  * <p>The summary information of count of wireless devices in an import task that failed to onboarded to the
4981
5678
  * import task.</p>
4982
5679
  */
@@ -4987,11 +5684,13 @@ export interface WirelessDeviceImportTask {
4987
5684
  */
4988
5685
  export interface ListWirelessDeviceImportTasksResponse {
4989
5686
  /**
5687
+ * @public
4990
5688
  * <p>The token to use to get the next set of results, or <code>null</code> if there are no additional
4991
5689
  * results.</p>
4992
5690
  */
4993
5691
  NextToken?: string;
4994
5692
  /**
5693
+ * @public
4995
5694
  * <p>List of import tasks and summary information of onboarding status of devices in each import task.</p>
4996
5695
  */
4997
5696
  WirelessDeviceImportTaskList?: WirelessDeviceImportTask[];
@@ -5001,36 +5700,44 @@ export interface ListWirelessDeviceImportTasksResponse {
5001
5700
  */
5002
5701
  export interface ListWirelessDevicesRequest {
5003
5702
  /**
5703
+ * @public
5004
5704
  * <p>The maximum number of results to return in this operation.</p>
5005
5705
  */
5006
5706
  MaxResults?: number;
5007
5707
  /**
5708
+ * @public
5008
5709
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
5009
5710
  * response; otherwise <b>null</b> to receive the first set of
5010
5711
  * results.</p>
5011
5712
  */
5012
5713
  NextToken?: string;
5013
5714
  /**
5715
+ * @public
5014
5716
  * <p>A filter to list only the wireless devices that use this destination.</p>
5015
5717
  */
5016
5718
  DestinationName?: string;
5017
5719
  /**
5720
+ * @public
5018
5721
  * <p>A filter to list only the wireless devices that use this device profile.</p>
5019
5722
  */
5020
5723
  DeviceProfileId?: string;
5021
5724
  /**
5725
+ * @public
5022
5726
  * <p>A filter to list only the wireless devices that use this service profile.</p>
5023
5727
  */
5024
5728
  ServiceProfileId?: string;
5025
5729
  /**
5730
+ * @public
5026
5731
  * <p>A filter to list only the wireless devices that use this wireless device type.</p>
5027
5732
  */
5028
5733
  WirelessDeviceType?: WirelessDeviceType | string;
5029
5734
  /**
5735
+ * @public
5030
5736
  * <p>The ID of a FUOTA task.</p>
5031
5737
  */
5032
5738
  FuotaTaskId?: string;
5033
5739
  /**
5740
+ * @public
5034
5741
  * <p>The ID of the multicast group.</p>
5035
5742
  */
5036
5743
  MulticastGroupId?: string;
@@ -5041,6 +5748,7 @@ export interface ListWirelessDevicesRequest {
5041
5748
  */
5042
5749
  export interface LoRaWANListDevice {
5043
5750
  /**
5751
+ * @public
5044
5752
  * <p>The DevEUI value.</p>
5045
5753
  */
5046
5754
  DevEui?: string;