@aws-sdk/client-iot 3.378.0 → 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.
@@ -8,6 +8,7 @@ import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, Certificate
8
8
  */
9
9
  export interface ListPolicyVersionsResponse {
10
10
  /**
11
+ * @public
11
12
  * <p>The policy versions.</p>
12
13
  */
13
14
  policyVersions?: PolicyVersion[];
@@ -18,18 +19,22 @@ export interface ListPolicyVersionsResponse {
18
19
  */
19
20
  export interface ListPrincipalPoliciesRequest {
20
21
  /**
22
+ * @public
21
23
  * <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
22
24
  */
23
25
  principal: string | undefined;
24
26
  /**
27
+ * @public
25
28
  * <p>The marker for the next set of results.</p>
26
29
  */
27
30
  marker?: string;
28
31
  /**
32
+ * @public
29
33
  * <p>The result page size.</p>
30
34
  */
31
35
  pageSize?: number;
32
36
  /**
37
+ * @public
33
38
  * <p>Specifies the order for results. If true, results are returned in ascending creation
34
39
  * order.</p>
35
40
  */
@@ -41,10 +46,12 @@ export interface ListPrincipalPoliciesRequest {
41
46
  */
42
47
  export interface ListPrincipalPoliciesResponse {
43
48
  /**
49
+ * @public
44
50
  * <p>The policies.</p>
45
51
  */
46
52
  policies?: Policy[];
47
53
  /**
54
+ * @public
48
55
  * <p>The marker for the next set of results, or null if there are no additional
49
56
  * results.</p>
50
57
  */
@@ -56,16 +63,19 @@ export interface ListPrincipalPoliciesResponse {
56
63
  */
57
64
  export interface ListPrincipalThingsRequest {
58
65
  /**
66
+ * @public
59
67
  * <p>To retrieve the next set of results, the <code>nextToken</code>
60
68
  * value from a previous response; otherwise <b>null</b> to receive
61
69
  * the first set of results.</p>
62
70
  */
63
71
  nextToken?: string;
64
72
  /**
73
+ * @public
65
74
  * <p>The maximum number of results to return in this operation.</p>
66
75
  */
67
76
  maxResults?: number;
68
77
  /**
78
+ * @public
69
79
  * <p>The principal.</p>
70
80
  */
71
81
  principal: string | undefined;
@@ -76,10 +86,12 @@ export interface ListPrincipalThingsRequest {
76
86
  */
77
87
  export interface ListPrincipalThingsResponse {
78
88
  /**
89
+ * @public
79
90
  * <p>The things.</p>
80
91
  */
81
92
  things?: string[];
82
93
  /**
94
+ * @public
83
95
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
84
96
  */
85
97
  nextToken?: string;
@@ -89,10 +101,12 @@ export interface ListPrincipalThingsResponse {
89
101
  */
90
102
  export interface ListProvisioningTemplatesRequest {
91
103
  /**
104
+ * @public
92
105
  * <p>The maximum number of results to return at one time.</p>
93
106
  */
94
107
  maxResults?: number;
95
108
  /**
109
+ * @public
96
110
  * <p>A token to retrieve the next set of results.</p>
97
111
  */
98
112
  nextToken?: string;
@@ -103,30 +117,37 @@ export interface ListProvisioningTemplatesRequest {
103
117
  */
104
118
  export interface ProvisioningTemplateSummary {
105
119
  /**
120
+ * @public
106
121
  * <p>The ARN of the provisioning template.</p>
107
122
  */
108
123
  templateArn?: string;
109
124
  /**
125
+ * @public
110
126
  * <p>The name of the provisioning template.</p>
111
127
  */
112
128
  templateName?: string;
113
129
  /**
130
+ * @public
114
131
  * <p>The description of the provisioning template.</p>
115
132
  */
116
133
  description?: string;
117
134
  /**
135
+ * @public
118
136
  * <p>The date when the provisioning template summary was created.</p>
119
137
  */
120
138
  creationDate?: Date;
121
139
  /**
140
+ * @public
122
141
  * <p>The date when the provisioning template summary was last modified.</p>
123
142
  */
124
143
  lastModifiedDate?: Date;
125
144
  /**
145
+ * @public
126
146
  * <p>True if the fleet provision template is enabled, otherwise false.</p>
127
147
  */
128
148
  enabled?: boolean;
129
149
  /**
150
+ * @public
130
151
  * <p>The type you define in a provisioning template. You can create a template with only one type.
131
152
  * You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>.
132
153
  * For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.
@@ -139,10 +160,12 @@ export interface ProvisioningTemplateSummary {
139
160
  */
140
161
  export interface ListProvisioningTemplatesResponse {
141
162
  /**
163
+ * @public
142
164
  * <p>A list of provisioning templates</p>
143
165
  */
144
166
  templates?: ProvisioningTemplateSummary[];
145
167
  /**
168
+ * @public
146
169
  * <p>A token to retrieve the next set of results.</p>
147
170
  */
148
171
  nextToken?: string;
@@ -152,14 +175,17 @@ export interface ListProvisioningTemplatesResponse {
152
175
  */
153
176
  export interface ListProvisioningTemplateVersionsRequest {
154
177
  /**
178
+ * @public
155
179
  * <p>The name of the provisioning template.</p>
156
180
  */
157
181
  templateName: string | undefined;
158
182
  /**
183
+ * @public
159
184
  * <p>The maximum number of results to return at one time.</p>
160
185
  */
161
186
  maxResults?: number;
162
187
  /**
188
+ * @public
163
189
  * <p>A token to retrieve the next set of results.</p>
164
190
  */
165
191
  nextToken?: string;
@@ -170,14 +196,17 @@ export interface ListProvisioningTemplateVersionsRequest {
170
196
  */
171
197
  export interface ProvisioningTemplateVersionSummary {
172
198
  /**
199
+ * @public
173
200
  * <p>The ID of the fleet provisioning template version.</p>
174
201
  */
175
202
  versionId?: number;
176
203
  /**
204
+ * @public
177
205
  * <p>The date when the provisioning template version was created</p>
178
206
  */
179
207
  creationDate?: Date;
180
208
  /**
209
+ * @public
181
210
  * <p>True if the provisioning template version is the default version, otherwise
182
211
  * false.</p>
183
212
  */
@@ -188,10 +217,12 @@ export interface ProvisioningTemplateVersionSummary {
188
217
  */
189
218
  export interface ListProvisioningTemplateVersionsResponse {
190
219
  /**
220
+ * @public
191
221
  * <p>The list of provisioning template versions.</p>
192
222
  */
193
223
  versions?: ProvisioningTemplateVersionSummary[];
194
224
  /**
225
+ * @public
195
226
  * <p>A token to retrieve the next set of results.</p>
196
227
  */
197
228
  nextToken?: string;
@@ -201,15 +232,18 @@ export interface ListProvisioningTemplateVersionsResponse {
201
232
  */
202
233
  export interface ListRelatedResourcesForAuditFindingRequest {
203
234
  /**
235
+ * @public
204
236
  * <p>The finding Id.</p>
205
237
  */
206
238
  findingId: string | undefined;
207
239
  /**
240
+ * @public
208
241
  * <p>A token that can be used to retrieve the next set of results,
209
242
  * or <code>null</code> if there are no additional results.</p>
210
243
  */
211
244
  nextToken?: string;
212
245
  /**
246
+ * @public
213
247
  * <p>The maximum number of results to return at one time.</p>
214
248
  */
215
249
  maxResults?: number;
@@ -219,10 +253,12 @@ export interface ListRelatedResourcesForAuditFindingRequest {
219
253
  */
220
254
  export interface ListRelatedResourcesForAuditFindingResponse {
221
255
  /**
256
+ * @public
222
257
  * <p>The related resources.</p>
223
258
  */
224
259
  relatedResources?: RelatedResource[];
225
260
  /**
261
+ * @public
226
262
  * <p>A token that can be used to retrieve the next set of results,
227
263
  * or <code>null</code> for the first API call.</p>
228
264
  */
@@ -233,14 +269,17 @@ export interface ListRelatedResourcesForAuditFindingResponse {
233
269
  */
234
270
  export interface ListRoleAliasesRequest {
235
271
  /**
272
+ * @public
236
273
  * <p>The maximum number of results to return at one time.</p>
237
274
  */
238
275
  pageSize?: number;
239
276
  /**
277
+ * @public
240
278
  * <p>A marker used to get the next set of results.</p>
241
279
  */
242
280
  marker?: string;
243
281
  /**
282
+ * @public
244
283
  * <p>Return the list of role aliases in ascending alphabetical order.</p>
245
284
  */
246
285
  ascendingOrder?: boolean;
@@ -250,10 +289,12 @@ export interface ListRoleAliasesRequest {
250
289
  */
251
290
  export interface ListRoleAliasesResponse {
252
291
  /**
292
+ * @public
253
293
  * <p>The role aliases.</p>
254
294
  */
255
295
  roleAliases?: string[];
256
296
  /**
297
+ * @public
257
298
  * <p>A marker used to get the next set of results.</p>
258
299
  */
259
300
  nextMarker?: string;
@@ -263,10 +304,12 @@ export interface ListRoleAliasesResponse {
263
304
  */
264
305
  export interface ListScheduledAuditsRequest {
265
306
  /**
307
+ * @public
266
308
  * <p>The token for the next set of results.</p>
267
309
  */
268
310
  nextToken?: string;
269
311
  /**
312
+ * @public
270
313
  * <p>The maximum number of results to return at one time. The default is 25.</p>
271
314
  */
272
315
  maxResults?: number;
@@ -277,18 +320,22 @@ export interface ListScheduledAuditsRequest {
277
320
  */
278
321
  export interface ScheduledAuditMetadata {
279
322
  /**
323
+ * @public
280
324
  * <p>The name of the scheduled audit.</p>
281
325
  */
282
326
  scheduledAuditName?: string;
283
327
  /**
328
+ * @public
284
329
  * <p>The ARN of the scheduled audit.</p>
285
330
  */
286
331
  scheduledAuditArn?: string;
287
332
  /**
333
+ * @public
288
334
  * <p>How often the scheduled audit occurs.</p>
289
335
  */
290
336
  frequency?: AuditFrequency | string;
291
337
  /**
338
+ * @public
292
339
  * <p>The day of the month on which the scheduled audit is run (if the
293
340
  * <code>frequency</code> is "MONTHLY").
294
341
  * If days 29-31 are specified, and the month does not have that many
@@ -296,6 +343,7 @@ export interface ScheduledAuditMetadata {
296
343
  */
297
344
  dayOfMonth?: string;
298
345
  /**
346
+ * @public
299
347
  * <p>The day of the week on which the scheduled audit is run (if the
300
348
  * <code>frequency</code> is "WEEKLY" or "BIWEEKLY").</p>
301
349
  */
@@ -306,10 +354,12 @@ export interface ScheduledAuditMetadata {
306
354
  */
307
355
  export interface ListScheduledAuditsResponse {
308
356
  /**
357
+ * @public
309
358
  * <p>The list of scheduled audits.</p>
310
359
  */
311
360
  scheduledAudits?: ScheduledAuditMetadata[];
312
361
  /**
362
+ * @public
313
363
  * <p>A token that can be used to retrieve the next set of results,
314
364
  * or <code>null</code> if there are no additional results.</p>
315
365
  */
@@ -320,20 +370,24 @@ export interface ListScheduledAuditsResponse {
320
370
  */
321
371
  export interface ListSecurityProfilesRequest {
322
372
  /**
373
+ * @public
323
374
  * <p>The token for the next set of results.</p>
324
375
  */
325
376
  nextToken?: string;
326
377
  /**
378
+ * @public
327
379
  * <p>The maximum number of results to return at one time.</p>
328
380
  */
329
381
  maxResults?: number;
330
382
  /**
383
+ * @public
331
384
  * <p>A filter to limit results to the security profiles that use the defined dimension.
332
385
  * Cannot be used with <code>metricName</code>
333
386
  * </p>
334
387
  */
335
388
  dimensionName?: string;
336
389
  /**
390
+ * @public
337
391
  * <p> The name of the custom metric.
338
392
  * Cannot be used with <code>dimensionName</code>. </p>
339
393
  */
@@ -345,10 +399,12 @@ export interface ListSecurityProfilesRequest {
345
399
  */
346
400
  export interface SecurityProfileIdentifier {
347
401
  /**
402
+ * @public
348
403
  * <p>The name you've given to the security profile.</p>
349
404
  */
350
405
  name: string | undefined;
351
406
  /**
407
+ * @public
352
408
  * <p>The ARN of the security profile.</p>
353
409
  */
354
410
  arn: string | undefined;
@@ -358,10 +414,12 @@ export interface SecurityProfileIdentifier {
358
414
  */
359
415
  export interface ListSecurityProfilesResponse {
360
416
  /**
417
+ * @public
361
418
  * <p>A list of security profile identifiers (names and ARNs).</p>
362
419
  */
363
420
  securityProfileIdentifiers?: SecurityProfileIdentifier[];
364
421
  /**
422
+ * @public
365
423
  * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
366
424
  * additional results.</p>
367
425
  */
@@ -372,18 +430,22 @@ export interface ListSecurityProfilesResponse {
372
430
  */
373
431
  export interface ListSecurityProfilesForTargetRequest {
374
432
  /**
433
+ * @public
375
434
  * <p>The token for the next set of results.</p>
376
435
  */
377
436
  nextToken?: string;
378
437
  /**
438
+ * @public
379
439
  * <p>The maximum number of results to return at one time.</p>
380
440
  */
381
441
  maxResults?: number;
382
442
  /**
443
+ * @public
383
444
  * <p>If true, return child groups too.</p>
384
445
  */
385
446
  recursive?: boolean;
386
447
  /**
448
+ * @public
387
449
  * <p>The ARN of the target (thing group) whose attached security profiles you want to get.</p>
388
450
  */
389
451
  securityProfileTargetArn: string | undefined;
@@ -395,6 +457,7 @@ export interface ListSecurityProfilesForTargetRequest {
395
457
  */
396
458
  export interface SecurityProfileTarget {
397
459
  /**
460
+ * @public
398
461
  * <p>The ARN of the security profile.</p>
399
462
  */
400
463
  arn: string | undefined;
@@ -405,10 +468,12 @@ export interface SecurityProfileTarget {
405
468
  */
406
469
  export interface SecurityProfileTargetMapping {
407
470
  /**
471
+ * @public
408
472
  * <p>Information that identifies the security profile.</p>
409
473
  */
410
474
  securityProfileIdentifier?: SecurityProfileIdentifier;
411
475
  /**
476
+ * @public
412
477
  * <p>Information about the target (thing group) associated with the security profile.</p>
413
478
  */
414
479
  target?: SecurityProfileTarget;
@@ -418,10 +483,12 @@ export interface SecurityProfileTargetMapping {
418
483
  */
419
484
  export interface ListSecurityProfilesForTargetResponse {
420
485
  /**
486
+ * @public
421
487
  * <p>A list of security profiles and their associated targets.</p>
422
488
  */
423
489
  securityProfileTargetMappings?: SecurityProfileTargetMapping[];
424
490
  /**
491
+ * @public
425
492
  * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
426
493
  * additional results.</p>
427
494
  */
@@ -432,14 +499,17 @@ export interface ListSecurityProfilesForTargetResponse {
432
499
  */
433
500
  export interface ListStreamsRequest {
434
501
  /**
502
+ * @public
435
503
  * <p>The maximum number of results to return at a time.</p>
436
504
  */
437
505
  maxResults?: number;
438
506
  /**
507
+ * @public
439
508
  * <p>A token used to get the next set of results.</p>
440
509
  */
441
510
  nextToken?: string;
442
511
  /**
512
+ * @public
443
513
  * <p>Set to true to return the list of streams in ascending order.</p>
444
514
  */
445
515
  ascendingOrder?: boolean;
@@ -450,18 +520,22 @@ export interface ListStreamsRequest {
450
520
  */
451
521
  export interface StreamSummary {
452
522
  /**
523
+ * @public
453
524
  * <p>The stream ID.</p>
454
525
  */
455
526
  streamId?: string;
456
527
  /**
528
+ * @public
457
529
  * <p>The stream ARN.</p>
458
530
  */
459
531
  streamArn?: string;
460
532
  /**
533
+ * @public
461
534
  * <p>The stream version.</p>
462
535
  */
463
536
  streamVersion?: number;
464
537
  /**
538
+ * @public
465
539
  * <p>A description of the stream.</p>
466
540
  */
467
541
  description?: string;
@@ -471,10 +545,12 @@ export interface StreamSummary {
471
545
  */
472
546
  export interface ListStreamsResponse {
473
547
  /**
548
+ * @public
474
549
  * <p>A list of streams.</p>
475
550
  */
476
551
  streams?: StreamSummary[];
477
552
  /**
553
+ * @public
478
554
  * <p>A token used to get the next set of results.</p>
479
555
  */
480
556
  nextToken?: string;
@@ -484,10 +560,12 @@ export interface ListStreamsResponse {
484
560
  */
485
561
  export interface ListTagsForResourceRequest {
486
562
  /**
563
+ * @public
487
564
  * <p>The ARN of the resource.</p>
488
565
  */
489
566
  resourceArn: string | undefined;
490
567
  /**
568
+ * @public
491
569
  * <p>To retrieve the next set of results, the <code>nextToken</code>
492
570
  * value from a previous response; otherwise <b>null</b> to receive
493
571
  * the first set of results.</p>
@@ -499,10 +577,12 @@ export interface ListTagsForResourceRequest {
499
577
  */
500
578
  export interface ListTagsForResourceResponse {
501
579
  /**
580
+ * @public
502
581
  * <p>The list of tags assigned to the resource.</p>
503
582
  */
504
583
  tags?: Tag[];
505
584
  /**
585
+ * @public
506
586
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
507
587
  */
508
588
  nextToken?: string;
@@ -512,14 +592,17 @@ export interface ListTagsForResourceResponse {
512
592
  */
513
593
  export interface ListTargetsForPolicyRequest {
514
594
  /**
595
+ * @public
515
596
  * <p>The policy name.</p>
516
597
  */
517
598
  policyName: string | undefined;
518
599
  /**
600
+ * @public
519
601
  * <p>A marker used to get the next set of results.</p>
520
602
  */
521
603
  marker?: string;
522
604
  /**
605
+ * @public
523
606
  * <p>The maximum number of results to return at one time.</p>
524
607
  */
525
608
  pageSize?: number;
@@ -529,10 +612,12 @@ export interface ListTargetsForPolicyRequest {
529
612
  */
530
613
  export interface ListTargetsForPolicyResponse {
531
614
  /**
615
+ * @public
532
616
  * <p>The policy targets.</p>
533
617
  */
534
618
  targets?: string[];
535
619
  /**
620
+ * @public
536
621
  * <p>A marker used to get the next set of results.</p>
537
622
  */
538
623
  nextMarker?: string;
@@ -542,14 +627,17 @@ export interface ListTargetsForPolicyResponse {
542
627
  */
543
628
  export interface ListTargetsForSecurityProfileRequest {
544
629
  /**
630
+ * @public
545
631
  * <p>The security profile.</p>
546
632
  */
547
633
  securityProfileName: string | undefined;
548
634
  /**
635
+ * @public
549
636
  * <p>The token for the next set of results.</p>
550
637
  */
551
638
  nextToken?: string;
552
639
  /**
640
+ * @public
553
641
  * <p>The maximum number of results to return at one time.</p>
554
642
  */
555
643
  maxResults?: number;
@@ -559,10 +647,12 @@ export interface ListTargetsForSecurityProfileRequest {
559
647
  */
560
648
  export interface ListTargetsForSecurityProfileResponse {
561
649
  /**
650
+ * @public
562
651
  * <p>The thing groups to which the security profile is attached.</p>
563
652
  */
564
653
  securityProfileTargets?: SecurityProfileTarget[];
565
654
  /**
655
+ * @public
566
656
  * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
567
657
  * additional results.</p>
568
658
  */
@@ -573,24 +663,29 @@ export interface ListTargetsForSecurityProfileResponse {
573
663
  */
574
664
  export interface ListThingGroupsRequest {
575
665
  /**
666
+ * @public
576
667
  * <p>To retrieve the next set of results, the <code>nextToken</code>
577
668
  * value from a previous response; otherwise <b>null</b> to receive
578
669
  * the first set of results.</p>
579
670
  */
580
671
  nextToken?: string;
581
672
  /**
673
+ * @public
582
674
  * <p>The maximum number of results to return at one time.</p>
583
675
  */
584
676
  maxResults?: number;
585
677
  /**
678
+ * @public
586
679
  * <p>A filter that limits the results to those with the specified parent group.</p>
587
680
  */
588
681
  parentGroup?: string;
589
682
  /**
683
+ * @public
590
684
  * <p>A filter that limits the results to those with the specified name prefix.</p>
591
685
  */
592
686
  namePrefixFilter?: string;
593
687
  /**
688
+ * @public
594
689
  * <p>If true, return child groups as well.</p>
595
690
  */
596
691
  recursive?: boolean;
@@ -600,10 +695,12 @@ export interface ListThingGroupsRequest {
600
695
  */
601
696
  export interface ListThingGroupsResponse {
602
697
  /**
698
+ * @public
603
699
  * <p>The thing groups.</p>
604
700
  */
605
701
  thingGroups?: GroupNameAndArn[];
606
702
  /**
703
+ * @public
607
704
  * <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
608
705
  */
609
706
  nextToken?: string;
@@ -613,16 +710,19 @@ export interface ListThingGroupsResponse {
613
710
  */
614
711
  export interface ListThingGroupsForThingRequest {
615
712
  /**
713
+ * @public
616
714
  * <p>The thing name.</p>
617
715
  */
618
716
  thingName: string | undefined;
619
717
  /**
718
+ * @public
620
719
  * <p>To retrieve the next set of results, the <code>nextToken</code>
621
720
  * value from a previous response; otherwise <b>null</b> to receive
622
721
  * the first set of results.</p>
623
722
  */
624
723
  nextToken?: string;
625
724
  /**
725
+ * @public
626
726
  * <p>The maximum number of results to return at one time.</p>
627
727
  */
628
728
  maxResults?: number;
@@ -632,10 +732,12 @@ export interface ListThingGroupsForThingRequest {
632
732
  */
633
733
  export interface ListThingGroupsForThingResponse {
634
734
  /**
735
+ * @public
635
736
  * <p>The thing groups.</p>
636
737
  */
637
738
  thingGroups?: GroupNameAndArn[];
638
739
  /**
740
+ * @public
639
741
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
640
742
  */
641
743
  nextToken?: string;
@@ -646,16 +748,19 @@ export interface ListThingGroupsForThingResponse {
646
748
  */
647
749
  export interface ListThingPrincipalsRequest {
648
750
  /**
751
+ * @public
649
752
  * <p>To retrieve the next set of results, the <code>nextToken</code>
650
753
  * value from a previous response; otherwise <b>null</b> to receive
651
754
  * the first set of results.</p>
652
755
  */
653
756
  nextToken?: string;
654
757
  /**
758
+ * @public
655
759
  * <p>The maximum number of results to return in this operation.</p>
656
760
  */
657
761
  maxResults?: number;
658
762
  /**
763
+ * @public
659
764
  * <p>The name of the thing.</p>
660
765
  */
661
766
  thingName: string | undefined;
@@ -666,10 +771,12 @@ export interface ListThingPrincipalsRequest {
666
771
  */
667
772
  export interface ListThingPrincipalsResponse {
668
773
  /**
774
+ * @public
669
775
  * <p>The principals associated with the thing.</p>
670
776
  */
671
777
  principals?: string[];
672
778
  /**
779
+ * @public
673
780
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
674
781
  */
675
782
  nextToken?: string;
@@ -691,20 +798,24 @@ export type ReportType = (typeof ReportType)[keyof typeof ReportType];
691
798
  */
692
799
  export interface ListThingRegistrationTaskReportsRequest {
693
800
  /**
801
+ * @public
694
802
  * <p>The id of the task.</p>
695
803
  */
696
804
  taskId: string | undefined;
697
805
  /**
806
+ * @public
698
807
  * <p>The type of task report.</p>
699
808
  */
700
809
  reportType: ReportType | string | undefined;
701
810
  /**
811
+ * @public
702
812
  * <p>To retrieve the next set of results, the <code>nextToken</code>
703
813
  * value from a previous response; otherwise <b>null</b> to receive
704
814
  * the first set of results.</p>
705
815
  */
706
816
  nextToken?: string;
707
817
  /**
818
+ * @public
708
819
  * <p>The maximum number of results to return per request.</p>
709
820
  */
710
821
  maxResults?: number;
@@ -714,14 +825,17 @@ export interface ListThingRegistrationTaskReportsRequest {
714
825
  */
715
826
  export interface ListThingRegistrationTaskReportsResponse {
716
827
  /**
828
+ * @public
717
829
  * <p>Links to the task resources.</p>
718
830
  */
719
831
  resourceLinks?: string[];
720
832
  /**
833
+ * @public
721
834
  * <p>The type of task report.</p>
722
835
  */
723
836
  reportType?: ReportType | string;
724
837
  /**
838
+ * @public
725
839
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
726
840
  */
727
841
  nextToken?: string;
@@ -731,16 +845,19 @@ export interface ListThingRegistrationTaskReportsResponse {
731
845
  */
732
846
  export interface ListThingRegistrationTasksRequest {
733
847
  /**
848
+ * @public
734
849
  * <p>To retrieve the next set of results, the <code>nextToken</code>
735
850
  * value from a previous response; otherwise <b>null</b> to receive
736
851
  * the first set of results.</p>
737
852
  */
738
853
  nextToken?: string;
739
854
  /**
855
+ * @public
740
856
  * <p>The maximum number of results to return at one time.</p>
741
857
  */
742
858
  maxResults?: number;
743
859
  /**
860
+ * @public
744
861
  * <p>The status of the bulk thing provisioning task.</p>
745
862
  */
746
863
  status?: Status | string;
@@ -750,10 +867,12 @@ export interface ListThingRegistrationTasksRequest {
750
867
  */
751
868
  export interface ListThingRegistrationTasksResponse {
752
869
  /**
870
+ * @public
753
871
  * <p>A list of bulk thing provisioning task IDs.</p>
754
872
  */
755
873
  taskIds?: string[];
756
874
  /**
875
+ * @public
757
876
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
758
877
  */
759
878
  nextToken?: string;
@@ -764,28 +883,34 @@ export interface ListThingRegistrationTasksResponse {
764
883
  */
765
884
  export interface ListThingsRequest {
766
885
  /**
886
+ * @public
767
887
  * <p>To retrieve the next set of results, the <code>nextToken</code>
768
888
  * value from a previous response; otherwise <b>null</b> to receive
769
889
  * the first set of results.</p>
770
890
  */
771
891
  nextToken?: string;
772
892
  /**
893
+ * @public
773
894
  * <p>The maximum number of results to return in this operation.</p>
774
895
  */
775
896
  maxResults?: number;
776
897
  /**
898
+ * @public
777
899
  * <p>The attribute name used to search for things.</p>
778
900
  */
779
901
  attributeName?: string;
780
902
  /**
903
+ * @public
781
904
  * <p>The attribute value used to search for things.</p>
782
905
  */
783
906
  attributeValue?: string;
784
907
  /**
908
+ * @public
785
909
  * <p>The name of the thing type used to search for things.</p>
786
910
  */
787
911
  thingTypeName?: string;
788
912
  /**
913
+ * @public
789
914
  * <p>When <code>true</code>, the action returns the thing resources with attribute values
790
915
  * that start with the <code>attributeValue</code> provided.</p>
791
916
  * <p>When <code>false</code>, or not present, the action returns only the thing
@@ -801,22 +926,27 @@ export interface ListThingsRequest {
801
926
  */
802
927
  export interface ThingAttribute {
803
928
  /**
929
+ * @public
804
930
  * <p>The name of the thing.</p>
805
931
  */
806
932
  thingName?: string;
807
933
  /**
934
+ * @public
808
935
  * <p>The name of the thing type, if the thing has been associated with a type.</p>
809
936
  */
810
937
  thingTypeName?: string;
811
938
  /**
939
+ * @public
812
940
  * <p>The thing ARN.</p>
813
941
  */
814
942
  thingArn?: string;
815
943
  /**
944
+ * @public
816
945
  * <p>A list of thing attributes which are name-value pairs.</p>
817
946
  */
818
947
  attributes?: Record<string, string>;
819
948
  /**
949
+ * @public
820
950
  * <p>The version of the thing record in the registry.</p>
821
951
  */
822
952
  version?: number;
@@ -827,10 +957,12 @@ export interface ThingAttribute {
827
957
  */
828
958
  export interface ListThingsResponse {
829
959
  /**
960
+ * @public
830
961
  * <p>The things.</p>
831
962
  */
832
963
  things?: ThingAttribute[];
833
964
  /**
965
+ * @public
834
966
  * <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
835
967
  */
836
968
  nextToken?: string;
@@ -840,16 +972,19 @@ export interface ListThingsResponse {
840
972
  */
841
973
  export interface ListThingsInBillingGroupRequest {
842
974
  /**
975
+ * @public
843
976
  * <p>The name of the billing group.</p>
844
977
  */
845
978
  billingGroupName: string | undefined;
846
979
  /**
980
+ * @public
847
981
  * <p>To retrieve the next set of results, the <code>nextToken</code>
848
982
  * value from a previous response; otherwise <b>null</b> to receive
849
983
  * the first set of results.</p>
850
984
  */
851
985
  nextToken?: string;
852
986
  /**
987
+ * @public
853
988
  * <p>The maximum number of results to return per request.</p>
854
989
  */
855
990
  maxResults?: number;
@@ -859,10 +994,12 @@ export interface ListThingsInBillingGroupRequest {
859
994
  */
860
995
  export interface ListThingsInBillingGroupResponse {
861
996
  /**
997
+ * @public
862
998
  * <p>A list of things in the billing group.</p>
863
999
  */
864
1000
  things?: string[];
865
1001
  /**
1002
+ * @public
866
1003
  * <p>The token to use to get the next set of results. Will not be returned if operation has returned all results.</p>
867
1004
  */
868
1005
  nextToken?: string;
@@ -872,21 +1009,25 @@ export interface ListThingsInBillingGroupResponse {
872
1009
  */
873
1010
  export interface ListThingsInThingGroupRequest {
874
1011
  /**
1012
+ * @public
875
1013
  * <p>The thing group name.</p>
876
1014
  */
877
1015
  thingGroupName: string | undefined;
878
1016
  /**
1017
+ * @public
879
1018
  * <p>When true, list things in this thing group and in all child groups as
880
1019
  * well.</p>
881
1020
  */
882
1021
  recursive?: boolean;
883
1022
  /**
1023
+ * @public
884
1024
  * <p>To retrieve the next set of results, the <code>nextToken</code>
885
1025
  * value from a previous response; otherwise <b>null</b> to receive
886
1026
  * the first set of results.</p>
887
1027
  */
888
1028
  nextToken?: string;
889
1029
  /**
1030
+ * @public
890
1031
  * <p>The maximum number of results to return at one time.</p>
891
1032
  */
892
1033
  maxResults?: number;
@@ -896,10 +1037,12 @@ export interface ListThingsInThingGroupRequest {
896
1037
  */
897
1038
  export interface ListThingsInThingGroupResponse {
898
1039
  /**
1040
+ * @public
899
1041
  * <p>The things in the specified thing group.</p>
900
1042
  */
901
1043
  things?: string[];
902
1044
  /**
1045
+ * @public
903
1046
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
904
1047
  */
905
1048
  nextToken?: string;
@@ -910,16 +1053,19 @@ export interface ListThingsInThingGroupResponse {
910
1053
  */
911
1054
  export interface ListThingTypesRequest {
912
1055
  /**
1056
+ * @public
913
1057
  * <p>To retrieve the next set of results, the <code>nextToken</code>
914
1058
  * value from a previous response; otherwise <b>null</b> to receive
915
1059
  * the first set of results.</p>
916
1060
  */
917
1061
  nextToken?: string;
918
1062
  /**
1063
+ * @public
919
1064
  * <p>The maximum number of results to return in this operation.</p>
920
1065
  */
921
1066
  maxResults?: number;
922
1067
  /**
1068
+ * @public
923
1069
  * <p>The name of the thing type.</p>
924
1070
  */
925
1071
  thingTypeName?: string;
@@ -930,18 +1076,22 @@ export interface ListThingTypesRequest {
930
1076
  */
931
1077
  export interface ThingTypeDefinition {
932
1078
  /**
1079
+ * @public
933
1080
  * <p>The name of the thing type.</p>
934
1081
  */
935
1082
  thingTypeName?: string;
936
1083
  /**
1084
+ * @public
937
1085
  * <p>The thing type ARN.</p>
938
1086
  */
939
1087
  thingTypeArn?: string;
940
1088
  /**
1089
+ * @public
941
1090
  * <p>The ThingTypeProperties for the thing type.</p>
942
1091
  */
943
1092
  thingTypeProperties?: ThingTypeProperties;
944
1093
  /**
1094
+ * @public
945
1095
  * <p>The ThingTypeMetadata contains additional information about the thing type including: creation date and
946
1096
  * time, a value indicating whether the thing type is deprecated, and a date and time when it was
947
1097
  * deprecated.</p>
@@ -954,10 +1104,12 @@ export interface ThingTypeDefinition {
954
1104
  */
955
1105
  export interface ListThingTypesResponse {
956
1106
  /**
1107
+ * @public
957
1108
  * <p>The thing types.</p>
958
1109
  */
959
1110
  thingTypes?: ThingTypeDefinition[];
960
1111
  /**
1112
+ * @public
961
1113
  * <p>The token for the next set of results. Will not be returned if operation has returned all results.</p>
962
1114
  */
963
1115
  nextToken?: string;
@@ -967,10 +1119,12 @@ export interface ListThingTypesResponse {
967
1119
  */
968
1120
  export interface ListTopicRuleDestinationsRequest {
969
1121
  /**
1122
+ * @public
970
1123
  * <p>The maximum number of results to return at one time.</p>
971
1124
  */
972
1125
  maxResults?: number;
973
1126
  /**
1127
+ * @public
974
1128
  * <p>To retrieve the next set of results, the <code>nextToken</code>
975
1129
  * value from a previous response; otherwise <b>null</b> to receive
976
1130
  * the first set of results.</p>
@@ -983,6 +1137,7 @@ export interface ListTopicRuleDestinationsRequest {
983
1137
  */
984
1138
  export interface HttpUrlDestinationSummary {
985
1139
  /**
1140
+ * @public
986
1141
  * <p>The URL used to confirm ownership of or access to the HTTP topic rule destination
987
1142
  * URL.</p>
988
1143
  */
@@ -994,18 +1149,22 @@ export interface HttpUrlDestinationSummary {
994
1149
  */
995
1150
  export interface VpcDestinationSummary {
996
1151
  /**
1152
+ * @public
997
1153
  * <p>The subnet IDs of the VPC destination.</p>
998
1154
  */
999
1155
  subnetIds?: string[];
1000
1156
  /**
1157
+ * @public
1001
1158
  * <p>The security groups of the VPC destination.</p>
1002
1159
  */
1003
1160
  securityGroups?: string[];
1004
1161
  /**
1162
+ * @public
1005
1163
  * <p>The ID of the VPC.</p>
1006
1164
  */
1007
1165
  vpcId?: string;
1008
1166
  /**
1167
+ * @public
1009
1168
  * <p>The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).</p>
1010
1169
  */
1011
1170
  roleArn?: string;
@@ -1016,10 +1175,12 @@ export interface VpcDestinationSummary {
1016
1175
  */
1017
1176
  export interface TopicRuleDestinationSummary {
1018
1177
  /**
1178
+ * @public
1019
1179
  * <p>The topic rule destination ARN.</p>
1020
1180
  */
1021
1181
  arn?: string;
1022
1182
  /**
1183
+ * @public
1023
1184
  * <p>The status of the topic rule destination. Valid values are:</p>
1024
1185
  * <dl>
1025
1186
  * <dt>IN_PROGRESS</dt>
@@ -1055,22 +1216,27 @@ export interface TopicRuleDestinationSummary {
1055
1216
  */
1056
1217
  status?: TopicRuleDestinationStatus | string;
1057
1218
  /**
1219
+ * @public
1058
1220
  * <p>The date and time when the topic rule destination was created.</p>
1059
1221
  */
1060
1222
  createdAt?: Date;
1061
1223
  /**
1224
+ * @public
1062
1225
  * <p>The date and time when the topic rule destination was last updated.</p>
1063
1226
  */
1064
1227
  lastUpdatedAt?: Date;
1065
1228
  /**
1229
+ * @public
1066
1230
  * <p>The reason the topic rule destination is in the current status.</p>
1067
1231
  */
1068
1232
  statusReason?: string;
1069
1233
  /**
1234
+ * @public
1070
1235
  * <p>Information about the HTTP URL.</p>
1071
1236
  */
1072
1237
  httpUrlSummary?: HttpUrlDestinationSummary;
1073
1238
  /**
1239
+ * @public
1074
1240
  * <p>Information about the virtual private cloud (VPC) connection.</p>
1075
1241
  */
1076
1242
  vpcDestinationSummary?: VpcDestinationSummary;
@@ -1080,10 +1246,12 @@ export interface TopicRuleDestinationSummary {
1080
1246
  */
1081
1247
  export interface ListTopicRuleDestinationsResponse {
1082
1248
  /**
1249
+ * @public
1083
1250
  * <p>Information about a topic rule destination.</p>
1084
1251
  */
1085
1252
  destinationSummaries?: TopicRuleDestinationSummary[];
1086
1253
  /**
1254
+ * @public
1087
1255
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
1088
1256
  */
1089
1257
  nextToken?: string;
@@ -1094,20 +1262,24 @@ export interface ListTopicRuleDestinationsResponse {
1094
1262
  */
1095
1263
  export interface ListTopicRulesRequest {
1096
1264
  /**
1265
+ * @public
1097
1266
  * <p>The topic.</p>
1098
1267
  */
1099
1268
  topic?: string;
1100
1269
  /**
1270
+ * @public
1101
1271
  * <p>The maximum number of results to return.</p>
1102
1272
  */
1103
1273
  maxResults?: number;
1104
1274
  /**
1275
+ * @public
1105
1276
  * <p>To retrieve the next set of results, the <code>nextToken</code>
1106
1277
  * value from a previous response; otherwise <b>null</b> to receive
1107
1278
  * the first set of results.</p>
1108
1279
  */
1109
1280
  nextToken?: string;
1110
1281
  /**
1282
+ * @public
1111
1283
  * <p>Specifies whether the rule is disabled.</p>
1112
1284
  */
1113
1285
  ruleDisabled?: boolean;
@@ -1118,22 +1290,27 @@ export interface ListTopicRulesRequest {
1118
1290
  */
1119
1291
  export interface TopicRuleListItem {
1120
1292
  /**
1293
+ * @public
1121
1294
  * <p>The rule ARN.</p>
1122
1295
  */
1123
1296
  ruleArn?: string;
1124
1297
  /**
1298
+ * @public
1125
1299
  * <p>The name of the rule.</p>
1126
1300
  */
1127
1301
  ruleName?: string;
1128
1302
  /**
1303
+ * @public
1129
1304
  * <p>The pattern for the topic names that apply.</p>
1130
1305
  */
1131
1306
  topicPattern?: string;
1132
1307
  /**
1308
+ * @public
1133
1309
  * <p>The date and time the rule was created.</p>
1134
1310
  */
1135
1311
  createdAt?: Date;
1136
1312
  /**
1313
+ * @public
1137
1314
  * <p>Specifies whether the rule is disabled.</p>
1138
1315
  */
1139
1316
  ruleDisabled?: boolean;
@@ -1144,10 +1321,12 @@ export interface TopicRuleListItem {
1144
1321
  */
1145
1322
  export interface ListTopicRulesResponse {
1146
1323
  /**
1324
+ * @public
1147
1325
  * <p>The rules.</p>
1148
1326
  */
1149
1327
  rules?: TopicRuleListItem[];
1150
1328
  /**
1329
+ * @public
1151
1330
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
1152
1331
  */
1153
1332
  nextToken?: string;
@@ -1157,17 +1336,20 @@ export interface ListTopicRulesResponse {
1157
1336
  */
1158
1337
  export interface ListV2LoggingLevelsRequest {
1159
1338
  /**
1339
+ * @public
1160
1340
  * <p>The type of resource for which you are configuring logging. Must be
1161
1341
  * <code>THING_Group</code>.</p>
1162
1342
  */
1163
1343
  targetType?: LogTargetType | string;
1164
1344
  /**
1345
+ * @public
1165
1346
  * <p>To retrieve the next set of results, the <code>nextToken</code>
1166
1347
  * value from a previous response; otherwise <b>null</b> to receive
1167
1348
  * the first set of results.</p>
1168
1349
  */
1169
1350
  nextToken?: string;
1170
1351
  /**
1352
+ * @public
1171
1353
  * <p>The maximum number of results to return at one time.</p>
1172
1354
  */
1173
1355
  maxResults?: number;
@@ -1178,10 +1360,12 @@ export interface ListV2LoggingLevelsRequest {
1178
1360
  */
1179
1361
  export interface LogTarget {
1180
1362
  /**
1363
+ * @public
1181
1364
  * <p>The target type.</p>
1182
1365
  */
1183
1366
  targetType: LogTargetType | string | undefined;
1184
1367
  /**
1368
+ * @public
1185
1369
  * <p>The target name.</p>
1186
1370
  */
1187
1371
  targetName?: string;
@@ -1192,10 +1376,12 @@ export interface LogTarget {
1192
1376
  */
1193
1377
  export interface LogTargetConfiguration {
1194
1378
  /**
1379
+ * @public
1195
1380
  * <p>A log target</p>
1196
1381
  */
1197
1382
  logTarget?: LogTarget;
1198
1383
  /**
1384
+ * @public
1199
1385
  * <p>The logging level.</p>
1200
1386
  */
1201
1387
  logLevel?: LogLevel | string;
@@ -1205,10 +1391,12 @@ export interface LogTargetConfiguration {
1205
1391
  */
1206
1392
  export interface ListV2LoggingLevelsResponse {
1207
1393
  /**
1394
+ * @public
1208
1395
  * <p>The logging configuration for a target.</p>
1209
1396
  */
1210
1397
  logTargetConfigurations?: LogTargetConfiguration[];
1211
1398
  /**
1399
+ * @public
1212
1400
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
1213
1401
  */
1214
1402
  nextToken?: string;
@@ -1218,42 +1406,51 @@ export interface ListV2LoggingLevelsResponse {
1218
1406
  */
1219
1407
  export interface ListViolationEventsRequest {
1220
1408
  /**
1409
+ * @public
1221
1410
  * <p>The start time for the alerts to be listed.</p>
1222
1411
  */
1223
1412
  startTime: Date | undefined;
1224
1413
  /**
1414
+ * @public
1225
1415
  * <p>The end time for the alerts to be listed.</p>
1226
1416
  */
1227
1417
  endTime: Date | undefined;
1228
1418
  /**
1419
+ * @public
1229
1420
  * <p>A filter to limit results to those alerts caused by the specified thing.</p>
1230
1421
  */
1231
1422
  thingName?: string;
1232
1423
  /**
1424
+ * @public
1233
1425
  * <p>A filter to limit results to those alerts generated by the specified security profile.</p>
1234
1426
  */
1235
1427
  securityProfileName?: string;
1236
1428
  /**
1429
+ * @public
1237
1430
  * <p>
1238
1431
  * The criteria for a behavior.
1239
1432
  * </p>
1240
1433
  */
1241
1434
  behaviorCriteriaType?: BehaviorCriteriaType | string;
1242
1435
  /**
1436
+ * @public
1243
1437
  * <p>
1244
1438
  * A list of all suppressed alerts.
1245
1439
  * </p>
1246
1440
  */
1247
1441
  listSuppressedAlerts?: boolean;
1248
1442
  /**
1443
+ * @public
1249
1444
  * <p>The verification state of the violation (detect alarm).</p>
1250
1445
  */
1251
1446
  verificationState?: VerificationState | string;
1252
1447
  /**
1448
+ * @public
1253
1449
  * <p>The token for the next set of results.</p>
1254
1450
  */
1255
1451
  nextToken?: string;
1256
1452
  /**
1453
+ * @public
1257
1454
  * <p>The maximum number of results to return at one time.</p>
1258
1455
  */
1259
1456
  maxResults?: number;
@@ -1277,44 +1474,54 @@ export type ViolationEventType = (typeof ViolationEventType)[keyof typeof Violat
1277
1474
  */
1278
1475
  export interface ViolationEvent {
1279
1476
  /**
1477
+ * @public
1280
1478
  * <p>The ID of the violation event.</p>
1281
1479
  */
1282
1480
  violationId?: string;
1283
1481
  /**
1482
+ * @public
1284
1483
  * <p>The name of the thing responsible for the violation event.</p>
1285
1484
  */
1286
1485
  thingName?: string;
1287
1486
  /**
1487
+ * @public
1288
1488
  * <p>The name of the security profile whose behavior was violated.</p>
1289
1489
  */
1290
1490
  securityProfileName?: string;
1291
1491
  /**
1492
+ * @public
1292
1493
  * <p>The behavior that was violated.</p>
1293
1494
  */
1294
1495
  behavior?: Behavior;
1295
1496
  /**
1497
+ * @public
1296
1498
  * <p>The value of the metric (the measurement).</p>
1297
1499
  */
1298
1500
  metricValue?: MetricValue;
1299
1501
  /**
1502
+ * @public
1300
1503
  * <p>
1301
1504
  * The details of a violation event.
1302
1505
  * </p>
1303
1506
  */
1304
1507
  violationEventAdditionalInfo?: ViolationEventAdditionalInfo;
1305
1508
  /**
1509
+ * @public
1306
1510
  * <p>The type of violation event.</p>
1307
1511
  */
1308
1512
  violationEventType?: ViolationEventType | string;
1309
1513
  /**
1514
+ * @public
1310
1515
  * <p>The verification state of the violation (detect alarm).</p>
1311
1516
  */
1312
1517
  verificationState?: VerificationState | string;
1313
1518
  /**
1519
+ * @public
1314
1520
  * <p>The description of the verification state of the violation.</p>
1315
1521
  */
1316
1522
  verificationStateDescription?: string;
1317
1523
  /**
1524
+ * @public
1318
1525
  * <p>The time the violation event occurred.</p>
1319
1526
  */
1320
1527
  violationEventTime?: Date;
@@ -1324,11 +1531,13 @@ export interface ViolationEvent {
1324
1531
  */
1325
1532
  export interface ListViolationEventsResponse {
1326
1533
  /**
1534
+ * @public
1327
1535
  * <p>The security profile violation alerts issued for this account during the given time period,
1328
1536
  * potentially filtered by security profile, behavior violated, or thing (device) violating.</p>
1329
1537
  */
1330
1538
  violationEvents?: ViolationEvent[];
1331
1539
  /**
1540
+ * @public
1332
1541
  * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
1333
1542
  * additional results.</p>
1334
1543
  */
@@ -1339,14 +1548,17 @@ export interface ListViolationEventsResponse {
1339
1548
  */
1340
1549
  export interface PutVerificationStateOnViolationRequest {
1341
1550
  /**
1551
+ * @public
1342
1552
  * <p>The violation ID.</p>
1343
1553
  */
1344
1554
  violationId: string | undefined;
1345
1555
  /**
1556
+ * @public
1346
1557
  * <p>The verification state of the violation.</p>
1347
1558
  */
1348
1559
  verificationState: VerificationState | string | undefined;
1349
1560
  /**
1561
+ * @public
1350
1562
  * <p>The description of the verification state of the violation (detect alarm).</p>
1351
1563
  */
1352
1564
  verificationStateDescription?: string;
@@ -1362,10 +1574,12 @@ export interface PutVerificationStateOnViolationResponse {
1362
1574
  */
1363
1575
  export interface RegisterCACertificateRequest {
1364
1576
  /**
1577
+ * @public
1365
1578
  * <p>The CA certificate.</p>
1366
1579
  */
1367
1580
  caCertificate: string | undefined;
1368
1581
  /**
1582
+ * @public
1369
1583
  * <p>The private key verification certificate. If <code>certificateMode</code> is
1370
1584
  * <code>SNI_ONLY</code>, the <code>verificationCertificate</code> field must be empty. If
1371
1585
  * <code>certificateMode</code> is <code>DEFAULT</code> or not provided, the
@@ -1373,21 +1587,25 @@ export interface RegisterCACertificateRequest {
1373
1587
  */
1374
1588
  verificationCertificate?: string;
1375
1589
  /**
1590
+ * @public
1376
1591
  * <p>A boolean value that specifies if the CA certificate is set to active.</p>
1377
1592
  * <p>Valid values: <code>ACTIVE | INACTIVE</code>
1378
1593
  * </p>
1379
1594
  */
1380
1595
  setAsActive?: boolean;
1381
1596
  /**
1597
+ * @public
1382
1598
  * <p>Allows this CA certificate to be used for auto registration of device
1383
1599
  * certificates.</p>
1384
1600
  */
1385
1601
  allowAutoRegistration?: boolean;
1386
1602
  /**
1603
+ * @public
1387
1604
  * <p>Information about the registration configuration.</p>
1388
1605
  */
1389
1606
  registrationConfig?: RegistrationConfig;
1390
1607
  /**
1608
+ * @public
1391
1609
  * <p>Metadata which can be used to manage the CA certificate.</p>
1392
1610
  * <note>
1393
1611
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -1399,6 +1617,7 @@ export interface RegisterCACertificateRequest {
1399
1617
  */
1400
1618
  tags?: Tag[];
1401
1619
  /**
1620
+ * @public
1402
1621
  * <p>Describes the certificate mode in which the Certificate Authority (CA) will be
1403
1622
  * registered. If the <code>verificationCertificate</code> field is not provided, set <code>certificateMode</code> to be <code>SNI_ONLY</code>.
1404
1623
  * If the <code>verificationCertificate</code> field is provided, set <code>certificateMode</code> to be <code>DEFAULT</code>.
@@ -1417,10 +1636,12 @@ export interface RegisterCACertificateRequest {
1417
1636
  */
1418
1637
  export interface RegisterCACertificateResponse {
1419
1638
  /**
1639
+ * @public
1420
1640
  * <p>The CA certificate ARN.</p>
1421
1641
  */
1422
1642
  certificateArn?: string;
1423
1643
  /**
1644
+ * @public
1424
1645
  * <p>The CA certificate identifier.</p>
1425
1646
  */
1426
1647
  certificateId?: string;
@@ -1457,14 +1678,17 @@ export declare class CertificateConflictException extends __BaseException {
1457
1678
  */
1458
1679
  export interface RegisterCertificateRequest {
1459
1680
  /**
1681
+ * @public
1460
1682
  * <p>The certificate data, in PEM format.</p>
1461
1683
  */
1462
1684
  certificatePem: string | undefined;
1463
1685
  /**
1686
+ * @public
1464
1687
  * <p>The CA certificate used to sign the device certificate being registered.</p>
1465
1688
  */
1466
1689
  caCertificatePem?: string;
1467
1690
  /**
1691
+ * @public
1468
1692
  * @deprecated
1469
1693
  *
1470
1694
  * <p>A boolean value that specifies if the certificate is set to active.</p>
@@ -1473,6 +1697,7 @@ export interface RegisterCertificateRequest {
1473
1697
  */
1474
1698
  setAsActive?: boolean;
1475
1699
  /**
1700
+ * @public
1476
1701
  * <p>The status of the register certificate request. Valid values that you can use include
1477
1702
  * <code>ACTIVE</code>, <code>INACTIVE</code>, and <code>REVOKED</code>.</p>
1478
1703
  */
@@ -1484,10 +1709,12 @@ export interface RegisterCertificateRequest {
1484
1709
  */
1485
1710
  export interface RegisterCertificateResponse {
1486
1711
  /**
1712
+ * @public
1487
1713
  * <p>The certificate ARN.</p>
1488
1714
  */
1489
1715
  certificateArn?: string;
1490
1716
  /**
1717
+ * @public
1491
1718
  * <p>The certificate identifier.</p>
1492
1719
  */
1493
1720
  certificateId?: string;
@@ -1497,10 +1724,12 @@ export interface RegisterCertificateResponse {
1497
1724
  */
1498
1725
  export interface RegisterCertificateWithoutCARequest {
1499
1726
  /**
1727
+ * @public
1500
1728
  * <p>The certificate data, in PEM format.</p>
1501
1729
  */
1502
1730
  certificatePem: string | undefined;
1503
1731
  /**
1732
+ * @public
1504
1733
  * <p>The status of the register certificate request.</p>
1505
1734
  */
1506
1735
  status?: CertificateStatus | string;
@@ -1510,10 +1739,12 @@ export interface RegisterCertificateWithoutCARequest {
1510
1739
  */
1511
1740
  export interface RegisterCertificateWithoutCAResponse {
1512
1741
  /**
1742
+ * @public
1513
1743
  * <p>The Amazon Resource Name (ARN) of the registered certificate.</p>
1514
1744
  */
1515
1745
  certificateArn?: string;
1516
1746
  /**
1747
+ * @public
1517
1748
  * <p>The ID of the registered certificate. (The last part of the certificate ARN contains the
1518
1749
  * certificate ID.</p>
1519
1750
  */
@@ -1524,10 +1755,12 @@ export interface RegisterCertificateWithoutCAResponse {
1524
1755
  */
1525
1756
  export interface RegisterThingRequest {
1526
1757
  /**
1758
+ * @public
1527
1759
  * <p>The provisioning template. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html">Provisioning Devices That Have Device Certificates</a> for more information.</p>
1528
1760
  */
1529
1761
  templateBody: string | undefined;
1530
1762
  /**
1763
+ * @public
1531
1764
  * <p>The parameters for provisioning a thing. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning Templates</a> for more information.</p>
1532
1765
  */
1533
1766
  parameters?: Record<string, string>;
@@ -1537,10 +1770,12 @@ export interface RegisterThingRequest {
1537
1770
  */
1538
1771
  export interface RegisterThingResponse {
1539
1772
  /**
1773
+ * @public
1540
1774
  * <p>The certificate data, in PEM format.</p>
1541
1775
  */
1542
1776
  certificatePem?: string;
1543
1777
  /**
1778
+ * @public
1544
1779
  * <p>ARNs for the generated resources.</p>
1545
1780
  */
1546
1781
  resourceArns?: Record<string, string>;
@@ -1563,11 +1798,13 @@ export declare class ResourceRegistrationFailureException extends __BaseExceptio
1563
1798
  */
1564
1799
  export interface RejectCertificateTransferRequest {
1565
1800
  /**
1801
+ * @public
1566
1802
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
1567
1803
  * certificate ID.)</p>
1568
1804
  */
1569
1805
  certificateId: string | undefined;
1570
1806
  /**
1807
+ * @public
1571
1808
  * <p>The reason the certificate transfer was rejected.</p>
1572
1809
  */
1573
1810
  rejectReason?: string;
@@ -1577,18 +1814,22 @@ export interface RejectCertificateTransferRequest {
1577
1814
  */
1578
1815
  export interface RemoveThingFromBillingGroupRequest {
1579
1816
  /**
1817
+ * @public
1580
1818
  * <p>The name of the billing group.</p>
1581
1819
  */
1582
1820
  billingGroupName?: string;
1583
1821
  /**
1822
+ * @public
1584
1823
  * <p>The ARN of the billing group.</p>
1585
1824
  */
1586
1825
  billingGroupArn?: string;
1587
1826
  /**
1827
+ * @public
1588
1828
  * <p>The name of the thing to be removed from the billing group.</p>
1589
1829
  */
1590
1830
  thingName?: string;
1591
1831
  /**
1832
+ * @public
1592
1833
  * <p>The ARN of the thing to be removed from the billing group.</p>
1593
1834
  */
1594
1835
  thingArn?: string;
@@ -1603,18 +1844,22 @@ export interface RemoveThingFromBillingGroupResponse {
1603
1844
  */
1604
1845
  export interface RemoveThingFromThingGroupRequest {
1605
1846
  /**
1847
+ * @public
1606
1848
  * <p>The group name.</p>
1607
1849
  */
1608
1850
  thingGroupName?: string;
1609
1851
  /**
1852
+ * @public
1610
1853
  * <p>The group ARN.</p>
1611
1854
  */
1612
1855
  thingGroupArn?: string;
1613
1856
  /**
1857
+ * @public
1614
1858
  * <p>The name of the thing to remove from the group.</p>
1615
1859
  */
1616
1860
  thingName?: string;
1617
1861
  /**
1862
+ * @public
1618
1863
  * <p>The ARN of the thing to remove from the group.</p>
1619
1864
  */
1620
1865
  thingArn?: string;
@@ -1630,10 +1875,12 @@ export interface RemoveThingFromThingGroupResponse {
1630
1875
  */
1631
1876
  export interface ReplaceTopicRuleRequest {
1632
1877
  /**
1878
+ * @public
1633
1879
  * <p>The name of the rule.</p>
1634
1880
  */
1635
1881
  ruleName: string | undefined;
1636
1882
  /**
1883
+ * @public
1637
1884
  * <p>The rule payload.</p>
1638
1885
  */
1639
1886
  topicRulePayload: TopicRulePayload | undefined;
@@ -1643,24 +1890,29 @@ export interface ReplaceTopicRuleRequest {
1643
1890
  */
1644
1891
  export interface SearchIndexRequest {
1645
1892
  /**
1893
+ * @public
1646
1894
  * <p>The search index name.</p>
1647
1895
  */
1648
1896
  indexName?: string;
1649
1897
  /**
1898
+ * @public
1650
1899
  * <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query
1651
1900
  * syntax</a>.</p>
1652
1901
  */
1653
1902
  queryString: string | undefined;
1654
1903
  /**
1904
+ * @public
1655
1905
  * <p>The token used to get the next set of results, or <code>null</code> if there are no additional
1656
1906
  * results.</p>
1657
1907
  */
1658
1908
  nextToken?: string;
1659
1909
  /**
1910
+ * @public
1660
1911
  * <p>The maximum number of results to return at one time.</p>
1661
1912
  */
1662
1913
  maxResults?: number;
1663
1914
  /**
1915
+ * @public
1664
1916
  * <p>The query version.</p>
1665
1917
  */
1666
1918
  queryVersion?: string;
@@ -1671,22 +1923,27 @@ export interface SearchIndexRequest {
1671
1923
  */
1672
1924
  export interface ThingGroupDocument {
1673
1925
  /**
1926
+ * @public
1674
1927
  * <p>The thing group name.</p>
1675
1928
  */
1676
1929
  thingGroupName?: string;
1677
1930
  /**
1931
+ * @public
1678
1932
  * <p>The thing group ID.</p>
1679
1933
  */
1680
1934
  thingGroupId?: string;
1681
1935
  /**
1936
+ * @public
1682
1937
  * <p>The thing group description.</p>
1683
1938
  */
1684
1939
  thingGroupDescription?: string;
1685
1940
  /**
1941
+ * @public
1686
1942
  * <p>The thing group attributes.</p>
1687
1943
  */
1688
1944
  attributes?: Record<string, string>;
1689
1945
  /**
1946
+ * @public
1690
1947
  * <p>Parent group names.</p>
1691
1948
  */
1692
1949
  parentGroupNames?: string[];
@@ -1697,16 +1954,19 @@ export interface ThingGroupDocument {
1697
1954
  */
1698
1955
  export interface ThingConnectivity {
1699
1956
  /**
1957
+ * @public
1700
1958
  * <p>True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not
1701
1959
  * connected.</p>
1702
1960
  */
1703
1961
  connected?: boolean;
1704
1962
  /**
1963
+ * @public
1705
1964
  * <p>The epoch time (in milliseconds) when the thing last connected or disconnected. If the
1706
1965
  * thing has been disconnected for approximately an hour, the time value might be missing.</p>
1707
1966
  */
1708
1967
  timestamp?: number;
1709
1968
  /**
1969
+ * @public
1710
1970
  * <p>The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the <code>disconnectReason</code> value might be missing.</p>
1711
1971
  */
1712
1972
  disconnectReason?: string;
@@ -1717,37 +1977,45 @@ export interface ThingConnectivity {
1717
1977
  */
1718
1978
  export interface ThingDocument {
1719
1979
  /**
1980
+ * @public
1720
1981
  * <p>The thing name.</p>
1721
1982
  */
1722
1983
  thingName?: string;
1723
1984
  /**
1985
+ * @public
1724
1986
  * <p>The thing ID.</p>
1725
1987
  */
1726
1988
  thingId?: string;
1727
1989
  /**
1990
+ * @public
1728
1991
  * <p>The thing type name.</p>
1729
1992
  */
1730
1993
  thingTypeName?: string;
1731
1994
  /**
1995
+ * @public
1732
1996
  * <p>Thing group names.</p>
1733
1997
  */
1734
1998
  thingGroupNames?: string[];
1735
1999
  /**
2000
+ * @public
1736
2001
  * <p>The attributes.</p>
1737
2002
  */
1738
2003
  attributes?: Record<string, string>;
1739
2004
  /**
2005
+ * @public
1740
2006
  * <p>The unnamed shadow and named shadow.</p>
1741
2007
  * <p>For more information about shadows, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html">IoT Device Shadow service.</a>
1742
2008
  * </p>
1743
2009
  */
1744
2010
  shadow?: string;
1745
2011
  /**
2012
+ * @public
1746
2013
  * <p>Contains Device Defender data.</p>
1747
2014
  * <p>For more information about Device Defender, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html">Device Defender</a>. </p>
1748
2015
  */
1749
2016
  deviceDefender?: string;
1750
2017
  /**
2018
+ * @public
1751
2019
  * <p>Indicates whether the thing is connected to the Amazon Web Services IoT Core service.</p>
1752
2020
  */
1753
2021
  connectivity?: ThingConnectivity;
@@ -1757,15 +2025,18 @@ export interface ThingDocument {
1757
2025
  */
1758
2026
  export interface SearchIndexResponse {
1759
2027
  /**
2028
+ * @public
1760
2029
  * <p>The token used to get the next set of results, or <code>null</code> if there are no additional
1761
2030
  * results.</p>
1762
2031
  */
1763
2032
  nextToken?: string;
1764
2033
  /**
2034
+ * @public
1765
2035
  * <p>The things that match the search query.</p>
1766
2036
  */
1767
2037
  things?: ThingDocument[];
1768
2038
  /**
2039
+ * @public
1769
2040
  * <p>The thing groups that match the search query.</p>
1770
2041
  */
1771
2042
  thingGroups?: ThingGroupDocument[];
@@ -1775,6 +2046,7 @@ export interface SearchIndexResponse {
1775
2046
  */
1776
2047
  export interface SetDefaultAuthorizerRequest {
1777
2048
  /**
2049
+ * @public
1778
2050
  * <p>The authorizer name.</p>
1779
2051
  */
1780
2052
  authorizerName: string | undefined;
@@ -1784,10 +2056,12 @@ export interface SetDefaultAuthorizerRequest {
1784
2056
  */
1785
2057
  export interface SetDefaultAuthorizerResponse {
1786
2058
  /**
2059
+ * @public
1787
2060
  * <p>The authorizer name.</p>
1788
2061
  */
1789
2062
  authorizerName?: string;
1790
2063
  /**
2064
+ * @public
1791
2065
  * <p>The authorizer ARN.</p>
1792
2066
  */
1793
2067
  authorizerArn?: string;
@@ -1798,10 +2072,12 @@ export interface SetDefaultAuthorizerResponse {
1798
2072
  */
1799
2073
  export interface SetDefaultPolicyVersionRequest {
1800
2074
  /**
2075
+ * @public
1801
2076
  * <p>The policy name.</p>
1802
2077
  */
1803
2078
  policyName: string | undefined;
1804
2079
  /**
2080
+ * @public
1805
2081
  * <p>The policy version ID.</p>
1806
2082
  */
1807
2083
  policyVersionId: string | undefined;
@@ -1812,10 +2088,12 @@ export interface SetDefaultPolicyVersionRequest {
1812
2088
  */
1813
2089
  export interface LoggingOptionsPayload {
1814
2090
  /**
2091
+ * @public
1815
2092
  * <p>The ARN of the IAM role that grants access.</p>
1816
2093
  */
1817
2094
  roleArn: string | undefined;
1818
2095
  /**
2096
+ * @public
1819
2097
  * <p>The log level.</p>
1820
2098
  */
1821
2099
  logLevel?: LogLevel | string;
@@ -1826,6 +2104,7 @@ export interface LoggingOptionsPayload {
1826
2104
  */
1827
2105
  export interface SetLoggingOptionsRequest {
1828
2106
  /**
2107
+ * @public
1829
2108
  * <p>The logging options payload.</p>
1830
2109
  */
1831
2110
  loggingOptionsPayload: LoggingOptionsPayload | undefined;
@@ -1835,10 +2114,12 @@ export interface SetLoggingOptionsRequest {
1835
2114
  */
1836
2115
  export interface SetV2LoggingLevelRequest {
1837
2116
  /**
2117
+ * @public
1838
2118
  * <p>The log target.</p>
1839
2119
  */
1840
2120
  logTarget: LogTarget | undefined;
1841
2121
  /**
2122
+ * @public
1842
2123
  * <p>The log level.</p>
1843
2124
  */
1844
2125
  logLevel: LogLevel | string | undefined;
@@ -1848,14 +2129,17 @@ export interface SetV2LoggingLevelRequest {
1848
2129
  */
1849
2130
  export interface SetV2LoggingOptionsRequest {
1850
2131
  /**
2132
+ * @public
1851
2133
  * <p>The ARN of the role that allows IoT to write to Cloudwatch logs.</p>
1852
2134
  */
1853
2135
  roleArn?: string;
1854
2136
  /**
2137
+ * @public
1855
2138
  * <p>The default logging level.</p>
1856
2139
  */
1857
2140
  defaultLogLevel?: LogLevel | string;
1858
2141
  /**
2142
+ * @public
1859
2143
  * <p>If true all logs are disabled. The default is false.</p>
1860
2144
  */
1861
2145
  disableAllLogs?: boolean;
@@ -1865,10 +2149,12 @@ export interface SetV2LoggingOptionsRequest {
1865
2149
  */
1866
2150
  export interface StartAuditMitigationActionsTaskRequest {
1867
2151
  /**
2152
+ * @public
1868
2153
  * <p>A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.</p>
1869
2154
  */
1870
2155
  taskId: string | undefined;
1871
2156
  /**
2157
+ * @public
1872
2158
  * <p>Specifies the audit findings to which the mitigation actions are applied. You can apply
1873
2159
  * them to a type of audit check, to all findings from an audit, or to a
1874
2160
  * specific set of
@@ -1876,10 +2162,12 @@ export interface StartAuditMitigationActionsTaskRequest {
1876
2162
  */
1877
2163
  target: AuditMitigationActionsTaskTarget | undefined;
1878
2164
  /**
2165
+ * @public
1879
2166
  * <p>For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.</p>
1880
2167
  */
1881
2168
  auditCheckToActionsMapping: Record<string, string[]> | undefined;
1882
2169
  /**
2170
+ * @public
1883
2171
  * <p>Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.</p>
1884
2172
  */
1885
2173
  clientRequestToken?: string;
@@ -1889,6 +2177,7 @@ export interface StartAuditMitigationActionsTaskRequest {
1889
2177
  */
1890
2178
  export interface StartAuditMitigationActionsTaskResponse {
1891
2179
  /**
2180
+ * @public
1892
2181
  * <p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code> that you specified in the request.</p>
1893
2182
  */
1894
2183
  taskId?: string;
@@ -1912,42 +2201,49 @@ export declare class TaskAlreadyExistsException extends __BaseException {
1912
2201
  */
1913
2202
  export interface StartDetectMitigationActionsTaskRequest {
1914
2203
  /**
2204
+ * @public
1915
2205
  * <p>
1916
2206
  * The unique identifier of the task.
1917
2207
  * </p>
1918
2208
  */
1919
2209
  taskId: string | undefined;
1920
2210
  /**
2211
+ * @public
1921
2212
  * <p>
1922
2213
  * Specifies the ML Detect findings to which the mitigation actions are applied.
1923
2214
  * </p>
1924
2215
  */
1925
2216
  target: DetectMitigationActionsTaskTarget | undefined;
1926
2217
  /**
2218
+ * @public
1927
2219
  * <p>
1928
2220
  * The actions to be performed when a device has unexpected behavior.
1929
2221
  * </p>
1930
2222
  */
1931
2223
  actions: string[] | undefined;
1932
2224
  /**
2225
+ * @public
1933
2226
  * <p>
1934
2227
  * Specifies the time period of which violation events occurred between.
1935
2228
  * </p>
1936
2229
  */
1937
2230
  violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
1938
2231
  /**
2232
+ * @public
1939
2233
  * <p>
1940
2234
  * Specifies to list only active violations.
1941
2235
  * </p>
1942
2236
  */
1943
2237
  includeOnlyActiveViolations?: boolean;
1944
2238
  /**
2239
+ * @public
1945
2240
  * <p>
1946
2241
  * Specifies to include suppressed alerts.
1947
2242
  * </p>
1948
2243
  */
1949
2244
  includeSuppressedAlerts?: boolean;
1950
2245
  /**
2246
+ * @public
1951
2247
  * <p>
1952
2248
  * Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
1953
2249
  * </p>
@@ -1959,6 +2255,7 @@ export interface StartDetectMitigationActionsTaskRequest {
1959
2255
  */
1960
2256
  export interface StartDetectMitigationActionsTaskResponse {
1961
2257
  /**
2258
+ * @public
1962
2259
  * <p>
1963
2260
  * The unique identifier of the task.
1964
2261
  * </p>
@@ -1970,6 +2267,7 @@ export interface StartDetectMitigationActionsTaskResponse {
1970
2267
  */
1971
2268
  export interface StartOnDemandAuditTaskRequest {
1972
2269
  /**
2270
+ * @public
1973
2271
  * <p>Which checks are performed during the audit. The checks you specify must be enabled
1974
2272
  * for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code>
1975
2273
  * to see the list of all checks, including those that are enabled or
@@ -1982,6 +2280,7 @@ export interface StartOnDemandAuditTaskRequest {
1982
2280
  */
1983
2281
  export interface StartOnDemandAuditTaskResponse {
1984
2282
  /**
2283
+ * @public
1985
2284
  * <p>The ID of the on-demand audit you started.</p>
1986
2285
  */
1987
2286
  taskId?: string;
@@ -1991,20 +2290,24 @@ export interface StartOnDemandAuditTaskResponse {
1991
2290
  */
1992
2291
  export interface StartThingRegistrationTaskRequest {
1993
2292
  /**
2293
+ * @public
1994
2294
  * <p>The provisioning template.</p>
1995
2295
  */
1996
2296
  templateBody: string | undefined;
1997
2297
  /**
2298
+ * @public
1998
2299
  * <p>The S3 bucket that contains the input file.</p>
1999
2300
  */
2000
2301
  inputFileBucket: string | undefined;
2001
2302
  /**
2303
+ * @public
2002
2304
  * <p>The name of input file within the S3 bucket. This file contains a newline delimited
2003
2305
  * JSON file. Each line contains the parameter values to provision one device
2004
2306
  * (thing).</p>
2005
2307
  */
2006
2308
  inputFileKey: string | undefined;
2007
2309
  /**
2310
+ * @public
2008
2311
  * <p>The IAM role ARN that grants permission the input file.</p>
2009
2312
  */
2010
2313
  roleArn: string | undefined;
@@ -2014,6 +2317,7 @@ export interface StartThingRegistrationTaskRequest {
2014
2317
  */
2015
2318
  export interface StartThingRegistrationTaskResponse {
2016
2319
  /**
2320
+ * @public
2017
2321
  * <p>The bulk thing provisioning task ID.</p>
2018
2322
  */
2019
2323
  taskId?: string;
@@ -2023,6 +2327,7 @@ export interface StartThingRegistrationTaskResponse {
2023
2327
  */
2024
2328
  export interface StopThingRegistrationTaskRequest {
2025
2329
  /**
2330
+ * @public
2026
2331
  * <p>The bulk thing provisioning task ID.</p>
2027
2332
  */
2028
2333
  taskId: string | undefined;
@@ -2037,10 +2342,12 @@ export interface StopThingRegistrationTaskResponse {
2037
2342
  */
2038
2343
  export interface TagResourceRequest {
2039
2344
  /**
2345
+ * @public
2040
2346
  * <p>The ARN of the resource.</p>
2041
2347
  */
2042
2348
  resourceArn: string | undefined;
2043
2349
  /**
2350
+ * @public
2044
2351
  * <p>The new or modified tags for the resource.</p>
2045
2352
  */
2046
2353
  tags: Tag[] | undefined;
@@ -2055,28 +2362,34 @@ export interface TagResourceResponse {
2055
2362
  */
2056
2363
  export interface TestAuthorizationRequest {
2057
2364
  /**
2365
+ * @public
2058
2366
  * <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
2059
2367
  */
2060
2368
  principal?: string;
2061
2369
  /**
2370
+ * @public
2062
2371
  * <p>The Cognito identity pool ID.</p>
2063
2372
  */
2064
2373
  cognitoIdentityPoolId?: string;
2065
2374
  /**
2375
+ * @public
2066
2376
  * <p>A list of authorization info objects. Simulating authorization will create a response
2067
2377
  * for each <code>authInfo</code> object in the list.</p>
2068
2378
  */
2069
2379
  authInfos: AuthInfo[] | undefined;
2070
2380
  /**
2381
+ * @public
2071
2382
  * <p>The MQTT client ID.</p>
2072
2383
  */
2073
2384
  clientId?: string;
2074
2385
  /**
2386
+ * @public
2075
2387
  * <p>When testing custom authorization, the policies specified here are treated as if they
2076
2388
  * are attached to the principal being authorized.</p>
2077
2389
  */
2078
2390
  policyNamesToAdd?: string[];
2079
2391
  /**
2392
+ * @public
2080
2393
  * <p>When testing custom authorization, the policies specified here are treated as if they
2081
2394
  * are not attached to the principal being authorized.</p>
2082
2395
  */
@@ -2087,6 +2400,7 @@ export interface TestAuthorizationRequest {
2087
2400
  */
2088
2401
  export interface TestAuthorizationResponse {
2089
2402
  /**
2403
+ * @public
2090
2404
  * <p>The authentication results.</p>
2091
2405
  */
2092
2406
  authResults?: AuthResult[];
@@ -2109,10 +2423,12 @@ export declare class InvalidResponseException extends __BaseException {
2109
2423
  */
2110
2424
  export interface HttpContext {
2111
2425
  /**
2426
+ * @public
2112
2427
  * <p>The header keys and values in an HTTP authorization request.</p>
2113
2428
  */
2114
2429
  headers?: Record<string, string>;
2115
2430
  /**
2431
+ * @public
2116
2432
  * <p>The query string keys and values in an HTTP authorization request.</p>
2117
2433
  */
2118
2434
  queryString?: string;
@@ -2123,14 +2439,17 @@ export interface HttpContext {
2123
2439
  */
2124
2440
  export interface MqttContext {
2125
2441
  /**
2442
+ * @public
2126
2443
  * <p>The value of the <code>username</code> key in an MQTT authorization request.</p>
2127
2444
  */
2128
2445
  username?: string;
2129
2446
  /**
2447
+ * @public
2130
2448
  * <p>The value of the <code>password</code> key in an MQTT authorization request.</p>
2131
2449
  */
2132
2450
  password?: Uint8Array;
2133
2451
  /**
2452
+ * @public
2134
2453
  * <p>The value of the <code>clientId</code> key in an MQTT authorization request.</p>
2135
2454
  */
2136
2455
  clientId?: string;
@@ -2141,6 +2460,7 @@ export interface MqttContext {
2141
2460
  */
2142
2461
  export interface TlsContext {
2143
2462
  /**
2463
+ * @public
2144
2464
  * <p>The value of the <code>serverName</code> key in a TLS authorization request.</p>
2145
2465
  */
2146
2466
  serverName?: string;
@@ -2150,27 +2470,33 @@ export interface TlsContext {
2150
2470
  */
2151
2471
  export interface TestInvokeAuthorizerRequest {
2152
2472
  /**
2473
+ * @public
2153
2474
  * <p>The custom authorizer name.</p>
2154
2475
  */
2155
2476
  authorizerName: string | undefined;
2156
2477
  /**
2478
+ * @public
2157
2479
  * <p>The token returned by your custom authentication service.</p>
2158
2480
  */
2159
2481
  token?: string;
2160
2482
  /**
2483
+ * @public
2161
2484
  * <p>The signature made with the token and your custom authentication service's private
2162
2485
  * key. This value must be Base-64-encoded.</p>
2163
2486
  */
2164
2487
  tokenSignature?: string;
2165
2488
  /**
2489
+ * @public
2166
2490
  * <p>Specifies a test HTTP authorization request.</p>
2167
2491
  */
2168
2492
  httpContext?: HttpContext;
2169
2493
  /**
2494
+ * @public
2170
2495
  * <p>Specifies a test MQTT authorization request.</p>
2171
2496
  */
2172
2497
  mqttContext?: MqttContext;
2173
2498
  /**
2499
+ * @public
2174
2500
  * <p>Specifies a test TLS authorization request.</p>
2175
2501
  */
2176
2502
  tlsContext?: TlsContext;
@@ -2180,22 +2506,27 @@ export interface TestInvokeAuthorizerRequest {
2180
2506
  */
2181
2507
  export interface TestInvokeAuthorizerResponse {
2182
2508
  /**
2509
+ * @public
2183
2510
  * <p>True if the token is authenticated, otherwise false.</p>
2184
2511
  */
2185
2512
  isAuthenticated?: boolean;
2186
2513
  /**
2514
+ * @public
2187
2515
  * <p>The principal ID.</p>
2188
2516
  */
2189
2517
  principalId?: string;
2190
2518
  /**
2519
+ * @public
2191
2520
  * <p>IAM policy documents.</p>
2192
2521
  */
2193
2522
  policyDocuments?: string[];
2194
2523
  /**
2524
+ * @public
2195
2525
  * <p>The number of seconds after which the temporary credentials are refreshed.</p>
2196
2526
  */
2197
2527
  refreshAfterInSeconds?: number;
2198
2528
  /**
2529
+ * @public
2199
2530
  * <p>The number of seconds after which the connection is terminated.</p>
2200
2531
  */
2201
2532
  disconnectAfterInSeconds?: number;
@@ -2206,15 +2537,18 @@ export interface TestInvokeAuthorizerResponse {
2206
2537
  */
2207
2538
  export interface TransferCertificateRequest {
2208
2539
  /**
2540
+ * @public
2209
2541
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
2210
2542
  * certificate ID.)</p>
2211
2543
  */
2212
2544
  certificateId: string | undefined;
2213
2545
  /**
2546
+ * @public
2214
2547
  * <p>The Amazon Web Services account.</p>
2215
2548
  */
2216
2549
  targetAwsAccount: string | undefined;
2217
2550
  /**
2551
+ * @public
2218
2552
  * <p>The transfer message.</p>
2219
2553
  */
2220
2554
  transferMessage?: string;
@@ -2225,6 +2559,7 @@ export interface TransferCertificateRequest {
2225
2559
  */
2226
2560
  export interface TransferCertificateResponse {
2227
2561
  /**
2562
+ * @public
2228
2563
  * <p>The ARN of the certificate.</p>
2229
2564
  */
2230
2565
  transferredCertificateArn?: string;
@@ -2247,10 +2582,12 @@ export declare class TransferConflictException extends __BaseException {
2247
2582
  */
2248
2583
  export interface UntagResourceRequest {
2249
2584
  /**
2585
+ * @public
2250
2586
  * <p>The ARN of the resource.</p>
2251
2587
  */
2252
2588
  resourceArn: string | undefined;
2253
2589
  /**
2590
+ * @public
2254
2591
  * <p>A list of the keys of the tags to be removed from the resource.</p>
2255
2592
  */
2256
2593
  tagKeys: string[] | undefined;
@@ -2265,6 +2602,7 @@ export interface UntagResourceResponse {
2265
2602
  */
2266
2603
  export interface UpdateAccountAuditConfigurationRequest {
2267
2604
  /**
2605
+ * @public
2268
2606
  * <p>The Amazon
2269
2607
  * Resource Name
2270
2608
  * (ARN)
@@ -2276,10 +2614,12 @@ export interface UpdateAccountAuditConfigurationRequest {
2276
2614
  */
2277
2615
  roleArn?: string;
2278
2616
  /**
2617
+ * @public
2279
2618
  * <p>Information about the targets to which audit notifications are sent.</p>
2280
2619
  */
2281
2620
  auditNotificationTargetConfigurations?: Record<string, AuditNotificationTarget>;
2282
2621
  /**
2622
+ * @public
2283
2623
  * <p>Specifies which audit checks are enabled and disabled for this account. Use
2284
2624
  * <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those
2285
2625
  * that are currently enabled.</p>
@@ -2306,6 +2646,7 @@ export interface UpdateAccountAuditConfigurationResponse {
2306
2646
  */
2307
2647
  export interface UpdateAuditSuppressionRequest {
2308
2648
  /**
2649
+ * @public
2309
2650
  * <p>An audit check name. Checks must be enabled
2310
2651
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
2311
2652
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -2313,22 +2654,26 @@ export interface UpdateAuditSuppressionRequest {
2313
2654
  */
2314
2655
  checkName: string | undefined;
2315
2656
  /**
2657
+ * @public
2316
2658
  * <p>Information that identifies the noncompliant resource.</p>
2317
2659
  */
2318
2660
  resourceIdentifier: ResourceIdentifier | undefined;
2319
2661
  /**
2662
+ * @public
2320
2663
  * <p>
2321
2664
  * The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
2322
2665
  * </p>
2323
2666
  */
2324
2667
  expirationDate?: Date;
2325
2668
  /**
2669
+ * @public
2326
2670
  * <p>
2327
2671
  * Indicates whether a suppression should exist indefinitely or not.
2328
2672
  * </p>
2329
2673
  */
2330
2674
  suppressIndefinitely?: boolean;
2331
2675
  /**
2676
+ * @public
2332
2677
  * <p>
2333
2678
  * The description of the audit suppression.
2334
2679
  * </p>
@@ -2345,26 +2690,32 @@ export interface UpdateAuditSuppressionResponse {
2345
2690
  */
2346
2691
  export interface UpdateAuthorizerRequest {
2347
2692
  /**
2693
+ * @public
2348
2694
  * <p>The authorizer name.</p>
2349
2695
  */
2350
2696
  authorizerName: string | undefined;
2351
2697
  /**
2698
+ * @public
2352
2699
  * <p>The ARN of the authorizer's Lambda function.</p>
2353
2700
  */
2354
2701
  authorizerFunctionArn?: string;
2355
2702
  /**
2703
+ * @public
2356
2704
  * <p>The key used to extract the token from the HTTP headers. </p>
2357
2705
  */
2358
2706
  tokenKeyName?: string;
2359
2707
  /**
2708
+ * @public
2360
2709
  * <p>The public keys used to verify the token signature.</p>
2361
2710
  */
2362
2711
  tokenSigningPublicKeys?: Record<string, string>;
2363
2712
  /**
2713
+ * @public
2364
2714
  * <p>The status of the update authorizer request.</p>
2365
2715
  */
2366
2716
  status?: AuthorizerStatus | string;
2367
2717
  /**
2718
+ * @public
2368
2719
  * <p>When <code>true</code>, the result from the authorizer’s Lambda function is
2369
2720
  * cached for the time specified in <code>refreshAfterInSeconds</code>. The cached
2370
2721
  * result is used while the device reuses the same HTTP connection.</p>
@@ -2376,10 +2727,12 @@ export interface UpdateAuthorizerRequest {
2376
2727
  */
2377
2728
  export interface UpdateAuthorizerResponse {
2378
2729
  /**
2730
+ * @public
2379
2731
  * <p>The authorizer name.</p>
2380
2732
  */
2381
2733
  authorizerName?: string;
2382
2734
  /**
2735
+ * @public
2383
2736
  * <p>The authorizer ARN.</p>
2384
2737
  */
2385
2738
  authorizerArn?: string;
@@ -2389,14 +2742,17 @@ export interface UpdateAuthorizerResponse {
2389
2742
  */
2390
2743
  export interface UpdateBillingGroupRequest {
2391
2744
  /**
2745
+ * @public
2392
2746
  * <p>The name of the billing group.</p>
2393
2747
  */
2394
2748
  billingGroupName: string | undefined;
2395
2749
  /**
2750
+ * @public
2396
2751
  * <p>The properties of the billing group.</p>
2397
2752
  */
2398
2753
  billingGroupProperties: BillingGroupProperties | undefined;
2399
2754
  /**
2755
+ * @public
2400
2756
  * <p>The expected version of the billing group. If the version of the billing group does
2401
2757
  * not match the expected version specified in the request, the
2402
2758
  * <code>UpdateBillingGroup</code> request is rejected with a
@@ -2409,6 +2765,7 @@ export interface UpdateBillingGroupRequest {
2409
2765
  */
2410
2766
  export interface UpdateBillingGroupResponse {
2411
2767
  /**
2768
+ * @public
2412
2769
  * <p>The latest version of the billing group.</p>
2413
2770
  */
2414
2771
  version?: number;
@@ -2419,10 +2776,12 @@ export interface UpdateBillingGroupResponse {
2419
2776
  */
2420
2777
  export interface UpdateCACertificateRequest {
2421
2778
  /**
2779
+ * @public
2422
2780
  * <p>The CA certificate identifier.</p>
2423
2781
  */
2424
2782
  certificateId: string | undefined;
2425
2783
  /**
2784
+ * @public
2426
2785
  * <p>The updated status of the CA certificate.</p>
2427
2786
  * <p>
2428
2787
  * <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and
@@ -2430,15 +2789,18 @@ export interface UpdateCACertificateRequest {
2430
2789
  */
2431
2790
  newStatus?: CACertificateStatus | string;
2432
2791
  /**
2792
+ * @public
2433
2793
  * <p>The new value for the auto registration status. Valid values are: "ENABLE" or
2434
2794
  * "DISABLE".</p>
2435
2795
  */
2436
2796
  newAutoRegistrationStatus?: AutoRegistrationStatus | string;
2437
2797
  /**
2798
+ * @public
2438
2799
  * <p>Information about the registration configuration.</p>
2439
2800
  */
2440
2801
  registrationConfig?: RegistrationConfig;
2441
2802
  /**
2803
+ * @public
2442
2804
  * <p>If true, removes auto registration.</p>
2443
2805
  */
2444
2806
  removeAutoRegistration?: boolean;
@@ -2449,11 +2811,13 @@ export interface UpdateCACertificateRequest {
2449
2811
  */
2450
2812
  export interface UpdateCertificateRequest {
2451
2813
  /**
2814
+ * @public
2452
2815
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
2453
2816
  * certificate ID.)</p>
2454
2817
  */
2455
2818
  certificateId: string | undefined;
2456
2819
  /**
2820
+ * @public
2457
2821
  * <p>The new status.</p>
2458
2822
  * <p>
2459
2823
  * <b>Note:</b> Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result
@@ -2470,11 +2834,13 @@ export interface UpdateCertificateRequest {
2470
2834
  */
2471
2835
  export interface UpdateCustomMetricRequest {
2472
2836
  /**
2837
+ * @public
2473
2838
  * <p> The name of the custom metric.
2474
2839
  * Cannot be updated. </p>
2475
2840
  */
2476
2841
  metricName: string | undefined;
2477
2842
  /**
2843
+ * @public
2478
2844
  * <p>
2479
2845
  * Field
2480
2846
  * represents a friendly name in the console for the custom metric,
@@ -2491,18 +2857,21 @@ export interface UpdateCustomMetricRequest {
2491
2857
  */
2492
2858
  export interface UpdateCustomMetricResponse {
2493
2859
  /**
2860
+ * @public
2494
2861
  * <p>
2495
2862
  * The name of the custom metric.
2496
2863
  * </p>
2497
2864
  */
2498
2865
  metricName?: string;
2499
2866
  /**
2867
+ * @public
2500
2868
  * <p>
2501
2869
  * The Amazon Resource Number (ARN) of the custom metric.
2502
2870
  * </p>
2503
2871
  */
2504
2872
  metricArn?: string;
2505
2873
  /**
2874
+ * @public
2506
2875
  * <p> The type of the custom metric. </p>
2507
2876
  * <important>
2508
2877
  * <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p>
@@ -2510,18 +2879,21 @@ export interface UpdateCustomMetricResponse {
2510
2879
  */
2511
2880
  metricType?: CustomMetricType | string;
2512
2881
  /**
2882
+ * @public
2513
2883
  * <p>
2514
2884
  * A friendly name in the console for the custom metric
2515
2885
  * </p>
2516
2886
  */
2517
2887
  displayName?: string;
2518
2888
  /**
2889
+ * @public
2519
2890
  * <p>
2520
2891
  * The creation date of the custom metric in milliseconds since epoch.
2521
2892
  * </p>
2522
2893
  */
2523
2894
  creationDate?: Date;
2524
2895
  /**
2896
+ * @public
2525
2897
  * <p>
2526
2898
  * The time the custom metric was last modified in milliseconds since epoch.
2527
2899
  * </p>
@@ -2533,10 +2905,12 @@ export interface UpdateCustomMetricResponse {
2533
2905
  */
2534
2906
  export interface UpdateDimensionRequest {
2535
2907
  /**
2908
+ * @public
2536
2909
  * <p>A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.</p>
2537
2910
  */
2538
2911
  name: string | undefined;
2539
2912
  /**
2913
+ * @public
2540
2914
  * <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>
2541
2915
  */
2542
2916
  stringValues: string[] | undefined;
@@ -2546,28 +2920,34 @@ export interface UpdateDimensionRequest {
2546
2920
  */
2547
2921
  export interface UpdateDimensionResponse {
2548
2922
  /**
2923
+ * @public
2549
2924
  * <p>A unique identifier for the dimension.</p>
2550
2925
  */
2551
2926
  name?: string;
2552
2927
  /**
2928
+ * @public
2553
2929
  * <p>The Amazon Resource
2554
2930
  * Name (ARN)of
2555
2931
  * the created dimension.</p>
2556
2932
  */
2557
2933
  arn?: string;
2558
2934
  /**
2935
+ * @public
2559
2936
  * <p>The type of the dimension.</p>
2560
2937
  */
2561
2938
  type?: DimensionType | string;
2562
2939
  /**
2940
+ * @public
2563
2941
  * <p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>
2564
2942
  */
2565
2943
  stringValues?: string[];
2566
2944
  /**
2945
+ * @public
2567
2946
  * <p>The date and time, in milliseconds since epoch, when the dimension was initially created.</p>
2568
2947
  */
2569
2948
  creationDate?: Date;
2570
2949
  /**
2950
+ * @public
2571
2951
  * <p>The date and time, in milliseconds since epoch, when the dimension was most recently updated.</p>
2572
2952
  */
2573
2953
  lastModifiedDate?: Date;
@@ -2577,22 +2957,27 @@ export interface UpdateDimensionResponse {
2577
2957
  */
2578
2958
  export interface UpdateDomainConfigurationRequest {
2579
2959
  /**
2960
+ * @public
2580
2961
  * <p>The name of the domain configuration to be updated.</p>
2581
2962
  */
2582
2963
  domainConfigurationName: string | undefined;
2583
2964
  /**
2965
+ * @public
2584
2966
  * <p>An object that specifies the authorization service for a domain.</p>
2585
2967
  */
2586
2968
  authorizerConfig?: AuthorizerConfig;
2587
2969
  /**
2970
+ * @public
2588
2971
  * <p>The status to which the domain configuration should be updated.</p>
2589
2972
  */
2590
2973
  domainConfigurationStatus?: DomainConfigurationStatus | string;
2591
2974
  /**
2975
+ * @public
2592
2976
  * <p>Removes the authorization configuration from a domain.</p>
2593
2977
  */
2594
2978
  removeAuthorizerConfig?: boolean;
2595
2979
  /**
2980
+ * @public
2596
2981
  * <p>An object that specifies the TLS configuration for a domain.</p>
2597
2982
  */
2598
2983
  tlsConfig?: TlsConfig;
@@ -2602,10 +2987,12 @@ export interface UpdateDomainConfigurationRequest {
2602
2987
  */
2603
2988
  export interface UpdateDomainConfigurationResponse {
2604
2989
  /**
2990
+ * @public
2605
2991
  * <p>The name of the domain configuration that was updated.</p>
2606
2992
  */
2607
2993
  domainConfigurationName?: string;
2608
2994
  /**
2995
+ * @public
2609
2996
  * <p>The ARN of the domain configuration that was updated.</p>
2610
2997
  */
2611
2998
  domainConfigurationArn?: string;
@@ -2615,18 +3002,22 @@ export interface UpdateDomainConfigurationResponse {
2615
3002
  */
2616
3003
  export interface UpdateDynamicThingGroupRequest {
2617
3004
  /**
3005
+ * @public
2618
3006
  * <p>The name of the dynamic thing group to update.</p>
2619
3007
  */
2620
3008
  thingGroupName: string | undefined;
2621
3009
  /**
3010
+ * @public
2622
3011
  * <p>The dynamic thing group properties to update.</p>
2623
3012
  */
2624
3013
  thingGroupProperties: ThingGroupProperties | undefined;
2625
3014
  /**
3015
+ * @public
2626
3016
  * <p>The expected version of the dynamic thing group to update.</p>
2627
3017
  */
2628
3018
  expectedVersion?: number;
2629
3019
  /**
3020
+ * @public
2630
3021
  * <p>The dynamic thing group index to update.</p>
2631
3022
  * <note>
2632
3023
  * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
@@ -2634,10 +3025,12 @@ export interface UpdateDynamicThingGroupRequest {
2634
3025
  */
2635
3026
  indexName?: string;
2636
3027
  /**
3028
+ * @public
2637
3029
  * <p>The dynamic thing group search query string to update.</p>
2638
3030
  */
2639
3031
  queryString?: string;
2640
3032
  /**
3033
+ * @public
2641
3034
  * <p>The dynamic thing group query version to update.</p>
2642
3035
  * <note>
2643
3036
  * <p>Currently one query version is supported: "2017-09-30". If not specified, the
@@ -2651,6 +3044,7 @@ export interface UpdateDynamicThingGroupRequest {
2651
3044
  */
2652
3045
  export interface UpdateDynamicThingGroupResponse {
2653
3046
  /**
3047
+ * @public
2654
3048
  * <p>The dynamic thing group version.</p>
2655
3049
  */
2656
3050
  version?: number;
@@ -2660,6 +3054,7 @@ export interface UpdateDynamicThingGroupResponse {
2660
3054
  */
2661
3055
  export interface UpdateEventConfigurationsRequest {
2662
3056
  /**
3057
+ * @public
2663
3058
  * <p>The new event configuration values.</p>
2664
3059
  */
2665
3060
  eventConfigurations?: Record<string, Configuration>;
@@ -2674,43 +3069,53 @@ export interface UpdateEventConfigurationsResponse {
2674
3069
  */
2675
3070
  export interface UpdateFleetMetricRequest {
2676
3071
  /**
3072
+ * @public
2677
3073
  * <p>The name of the fleet metric to update.</p>
2678
3074
  */
2679
3075
  metricName: string | undefined;
2680
3076
  /**
3077
+ * @public
2681
3078
  * <p>The search query string.</p>
2682
3079
  */
2683
3080
  queryString?: string;
2684
3081
  /**
3082
+ * @public
2685
3083
  * <p>The type of the aggregation query.</p>
2686
3084
  */
2687
3085
  aggregationType?: AggregationType;
2688
3086
  /**
3087
+ * @public
2689
3088
  * <p>The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.</p>
2690
3089
  */
2691
3090
  period?: number;
2692
3091
  /**
3092
+ * @public
2693
3093
  * <p>The field to aggregate.</p>
2694
3094
  */
2695
3095
  aggregationField?: string;
2696
3096
  /**
3097
+ * @public
2697
3098
  * <p>The description of the fleet metric.</p>
2698
3099
  */
2699
3100
  description?: string;
2700
3101
  /**
3102
+ * @public
2701
3103
  * <p>The version of the query.</p>
2702
3104
  */
2703
3105
  queryVersion?: string;
2704
3106
  /**
3107
+ * @public
2705
3108
  * <p>The name of the index to search.</p>
2706
3109
  */
2707
3110
  indexName: string | undefined;
2708
3111
  /**
3112
+ * @public
2709
3113
  * <p>Used to support unit transformation such as milliseconds to seconds. The unit must be
2710
3114
  * supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>.</p>
2711
3115
  */
2712
3116
  unit?: FleetMetricUnit | string;
2713
3117
  /**
3118
+ * @public
2714
3119
  * <p>The expected version of the fleet metric record in the registry.</p>
2715
3120
  */
2716
3121
  expectedVersion?: number;
@@ -2720,10 +3125,12 @@ export interface UpdateFleetMetricRequest {
2720
3125
  */
2721
3126
  export interface UpdateIndexingConfigurationRequest {
2722
3127
  /**
3128
+ * @public
2723
3129
  * <p>Thing indexing configuration.</p>
2724
3130
  */
2725
3131
  thingIndexingConfiguration?: ThingIndexingConfiguration;
2726
3132
  /**
3133
+ * @public
2727
3134
  * <p>Thing group indexing configuration.</p>
2728
3135
  */
2729
3136
  thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
@@ -2738,31 +3145,38 @@ export interface UpdateIndexingConfigurationResponse {
2738
3145
  */
2739
3146
  export interface UpdateJobRequest {
2740
3147
  /**
3148
+ * @public
2741
3149
  * <p>The ID of the job to be updated.</p>
2742
3150
  */
2743
3151
  jobId: string | undefined;
2744
3152
  /**
3153
+ * @public
2745
3154
  * <p>A short text description of the job.</p>
2746
3155
  */
2747
3156
  description?: string;
2748
3157
  /**
3158
+ * @public
2749
3159
  * <p>Configuration information for pre-signed S3 URLs.</p>
2750
3160
  */
2751
3161
  presignedUrlConfig?: PresignedUrlConfig;
2752
3162
  /**
3163
+ * @public
2753
3164
  * <p>Allows you to create a staged rollout of the job.</p>
2754
3165
  */
2755
3166
  jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
2756
3167
  /**
3168
+ * @public
2757
3169
  * <p>Allows you to create criteria to abort a job.</p>
2758
3170
  */
2759
3171
  abortConfig?: AbortConfig;
2760
3172
  /**
3173
+ * @public
2761
3174
  * <p>Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to <code>IN_PROGRESS</code>.
2762
3175
  * If the job execution status is not set to another terminal state before the time expires, it will be automatically set to <code>TIMED_OUT</code>. </p>
2763
3176
  */
2764
3177
  timeoutConfig?: TimeoutConfig;
2765
3178
  /**
3179
+ * @public
2766
3180
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
2767
3181
  * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
2768
3182
  * contain the value in the following format.</p>
@@ -2775,6 +3189,7 @@ export interface UpdateJobRequest {
2775
3189
  */
2776
3190
  namespaceId?: string;
2777
3191
  /**
3192
+ * @public
2778
3193
  * <p>Allows you to create the criteria to retry a job.</p>
2779
3194
  */
2780
3195
  jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
@@ -2784,6 +3199,7 @@ export interface UpdateJobRequest {
2784
3199
  */
2785
3200
  export interface UpdateMitigationActionRequest {
2786
3201
  /**
3202
+ * @public
2787
3203
  * <p>The friendly name for the mitigation action. You cannot change the name by using
2788
3204
  * <code>UpdateMitigationAction</code>. Instead, you must delete and
2789
3205
  * recreate the
@@ -2791,10 +3207,12 @@ export interface UpdateMitigationActionRequest {
2791
3207
  */
2792
3208
  actionName: string | undefined;
2793
3209
  /**
3210
+ * @public
2794
3211
  * <p>The ARN of the IAM role that is used to apply the mitigation action.</p>
2795
3212
  */
2796
3213
  roleArn?: string;
2797
3214
  /**
3215
+ * @public
2798
3216
  * <p>Defines the type of action and the parameters for that action.</p>
2799
3217
  */
2800
3218
  actionParams?: MitigationActionParams;
@@ -2804,10 +3222,12 @@ export interface UpdateMitigationActionRequest {
2804
3222
  */
2805
3223
  export interface UpdateMitigationActionResponse {
2806
3224
  /**
3225
+ * @public
2807
3226
  * <p>The ARN for the new mitigation action.</p>
2808
3227
  */
2809
3228
  actionArn?: string;
2810
3229
  /**
3230
+ * @public
2811
3231
  * <p>A unique identifier for the mitigation action.</p>
2812
3232
  */
2813
3233
  actionId?: string;
@@ -2817,14 +3237,17 @@ export interface UpdateMitigationActionResponse {
2817
3237
  */
2818
3238
  export interface UpdatePackageRequest {
2819
3239
  /**
3240
+ * @public
2820
3241
  * <p>The name of the target package.</p>
2821
3242
  */
2822
3243
  packageName: string | undefined;
2823
3244
  /**
3245
+ * @public
2824
3246
  * <p>The package description.</p>
2825
3247
  */
2826
3248
  description?: string;
2827
3249
  /**
3250
+ * @public
2828
3251
  * <p>The name of the default package version.</p>
2829
3252
  * <p>
2830
3253
  * <b>Note:</b> You cannot name a <code>defaultVersion</code>
@@ -2832,6 +3255,7 @@ export interface UpdatePackageRequest {
2832
3255
  */
2833
3256
  defaultVersionName?: string;
2834
3257
  /**
3258
+ * @public
2835
3259
  * <p>Indicates whether you want to remove the named default package version from the software package.
2836
3260
  * Set as <code>true</code> to remove the default package version. </p>
2837
3261
  * <p>
@@ -2840,6 +3264,7 @@ export interface UpdatePackageRequest {
2840
3264
  */
2841
3265
  unsetDefaultVersion?: boolean;
2842
3266
  /**
3267
+ * @public
2843
3268
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
2844
3269
  * Don't reuse this client token if a new idempotent request is required.</p>
2845
3270
  */
@@ -2855,10 +3280,12 @@ export interface UpdatePackageResponse {
2855
3280
  */
2856
3281
  export interface UpdatePackageConfigurationRequest {
2857
3282
  /**
3283
+ * @public
2858
3284
  * <p>Configuration to manage job's package version reporting. This updates the thing's reserved named shadow that the job targets.</p>
2859
3285
  */
2860
3286
  versionUpdateByJobsConfig?: VersionUpdateByJobsConfig;
2861
3287
  /**
3288
+ * @public
2862
3289
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
2863
3290
  * Don't reuse this client token if a new idempotent request is required.</p>
2864
3291
  */
@@ -2886,18 +3313,22 @@ export type PackageVersionAction = (typeof PackageVersionAction)[keyof typeof Pa
2886
3313
  */
2887
3314
  export interface UpdatePackageVersionRequest {
2888
3315
  /**
3316
+ * @public
2889
3317
  * <p>The name of the associated software package.</p>
2890
3318
  */
2891
3319
  packageName: string | undefined;
2892
3320
  /**
3321
+ * @public
2893
3322
  * <p>The name of the target package version.</p>
2894
3323
  */
2895
3324
  versionName: string | undefined;
2896
3325
  /**
3326
+ * @public
2897
3327
  * <p>The package version description.</p>
2898
3328
  */
2899
3329
  description?: string;
2900
3330
  /**
3331
+ * @public
2901
3332
  * <p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet. </p>
2902
3333
  * <p>
2903
3334
  * <b>Note:</b> Attributes can be updated only when the package version
@@ -2906,10 +3337,12 @@ export interface UpdatePackageVersionRequest {
2906
3337
  */
2907
3338
  attributes?: Record<string, string>;
2908
3339
  /**
3340
+ * @public
2909
3341
  * <p>The status that the package version should be assigned. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
2910
3342
  */
2911
3343
  action?: PackageVersionAction | string;
2912
3344
  /**
3345
+ * @public
2913
3346
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
2914
3347
  * Don't reuse this client token if a new idempotent request is required.</p>
2915
3348
  */
@@ -2925,33 +3358,40 @@ export interface UpdatePackageVersionResponse {
2925
3358
  */
2926
3359
  export interface UpdateProvisioningTemplateRequest {
2927
3360
  /**
3361
+ * @public
2928
3362
  * <p>The name of the provisioning template.</p>
2929
3363
  */
2930
3364
  templateName: string | undefined;
2931
3365
  /**
3366
+ * @public
2932
3367
  * <p>The description of the provisioning template.</p>
2933
3368
  */
2934
3369
  description?: string;
2935
3370
  /**
3371
+ * @public
2936
3372
  * <p>True to enable the provisioning template, otherwise false.</p>
2937
3373
  */
2938
3374
  enabled?: boolean;
2939
3375
  /**
3376
+ * @public
2940
3377
  * <p>The ID of the default provisioning template version.</p>
2941
3378
  */
2942
3379
  defaultVersionId?: number;
2943
3380
  /**
3381
+ * @public
2944
3382
  * <p>The ARN of the role associated with the provisioning template. This IoT role grants
2945
3383
  * permission to provision a device.</p>
2946
3384
  */
2947
3385
  provisioningRoleArn?: string;
2948
3386
  /**
3387
+ * @public
2949
3388
  * <p>Updates the pre-provisioning hook template. Only supports template of type
2950
3389
  * <code>FLEET_PROVISIONING</code>. For more information about provisioning template types,
2951
3390
  * see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type">type</a>.</p>
2952
3391
  */
2953
3392
  preProvisioningHook?: ProvisioningHook;
2954
3393
  /**
3394
+ * @public
2955
3395
  * <p>Removes pre-provisioning hook template.</p>
2956
3396
  */
2957
3397
  removePreProvisioningHook?: boolean;
@@ -2966,14 +3406,17 @@ export interface UpdateProvisioningTemplateResponse {
2966
3406
  */
2967
3407
  export interface UpdateRoleAliasRequest {
2968
3408
  /**
3409
+ * @public
2969
3410
  * <p>The role alias to update.</p>
2970
3411
  */
2971
3412
  roleAlias: string | undefined;
2972
3413
  /**
3414
+ * @public
2973
3415
  * <p>The role ARN.</p>
2974
3416
  */
2975
3417
  roleArn?: string;
2976
3418
  /**
3419
+ * @public
2977
3420
  * <p>The number of seconds the credential will be valid.</p>
2978
3421
  * <p>This value must be less than or equal to the maximum session duration of the IAM role
2979
3422
  * that the role alias references.</p>
@@ -2985,10 +3428,12 @@ export interface UpdateRoleAliasRequest {
2985
3428
  */
2986
3429
  export interface UpdateRoleAliasResponse {
2987
3430
  /**
3431
+ * @public
2988
3432
  * <p>The role alias.</p>
2989
3433
  */
2990
3434
  roleAlias?: string;
2991
3435
  /**
3436
+ * @public
2992
3437
  * <p>The role alias ARN.</p>
2993
3438
  */
2994
3439
  roleAliasArn?: string;
@@ -2998,6 +3443,7 @@ export interface UpdateRoleAliasResponse {
2998
3443
  */
2999
3444
  export interface UpdateScheduledAuditRequest {
3000
3445
  /**
3446
+ * @public
3001
3447
  * <p>How often the scheduled audit takes
3002
3448
  * place,
3003
3449
  * either <code>DAILY</code>,
@@ -3006,6 +3452,7 @@ export interface UpdateScheduledAuditRequest {
3006
3452
  */
3007
3453
  frequency?: AuditFrequency | string;
3008
3454
  /**
3455
+ * @public
3009
3456
  * <p>The day of the month on which the scheduled audit takes place.
3010
3457
  * This
3011
3458
  * can
@@ -3015,6 +3462,7 @@ export interface UpdateScheduledAuditRequest {
3015
3462
  */
3016
3463
  dayOfMonth?: string;
3017
3464
  /**
3465
+ * @public
3018
3466
  * <p>The day of the week on which the scheduled audit takes place.
3019
3467
  * This
3020
3468
  * can
@@ -3023,6 +3471,7 @@ export interface UpdateScheduledAuditRequest {
3023
3471
  */
3024
3472
  dayOfWeek?: DayOfWeek | string;
3025
3473
  /**
3474
+ * @public
3026
3475
  * <p>Which checks are performed during the scheduled audit. Checks must be enabled
3027
3476
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
3028
3477
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -3030,6 +3479,7 @@ export interface UpdateScheduledAuditRequest {
3030
3479
  */
3031
3480
  targetCheckNames?: string[];
3032
3481
  /**
3482
+ * @public
3033
3483
  * <p>The name of the scheduled audit. (Max. 128 chars)</p>
3034
3484
  */
3035
3485
  scheduledAuditName: string | undefined;
@@ -3039,6 +3489,7 @@ export interface UpdateScheduledAuditRequest {
3039
3489
  */
3040
3490
  export interface UpdateScheduledAuditResponse {
3041
3491
  /**
3492
+ * @public
3042
3493
  * <p>The ARN of the scheduled audit.</p>
3043
3494
  */
3044
3495
  scheduledAuditArn?: string;
@@ -3048,22 +3499,27 @@ export interface UpdateScheduledAuditResponse {
3048
3499
  */
3049
3500
  export interface UpdateSecurityProfileRequest {
3050
3501
  /**
3502
+ * @public
3051
3503
  * <p>The name of the security profile you want to update.</p>
3052
3504
  */
3053
3505
  securityProfileName: string | undefined;
3054
3506
  /**
3507
+ * @public
3055
3508
  * <p>A description of the security profile.</p>
3056
3509
  */
3057
3510
  securityProfileDescription?: string;
3058
3511
  /**
3512
+ * @public
3059
3513
  * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3060
3514
  */
3061
3515
  behaviors?: Behavior[];
3062
3516
  /**
3517
+ * @public
3063
3518
  * <p>Where the alerts are sent. (Alerts are always sent to the console.)</p>
3064
3519
  */
3065
3520
  alertTargets?: Record<string, AlertTarget>;
3066
3521
  /**
3522
+ * @public
3067
3523
  * @deprecated
3068
3524
  *
3069
3525
  * <p>
@@ -3079,26 +3535,31 @@ export interface UpdateSecurityProfileRequest {
3079
3535
  */
3080
3536
  additionalMetricsToRetain?: string[];
3081
3537
  /**
3538
+ * @public
3082
3539
  * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3083
3540
  */
3084
3541
  additionalMetricsToRetainV2?: MetricToRetain[];
3085
3542
  /**
3543
+ * @public
3086
3544
  * <p>If true, delete all <code>behaviors</code> defined for this security profile.
3087
3545
  * If any <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>
3088
3546
  */
3089
3547
  deleteBehaviors?: boolean;
3090
3548
  /**
3549
+ * @public
3091
3550
  * <p>If true, delete all <code>alertTargets</code> defined for this security profile.
3092
3551
  * If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.</p>
3093
3552
  */
3094
3553
  deleteAlertTargets?: boolean;
3095
3554
  /**
3555
+ * @public
3096
3556
  * <p>If true, delete all <code>additionalMetricsToRetain</code> defined for this
3097
3557
  * security profile. If any <code>additionalMetricsToRetain</code> are defined in the current
3098
3558
  * invocation, an exception occurs.</p>
3099
3559
  */
3100
3560
  deleteAdditionalMetricsToRetain?: boolean;
3101
3561
  /**
3562
+ * @public
3102
3563
  * <p>The expected version of the security profile. A new version is generated whenever
3103
3564
  * the security profile is updated. If you specify a value that is different from the actual
3104
3565
  * version, a <code>VersionConflictException</code> is thrown.</p>
@@ -3110,26 +3571,32 @@ export interface UpdateSecurityProfileRequest {
3110
3571
  */
3111
3572
  export interface UpdateSecurityProfileResponse {
3112
3573
  /**
3574
+ * @public
3113
3575
  * <p>The name of the security profile that was updated.</p>
3114
3576
  */
3115
3577
  securityProfileName?: string;
3116
3578
  /**
3579
+ * @public
3117
3580
  * <p>The ARN of the security profile that was updated.</p>
3118
3581
  */
3119
3582
  securityProfileArn?: string;
3120
3583
  /**
3584
+ * @public
3121
3585
  * <p>The description of the security profile.</p>
3122
3586
  */
3123
3587
  securityProfileDescription?: string;
3124
3588
  /**
3589
+ * @public
3125
3590
  * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3126
3591
  */
3127
3592
  behaviors?: Behavior[];
3128
3593
  /**
3594
+ * @public
3129
3595
  * <p>Where the alerts are sent. (Alerts are always sent to the console.)</p>
3130
3596
  */
3131
3597
  alertTargets?: Record<string, AlertTarget>;
3132
3598
  /**
3599
+ * @public
3133
3600
  * @deprecated
3134
3601
  *
3135
3602
  * <p>
@@ -3145,18 +3612,22 @@ export interface UpdateSecurityProfileResponse {
3145
3612
  */
3146
3613
  additionalMetricsToRetain?: string[];
3147
3614
  /**
3615
+ * @public
3148
3616
  * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3149
3617
  */
3150
3618
  additionalMetricsToRetainV2?: MetricToRetain[];
3151
3619
  /**
3620
+ * @public
3152
3621
  * <p>The updated version of the security profile.</p>
3153
3622
  */
3154
3623
  version?: number;
3155
3624
  /**
3625
+ * @public
3156
3626
  * <p>The time the security profile was created.</p>
3157
3627
  */
3158
3628
  creationDate?: Date;
3159
3629
  /**
3630
+ * @public
3160
3631
  * <p>The time the security profile was last modified.</p>
3161
3632
  */
3162
3633
  lastModifiedDate?: Date;
@@ -3166,18 +3637,22 @@ export interface UpdateSecurityProfileResponse {
3166
3637
  */
3167
3638
  export interface UpdateStreamRequest {
3168
3639
  /**
3640
+ * @public
3169
3641
  * <p>The stream ID.</p>
3170
3642
  */
3171
3643
  streamId: string | undefined;
3172
3644
  /**
3645
+ * @public
3173
3646
  * <p>The description of the stream.</p>
3174
3647
  */
3175
3648
  description?: string;
3176
3649
  /**
3650
+ * @public
3177
3651
  * <p>The files associated with the stream.</p>
3178
3652
  */
3179
3653
  files?: StreamFile[];
3180
3654
  /**
3655
+ * @public
3181
3656
  * <p>An IAM role that allows the IoT service principal assumes to access your S3 files.</p>
3182
3657
  */
3183
3658
  roleArn?: string;
@@ -3187,18 +3662,22 @@ export interface UpdateStreamRequest {
3187
3662
  */
3188
3663
  export interface UpdateStreamResponse {
3189
3664
  /**
3665
+ * @public
3190
3666
  * <p>The stream ID.</p>
3191
3667
  */
3192
3668
  streamId?: string;
3193
3669
  /**
3670
+ * @public
3194
3671
  * <p>The stream ARN.</p>
3195
3672
  */
3196
3673
  streamArn?: string;
3197
3674
  /**
3675
+ * @public
3198
3676
  * <p>A description of the stream.</p>
3199
3677
  */
3200
3678
  description?: string;
3201
3679
  /**
3680
+ * @public
3202
3681
  * <p>The stream version.</p>
3203
3682
  */
3204
3683
  streamVersion?: number;
@@ -3209,16 +3688,19 @@ export interface UpdateStreamResponse {
3209
3688
  */
3210
3689
  export interface UpdateThingRequest {
3211
3690
  /**
3691
+ * @public
3212
3692
  * <p>The name of the thing to update.</p>
3213
3693
  * <p>You can't change a thing's name. To change a thing's name, you must create a
3214
3694
  * new thing, give it the new name, and then delete the old thing.</p>
3215
3695
  */
3216
3696
  thingName: string | undefined;
3217
3697
  /**
3698
+ * @public
3218
3699
  * <p>The name of the thing type.</p>
3219
3700
  */
3220
3701
  thingTypeName?: string;
3221
3702
  /**
3703
+ * @public
3222
3704
  * <p>A list of thing attributes, a JSON string containing name-value pairs. For
3223
3705
  * example:</p>
3224
3706
  * <p>
@@ -3228,6 +3710,7 @@ export interface UpdateThingRequest {
3228
3710
  */
3229
3711
  attributePayload?: AttributePayload;
3230
3712
  /**
3713
+ * @public
3231
3714
  * <p>The expected version of the thing record in the registry. If the version of the
3232
3715
  * record in the registry does not match the expected version specified in the request, the
3233
3716
  * <code>UpdateThing</code> request is rejected with a
@@ -3235,6 +3718,7 @@ export interface UpdateThingRequest {
3235
3718
  */
3236
3719
  expectedVersion?: number;
3237
3720
  /**
3721
+ * @public
3238
3722
  * <p>Remove a thing type association. If <b>true</b>, the
3239
3723
  * association is removed.</p>
3240
3724
  */
@@ -3251,14 +3735,17 @@ export interface UpdateThingResponse {
3251
3735
  */
3252
3736
  export interface UpdateThingGroupRequest {
3253
3737
  /**
3738
+ * @public
3254
3739
  * <p>The thing group to update.</p>
3255
3740
  */
3256
3741
  thingGroupName: string | undefined;
3257
3742
  /**
3743
+ * @public
3258
3744
  * <p>The thing group properties.</p>
3259
3745
  */
3260
3746
  thingGroupProperties: ThingGroupProperties | undefined;
3261
3747
  /**
3748
+ * @public
3262
3749
  * <p>The expected version of the thing group. If this does not match the version of the
3263
3750
  * thing group being updated, the update will fail.</p>
3264
3751
  */
@@ -3269,6 +3756,7 @@ export interface UpdateThingGroupRequest {
3269
3756
  */
3270
3757
  export interface UpdateThingGroupResponse {
3271
3758
  /**
3759
+ * @public
3272
3760
  * <p>The version of the updated thing group.</p>
3273
3761
  */
3274
3762
  version?: number;
@@ -3278,18 +3766,22 @@ export interface UpdateThingGroupResponse {
3278
3766
  */
3279
3767
  export interface UpdateThingGroupsForThingRequest {
3280
3768
  /**
3769
+ * @public
3281
3770
  * <p>The thing whose group memberships will be updated.</p>
3282
3771
  */
3283
3772
  thingName?: string;
3284
3773
  /**
3774
+ * @public
3285
3775
  * <p>The groups to which the thing will be added.</p>
3286
3776
  */
3287
3777
  thingGroupsToAdd?: string[];
3288
3778
  /**
3779
+ * @public
3289
3780
  * <p>The groups from which the thing will be removed.</p>
3290
3781
  */
3291
3782
  thingGroupsToRemove?: string[];
3292
3783
  /**
3784
+ * @public
3293
3785
  * <p>Override dynamic thing groups with static thing groups when 10-group limit is
3294
3786
  * reached. If a thing belongs to 10 thing groups, and one or more of those groups are
3295
3787
  * dynamic thing groups, adding a thing to a static group removes the thing from the last
@@ -3307,10 +3799,12 @@ export interface UpdateThingGroupsForThingResponse {
3307
3799
  */
3308
3800
  export interface UpdateTopicRuleDestinationRequest {
3309
3801
  /**
3802
+ * @public
3310
3803
  * <p>The ARN of the topic rule destination.</p>
3311
3804
  */
3312
3805
  arn: string | undefined;
3313
3806
  /**
3807
+ * @public
3314
3808
  * <p>The status of the topic rule destination. Valid values are:</p>
3315
3809
  * <dl>
3316
3810
  * <dt>IN_PROGRESS</dt>
@@ -3356,6 +3850,7 @@ export interface UpdateTopicRuleDestinationResponse {
3356
3850
  */
3357
3851
  export interface ValidateSecurityProfileBehaviorsRequest {
3358
3852
  /**
3853
+ * @public
3359
3854
  * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3360
3855
  */
3361
3856
  behaviors: Behavior[] | undefined;
@@ -3366,6 +3861,7 @@ export interface ValidateSecurityProfileBehaviorsRequest {
3366
3861
  */
3367
3862
  export interface ValidationError {
3368
3863
  /**
3864
+ * @public
3369
3865
  * <p>The description of an error found in the behaviors.</p>
3370
3866
  */
3371
3867
  errorMessage?: string;
@@ -3375,10 +3871,12 @@ export interface ValidationError {
3375
3871
  */
3376
3872
  export interface ValidateSecurityProfileBehaviorsResponse {
3377
3873
  /**
3874
+ * @public
3378
3875
  * <p>True if the behaviors were valid.</p>
3379
3876
  */
3380
3877
  valid?: boolean;
3381
3878
  /**
3879
+ * @public
3382
3880
  * <p>The list of any errors found in the behaviors.</p>
3383
3881
  */
3384
3882
  validationErrors?: ValidationError[];