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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,26 +7,32 @@ import { ApplicationConfig, CertificateList, ConnectionStatusEventConfiguration,
7
7
  */
8
8
  export interface SidewalkListDevice {
9
9
  /**
10
+ * @public
10
11
  * <p>The Sidewalk Amazon ID.</p>
11
12
  */
12
13
  AmazonId?: string;
13
14
  /**
15
+ * @public
14
16
  * <p>The sidewalk device identification.</p>
15
17
  */
16
18
  SidewalkId?: string;
17
19
  /**
20
+ * @public
18
21
  * <p>The Sidewalk manufacturing series number.</p>
19
22
  */
20
23
  SidewalkManufacturingSn?: string;
21
24
  /**
25
+ * @public
22
26
  * <p>The sidewalk device certificates for Ed25519 and P256r1.</p>
23
27
  */
24
28
  DeviceCertificates?: CertificateList[];
25
29
  /**
30
+ * @public
26
31
  * <p>Sidewalk object used by list functions.</p>
27
32
  */
28
33
  DeviceProfileId?: string;
29
34
  /**
35
+ * @public
30
36
  * <p>The status of the Sidewalk devices, such as provisioned or registered.</p>
31
37
  */
32
38
  Status?: WirelessDeviceSidewalkStatus | string;
@@ -37,26 +43,32 @@ export interface SidewalkListDevice {
37
43
  */
38
44
  export interface WirelessDeviceStatistics {
39
45
  /**
46
+ * @public
40
47
  * <p>The Amazon Resource Name of the resource.</p>
41
48
  */
42
49
  Arn?: string;
43
50
  /**
51
+ * @public
44
52
  * <p>The ID of the wireless device reporting the data.</p>
45
53
  */
46
54
  Id?: string;
47
55
  /**
56
+ * @public
48
57
  * <p>The wireless device type.</p>
49
58
  */
50
59
  Type?: WirelessDeviceType | string;
51
60
  /**
61
+ * @public
52
62
  * <p>The name of the resource.</p>
53
63
  */
54
64
  Name?: string;
55
65
  /**
66
+ * @public
56
67
  * <p>The name of the destination to which the device is assigned.</p>
57
68
  */
58
69
  DestinationName?: string;
59
70
  /**
71
+ * @public
60
72
  * <p>The date and time when the most recent uplink was received.</p>
61
73
  * <note>
62
74
  * <p>Theis value is only valid for 3 months.</p>
@@ -64,22 +76,27 @@ export interface WirelessDeviceStatistics {
64
76
  */
65
77
  LastUplinkReceivedAt?: string;
66
78
  /**
79
+ * @public
67
80
  * <p>LoRaWAN device info.</p>
68
81
  */
69
82
  LoRaWAN?: LoRaWANListDevice;
70
83
  /**
84
+ * @public
71
85
  * <p>The Sidewalk account credentials.</p>
72
86
  */
73
87
  Sidewalk?: SidewalkListDevice;
74
88
  /**
89
+ * @public
75
90
  * <p>The status of a wireless device in a FUOTA task.</p>
76
91
  */
77
92
  FuotaDeviceStatus?: FuotaDeviceStatus | string;
78
93
  /**
94
+ * @public
79
95
  * <p>The status of the wireless device in the multicast group.</p>
80
96
  */
81
97
  MulticastDeviceStatus?: string;
82
98
  /**
99
+ * @public
83
100
  * <p>Id of the multicast group.</p>
84
101
  */
85
102
  McGroupId?: number;
@@ -89,10 +106,12 @@ export interface WirelessDeviceStatistics {
89
106
  */
90
107
  export interface ListWirelessDevicesResponse {
91
108
  /**
109
+ * @public
92
110
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
93
111
  */
94
112
  NextToken?: string;
95
113
  /**
114
+ * @public
96
115
  * <p>The ID of the wireless device.</p>
97
116
  */
98
117
  WirelessDeviceList?: WirelessDeviceStatistics[];
@@ -102,12 +121,14 @@ export interface ListWirelessDevicesResponse {
102
121
  */
103
122
  export interface ListWirelessGatewaysRequest {
104
123
  /**
124
+ * @public
105
125
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
106
126
  * response; otherwise <b>null</b> to receive the first set of
107
127
  * results.</p>
108
128
  */
109
129
  NextToken?: string;
110
130
  /**
131
+ * @public
111
132
  * <p>The maximum number of results to return in this operation.</p>
112
133
  */
113
134
  MaxResults?: number;
@@ -118,26 +139,32 @@ export interface ListWirelessGatewaysRequest {
118
139
  */
119
140
  export interface WirelessGatewayStatistics {
120
141
  /**
142
+ * @public
121
143
  * <p>The Amazon Resource Name of the resource.</p>
122
144
  */
123
145
  Arn?: string;
124
146
  /**
147
+ * @public
125
148
  * <p>The ID of the wireless gateway reporting the data.</p>
126
149
  */
127
150
  Id?: string;
128
151
  /**
152
+ * @public
129
153
  * <p>The name of the resource.</p>
130
154
  */
131
155
  Name?: string;
132
156
  /**
157
+ * @public
133
158
  * <p>The description of the resource.</p>
134
159
  */
135
160
  Description?: string;
136
161
  /**
162
+ * @public
137
163
  * <p>LoRaWAN gateway info.</p>
138
164
  */
139
165
  LoRaWAN?: LoRaWANGateway;
140
166
  /**
167
+ * @public
141
168
  * <p>The date and time when the most recent uplink was received.</p>
142
169
  * <note>
143
170
  * <p>This value is only valid for 3 months.</p>
@@ -150,10 +177,12 @@ export interface WirelessGatewayStatistics {
150
177
  */
151
178
  export interface ListWirelessGatewaysResponse {
152
179
  /**
180
+ * @public
153
181
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
154
182
  */
155
183
  NextToken?: string;
156
184
  /**
185
+ * @public
157
186
  * <p>The ID of the wireless gateway.</p>
158
187
  */
159
188
  WirelessGatewayList?: WirelessGatewayStatistics[];
@@ -174,16 +203,19 @@ export type WirelessGatewayTaskDefinitionType = (typeof WirelessGatewayTaskDefin
174
203
  */
175
204
  export interface ListWirelessGatewayTaskDefinitionsRequest {
176
205
  /**
206
+ * @public
177
207
  * <p>The maximum number of results to return in this operation.</p>
178
208
  */
179
209
  MaxResults?: number;
180
210
  /**
211
+ * @public
181
212
  * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
182
213
  * response; otherwise <b>null</b> to receive the first set of
183
214
  * results.</p>
184
215
  */
185
216
  NextToken?: string;
186
217
  /**
218
+ * @public
187
219
  * <p>A filter to list only the wireless gateway task definitions that use this task
188
220
  * definition type.</p>
189
221
  */
@@ -195,10 +227,12 @@ export interface ListWirelessGatewayTaskDefinitionsRequest {
195
227
  */
196
228
  export interface LoRaWANUpdateGatewayTaskEntry {
197
229
  /**
230
+ * @public
198
231
  * <p>The version of the gateways that should receive the update.</p>
199
232
  */
200
233
  CurrentVersion?: LoRaWANGatewayVersion;
201
234
  /**
235
+ * @public
202
236
  * <p>The firmware version to update the gateway to.</p>
203
237
  */
204
238
  UpdateVersion?: LoRaWANGatewayVersion;
@@ -209,14 +243,17 @@ export interface LoRaWANUpdateGatewayTaskEntry {
209
243
  */
210
244
  export interface UpdateWirelessGatewayTaskEntry {
211
245
  /**
246
+ * @public
212
247
  * <p>The ID of the new wireless gateway task entry.</p>
213
248
  */
214
249
  Id?: string;
215
250
  /**
251
+ * @public
216
252
  * <p>The properties that relate to the LoRaWAN wireless gateway.</p>
217
253
  */
218
254
  LoRaWAN?: LoRaWANUpdateGatewayTaskEntry;
219
255
  /**
256
+ * @public
220
257
  * <p>The Amazon Resource Name of the resource.</p>
221
258
  */
222
259
  Arn?: string;
@@ -226,10 +263,12 @@ export interface UpdateWirelessGatewayTaskEntry {
226
263
  */
227
264
  export interface ListWirelessGatewayTaskDefinitionsResponse {
228
265
  /**
266
+ * @public
229
267
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
230
268
  */
231
269
  NextToken?: string;
232
270
  /**
271
+ * @public
233
272
  * <p>The list of task definitions.</p>
234
273
  */
235
274
  TaskDefinitions?: UpdateWirelessGatewayTaskEntry[];
@@ -240,10 +279,12 @@ export interface ListWirelessGatewayTaskDefinitionsResponse {
240
279
  */
241
280
  export interface SemtechGnssConfiguration {
242
281
  /**
282
+ * @public
243
283
  * <p>The status indicating whether the solver is enabled.</p>
244
284
  */
245
285
  Status: PositionConfigurationStatus | string | undefined;
246
286
  /**
287
+ * @public
247
288
  * <p>Whether forward error correction is enabled.</p>
248
289
  */
249
290
  Fec: PositionConfigurationFec | string | undefined;
@@ -254,6 +295,7 @@ export interface SemtechGnssConfiguration {
254
295
  */
255
296
  export interface PositionSolverConfigurations {
256
297
  /**
298
+ * @public
257
299
  * <p>The Semtech GNSS solver configuration object.</p>
258
300
  */
259
301
  SemtechGnss?: SemtechGnssConfiguration;
@@ -263,20 +305,24 @@ export interface PositionSolverConfigurations {
263
305
  */
264
306
  export interface PutPositionConfigurationRequest {
265
307
  /**
308
+ * @public
266
309
  * <p>Resource identifier used to update the position configuration.</p>
267
310
  */
268
311
  ResourceIdentifier: string | undefined;
269
312
  /**
313
+ * @public
270
314
  * <p>Resource type of the resource for which you want to update the position
271
315
  * configuration.</p>
272
316
  */
273
317
  ResourceType: PositionResourceType | string | undefined;
274
318
  /**
319
+ * @public
275
320
  * <p>The positioning solvers used to update the position configuration of the
276
321
  * resource.</p>
277
322
  */
278
323
  Solvers?: PositionSolverConfigurations;
279
324
  /**
325
+ * @public
280
326
  * <p>The position data destination that describes the AWS IoT rule that processes the
281
327
  * device's position data for use by AWS IoT Core for LoRaWAN.</p>
282
328
  */
@@ -292,16 +338,19 @@ export interface PutPositionConfigurationResponse {
292
338
  */
293
339
  export interface PutResourceLogLevelRequest {
294
340
  /**
341
+ * @public
295
342
  * <p>The identifier of the resource. For a Wireless Device, it is the wireless device ID.
296
343
  * For a wireless gateway, it is the wireless gateway ID.</p>
297
344
  */
298
345
  ResourceIdentifier: string | undefined;
299
346
  /**
347
+ * @public
300
348
  * <p>The type of the resource, which can be <code>WirelessDevice</code> or
301
349
  * <code>WirelessGateway</code>.</p>
302
350
  */
303
351
  ResourceType: string | undefined;
304
352
  /**
353
+ * @public
305
354
  * <p>The log level for a log message. The log levels can be disabled, or set to
306
355
  * <code>ERROR</code> to display less verbose logs containing only error information,
307
356
  * or to <code>INFO</code> for more detailed logs.</p>
@@ -328,11 +377,13 @@ export interface ResetAllResourceLogLevelsResponse {
328
377
  */
329
378
  export interface ResetResourceLogLevelRequest {
330
379
  /**
380
+ * @public
331
381
  * <p>The identifier of the resource. For a Wireless Device, it is the wireless device ID.
332
382
  * For a wireless gateway, it is the wireless gateway ID.</p>
333
383
  */
334
384
  ResourceIdentifier: string | undefined;
335
385
  /**
386
+ * @public
336
387
  * <p>The type of the resource, which can be <code>WirelessDevice</code> or
337
388
  * <code>WirelessGateway</code>.</p>
338
389
  */
@@ -349,6 +400,7 @@ export interface ResetResourceLogLevelResponse {
349
400
  */
350
401
  export interface LoRaWANMulticastMetadata {
351
402
  /**
403
+ * @public
352
404
  * <p>The Fport value.</p>
353
405
  */
354
406
  FPort?: number;
@@ -359,6 +411,7 @@ export interface LoRaWANMulticastMetadata {
359
411
  */
360
412
  export interface MulticastWirelessMetadata {
361
413
  /**
414
+ * @public
362
415
  * <p>The metadata information of the LoRaWAN multicast group.</p>
363
416
  */
364
417
  LoRaWAN?: LoRaWANMulticastMetadata;
@@ -368,14 +421,17 @@ export interface MulticastWirelessMetadata {
368
421
  */
369
422
  export interface SendDataToMulticastGroupRequest {
370
423
  /**
424
+ * @public
371
425
  * <p>The ID of the multicast group.</p>
372
426
  */
373
427
  Id: string | undefined;
374
428
  /**
429
+ * @public
375
430
  * <p>The binary to be sent to the end device, encoded in base64.</p>
376
431
  */
377
432
  PayloadData: string | undefined;
378
433
  /**
434
+ * @public
379
435
  * <p>Wireless metadata that is to be sent to multicast group.</p>
380
436
  */
381
437
  WirelessMetadata: MulticastWirelessMetadata | undefined;
@@ -385,6 +441,7 @@ export interface SendDataToMulticastGroupRequest {
385
441
  */
386
442
  export interface SendDataToMulticastGroupResponse {
387
443
  /**
444
+ * @public
388
445
  * <p>ID of a multicast group message.</p>
389
446
  */
390
447
  MessageId?: string;
@@ -409,15 +466,18 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
409
466
  */
410
467
  export interface SidewalkSendDataToDevice {
411
468
  /**
469
+ * @public
412
470
  * <p>The sequence number.</p>
413
471
  */
414
472
  Seq?: number;
415
473
  /**
474
+ * @public
416
475
  * <p>Sidewalk device message type. Default value is
417
476
  * <code>CUSTOM_COMMAND_ID_NOTIFY</code>.</p>
418
477
  */
419
478
  MessageType?: MessageType | string;
420
479
  /**
480
+ * @public
421
481
  * <p>The duration of time in seconds to retry sending the ACK.</p>
422
482
  */
423
483
  AckModeRetryDurationSecs?: number;
@@ -428,10 +488,12 @@ export interface SidewalkSendDataToDevice {
428
488
  */
429
489
  export interface WirelessMetadata {
430
490
  /**
491
+ * @public
431
492
  * <p>LoRaWAN device info.</p>
432
493
  */
433
494
  LoRaWAN?: LoRaWANSendDataToDevice;
434
495
  /**
496
+ * @public
435
497
  * <p>The Sidewalk account credentials.</p>
436
498
  */
437
499
  Sidewalk?: SidewalkSendDataToDevice;
@@ -441,19 +503,23 @@ export interface WirelessMetadata {
441
503
  */
442
504
  export interface SendDataToWirelessDeviceRequest {
443
505
  /**
506
+ * @public
444
507
  * <p>The ID of the wireless device to receive the data.</p>
445
508
  */
446
509
  Id: string | undefined;
447
510
  /**
511
+ * @public
448
512
  * <p>The transmit mode to use to send data to the wireless device. Can be: <code>0</code>
449
513
  * for UM (unacknowledge mode) or <code>1</code> for AM (acknowledge mode).</p>
450
514
  */
451
515
  TransmitMode: number | undefined;
452
516
  /**
517
+ * @public
453
518
  * <p>The binary to be sent to the end device, encoded in base64.</p>
454
519
  */
455
520
  PayloadData: string | undefined;
456
521
  /**
522
+ * @public
457
523
  * <p>Metadata about the message request.</p>
458
524
  */
459
525
  WirelessMetadata?: WirelessMetadata;
@@ -463,6 +529,7 @@ export interface SendDataToWirelessDeviceRequest {
463
529
  */
464
530
  export interface SendDataToWirelessDeviceResponse {
465
531
  /**
532
+ * @public
466
533
  * <p>The ID of the message sent to the wireless device.</p>
467
534
  */
468
535
  MessageId?: string;
@@ -472,15 +539,18 @@ export interface SendDataToWirelessDeviceResponse {
472
539
  */
473
540
  export interface StartBulkAssociateWirelessDeviceWithMulticastGroupRequest {
474
541
  /**
542
+ * @public
475
543
  * <p>The ID of the multicast group.</p>
476
544
  */
477
545
  Id: string | undefined;
478
546
  /**
547
+ * @public
479
548
  * <p>Query string used to search for wireless devices as part of the bulk associate and
480
549
  * disassociate process.</p>
481
550
  */
482
551
  QueryString?: string;
483
552
  /**
553
+ * @public
484
554
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
485
555
  * manage a resource.</p>
486
556
  */
@@ -496,15 +566,18 @@ export interface StartBulkAssociateWirelessDeviceWithMulticastGroupResponse {
496
566
  */
497
567
  export interface StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest {
498
568
  /**
569
+ * @public
499
570
  * <p>The ID of the multicast group.</p>
500
571
  */
501
572
  Id: string | undefined;
502
573
  /**
574
+ * @public
503
575
  * <p>Query string used to search for wireless devices as part of the bulk associate and
504
576
  * disassociate process.</p>
505
577
  */
506
578
  QueryString?: string;
507
579
  /**
580
+ * @public
508
581
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
509
582
  * manage a resource.</p>
510
583
  */
@@ -521,6 +594,7 @@ export interface StartBulkDisassociateWirelessDeviceFromMulticastGroupResponse {
521
594
  */
522
595
  export interface LoRaWANStartFuotaTask {
523
596
  /**
597
+ * @public
524
598
  * <p>Start time of a FUOTA task.</p>
525
599
  */
526
600
  StartTime?: Date;
@@ -530,10 +604,12 @@ export interface LoRaWANStartFuotaTask {
530
604
  */
531
605
  export interface StartFuotaTaskRequest {
532
606
  /**
607
+ * @public
533
608
  * <p>The ID of a FUOTA task.</p>
534
609
  */
535
610
  Id: string | undefined;
536
611
  /**
612
+ * @public
537
613
  * <p>The LoRaWAN information used to start a FUOTA task.</p>
538
614
  */
539
615
  LoRaWAN?: LoRaWANStartFuotaTask;
@@ -548,10 +624,12 @@ export interface StartFuotaTaskResponse {
548
624
  */
549
625
  export interface StartMulticastGroupSessionRequest {
550
626
  /**
627
+ * @public
551
628
  * <p>The ID of the multicast group.</p>
552
629
  */
553
630
  Id: string | undefined;
554
631
  /**
632
+ * @public
555
633
  * <p>The LoRaWAN information used with the multicast session.</p>
556
634
  */
557
635
  LoRaWAN: LoRaWANMulticastSession | undefined;
@@ -567,6 +645,7 @@ export interface StartMulticastGroupSessionResponse {
567
645
  */
568
646
  export interface SidewalkSingleStartImportInfo {
569
647
  /**
648
+ * @public
570
649
  * <p>The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.</p>
571
650
  */
572
651
  SidewalkManufacturingSn?: string;
@@ -576,11 +655,13 @@ export interface SidewalkSingleStartImportInfo {
576
655
  */
577
656
  export interface StartSingleWirelessDeviceImportTaskRequest {
578
657
  /**
658
+ * @public
579
659
  * <p>The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import
580
660
  * task that will be onboarded to AWS IoT Wireless.</p>
581
661
  */
582
662
  DestinationName: string | undefined;
583
663
  /**
664
+ * @public
584
665
  * <p>Each resource must have a unique client request token. If you try to create a new
585
666
  * resource with the same token as a resource that already exists, an exception occurs. If
586
667
  * you omit this value, AWS SDKs will automatically generate a unique client
@@ -588,15 +669,18 @@ export interface StartSingleWirelessDeviceImportTaskRequest {
588
669
  */
589
670
  ClientRequestToken?: string;
590
671
  /**
672
+ * @public
591
673
  * <p>The name of the wireless device for which an import task is being started.</p>
592
674
  */
593
675
  DeviceName?: string;
594
676
  /**
677
+ * @public
595
678
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
596
679
  * manage a resource.</p>
597
680
  */
598
681
  Tags?: Tag[];
599
682
  /**
683
+ * @public
600
684
  * <p>The Sidewalk-related parameters for importing a single wireless device.</p>
601
685
  */
602
686
  Sidewalk: SidewalkSingleStartImportInfo | undefined;
@@ -606,10 +690,12 @@ export interface StartSingleWirelessDeviceImportTaskRequest {
606
690
  */
607
691
  export interface StartSingleWirelessDeviceImportTaskResponse {
608
692
  /**
693
+ * @public
609
694
  * <p>The import task ID.</p>
610
695
  */
611
696
  Id?: string;
612
697
  /**
698
+ * @public
613
699
  * <p>The ARN (Amazon Resource Name) of the import task.</p>
614
700
  */
615
701
  Arn?: string;
@@ -620,10 +706,12 @@ export interface StartSingleWirelessDeviceImportTaskResponse {
620
706
  */
621
707
  export interface SidewalkStartImportInfo {
622
708
  /**
709
+ * @public
623
710
  * <p>The CSV file contained in an S3 bucket that's used for adding devices to an import task.</p>
624
711
  */
625
712
  DeviceCreationFile?: string;
626
713
  /**
714
+ * @public
627
715
  * <p>The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.</p>
628
716
  */
629
717
  Role?: string;
@@ -633,11 +721,13 @@ export interface SidewalkStartImportInfo {
633
721
  */
634
722
  export interface StartWirelessDeviceImportTaskRequest {
635
723
  /**
724
+ * @public
636
725
  * <p>The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import
637
726
  * task that are onboarded to AWS IoT Wireless.</p>
638
727
  */
639
728
  DestinationName: string | undefined;
640
729
  /**
730
+ * @public
641
731
  * <p>Each resource must have a unique client request token. If you try to create a new
642
732
  * resource with the same token as a resource that already exists, an exception occurs. If
643
733
  * you omit this value, AWS SDKs will automatically generate a unique client
@@ -645,11 +735,13 @@ export interface StartWirelessDeviceImportTaskRequest {
645
735
  */
646
736
  ClientRequestToken?: string;
647
737
  /**
738
+ * @public
648
739
  * <p>The tag to attach to the specified resource. Tags are metadata that you can use to
649
740
  * manage a resource.</p>
650
741
  */
651
742
  Tags?: Tag[];
652
743
  /**
744
+ * @public
653
745
  * <p>The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.</p>
654
746
  */
655
747
  Sidewalk: SidewalkStartImportInfo | undefined;
@@ -659,10 +751,12 @@ export interface StartWirelessDeviceImportTaskRequest {
659
751
  */
660
752
  export interface StartWirelessDeviceImportTaskResponse {
661
753
  /**
754
+ * @public
662
755
  * <p>The import task ID.</p>
663
756
  */
664
757
  Id?: string;
665
758
  /**
759
+ * @public
666
760
  * <p>The ARN (Amazon Resource Name) of the import task.</p>
667
761
  */
668
762
  Arn?: string;
@@ -672,10 +766,12 @@ export interface StartWirelessDeviceImportTaskResponse {
672
766
  */
673
767
  export interface TagResourceRequest {
674
768
  /**
769
+ * @public
675
770
  * <p>The ARN of the resource to add tags to.</p>
676
771
  */
677
772
  ResourceArn: string | undefined;
678
773
  /**
774
+ * @public
679
775
  * <p>Adds to or modifies the tags of the given resource. Tags are metadata that you can use
680
776
  * to manage a resource.</p>
681
777
  */
@@ -695,6 +791,7 @@ export declare class TooManyTagsException extends __BaseException {
695
791
  readonly $fault: "client";
696
792
  Message?: string;
697
793
  /**
794
+ * @public
698
795
  * <p>Name of the resource that exceeds maximum number of tags allowed.</p>
699
796
  */
700
797
  ResourceName?: string;
@@ -708,6 +805,7 @@ export declare class TooManyTagsException extends __BaseException {
708
805
  */
709
806
  export interface TestWirelessDeviceRequest {
710
807
  /**
808
+ * @public
711
809
  * <p>The ID of the wireless device to test.</p>
712
810
  */
713
811
  Id: string | undefined;
@@ -717,6 +815,7 @@ export interface TestWirelessDeviceRequest {
717
815
  */
718
816
  export interface TestWirelessDeviceResponse {
719
817
  /**
818
+ * @public
720
819
  * <p>The result returned by the test.</p>
721
820
  */
722
821
  Result?: string;
@@ -726,10 +825,12 @@ export interface TestWirelessDeviceResponse {
726
825
  */
727
826
  export interface UntagResourceRequest {
728
827
  /**
828
+ * @public
729
829
  * <p>The ARN of the resource to remove tags from.</p>
730
830
  */
731
831
  ResourceArn: string | undefined;
732
832
  /**
833
+ * @public
733
834
  * <p>A list of the keys of the tags to remove from the resource.</p>
734
835
  */
735
836
  TagKeys: string[] | undefined;
@@ -744,22 +845,27 @@ export interface UntagResourceResponse {
744
845
  */
745
846
  export interface UpdateDestinationRequest {
746
847
  /**
848
+ * @public
747
849
  * <p>The new name of the resource.</p>
748
850
  */
749
851
  Name: string | undefined;
750
852
  /**
853
+ * @public
751
854
  * <p>The type of value in <code>Expression</code>.</p>
752
855
  */
753
856
  ExpressionType?: ExpressionType | string;
754
857
  /**
858
+ * @public
755
859
  * <p>The new rule name or topic rule to send messages to.</p>
756
860
  */
757
861
  Expression?: string;
758
862
  /**
863
+ * @public
759
864
  * <p>A new description of the resource.</p>
760
865
  */
761
866
  Description?: string;
762
867
  /**
868
+ * @public
763
869
  * <p>The ARN of the IAM Role that authorizes the destination.</p>
764
870
  */
765
871
  RoleArn?: string;
@@ -774,26 +880,31 @@ export interface UpdateDestinationResponse {
774
880
  */
775
881
  export interface UpdateEventConfigurationByResourceTypesRequest {
776
882
  /**
883
+ * @public
777
884
  * <p>Device registration state resource type event configuration object for enabling and
778
885
  * disabling wireless gateway topic.</p>
779
886
  */
780
887
  DeviceRegistrationState?: DeviceRegistrationStateResourceTypeEventConfiguration;
781
888
  /**
889
+ * @public
782
890
  * <p>Proximity resource type event configuration object for enabling and disabling wireless
783
891
  * gateway topic.</p>
784
892
  */
785
893
  Proximity?: ProximityResourceTypeEventConfiguration;
786
894
  /**
895
+ * @public
787
896
  * <p>Join resource type event configuration object for enabling and disabling wireless
788
897
  * device topic.</p>
789
898
  */
790
899
  Join?: JoinResourceTypeEventConfiguration;
791
900
  /**
901
+ * @public
792
902
  * <p>Connection status resource type event configuration object for enabling and disabling
793
903
  * wireless gateway topic.</p>
794
904
  */
795
905
  ConnectionStatus?: ConnectionStatusResourceTypeEventConfiguration;
796
906
  /**
907
+ * @public
797
908
  * <p>Message delivery status resource type event configuration object for enabling and
798
909
  * disabling wireless device topic.</p>
799
910
  */
@@ -809,31 +920,38 @@ export interface UpdateEventConfigurationByResourceTypesResponse {
809
920
  */
810
921
  export interface UpdateFuotaTaskRequest {
811
922
  /**
923
+ * @public
812
924
  * <p>The ID of a FUOTA task.</p>
813
925
  */
814
926
  Id: string | undefined;
815
927
  /**
928
+ * @public
816
929
  * <p>The name of a FUOTA task.</p>
817
930
  */
818
931
  Name?: string;
819
932
  /**
933
+ * @public
820
934
  * <p>The description of the new resource.</p>
821
935
  */
822
936
  Description?: string;
823
937
  /**
938
+ * @public
824
939
  * <p>The LoRaWAN information used with a FUOTA task.</p>
825
940
  */
826
941
  LoRaWAN?: LoRaWANFuotaTask;
827
942
  /**
943
+ * @public
828
944
  * <p>The S3 URI points to a firmware update image that is to be used with a FUOTA
829
945
  * task.</p>
830
946
  */
831
947
  FirmwareUpdateImage?: string;
832
948
  /**
949
+ * @public
833
950
  * <p>The firmware update role that is to be used with a FUOTA task.</p>
834
951
  */
835
952
  FirmwareUpdateRole?: string;
836
953
  /**
954
+ * @public
837
955
  * <p>The percentage of the added fragments that are redundant. For example, if the size of
838
956
  * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
839
957
  * <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments
@@ -841,11 +959,13 @@ export interface UpdateFuotaTaskRequest {
841
959
  */
842
960
  RedundancyPercent?: number;
843
961
  /**
962
+ * @public
844
963
  * <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks
845
964
  * with multicast groups.</p>
846
965
  */
847
966
  FragmentSizeBytes?: number;
848
967
  /**
968
+ * @public
849
969
  * <p>The interval for sending fragments in milliseconds, rounded to the nearest
850
970
  * second.</p>
851
971
  * <note>
@@ -867,16 +987,19 @@ export interface UpdateFuotaTaskResponse {
867
987
  */
868
988
  export interface UpdateLogLevelsByResourceTypesRequest {
869
989
  /**
990
+ * @public
870
991
  * <p>The log level for a log message. The log levels can be disabled, or set to
871
992
  * <code>ERROR</code> to display less verbose logs containing only error information,
872
993
  * or to <code>INFO</code> for more detailed logs.</p>
873
994
  */
874
995
  DefaultLogLevel?: LogLevel | string;
875
996
  /**
997
+ * @public
876
998
  * <p>The list of wireless device log options.</p>
877
999
  */
878
1000
  WirelessDeviceLogOptions?: WirelessDeviceLogOption[];
879
1001
  /**
1002
+ * @public
880
1003
  * <p>The list of wireless gateway log options.</p>
881
1004
  */
882
1005
  WirelessGatewayLogOptions?: WirelessGatewayLogOption[];
@@ -891,18 +1014,22 @@ export interface UpdateLogLevelsByResourceTypesResponse {
891
1014
  */
892
1015
  export interface UpdateMulticastGroupRequest {
893
1016
  /**
1017
+ * @public
894
1018
  * <p>The ID of the multicast group.</p>
895
1019
  */
896
1020
  Id: string | undefined;
897
1021
  /**
1022
+ * @public
898
1023
  * <p>The name of the multicast group.</p>
899
1024
  */
900
1025
  Name?: string;
901
1026
  /**
1027
+ * @public
902
1028
  * <p>The description of the new resource.</p>
903
1029
  */
904
1030
  Description?: string;
905
1031
  /**
1032
+ * @public
906
1033
  * <p>The LoRaWAN information that is to be used with the multicast group.</p>
907
1034
  */
908
1035
  LoRaWAN?: LoRaWANMulticast;
@@ -917,43 +1044,52 @@ export interface UpdateMulticastGroupResponse {
917
1044
  */
918
1045
  export interface UpdateNetworkAnalyzerConfigurationRequest {
919
1046
  /**
1047
+ * @public
920
1048
  * <p>Name of the network analyzer configuration.</p>
921
1049
  */
922
1050
  ConfigurationName: string | undefined;
923
1051
  /**
1052
+ * @public
924
1053
  * <p>Trace content for your wireless gateway and wireless device resources.</p>
925
1054
  */
926
1055
  TraceContent?: TraceContent;
927
1056
  /**
1057
+ * @public
928
1058
  * <p>Wireless device resources to add to the network analyzer configuration. Provide the
929
1059
  * <code>WirelessDeviceId</code> of the resource to add in the input array.</p>
930
1060
  */
931
1061
  WirelessDevicesToAdd?: string[];
932
1062
  /**
1063
+ * @public
933
1064
  * <p>Wireless device resources to remove from the network analyzer configuration. Provide
934
1065
  * the <code>WirelessDeviceId</code> of the resources to remove in the input array.</p>
935
1066
  */
936
1067
  WirelessDevicesToRemove?: string[];
937
1068
  /**
1069
+ * @public
938
1070
  * <p>Wireless gateway resources to add to the network analyzer configuration. Provide the
939
1071
  * <code>WirelessGatewayId</code> of the resource to add in the input array.</p>
940
1072
  */
941
1073
  WirelessGatewaysToAdd?: string[];
942
1074
  /**
1075
+ * @public
943
1076
  * <p>Wireless gateway resources to remove from the network analyzer configuration. Provide
944
1077
  * the <code>WirelessGatewayId</code> of the resources to remove in the input array.</p>
945
1078
  */
946
1079
  WirelessGatewaysToRemove?: string[];
947
1080
  /**
1081
+ * @public
948
1082
  * <p>The description of the new resource.</p>
949
1083
  */
950
1084
  Description?: string;
951
1085
  /**
1086
+ * @public
952
1087
  * <p>Multicast group resources to add to the network analyzer configuration. Provide the
953
1088
  * <code>MulticastGroupId</code> of the resource to add in the input array.</p>
954
1089
  */
955
1090
  MulticastGroupsToAdd?: string[];
956
1091
  /**
1092
+ * @public
957
1093
  * <p>Multicast group resources to remove from the network analyzer configuration. Provide the
958
1094
  * <code>MulticastGroupId</code> of the resource to remove in the input array.</p>
959
1095
  */
@@ -970,6 +1106,7 @@ export interface UpdateNetworkAnalyzerConfigurationResponse {
970
1106
  */
971
1107
  export interface SidewalkUpdateAccount {
972
1108
  /**
1109
+ * @public
973
1110
  * <p>The new Sidewalk application server private key.</p>
974
1111
  */
975
1112
  AppServerPrivateKey?: string;
@@ -979,14 +1116,17 @@ export interface SidewalkUpdateAccount {
979
1116
  */
980
1117
  export interface UpdatePartnerAccountRequest {
981
1118
  /**
1119
+ * @public
982
1120
  * <p>The Sidewalk account credentials.</p>
983
1121
  */
984
1122
  Sidewalk: SidewalkUpdateAccount | undefined;
985
1123
  /**
1124
+ * @public
986
1125
  * <p>The ID of the partner account to update.</p>
987
1126
  */
988
1127
  PartnerAccountId: string | undefined;
989
1128
  /**
1129
+ * @public
990
1130
  * <p>The partner type.</p>
991
1131
  */
992
1132
  PartnerType: PartnerType | string | undefined;
@@ -1001,14 +1141,17 @@ export interface UpdatePartnerAccountResponse {
1001
1141
  */
1002
1142
  export interface UpdatePositionRequest {
1003
1143
  /**
1144
+ * @public
1004
1145
  * <p>Resource identifier of the resource for which position is updated.</p>
1005
1146
  */
1006
1147
  ResourceIdentifier: string | undefined;
1007
1148
  /**
1149
+ * @public
1008
1150
  * <p>Resource type of the resource for which position is updated.</p>
1009
1151
  */
1010
1152
  ResourceType: PositionResourceType | string | undefined;
1011
1153
  /**
1154
+ * @public
1012
1155
  * <p>The position information of the resource.</p>
1013
1156
  */
1014
1157
  Position: number[] | undefined;
@@ -1023,36 +1166,44 @@ export interface UpdatePositionResponse {
1023
1166
  */
1024
1167
  export interface UpdateResourceEventConfigurationRequest {
1025
1168
  /**
1169
+ * @public
1026
1170
  * <p>Resource identifier to opt in for event messaging.</p>
1027
1171
  */
1028
1172
  Identifier: string | undefined;
1029
1173
  /**
1174
+ * @public
1030
1175
  * <p>Identifier type of the particular resource identifier for event configuration.</p>
1031
1176
  */
1032
1177
  IdentifierType: IdentifierType | string | undefined;
1033
1178
  /**
1179
+ * @public
1034
1180
  * <p>Partner type of the resource if the identifier type is
1035
1181
  * <code>PartnerAccountId</code>
1036
1182
  * </p>
1037
1183
  */
1038
1184
  PartnerType?: EventNotificationPartnerType | string;
1039
1185
  /**
1186
+ * @public
1040
1187
  * <p>Event configuration for the device registration state event.</p>
1041
1188
  */
1042
1189
  DeviceRegistrationState?: DeviceRegistrationStateEventConfiguration;
1043
1190
  /**
1191
+ * @public
1044
1192
  * <p>Event configuration for the proximity event.</p>
1045
1193
  */
1046
1194
  Proximity?: ProximityEventConfiguration;
1047
1195
  /**
1196
+ * @public
1048
1197
  * <p>Event configuration for the join event.</p>
1049
1198
  */
1050
1199
  Join?: JoinEventConfiguration;
1051
1200
  /**
1201
+ * @public
1052
1202
  * <p>Event configuration for the connection status event.</p>
1053
1203
  */
1054
1204
  ConnectionStatus?: ConnectionStatusEventConfiguration;
1055
1205
  /**
1206
+ * @public
1056
1207
  * <p>Event configuration for the message delivery status event.</p>
1057
1208
  */
1058
1209
  MessageDeliveryStatus?: MessageDeliveryStatusEventConfiguration;
@@ -1067,16 +1218,19 @@ export interface UpdateResourceEventConfigurationResponse {
1067
1218
  */
1068
1219
  export interface UpdateResourcePositionRequest {
1069
1220
  /**
1221
+ * @public
1070
1222
  * <p>The identifier of the resource for which position information is updated. It can be the
1071
1223
  * wireless device ID or the wireless gateway ID, depending on the resource type.</p>
1072
1224
  */
1073
1225
  ResourceIdentifier: string | undefined;
1074
1226
  /**
1227
+ * @public
1075
1228
  * <p>The type of resource for which position information is updated, which can be a wireless device or a
1076
1229
  * wireless gateway.</p>
1077
1230
  */
1078
1231
  ResourceType: PositionResourceType | string | undefined;
1079
1232
  /**
1233
+ * @public
1080
1234
  * <p>The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format,
1081
1235
  * which a format that's used to encode geographic data structures. For more information, see <a href="https://geojson.org/">GeoJSON</a>.</p>
1082
1236
  */
@@ -1093,6 +1247,7 @@ export interface UpdateResourcePositionResponse {
1093
1247
  */
1094
1248
  export interface UpdateAbpV1_0_x {
1095
1249
  /**
1250
+ * @public
1096
1251
  * <p>The FCnt init value.</p>
1097
1252
  */
1098
1253
  FCntStart?: number;
@@ -1103,6 +1258,7 @@ export interface UpdateAbpV1_0_x {
1103
1258
  */
1104
1259
  export interface UpdateAbpV1_1 {
1105
1260
  /**
1261
+ * @public
1106
1262
  * <p>The FCnt init value.</p>
1107
1263
  */
1108
1264
  FCntStart?: number;
@@ -1113,10 +1269,12 @@ export interface UpdateAbpV1_1 {
1113
1269
  */
1114
1270
  export interface UpdateFPorts {
1115
1271
  /**
1272
+ * @public
1116
1273
  * <p>Positioning FPorts for the ClockSync, Stream, and GNSS functions.</p>
1117
1274
  */
1118
1275
  Positioning?: Positioning;
1119
1276
  /**
1277
+ * @public
1120
1278
  * <p>LoRaWAN application, which can be used for geolocation by activating positioning.</p>
1121
1279
  */
1122
1280
  Applications?: ApplicationConfig[];
@@ -1127,22 +1285,27 @@ export interface UpdateFPorts {
1127
1285
  */
1128
1286
  export interface LoRaWANUpdateDevice {
1129
1287
  /**
1288
+ * @public
1130
1289
  * <p>The ID of the device profile for the wireless device.</p>
1131
1290
  */
1132
1291
  DeviceProfileId?: string;
1133
1292
  /**
1293
+ * @public
1134
1294
  * <p>The ID of the service profile.</p>
1135
1295
  */
1136
1296
  ServiceProfileId?: string;
1137
1297
  /**
1298
+ * @public
1138
1299
  * <p>ABP device object for update APIs for v1.1</p>
1139
1300
  */
1140
1301
  AbpV1_1?: UpdateAbpV1_1;
1141
1302
  /**
1303
+ * @public
1142
1304
  * <p>ABP device object for update APIs for v1.0.x</p>
1143
1305
  */
1144
1306
  AbpV1_0_x?: UpdateAbpV1_0_x;
1145
1307
  /**
1308
+ * @public
1146
1309
  * <p>FPorts object for the positioning information of the device.</p>
1147
1310
  */
1148
1311
  FPorts?: UpdateFPorts;
@@ -1152,26 +1315,32 @@ export interface LoRaWANUpdateDevice {
1152
1315
  */
1153
1316
  export interface UpdateWirelessDeviceRequest {
1154
1317
  /**
1318
+ * @public
1155
1319
  * <p>The ID of the resource to update.</p>
1156
1320
  */
1157
1321
  Id: string | undefined;
1158
1322
  /**
1323
+ * @public
1159
1324
  * <p>The name of the new destination for the device.</p>
1160
1325
  */
1161
1326
  DestinationName?: string;
1162
1327
  /**
1328
+ * @public
1163
1329
  * <p>The new name of the resource.</p>
1164
1330
  */
1165
1331
  Name?: string;
1166
1332
  /**
1333
+ * @public
1167
1334
  * <p>A new description of the resource.</p>
1168
1335
  */
1169
1336
  Description?: string;
1170
1337
  /**
1338
+ * @public
1171
1339
  * <p>The updated wireless device's configuration.</p>
1172
1340
  */
1173
1341
  LoRaWAN?: LoRaWANUpdateDevice;
1174
1342
  /**
1343
+ * @public
1175
1344
  * <p>FPort values for the GNSS, stream, and ClockSync functions of the positioning
1176
1345
  * information.</p>
1177
1346
  */
@@ -1188,6 +1357,7 @@ export interface UpdateWirelessDeviceResponse {
1188
1357
  */
1189
1358
  export interface SidewalkUpdateImportInfo {
1190
1359
  /**
1360
+ * @public
1191
1361
  * <p>The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.</p>
1192
1362
  */
1193
1363
  DeviceCreationFile?: string;
@@ -1197,10 +1367,12 @@ export interface SidewalkUpdateImportInfo {
1197
1367
  */
1198
1368
  export interface UpdateWirelessDeviceImportTaskRequest {
1199
1369
  /**
1370
+ * @public
1200
1371
  * <p>The identifier of the import task to be updated.</p>
1201
1372
  */
1202
1373
  Id: string | undefined;
1203
1374
  /**
1375
+ * @public
1204
1376
  * <p>The Sidewalk-related parameters of the import task to be updated.</p>
1205
1377
  */
1206
1378
  Sidewalk: SidewalkUpdateImportInfo | undefined;
@@ -1215,27 +1387,33 @@ export interface UpdateWirelessDeviceImportTaskResponse {
1215
1387
  */
1216
1388
  export interface UpdateWirelessGatewayRequest {
1217
1389
  /**
1390
+ * @public
1218
1391
  * <p>The ID of the resource to update.</p>
1219
1392
  */
1220
1393
  Id: string | undefined;
1221
1394
  /**
1395
+ * @public
1222
1396
  * <p>The new name of the resource.</p>
1223
1397
  */
1224
1398
  Name?: string;
1225
1399
  /**
1400
+ * @public
1226
1401
  * <p>A new description of the resource.</p>
1227
1402
  */
1228
1403
  Description?: string;
1229
1404
  /**
1405
+ * @public
1230
1406
  * <p>A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.</p>
1231
1407
  */
1232
1408
  JoinEuiFilters?: string[][];
1233
1409
  /**
1410
+ * @public
1234
1411
  * <p>A list of NetId values that are used by LoRa gateways to filter the uplink
1235
1412
  * frames.</p>
1236
1413
  */
1237
1414
  NetIdFilters?: string[];
1238
1415
  /**
1416
+ * @public
1239
1417
  * <p>The MaxEIRP value.</p>
1240
1418
  */
1241
1419
  MaxEirp?: number;