@aws-sdk/client-iot 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31,19 +31,23 @@ export type JobExecutionFailureType = (typeof JobExecutionFailureType)[keyof typ
31
31
  */
32
32
  export interface AbortCriteria {
33
33
  /**
34
+ * @public
34
35
  * <p>The type of job execution failures that can initiate a job abort.</p>
35
36
  */
36
37
  failureType: JobExecutionFailureType | string | undefined;
37
38
  /**
39
+ * @public
38
40
  * <p>The type of job action to take to initiate the job abort.</p>
39
41
  */
40
42
  action: AbortAction | string | undefined;
41
43
  /**
44
+ * @public
42
45
  * <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p>
43
46
  * <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>
44
47
  */
45
48
  thresholdPercentage: number | undefined;
46
49
  /**
50
+ * @public
47
51
  * <p>The minimum number of things which must receive job execution notifications before the job
48
52
  * can be aborted.</p>
49
53
  */
@@ -55,6 +59,7 @@ export interface AbortCriteria {
55
59
  */
56
60
  export interface AbortConfig {
57
61
  /**
62
+ * @public
58
63
  * <p>The list of criteria that determine when and how to abort the job.</p>
59
64
  */
60
65
  criteriaList: AbortCriteria[] | undefined;
@@ -65,11 +70,13 @@ export interface AbortConfig {
65
70
  */
66
71
  export interface AcceptCertificateTransferRequest {
67
72
  /**
73
+ * @public
68
74
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
69
75
  * certificate ID.)</p>
70
76
  */
71
77
  certificateId: string | undefined;
72
78
  /**
79
+ * @public
73
80
  * <p>Specifies whether the certificate is active.</p>
74
81
  */
75
82
  setAsActive?: boolean;
@@ -165,18 +172,22 @@ export declare class UnauthorizedException extends __BaseException {
165
172
  */
166
173
  export interface CloudwatchAlarmAction {
167
174
  /**
175
+ * @public
168
176
  * <p>The IAM role that allows access to the CloudWatch alarm.</p>
169
177
  */
170
178
  roleArn: string | undefined;
171
179
  /**
180
+ * @public
172
181
  * <p>The CloudWatch alarm name.</p>
173
182
  */
174
183
  alarmName: string | undefined;
175
184
  /**
185
+ * @public
176
186
  * <p>The reason for the alarm change.</p>
177
187
  */
178
188
  stateReason: string | undefined;
179
189
  /**
190
+ * @public
180
191
  * <p>The value of the alarm state. Acceptable values are: OK, ALARM,
181
192
  * INSUFFICIENT_DATA.</p>
182
193
  */
@@ -188,14 +199,17 @@ export interface CloudwatchAlarmAction {
188
199
  */
189
200
  export interface CloudwatchLogsAction {
190
201
  /**
202
+ * @public
191
203
  * <p>The IAM role that allows access to the CloudWatch log.</p>
192
204
  */
193
205
  roleArn: string | undefined;
194
206
  /**
207
+ * @public
195
208
  * <p>The CloudWatch log group to which the action sends data.</p>
196
209
  */
197
210
  logGroupName: string | undefined;
198
211
  /**
212
+ * @public
199
213
  * <p>Indicates whether batches of log records will be extracted and uploaded into CloudWatch. Values include <code>true</code> or <code>false</code>
200
214
  * <i>(default)</i>.</p>
201
215
  */
@@ -207,27 +221,33 @@ export interface CloudwatchLogsAction {
207
221
  */
208
222
  export interface CloudwatchMetricAction {
209
223
  /**
224
+ * @public
210
225
  * <p>The IAM role that allows access to the CloudWatch metric.</p>
211
226
  */
212
227
  roleArn: string | undefined;
213
228
  /**
229
+ * @public
214
230
  * <p>The CloudWatch metric namespace name.</p>
215
231
  */
216
232
  metricNamespace: string | undefined;
217
233
  /**
234
+ * @public
218
235
  * <p>The CloudWatch metric name.</p>
219
236
  */
220
237
  metricName: string | undefined;
221
238
  /**
239
+ * @public
222
240
  * <p>The CloudWatch metric value.</p>
223
241
  */
224
242
  metricValue: string | undefined;
225
243
  /**
244
+ * @public
226
245
  * <p>The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit">metric
227
246
  * unit</a> supported by CloudWatch.</p>
228
247
  */
229
248
  metricUnit: string | undefined;
230
249
  /**
250
+ * @public
231
251
  * <p>An optional <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp">Unix timestamp</a>.</p>
232
252
  */
233
253
  metricTimestamp?: string;
@@ -265,44 +285,54 @@ export type DynamoKeyType = (typeof DynamoKeyType)[keyof typeof DynamoKeyType];
265
285
  */
266
286
  export interface DynamoDBAction {
267
287
  /**
288
+ * @public
268
289
  * <p>The name of the DynamoDB table.</p>
269
290
  */
270
291
  tableName: string | undefined;
271
292
  /**
293
+ * @public
272
294
  * <p>The ARN of the IAM role that grants access to the DynamoDB table.</p>
273
295
  */
274
296
  roleArn: string | undefined;
275
297
  /**
298
+ * @public
276
299
  * <p>The type of operation to be performed. This follows the substitution template, so it
277
300
  * can be <code>$\{operation\}</code>, but the substitution must result in one of the following:
278
301
  * <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>.</p>
279
302
  */
280
303
  operation?: string;
281
304
  /**
305
+ * @public
282
306
  * <p>The hash key name.</p>
283
307
  */
284
308
  hashKeyField: string | undefined;
285
309
  /**
310
+ * @public
286
311
  * <p>The hash key value.</p>
287
312
  */
288
313
  hashKeyValue: string | undefined;
289
314
  /**
315
+ * @public
290
316
  * <p>The hash key type. Valid values are "STRING" or "NUMBER"</p>
291
317
  */
292
318
  hashKeyType?: DynamoKeyType | string;
293
319
  /**
320
+ * @public
294
321
  * <p>The range key name.</p>
295
322
  */
296
323
  rangeKeyField?: string;
297
324
  /**
325
+ * @public
298
326
  * <p>The range key value.</p>
299
327
  */
300
328
  rangeKeyValue?: string;
301
329
  /**
330
+ * @public
302
331
  * <p>The range key type. Valid values are "STRING" or "NUMBER"</p>
303
332
  */
304
333
  rangeKeyType?: DynamoKeyType | string;
305
334
  /**
335
+ * @public
306
336
  * <p>The action payload. This name can be customized.</p>
307
337
  */
308
338
  payloadField?: string;
@@ -314,6 +344,7 @@ export interface DynamoDBAction {
314
344
  */
315
345
  export interface PutItemInput {
316
346
  /**
347
+ * @public
317
348
  * <p>The table where the message data will be written.</p>
318
349
  */
319
350
  tableName: string | undefined;
@@ -326,10 +357,12 @@ export interface PutItemInput {
326
357
  */
327
358
  export interface DynamoDBv2Action {
328
359
  /**
360
+ * @public
329
361
  * <p>The ARN of the IAM role that grants access to the DynamoDB table.</p>
330
362
  */
331
363
  roleArn: string | undefined;
332
364
  /**
365
+ * @public
333
366
  * <p>Specifies the DynamoDB table to which the message data will be written. For
334
367
  * example:</p>
335
368
  * <p>
@@ -353,22 +386,27 @@ export interface DynamoDBv2Action {
353
386
  */
354
387
  export interface ElasticsearchAction {
355
388
  /**
389
+ * @public
356
390
  * <p>The IAM role ARN that has access to OpenSearch.</p>
357
391
  */
358
392
  roleArn: string | undefined;
359
393
  /**
394
+ * @public
360
395
  * <p>The endpoint of your OpenSearch domain.</p>
361
396
  */
362
397
  endpoint: string | undefined;
363
398
  /**
399
+ * @public
364
400
  * <p>The index where you want to store your data.</p>
365
401
  */
366
402
  index: string | undefined;
367
403
  /**
404
+ * @public
368
405
  * <p>The type of document you are storing.</p>
369
406
  */
370
407
  type: string | undefined;
371
408
  /**
409
+ * @public
372
410
  * <p>The unique identifier for the document you are storing.</p>
373
411
  */
374
412
  id: string | undefined;
@@ -379,20 +417,24 @@ export interface ElasticsearchAction {
379
417
  */
380
418
  export interface FirehoseAction {
381
419
  /**
420
+ * @public
382
421
  * <p>The IAM role that grants access to the Amazon Kinesis Firehose stream.</p>
383
422
  */
384
423
  roleArn: string | undefined;
385
424
  /**
425
+ * @public
386
426
  * <p>The delivery stream name.</p>
387
427
  */
388
428
  deliveryStreamName: string | undefined;
389
429
  /**
430
+ * @public
390
431
  * <p>A character separator that will be used to separate records written to the Firehose
391
432
  * stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ','
392
433
  * (comma).</p>
393
434
  */
394
435
  separator?: string;
395
436
  /**
437
+ * @public
396
438
  * <p>Whether to deliver the Kinesis Data Firehose stream as a batch by using <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html">
397
439
  * <code>PutRecordBatch</code>
398
440
  * </a>. The default value is
@@ -411,14 +453,17 @@ export interface FirehoseAction {
411
453
  */
412
454
  export interface SigV4Authorization {
413
455
  /**
456
+ * @public
414
457
  * <p>The signing region.</p>
415
458
  */
416
459
  signingRegion: string | undefined;
417
460
  /**
461
+ * @public
418
462
  * <p>The service name to use while signing with Sig V4.</p>
419
463
  */
420
464
  serviceName: string | undefined;
421
465
  /**
466
+ * @public
422
467
  * <p>The ARN of the signing role.</p>
423
468
  */
424
469
  roleArn: string | undefined;
@@ -429,6 +474,7 @@ export interface SigV4Authorization {
429
474
  */
430
475
  export interface HttpAuthorization {
431
476
  /**
477
+ * @public
432
478
  * <p>Use Sig V4 authorization. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature
433
479
  * Version 4 Signing Process</a>.</p>
434
480
  */
@@ -440,10 +486,12 @@ export interface HttpAuthorization {
440
486
  */
441
487
  export interface HttpActionHeader {
442
488
  /**
489
+ * @public
443
490
  * <p>The HTTP header key.</p>
444
491
  */
445
492
  key: string | undefined;
446
493
  /**
494
+ * @public
447
495
  * <p>The HTTP header value. Substitution templates are supported.</p>
448
496
  */
449
497
  value: string | undefined;
@@ -454,12 +502,14 @@ export interface HttpActionHeader {
454
502
  */
455
503
  export interface HttpAction {
456
504
  /**
505
+ * @public
457
506
  * <p>The endpoint URL. If substitution templates are used in the URL, you must also specify a
458
507
  * <code>confirmationUrl</code>. If this is a new destination, a new
459
508
  * <code>TopicRuleDestination</code> is created if possible.</p>
460
509
  */
461
510
  url: string | undefined;
462
511
  /**
512
+ * @public
463
513
  * <p>The URL to which IoT sends a confirmation message. The value of the confirmation URL
464
514
  * must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses
465
515
  * the endpoint URL as the confirmation URL. If you use substitution templates in the
@@ -469,10 +519,12 @@ export interface HttpAction {
469
519
  */
470
520
  confirmationUrl?: string;
471
521
  /**
522
+ * @public
472
523
  * <p>The HTTP headers to send with the message data.</p>
473
524
  */
474
525
  headers?: HttpActionHeader[];
475
526
  /**
527
+ * @public
476
528
  * <p>The authentication method to use when sending data to an HTTPS endpoint.</p>
477
529
  */
478
530
  auth?: HttpAuthorization;
@@ -483,15 +535,18 @@ export interface HttpAction {
483
535
  */
484
536
  export interface IotAnalyticsAction {
485
537
  /**
538
+ * @public
486
539
  * <p>(deprecated) The ARN of the IoT Analytics channel to which message data will be
487
540
  * sent.</p>
488
541
  */
489
542
  channelArn?: string;
490
543
  /**
544
+ * @public
491
545
  * <p>The name of the IoT Analytics channel to which message data will be sent.</p>
492
546
  */
493
547
  channelName?: string;
494
548
  /**
549
+ * @public
495
550
  * <p>Whether to process the action as a batch. The default value is
496
551
  * <code>false</code>.</p>
497
552
  * <p>When <code>batchMode</code> is <code>true</code> and the rule SQL statement evaluates
@@ -502,6 +557,7 @@ export interface IotAnalyticsAction {
502
557
  */
503
558
  batchMode?: boolean;
504
559
  /**
560
+ * @public
505
561
  * <p>The ARN of the role which has a policy that grants IoT Analytics permission to send
506
562
  * message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>
507
563
  */
@@ -513,10 +569,12 @@ export interface IotAnalyticsAction {
513
569
  */
514
570
  export interface IotEventsAction {
515
571
  /**
572
+ * @public
516
573
  * <p>The name of the IoT Events input.</p>
517
574
  */
518
575
  inputName: string | undefined;
519
576
  /**
577
+ * @public
520
578
  * <p>The ID of the message. The default <code>messageId</code> is a new UUID value.</p>
521
579
  * <p>When <code>batchMode</code> is <code>true</code>, you can't specify a
522
580
  * <code>messageId</code>--a new UUID value will be assigned.</p>
@@ -525,6 +583,7 @@ export interface IotEventsAction {
525
583
  */
526
584
  messageId?: string;
527
585
  /**
586
+ * @public
528
587
  * <p>Whether to process the event actions as a batch. The default value is
529
588
  * <code>false</code>.</p>
530
589
  * <p>When <code>batchMode</code> is <code>true</code>, you can't specify a
@@ -538,6 +597,7 @@ export interface IotEventsAction {
538
597
  */
539
598
  batchMode?: boolean;
540
599
  /**
600
+ * @public
541
601
  * <p>The ARN of the role that grants IoT permission to send an input to an IoT
542
602
  * Events detector. ("Action":"iotevents:BatchPutMessage").</p>
543
603
  */
@@ -549,11 +609,13 @@ export interface IotEventsAction {
549
609
  */
550
610
  export interface AssetPropertyTimestamp {
551
611
  /**
612
+ * @public
552
613
  * <p>A string that contains the time in seconds since epoch. Accepts substitution
553
614
  * templates.</p>
554
615
  */
555
616
  timeInSeconds: string | undefined;
556
617
  /**
618
+ * @public
557
619
  * <p>Optional. A string that contains the nanosecond time offset. Accepts substitution
558
620
  * templates.</p>
559
621
  */
@@ -569,6 +631,7 @@ export type AssetPropertyVariant = AssetPropertyVariant.BooleanValueMember | Ass
569
631
  */
570
632
  export declare namespace AssetPropertyVariant {
571
633
  /**
634
+ * @public
572
635
  * <p>Optional. The string value of the value entry. Accepts substitution templates.</p>
573
636
  */
574
637
  interface StringValueMember {
@@ -579,6 +642,7 @@ export declare namespace AssetPropertyVariant {
579
642
  $unknown?: never;
580
643
  }
581
644
  /**
645
+ * @public
582
646
  * <p>Optional. A string that contains the integer value of the value entry. Accepts
583
647
  * substitution templates.</p>
584
648
  */
@@ -590,6 +654,7 @@ export declare namespace AssetPropertyVariant {
590
654
  $unknown?: never;
591
655
  }
592
656
  /**
657
+ * @public
593
658
  * <p>Optional. A string that contains the double value of the value entry. Accepts substitution
594
659
  * templates.</p>
595
660
  */
@@ -601,6 +666,7 @@ export declare namespace AssetPropertyVariant {
601
666
  $unknown?: never;
602
667
  }
603
668
  /**
669
+ * @public
604
670
  * <p>Optional. A string that contains the boolean value (<code>true</code> or
605
671
  * <code>false</code>) of the value entry. Accepts substitution templates.</p>
606
672
  */
@@ -611,6 +677,9 @@ export declare namespace AssetPropertyVariant {
611
677
  booleanValue: string;
612
678
  $unknown?: never;
613
679
  }
680
+ /**
681
+ * @public
682
+ */
614
683
  interface $UnknownMember {
615
684
  stringValue?: never;
616
685
  integerValue?: never;
@@ -633,14 +702,17 @@ export declare namespace AssetPropertyVariant {
633
702
  */
634
703
  export interface AssetPropertyValue {
635
704
  /**
705
+ * @public
636
706
  * <p>The value of the asset property.</p>
637
707
  */
638
708
  value: AssetPropertyVariant | undefined;
639
709
  /**
710
+ * @public
640
711
  * <p>The asset property value timestamp.</p>
641
712
  */
642
713
  timestamp: AssetPropertyTimestamp | undefined;
643
714
  /**
715
+ * @public
644
716
  * <p>Optional. A string that describes the quality of the value. Accepts substitution
645
717
  * templates. Must be <code>GOOD</code>, <code>BAD</code>, or <code>UNCERTAIN</code>.</p>
646
718
  */
@@ -652,30 +724,35 @@ export interface AssetPropertyValue {
652
724
  */
653
725
  export interface PutAssetPropertyValueEntry {
654
726
  /**
727
+ * @public
655
728
  * <p>Optional. A unique identifier for this entry that you can define to better track which
656
729
  * message caused an error in case of failure. Accepts substitution templates. Defaults to a new
657
730
  * UUID.</p>
658
731
  */
659
732
  entryId?: string;
660
733
  /**
734
+ * @public
661
735
  * <p>The ID of the IoT SiteWise asset. You must specify either a <code>propertyAlias</code>
662
736
  * or both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution
663
737
  * templates.</p>
664
738
  */
665
739
  assetId?: string;
666
740
  /**
741
+ * @public
667
742
  * <p>The ID of the asset's property. You must specify either a <code>propertyAlias</code> or
668
743
  * both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution
669
744
  * templates.</p>
670
745
  */
671
746
  propertyId?: string;
672
747
  /**
748
+ * @public
673
749
  * <p>The name of the property alias associated with your asset property. You must specify
674
750
  * either a <code>propertyAlias</code> or both an <code>aliasId</code> and a
675
751
  * <code>propertyId</code>. Accepts substitution templates.</p>
676
752
  */
677
753
  propertyAlias?: string;
678
754
  /**
755
+ * @public
679
756
  * <p>A list of property values to insert that each contain timestamp, quality, and value (TQV)
680
757
  * information.</p>
681
758
  */
@@ -688,10 +765,12 @@ export interface PutAssetPropertyValueEntry {
688
765
  */
689
766
  export interface IotSiteWiseAction {
690
767
  /**
768
+ * @public
691
769
  * <p>A list of asset property value entries.</p>
692
770
  */
693
771
  putAssetPropertyValueEntries: PutAssetPropertyValueEntry[] | undefined;
694
772
  /**
773
+ * @public
695
774
  * <p>The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. (<code>"Action": "iotsitewise:BatchPutAssetPropertyValue"</code>). The trust
696
775
  * policy can restrict access to specific asset hierarchy paths.</p>
697
776
  */
@@ -703,22 +782,27 @@ export interface IotSiteWiseAction {
703
782
  */
704
783
  export interface KafkaAction {
705
784
  /**
785
+ * @public
706
786
  * <p>The ARN of Kafka action's VPC <code>TopicRuleDestination</code>.</p>
707
787
  */
708
788
  destinationArn: string | undefined;
709
789
  /**
790
+ * @public
710
791
  * <p>The Kafka topic for messages to be sent to the Kafka broker.</p>
711
792
  */
712
793
  topic: string | undefined;
713
794
  /**
795
+ * @public
714
796
  * <p>The Kafka message key.</p>
715
797
  */
716
798
  key?: string;
717
799
  /**
800
+ * @public
718
801
  * <p>The Kafka message partition.</p>
719
802
  */
720
803
  partition?: string;
721
804
  /**
805
+ * @public
722
806
  * <p>Properties of the Apache Kafka producer client.</p>
723
807
  */
724
808
  clientProperties: Record<string, string> | undefined;
@@ -729,14 +813,17 @@ export interface KafkaAction {
729
813
  */
730
814
  export interface KinesisAction {
731
815
  /**
816
+ * @public
732
817
  * <p>The ARN of the IAM role that grants access to the Amazon Kinesis stream.</p>
733
818
  */
734
819
  roleArn: string | undefined;
735
820
  /**
821
+ * @public
736
822
  * <p>The name of the Amazon Kinesis stream.</p>
737
823
  */
738
824
  streamName: string | undefined;
739
825
  /**
826
+ * @public
740
827
  * <p>The partition key.</p>
741
828
  */
742
829
  partitionKey?: string;
@@ -747,6 +834,7 @@ export interface KinesisAction {
747
834
  */
748
835
  export interface LambdaAction {
749
836
  /**
837
+ * @public
750
838
  * <p>The ARN of the Lambda function.</p>
751
839
  */
752
840
  functionArn: string | undefined;
@@ -758,10 +846,12 @@ export interface LambdaAction {
758
846
  */
759
847
  export interface LocationTimestamp {
760
848
  /**
849
+ * @public
761
850
  * <p>An expression that returns a long epoch time value.</p>
762
851
  */
763
852
  value: string | undefined;
764
853
  /**
854
+ * @public
765
855
  * <p>The precision of the timestamp value that results from the expression
766
856
  * described in <code>value</code>.</p>
767
857
  * <p>Valid values: <code>SECONDS</code> | <code>MILLISECONDS</code> |
@@ -777,28 +867,34 @@ export interface LocationTimestamp {
777
867
  */
778
868
  export interface LocationAction {
779
869
  /**
870
+ * @public
780
871
  * <p>The IAM role that grants permission to write to the Amazon Location resource.</p>
781
872
  */
782
873
  roleArn: string | undefined;
783
874
  /**
875
+ * @public
784
876
  * <p>The name of the tracker resource in Amazon Location in which the location is updated.</p>
785
877
  */
786
878
  trackerName: string | undefined;
787
879
  /**
880
+ * @public
788
881
  * <p>The unique ID of the device providing the location data.</p>
789
882
  */
790
883
  deviceId: string | undefined;
791
884
  /**
885
+ * @public
792
886
  * <p>The time that the location data was sampled. The default value is
793
887
  * the time the MQTT message was processed.</p>
794
888
  */
795
889
  timestamp?: LocationTimestamp;
796
890
  /**
891
+ * @public
797
892
  * <p>A string that evaluates to a double value that represents the
798
893
  * latitude of the device's location.</p>
799
894
  */
800
895
  latitude: string | undefined;
801
896
  /**
897
+ * @public
802
898
  * <p>A string that evaluates to a double value that represents the
803
899
  * longitude of the device's location.</p>
804
900
  */
@@ -811,22 +907,27 @@ export interface LocationAction {
811
907
  */
812
908
  export interface OpenSearchAction {
813
909
  /**
910
+ * @public
814
911
  * <p>The IAM role ARN that has access to OpenSearch.</p>
815
912
  */
816
913
  roleArn: string | undefined;
817
914
  /**
915
+ * @public
818
916
  * <p>The endpoint of your OpenSearch domain.</p>
819
917
  */
820
918
  endpoint: string | undefined;
821
919
  /**
920
+ * @public
822
921
  * <p>The OpenSearch index where you want to store your data.</p>
823
922
  */
824
923
  index: string | undefined;
825
924
  /**
925
+ * @public
826
926
  * <p>The type of document you are storing.</p>
827
927
  */
828
928
  type: string | undefined;
829
929
  /**
930
+ * @public
830
931
  * <p>The unique identifier for the document you are storing.</p>
831
932
  */
832
933
  id: string | undefined;
@@ -839,10 +940,12 @@ export interface OpenSearchAction {
839
940
  */
840
941
  export interface UserProperty {
841
942
  /**
943
+ * @public
842
944
  * <p>A key to be specified in <code>UserProperty</code>.</p>
843
945
  */
844
946
  key: string | undefined;
845
947
  /**
948
+ * @public
846
949
  * <p>A value to be specified in <code>UserProperty</code>.</p>
847
950
  */
848
951
  value: string | undefined;
@@ -854,6 +957,7 @@ export interface UserProperty {
854
957
  */
855
958
  export interface MqttHeaders {
856
959
  /**
960
+ * @public
857
961
  * <p>An <code>Enum</code> string value that indicates whether the payload is formatted as
858
962
  * UTF-8.</p>
859
963
  * <p>Valid values are <code>UNSPECIFIED_BYTES</code> and <code>UTF8_DATA</code>.</p>
@@ -864,6 +968,7 @@ export interface MqttHeaders {
864
968
  */
865
969
  payloadFormatIndicator?: string;
866
970
  /**
971
+ * @public
867
972
  * <p>A UTF-8 encoded string that describes the content of the publishing message.</p>
868
973
  * <p>For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118">
869
974
  * Content Type</a> from the MQTT Version 5.0 specification.</p>
@@ -872,6 +977,7 @@ export interface MqttHeaders {
872
977
  */
873
978
  contentType?: string;
874
979
  /**
980
+ * @public
875
981
  * <p>A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe
876
982
  * the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard
877
983
  * characters.</p>
@@ -882,6 +988,7 @@ export interface MqttHeaders {
882
988
  */
883
989
  responseTopic?: string;
884
990
  /**
991
+ * @public
885
992
  * <p>The base64-encoded binary data used by the sender of the request message to identify which request the response message is
886
993
  * for when it's received.</p>
887
994
  * <p>For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115">
@@ -896,6 +1003,7 @@ export interface MqttHeaders {
896
1003
  */
897
1004
  correlationData?: string;
898
1005
  /**
1006
+ * @public
899
1007
  * <p>A user-defined integer value that will persist a message at the message broker for a
900
1008
  * specified amount of time to ensure that the message will expire if it's no longer relevant to
901
1009
  * the subscriber. The value of <code>messageExpiry</code> represents the number of seconds
@@ -906,6 +1014,7 @@ export interface MqttHeaders {
906
1014
  */
907
1015
  messageExpiry?: string;
908
1016
  /**
1017
+ * @public
909
1018
  * <p>An array of key-value pairs that you define in the MQTT5 header.</p>
910
1019
  */
911
1020
  userProperties?: UserProperty[];
@@ -916,19 +1025,23 @@ export interface MqttHeaders {
916
1025
  */
917
1026
  export interface RepublishAction {
918
1027
  /**
1028
+ * @public
919
1029
  * <p>The ARN of the IAM role that grants access.</p>
920
1030
  */
921
1031
  roleArn: string | undefined;
922
1032
  /**
1033
+ * @public
923
1034
  * <p>The name of the MQTT topic.</p>
924
1035
  */
925
1036
  topic: string | undefined;
926
1037
  /**
1038
+ * @public
927
1039
  * <p>The Quality of Service (QoS) level to use when republishing messages. The default value
928
1040
  * is 0.</p>
929
1041
  */
930
1042
  qos?: number;
931
1043
  /**
1044
+ * @public
932
1045
  * <p>MQTT Version 5.0 headers information. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">
933
1046
  * MQTT</a> from the Amazon Web Services IoT Core Developer Guide.</p>
934
1047
  */
@@ -958,18 +1071,22 @@ export type CannedAccessControlList = (typeof CannedAccessControlList)[keyof typ
958
1071
  */
959
1072
  export interface S3Action {
960
1073
  /**
1074
+ * @public
961
1075
  * <p>The ARN of the IAM role that grants access.</p>
962
1076
  */
963
1077
  roleArn: string | undefined;
964
1078
  /**
1079
+ * @public
965
1080
  * <p>The Amazon S3 bucket.</p>
966
1081
  */
967
1082
  bucketName: string | undefined;
968
1083
  /**
1084
+ * @public
969
1085
  * <p>The object key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>.</p>
970
1086
  */
971
1087
  key: string | undefined;
972
1088
  /**
1089
+ * @public
973
1090
  * <p>The Amazon S3 canned ACL that controls access to the object identified by the object
974
1091
  * key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">S3 canned ACLs</a>.</p>
975
1092
  */
@@ -982,12 +1099,14 @@ export interface S3Action {
982
1099
  */
983
1100
  export interface SalesforceAction {
984
1101
  /**
1102
+ * @public
985
1103
  * <p>The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The
986
1104
  * token is available from the Salesforce IoT Cloud platform after creation of the Input
987
1105
  * Stream.</p>
988
1106
  */
989
1107
  token: string | undefined;
990
1108
  /**
1109
+ * @public
991
1110
  * <p>The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from
992
1111
  * the Salesforce IoT Cloud platform after creation of the Input Stream.</p>
993
1112
  */
@@ -1011,14 +1130,17 @@ export type MessageFormat = (typeof MessageFormat)[keyof typeof MessageFormat];
1011
1130
  */
1012
1131
  export interface SnsAction {
1013
1132
  /**
1133
+ * @public
1014
1134
  * <p>The ARN of the SNS topic.</p>
1015
1135
  */
1016
1136
  targetArn: string | undefined;
1017
1137
  /**
1138
+ * @public
1018
1139
  * <p>The ARN of the IAM role that grants access.</p>
1019
1140
  */
1020
1141
  roleArn: string | undefined;
1021
1142
  /**
1143
+ * @public
1022
1144
  * <p>(Optional) The message format of the message to publish. Accepted values are "JSON"
1023
1145
  * and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine
1024
1146
  * if the payload should be parsed and relevant platform-specific bits of the payload should
@@ -1032,14 +1154,17 @@ export interface SnsAction {
1032
1154
  */
1033
1155
  export interface SqsAction {
1034
1156
  /**
1157
+ * @public
1035
1158
  * <p>The ARN of the IAM role that grants access.</p>
1036
1159
  */
1037
1160
  roleArn: string | undefined;
1038
1161
  /**
1162
+ * @public
1039
1163
  * <p>The URL of the Amazon SQS queue.</p>
1040
1164
  */
1041
1165
  queueUrl: string | undefined;
1042
1166
  /**
1167
+ * @public
1043
1168
  * <p>Specifies whether to use Base64 encoding.</p>
1044
1169
  */
1045
1170
  useBase64?: boolean;
@@ -1050,16 +1175,19 @@ export interface SqsAction {
1050
1175
  */
1051
1176
  export interface StepFunctionsAction {
1052
1177
  /**
1178
+ * @public
1053
1179
  * <p>(Optional) A name will be given to the state machine execution consisting of this
1054
1180
  * prefix followed by a UUID. Step Functions automatically creates a unique name for each state
1055
1181
  * machine execution if one is not provided.</p>
1056
1182
  */
1057
1183
  executionNamePrefix?: string;
1058
1184
  /**
1185
+ * @public
1059
1186
  * <p>The name of the Step Functions state machine whose execution will be started.</p>
1060
1187
  */
1061
1188
  stateMachineName: string | undefined;
1062
1189
  /**
1190
+ * @public
1063
1191
  * <p>The ARN of the role that grants IoT permission to start execution of a state machine
1064
1192
  * ("Action":"states:StartExecution").</p>
1065
1193
  */
@@ -1071,6 +1199,7 @@ export interface StepFunctionsAction {
1071
1199
  */
1072
1200
  export interface TimestreamDimension {
1073
1201
  /**
1202
+ * @public
1074
1203
  * <p>The metadata dimension name. This is the name of the column in the
1075
1204
  * Amazon Timestream database table record.</p>
1076
1205
  * <p>Dimensions cannot be named: <code>measure_name</code>,
@@ -1082,6 +1211,7 @@ export interface TimestreamDimension {
1082
1211
  */
1083
1212
  name: string | undefined;
1084
1213
  /**
1214
+ * @public
1085
1215
  * <p>The value to write in this column of the database record.</p>
1086
1216
  */
1087
1217
  value: string | undefined;
@@ -1093,10 +1223,12 @@ export interface TimestreamDimension {
1093
1223
  */
1094
1224
  export interface TimestreamTimestamp {
1095
1225
  /**
1226
+ * @public
1096
1227
  * <p>An expression that returns a long epoch time value.</p>
1097
1228
  */
1098
1229
  value: string | undefined;
1099
1230
  /**
1231
+ * @public
1100
1232
  * <p>The precision of the timestamp value that results from the expression
1101
1233
  * described in <code>value</code>.</p>
1102
1234
  * <p>Valid values: <code>SECONDS</code> | <code>MILLISECONDS</code> |
@@ -1113,23 +1245,28 @@ export interface TimestreamTimestamp {
1113
1245
  */
1114
1246
  export interface TimestreamAction {
1115
1247
  /**
1248
+ * @public
1116
1249
  * <p>The ARN of the role that grants permission to write to the
1117
1250
  * Amazon Timestream database table.</p>
1118
1251
  */
1119
1252
  roleArn: string | undefined;
1120
1253
  /**
1254
+ * @public
1121
1255
  * <p>The name of an Amazon Timestream database.</p>
1122
1256
  */
1123
1257
  databaseName: string | undefined;
1124
1258
  /**
1259
+ * @public
1125
1260
  * <p>The name of the database table into which to write the measure records.</p>
1126
1261
  */
1127
1262
  tableName: string | undefined;
1128
1263
  /**
1264
+ * @public
1129
1265
  * <p>Metadata attributes of the time series that are written in each measure record.</p>
1130
1266
  */
1131
1267
  dimensions: TimestreamDimension[] | undefined;
1132
1268
  /**
1269
+ * @public
1133
1270
  * <p>Specifies an application-defined value to replace the default value assigned to the
1134
1271
  * Timestream record's timestamp in the <code>time</code> column.</p>
1135
1272
  * <p>You can use this property to specify the value and the precision of the Timestream
@@ -1146,56 +1283,69 @@ export interface TimestreamAction {
1146
1283
  */
1147
1284
  export interface Action {
1148
1285
  /**
1286
+ * @public
1149
1287
  * <p>Write to a DynamoDB table.</p>
1150
1288
  */
1151
1289
  dynamoDB?: DynamoDBAction;
1152
1290
  /**
1291
+ * @public
1153
1292
  * <p>Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows
1154
1293
  * you to write each attribute in an MQTT message payload into a separate DynamoDB
1155
1294
  * column.</p>
1156
1295
  */
1157
1296
  dynamoDBv2?: DynamoDBv2Action;
1158
1297
  /**
1298
+ * @public
1159
1299
  * <p>Invoke a Lambda function.</p>
1160
1300
  */
1161
1301
  lambda?: LambdaAction;
1162
1302
  /**
1303
+ * @public
1163
1304
  * <p>Publish to an Amazon SNS topic.</p>
1164
1305
  */
1165
1306
  sns?: SnsAction;
1166
1307
  /**
1308
+ * @public
1167
1309
  * <p>Publish to an Amazon SQS queue.</p>
1168
1310
  */
1169
1311
  sqs?: SqsAction;
1170
1312
  /**
1313
+ * @public
1171
1314
  * <p>Write data to an Amazon Kinesis stream.</p>
1172
1315
  */
1173
1316
  kinesis?: KinesisAction;
1174
1317
  /**
1318
+ * @public
1175
1319
  * <p>Publish to another MQTT topic.</p>
1176
1320
  */
1177
1321
  republish?: RepublishAction;
1178
1322
  /**
1323
+ * @public
1179
1324
  * <p>Write to an Amazon S3 bucket.</p>
1180
1325
  */
1181
1326
  s3?: S3Action;
1182
1327
  /**
1328
+ * @public
1183
1329
  * <p>Write to an Amazon Kinesis Firehose stream.</p>
1184
1330
  */
1185
1331
  firehose?: FirehoseAction;
1186
1332
  /**
1333
+ * @public
1187
1334
  * <p>Capture a CloudWatch metric.</p>
1188
1335
  */
1189
1336
  cloudwatchMetric?: CloudwatchMetricAction;
1190
1337
  /**
1338
+ * @public
1191
1339
  * <p>Change the state of a CloudWatch alarm.</p>
1192
1340
  */
1193
1341
  cloudwatchAlarm?: CloudwatchAlarmAction;
1194
1342
  /**
1343
+ * @public
1195
1344
  * <p>Send data to CloudWatch Logs.</p>
1196
1345
  */
1197
1346
  cloudwatchLogs?: CloudwatchLogsAction;
1198
1347
  /**
1348
+ * @public
1199
1349
  * <p>Write data to an Amazon OpenSearch Service domain.</p>
1200
1350
  * <note>
1201
1351
  * <p>The <code>Elasticsearch</code> action can only be used by existing rule actions.
@@ -1206,45 +1356,55 @@ export interface Action {
1206
1356
  */
1207
1357
  elasticsearch?: ElasticsearchAction;
1208
1358
  /**
1359
+ * @public
1209
1360
  * <p>Send a message to a Salesforce IoT Cloud Input Stream.</p>
1210
1361
  */
1211
1362
  salesforce?: SalesforceAction;
1212
1363
  /**
1364
+ * @public
1213
1365
  * <p>Sends message data to an IoT Analytics channel.</p>
1214
1366
  */
1215
1367
  iotAnalytics?: IotAnalyticsAction;
1216
1368
  /**
1369
+ * @public
1217
1370
  * <p>Sends an input to an IoT Events detector.</p>
1218
1371
  */
1219
1372
  iotEvents?: IotEventsAction;
1220
1373
  /**
1374
+ * @public
1221
1375
  * <p>Sends data from the MQTT message that triggered the rule to IoT SiteWise asset
1222
1376
  * properties.</p>
1223
1377
  */
1224
1378
  iotSiteWise?: IotSiteWiseAction;
1225
1379
  /**
1380
+ * @public
1226
1381
  * <p>Starts execution of a Step Functions state machine.</p>
1227
1382
  */
1228
1383
  stepFunctions?: StepFunctionsAction;
1229
1384
  /**
1385
+ * @public
1230
1386
  * <p>The Timestream rule action writes attributes (measures) from an MQTT message
1231
1387
  * into an Amazon Timestream table. For more information, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html">Timestream</a>
1232
1388
  * topic rule action documentation.</p>
1233
1389
  */
1234
1390
  timestream?: TimestreamAction;
1235
1391
  /**
1392
+ * @public
1236
1393
  * <p>Send data to an HTTPS endpoint.</p>
1237
1394
  */
1238
1395
  http?: HttpAction;
1239
1396
  /**
1397
+ * @public
1240
1398
  * <p>Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.</p>
1241
1399
  */
1242
1400
  kafka?: KafkaAction;
1243
1401
  /**
1402
+ * @public
1244
1403
  * <p>Write data to an Amazon OpenSearch Service domain.</p>
1245
1404
  */
1246
1405
  openSearch?: OpenSearchAction;
1247
1406
  /**
1407
+ * @public
1248
1408
  * <p>The Amazon Location Service rule action sends device location updates from
1249
1409
  * an MQTT message to an Amazon Location tracker resource.</p>
1250
1410
  */
@@ -1305,6 +1465,7 @@ export type ConfidenceLevel = (typeof ConfidenceLevel)[keyof typeof ConfidenceLe
1305
1465
  */
1306
1466
  export interface MachineLearningDetectionConfig {
1307
1467
  /**
1468
+ * @public
1308
1469
  * <p>
1309
1470
  * The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>.
1310
1471
  * </p>
@@ -1319,6 +1480,7 @@ export interface MachineLearningDetectionConfig {
1319
1480
  */
1320
1481
  export interface StatisticalThreshold {
1321
1482
  /**
1483
+ * @public
1322
1484
  * <p>The percentile that
1323
1485
  * resolves to a threshold value by which compliance with a behavior is determined. Metrics are
1324
1486
  * collected over the specified period (<code>durationSeconds</code>) from all reporting devices
@@ -1336,33 +1498,39 @@ export interface StatisticalThreshold {
1336
1498
  */
1337
1499
  export interface MetricValue {
1338
1500
  /**
1501
+ * @public
1339
1502
  * <p>If the <code>comparisonOperator</code> calls for a numeric value, use this
1340
1503
  * to specify that numeric value to be compared with the <code>metric</code>.</p>
1341
1504
  */
1342
1505
  count?: number;
1343
1506
  /**
1507
+ * @public
1344
1508
  * <p>If the <code>comparisonOperator</code> calls for a set of CIDRs, use this
1345
1509
  * to specify that set to be compared with the <code>metric</code>.</p>
1346
1510
  */
1347
1511
  cidrs?: string[];
1348
1512
  /**
1513
+ * @public
1349
1514
  * <p>If the <code>comparisonOperator</code> calls for a set of ports, use this
1350
1515
  * to specify that set to be compared with the <code>metric</code>.</p>
1351
1516
  */
1352
1517
  ports?: number[];
1353
1518
  /**
1519
+ * @public
1354
1520
  * <p>
1355
1521
  * The numeral value of a metric.
1356
1522
  * </p>
1357
1523
  */
1358
1524
  number?: number;
1359
1525
  /**
1526
+ * @public
1360
1527
  * <p>
1361
1528
  * The numeral values of a metric.
1362
1529
  * </p>
1363
1530
  */
1364
1531
  numbers?: number[];
1365
1532
  /**
1533
+ * @public
1366
1534
  * <p>
1367
1535
  * The string values of a metric.
1368
1536
  * </p>
@@ -1375,6 +1543,7 @@ export interface MetricValue {
1375
1543
  */
1376
1544
  export interface BehaviorCriteria {
1377
1545
  /**
1546
+ * @public
1378
1547
  * <p>The operator that relates the thing measured (<code>metric</code>) to the criteria
1379
1548
  * (containing a <code>value</code> or <code>statisticalThreshold</code>). Valid operators include:</p>
1380
1549
  * <ul>
@@ -1402,10 +1571,12 @@ export interface BehaviorCriteria {
1402
1571
  */
1403
1572
  comparisonOperator?: ComparisonOperator | string;
1404
1573
  /**
1574
+ * @public
1405
1575
  * <p>The value to be compared with the <code>metric</code>.</p>
1406
1576
  */
1407
1577
  value?: MetricValue;
1408
1578
  /**
1579
+ * @public
1409
1580
  * <p>Use this to specify the time duration over which the behavior is evaluated, for those criteria that
1410
1581
  * have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>). For a
1411
1582
  * <code>statisticalThreshhold</code> metric comparison, measurements from all devices are
@@ -1415,23 +1586,27 @@ export interface BehaviorCriteria {
1415
1586
  */
1416
1587
  durationSeconds?: number;
1417
1588
  /**
1589
+ * @public
1418
1590
  * <p>If a device is in violation of the behavior for the specified number of consecutive
1419
1591
  * datapoints, an alarm occurs. If not specified, the default is 1.</p>
1420
1592
  */
1421
1593
  consecutiveDatapointsToAlarm?: number;
1422
1594
  /**
1595
+ * @public
1423
1596
  * <p>If an alarm has occurred and the offending device is no longer in violation of the behavior
1424
1597
  * for the specified number of consecutive datapoints, the alarm is cleared. If not specified,
1425
1598
  * the default is 1.</p>
1426
1599
  */
1427
1600
  consecutiveDatapointsToClear?: number;
1428
1601
  /**
1602
+ * @public
1429
1603
  * <p>A statistical ranking (percentile)that
1430
1604
  * indicates a threshold value by which a behavior is determined to be in compliance or in
1431
1605
  * violation of the behavior.</p>
1432
1606
  */
1433
1607
  statisticalThreshold?: StatisticalThreshold;
1434
1608
  /**
1609
+ * @public
1435
1610
  * <p>
1436
1611
  * The configuration of an ML Detect
1437
1612
  * </p>
@@ -1456,10 +1631,12 @@ export type DimensionValueOperator = (typeof DimensionValueOperator)[keyof typeo
1456
1631
  */
1457
1632
  export interface MetricDimension {
1458
1633
  /**
1634
+ * @public
1459
1635
  * <p>A unique identifier for the dimension.</p>
1460
1636
  */
1461
1637
  dimensionName: string | undefined;
1462
1638
  /**
1639
+ * @public
1463
1640
  * <p>Defines how the <code>dimensionValues</code> of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the <code>IN</code> operator, a message will be counted only if its topic matches one of the topic filters. With <code>NOT_IN</code> operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is <code>null</code>), it will be interpreted as <code>IN</code>.</p>
1464
1641
  */
1465
1642
  operator?: DimensionValueOperator | string;
@@ -1470,25 +1647,30 @@ export interface MetricDimension {
1470
1647
  */
1471
1648
  export interface Behavior {
1472
1649
  /**
1650
+ * @public
1473
1651
  * <p>The name
1474
1652
  * you've given to the behavior.</p>
1475
1653
  */
1476
1654
  name: string | undefined;
1477
1655
  /**
1656
+ * @public
1478
1657
  * <p>What is measured by the behavior.</p>
1479
1658
  */
1480
1659
  metric?: string;
1481
1660
  /**
1661
+ * @public
1482
1662
  * <p>The dimension for a metric in your behavior. For example, using a
1483
1663
  * <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.</p>
1484
1664
  */
1485
1665
  metricDimension?: MetricDimension;
1486
1666
  /**
1667
+ * @public
1487
1668
  * <p>The criteria that determine if a device is behaving normally in regard to
1488
1669
  * the <code>metric</code>.</p>
1489
1670
  */
1490
1671
  criteria?: BehaviorCriteria;
1491
1672
  /**
1673
+ * @public
1492
1674
  * <p>
1493
1675
  * Suppresses alerts.
1494
1676
  * </p>
@@ -1517,6 +1699,7 @@ export type VerificationState = (typeof VerificationState)[keyof typeof Verifica
1517
1699
  */
1518
1700
  export interface ViolationEventAdditionalInfo {
1519
1701
  /**
1702
+ * @public
1520
1703
  * <p>
1521
1704
  * The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>.
1522
1705
  * </p>
@@ -1529,44 +1712,54 @@ export interface ViolationEventAdditionalInfo {
1529
1712
  */
1530
1713
  export interface ActiveViolation {
1531
1714
  /**
1715
+ * @public
1532
1716
  * <p>The ID of the active violation.</p>
1533
1717
  */
1534
1718
  violationId?: string;
1535
1719
  /**
1720
+ * @public
1536
1721
  * <p>The name of the thing responsible for the active violation.</p>
1537
1722
  */
1538
1723
  thingName?: string;
1539
1724
  /**
1725
+ * @public
1540
1726
  * <p>The security profile with the behavior is in violation.</p>
1541
1727
  */
1542
1728
  securityProfileName?: string;
1543
1729
  /**
1730
+ * @public
1544
1731
  * <p>The behavior that is being violated.</p>
1545
1732
  */
1546
1733
  behavior?: Behavior;
1547
1734
  /**
1735
+ * @public
1548
1736
  * <p>The value of the metric (the measurement) that caused the most recent violation.</p>
1549
1737
  */
1550
1738
  lastViolationValue?: MetricValue;
1551
1739
  /**
1740
+ * @public
1552
1741
  * <p>
1553
1742
  * The details of a violation event.
1554
1743
  * </p>
1555
1744
  */
1556
1745
  violationEventAdditionalInfo?: ViolationEventAdditionalInfo;
1557
1746
  /**
1747
+ * @public
1558
1748
  * <p>The verification state of the violation (detect alarm).</p>
1559
1749
  */
1560
1750
  verificationState?: VerificationState | string;
1561
1751
  /**
1752
+ * @public
1562
1753
  * <p>The description of the verification state of the violation.</p>
1563
1754
  */
1564
1755
  verificationStateDescription?: string;
1565
1756
  /**
1757
+ * @public
1566
1758
  * <p>The time the most recent violation occurred.</p>
1567
1759
  */
1568
1760
  lastViolationTime?: Date;
1569
1761
  /**
1762
+ * @public
1570
1763
  * <p>The time the violation started.</p>
1571
1764
  */
1572
1765
  violationStartTime?: Date;
@@ -1577,10 +1770,12 @@ export interface ActiveViolation {
1577
1770
  */
1578
1771
  export interface MetricToRetain {
1579
1772
  /**
1773
+ * @public
1580
1774
  * <p>What is measured by the behavior.</p>
1581
1775
  */
1582
1776
  metric: string | undefined;
1583
1777
  /**
1778
+ * @public
1584
1779
  * <p>The dimension of a metric. This can't be used with custom metrics.</p>
1585
1780
  */
1586
1781
  metricDimension?: MetricDimension;
@@ -1591,10 +1786,12 @@ export interface MetricToRetain {
1591
1786
  */
1592
1787
  export interface AddThingsToThingGroupParams {
1593
1788
  /**
1789
+ * @public
1594
1790
  * <p>The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.</p>
1595
1791
  */
1596
1792
  thingGroupNames: string[] | undefined;
1597
1793
  /**
1794
+ * @public
1598
1795
  * <p>Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.</p>
1599
1796
  */
1600
1797
  overrideDynamicGroups?: boolean;
@@ -1604,6 +1801,7 @@ export interface AddThingsToThingGroupParams {
1604
1801
  */
1605
1802
  export interface AddThingToBillingGroupRequest {
1606
1803
  /**
1804
+ * @public
1607
1805
  * <p>The name of the billing group.</p>
1608
1806
  * <note>
1609
1807
  * <p>This call is asynchronous. It might take several seconds for the detachment to propagate.</p>
@@ -1611,14 +1809,17 @@ export interface AddThingToBillingGroupRequest {
1611
1809
  */
1612
1810
  billingGroupName?: string;
1613
1811
  /**
1812
+ * @public
1614
1813
  * <p>The ARN of the billing group.</p>
1615
1814
  */
1616
1815
  billingGroupArn?: string;
1617
1816
  /**
1817
+ * @public
1618
1818
  * <p>The name of the thing to be added to the billing group.</p>
1619
1819
  */
1620
1820
  thingName?: string;
1621
1821
  /**
1822
+ * @public
1622
1823
  * <p>The ARN of the thing to be added to the billing group.</p>
1623
1824
  */
1624
1825
  thingArn?: string;
@@ -1633,22 +1834,27 @@ export interface AddThingToBillingGroupResponse {
1633
1834
  */
1634
1835
  export interface AddThingToThingGroupRequest {
1635
1836
  /**
1837
+ * @public
1636
1838
  * <p>The name of the group to which you are adding a thing.</p>
1637
1839
  */
1638
1840
  thingGroupName?: string;
1639
1841
  /**
1842
+ * @public
1640
1843
  * <p>The ARN of the group to which you are adding a thing.</p>
1641
1844
  */
1642
1845
  thingGroupArn?: string;
1643
1846
  /**
1847
+ * @public
1644
1848
  * <p>The name of the thing to add to a group.</p>
1645
1849
  */
1646
1850
  thingName?: string;
1647
1851
  /**
1852
+ * @public
1648
1853
  * <p>The ARN of the thing to add to a group.</p>
1649
1854
  */
1650
1855
  thingArn?: string;
1651
1856
  /**
1857
+ * @public
1652
1858
  * <p>Override dynamic thing groups with static thing groups when 10-group limit is
1653
1859
  * reached. If a thing belongs to 10 thing groups, and one or more of those groups are
1654
1860
  * dynamic thing groups, adding a thing to a static group removes the thing from the last
@@ -1680,10 +1886,12 @@ export type AggregationTypeName = (typeof AggregationTypeName)[keyof typeof Aggr
1680
1886
  */
1681
1887
  export interface AggregationType {
1682
1888
  /**
1889
+ * @public
1683
1890
  * <p>The name of the aggregation type.</p>
1684
1891
  */
1685
1892
  name: AggregationTypeName | string | undefined;
1686
1893
  /**
1894
+ * @public
1687
1895
  * <p>A list of the values of aggregation types.</p>
1688
1896
  */
1689
1897
  values?: string[];
@@ -1694,10 +1902,12 @@ export interface AggregationType {
1694
1902
  */
1695
1903
  export interface AlertTarget {
1696
1904
  /**
1905
+ * @public
1697
1906
  * <p>The Amazon Resource Name (ARN) of the notification target to which alerts are sent.</p>
1698
1907
  */
1699
1908
  alertTargetArn: string | undefined;
1700
1909
  /**
1910
+ * @public
1701
1911
  * <p>The ARN of the role that grants permission to send alerts to the
1702
1912
  * notification target.</p>
1703
1913
  */
@@ -1720,10 +1930,12 @@ export type AlertTargetType = (typeof AlertTargetType)[keyof typeof AlertTargetT
1720
1930
  */
1721
1931
  export interface Policy {
1722
1932
  /**
1933
+ * @public
1723
1934
  * <p>The policy name.</p>
1724
1935
  */
1725
1936
  policyName?: string;
1726
1937
  /**
1938
+ * @public
1727
1939
  * <p>The policy ARN.</p>
1728
1940
  */
1729
1941
  policyArn?: string;
@@ -1734,6 +1946,7 @@ export interface Policy {
1734
1946
  */
1735
1947
  export interface Allowed {
1736
1948
  /**
1949
+ * @public
1737
1950
  * <p>A list of policies that allowed the authentication.</p>
1738
1951
  */
1739
1952
  policies?: Policy[];
@@ -1743,18 +1956,22 @@ export interface Allowed {
1743
1956
  */
1744
1957
  export interface AssociateTargetsWithJobRequest {
1745
1958
  /**
1959
+ * @public
1746
1960
  * <p>A list of thing group ARNs that define the targets of the job.</p>
1747
1961
  */
1748
1962
  targets: string[] | undefined;
1749
1963
  /**
1964
+ * @public
1750
1965
  * <p>The unique identifier you assigned to this job when it was created.</p>
1751
1966
  */
1752
1967
  jobId: string | undefined;
1753
1968
  /**
1969
+ * @public
1754
1970
  * <p>An optional comment string describing why the job was associated with the targets.</p>
1755
1971
  */
1756
1972
  comment?: string;
1757
1973
  /**
1974
+ * @public
1758
1975
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
1759
1976
  * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1760
1977
  * contain the value in the following format.</p>
@@ -1772,14 +1989,17 @@ export interface AssociateTargetsWithJobRequest {
1772
1989
  */
1773
1990
  export interface AssociateTargetsWithJobResponse {
1774
1991
  /**
1992
+ * @public
1775
1993
  * <p>An ARN identifying the job.</p>
1776
1994
  */
1777
1995
  jobArn?: string;
1778
1996
  /**
1997
+ * @public
1779
1998
  * <p>The unique identifier you assigned to this job when it was created.</p>
1780
1999
  */
1781
2000
  jobId?: string;
1782
2001
  /**
2002
+ * @public
1783
2003
  * <p>A short text description of the job.</p>
1784
2004
  */
1785
2005
  description?: string;
@@ -1801,10 +2021,12 @@ export declare class LimitExceededException extends __BaseException {
1801
2021
  */
1802
2022
  export interface AttachPolicyRequest {
1803
2023
  /**
2024
+ * @public
1804
2025
  * <p>The name of the policy to attach.</p>
1805
2026
  */
1806
2027
  policyName: string | undefined;
1807
2028
  /**
2029
+ * @public
1808
2030
  * <p>The <a href="https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html">identity</a> to which the policy is attached. For example, a thing group or a certificate.</p>
1809
2031
  */
1810
2032
  target: string | undefined;
@@ -1815,10 +2037,12 @@ export interface AttachPolicyRequest {
1815
2037
  */
1816
2038
  export interface AttachPrincipalPolicyRequest {
1817
2039
  /**
2040
+ * @public
1818
2041
  * <p>The policy name.</p>
1819
2042
  */
1820
2043
  policyName: string | undefined;
1821
2044
  /**
2045
+ * @public
1822
2046
  * <p>The principal, which can be a certificate ARN (as returned from the CreateCertificate
1823
2047
  * operation) or an Amazon Cognito ID.</p>
1824
2048
  */
@@ -1829,10 +2053,12 @@ export interface AttachPrincipalPolicyRequest {
1829
2053
  */
1830
2054
  export interface AttachSecurityProfileRequest {
1831
2055
  /**
2056
+ * @public
1832
2057
  * <p>The security profile that is attached.</p>
1833
2058
  */
1834
2059
  securityProfileName: string | undefined;
1835
2060
  /**
2061
+ * @public
1836
2062
  * <p>The ARN of the target (thing group) to which the security profile is attached.</p>
1837
2063
  */
1838
2064
  securityProfileTargetArn: string | undefined;
@@ -1862,10 +2088,12 @@ export declare class VersionConflictException extends __BaseException {
1862
2088
  */
1863
2089
  export interface AttachThingPrincipalRequest {
1864
2090
  /**
2091
+ * @public
1865
2092
  * <p>The name of the thing.</p>
1866
2093
  */
1867
2094
  thingName: string | undefined;
1868
2095
  /**
2096
+ * @public
1869
2097
  * <p>The principal, which can be a certificate ARN (as returned from the
1870
2098
  * CreateCertificate operation) or an Amazon Cognito ID.</p>
1871
2099
  */
@@ -1883,6 +2111,7 @@ export interface AttachThingPrincipalResponse {
1883
2111
  */
1884
2112
  export interface AttributePayload {
1885
2113
  /**
2114
+ * @public
1886
2115
  * <p>A JSON string containing up to three key-value pair in JSON format. For example:</p>
1887
2116
  * <p>
1888
2117
  * <code>\{\"attributes\":\{\"string1\":\"string2\"\}\}</code>
@@ -1890,6 +2119,7 @@ export interface AttributePayload {
1890
2119
  */
1891
2120
  attributes?: Record<string, string>;
1892
2121
  /**
2122
+ * @public
1893
2123
  * <p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with
1894
2124
  * the attributes stored in the registry, instead of overwriting them.</p>
1895
2125
  * <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p>
@@ -1905,6 +2135,7 @@ export interface AttributePayload {
1905
2135
  */
1906
2136
  export interface AuditCheckConfiguration {
1907
2137
  /**
2138
+ * @public
1908
2139
  * <p>True if this audit check is enabled for this account.</p>
1909
2140
  */
1910
2141
  enabled?: boolean;
@@ -1931,34 +2162,41 @@ export type AuditCheckRunStatus = (typeof AuditCheckRunStatus)[keyof typeof Audi
1931
2162
  */
1932
2163
  export interface AuditCheckDetails {
1933
2164
  /**
2165
+ * @public
1934
2166
  * <p>The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION",
1935
2167
  * "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".</p>
1936
2168
  */
1937
2169
  checkRunStatus?: AuditCheckRunStatus | string;
1938
2170
  /**
2171
+ * @public
1939
2172
  * <p>True if the check is complete and found all resources compliant.</p>
1940
2173
  */
1941
2174
  checkCompliant?: boolean;
1942
2175
  /**
2176
+ * @public
1943
2177
  * <p>The number of resources on which the check was performed.</p>
1944
2178
  */
1945
2179
  totalResourcesCount?: number;
1946
2180
  /**
2181
+ * @public
1947
2182
  * <p>The number of resources that were found noncompliant during the check.</p>
1948
2183
  */
1949
2184
  nonCompliantResourcesCount?: number;
1950
2185
  /**
2186
+ * @public
1951
2187
  * <p>
1952
2188
  * Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.
1953
2189
  * </p>
1954
2190
  */
1955
2191
  suppressedNonCompliantResourcesCount?: number;
1956
2192
  /**
2193
+ * @public
1957
2194
  * <p>The code of any error encountered when this check is performed during this audit.
1958
2195
  * One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".</p>
1959
2196
  */
1960
2197
  errorCode?: string;
1961
2198
  /**
2199
+ * @public
1962
2200
  * <p>The message associated with any error encountered when this check is performed during this audit.</p>
1963
2201
  */
1964
2202
  message?: string;
@@ -1969,14 +2207,17 @@ export interface AuditCheckDetails {
1969
2207
  */
1970
2208
  export interface IssuerCertificateIdentifier {
1971
2209
  /**
2210
+ * @public
1972
2211
  * <p>The subject of the issuer certificate.</p>
1973
2212
  */
1974
2213
  issuerCertificateSubject?: string;
1975
2214
  /**
2215
+ * @public
1976
2216
  * <p>The issuer ID.</p>
1977
2217
  */
1978
2218
  issuerId?: string;
1979
2219
  /**
2220
+ * @public
1980
2221
  * <p>The issuer certificate serial number.</p>
1981
2222
  */
1982
2223
  issuerCertificateSerialNumber?: string;
@@ -1987,10 +2228,12 @@ export interface IssuerCertificateIdentifier {
1987
2228
  */
1988
2229
  export interface PolicyVersionIdentifier {
1989
2230
  /**
2231
+ * @public
1990
2232
  * <p>The name of the policy.</p>
1991
2233
  */
1992
2234
  policyName?: string;
1993
2235
  /**
2236
+ * @public
1994
2237
  * <p>The ID of the version of the policy associated with the resource.</p>
1995
2238
  */
1996
2239
  policyVersionId?: string;
@@ -2001,42 +2244,52 @@ export interface PolicyVersionIdentifier {
2001
2244
  */
2002
2245
  export interface ResourceIdentifier {
2003
2246
  /**
2247
+ * @public
2004
2248
  * <p>The ID of the certificate attached to the resource.</p>
2005
2249
  */
2006
2250
  deviceCertificateId?: string;
2007
2251
  /**
2252
+ * @public
2008
2253
  * <p>The ID of the CA certificate used to authorize the certificate.</p>
2009
2254
  */
2010
2255
  caCertificateId?: string;
2011
2256
  /**
2257
+ * @public
2012
2258
  * <p>The ID of the Amazon Cognito identity pool.</p>
2013
2259
  */
2014
2260
  cognitoIdentityPoolId?: string;
2015
2261
  /**
2262
+ * @public
2016
2263
  * <p>The client ID.</p>
2017
2264
  */
2018
2265
  clientId?: string;
2019
2266
  /**
2267
+ * @public
2020
2268
  * <p>The version of the policy associated with the resource.</p>
2021
2269
  */
2022
2270
  policyVersionIdentifier?: PolicyVersionIdentifier;
2023
2271
  /**
2272
+ * @public
2024
2273
  * <p>The account with which the resource is associated.</p>
2025
2274
  */
2026
2275
  account?: string;
2027
2276
  /**
2277
+ * @public
2028
2278
  * <p>The ARN of the IAM role that has overly permissive actions.</p>
2029
2279
  */
2030
2280
  iamRoleArn?: string;
2031
2281
  /**
2282
+ * @public
2032
2283
  * <p>The ARN of the role alias that has overly permissive actions.</p>
2033
2284
  */
2034
2285
  roleAliasArn?: string;
2035
2286
  /**
2287
+ * @public
2036
2288
  * <p>The issuer certificate identifier.</p>
2037
2289
  */
2038
2290
  issuerCertificateIdentifier?: IssuerCertificateIdentifier;
2039
2291
  /**
2292
+ * @public
2040
2293
  * <p>The ARN of the identified device certificate.</p>
2041
2294
  */
2042
2295
  deviceCertificateArn?: string;
@@ -2066,14 +2319,17 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
2066
2319
  */
2067
2320
  export interface NonCompliantResource {
2068
2321
  /**
2322
+ * @public
2069
2323
  * <p>The type of the noncompliant resource.</p>
2070
2324
  */
2071
2325
  resourceType?: ResourceType | string;
2072
2326
  /**
2327
+ * @public
2073
2328
  * <p>Information that identifies the noncompliant resource.</p>
2074
2329
  */
2075
2330
  resourceIdentifier?: ResourceIdentifier;
2076
2331
  /**
2332
+ * @public
2077
2333
  * <p>Other information about the noncompliant resource.</p>
2078
2334
  */
2079
2335
  additionalInfo?: Record<string, string>;
@@ -2084,14 +2340,17 @@ export interface NonCompliantResource {
2084
2340
  */
2085
2341
  export interface RelatedResource {
2086
2342
  /**
2343
+ * @public
2087
2344
  * <p>The type of resource.</p>
2088
2345
  */
2089
2346
  resourceType?: ResourceType | string;
2090
2347
  /**
2348
+ * @public
2091
2349
  * <p>Information that identifies the resource.</p>
2092
2350
  */
2093
2351
  resourceIdentifier?: ResourceIdentifier;
2094
2352
  /**
2353
+ * @public
2095
2354
  * <p>Other information about the resource.</p>
2096
2355
  */
2097
2356
  additionalInfo?: Record<string, string>;
@@ -2116,48 +2375,59 @@ export type AuditFindingSeverity = (typeof AuditFindingSeverity)[keyof typeof Au
2116
2375
  */
2117
2376
  export interface AuditFinding {
2118
2377
  /**
2378
+ * @public
2119
2379
  * <p>A unique identifier for this set of audit findings. This identifier is used to apply
2120
2380
  * mitigation tasks to one or more sets of findings.</p>
2121
2381
  */
2122
2382
  findingId?: string;
2123
2383
  /**
2384
+ * @public
2124
2385
  * <p>The ID of the audit that generated this result (finding).</p>
2125
2386
  */
2126
2387
  taskId?: string;
2127
2388
  /**
2389
+ * @public
2128
2390
  * <p>The audit check that generated this result.</p>
2129
2391
  */
2130
2392
  checkName?: string;
2131
2393
  /**
2394
+ * @public
2132
2395
  * <p>The time the audit started.</p>
2133
2396
  */
2134
2397
  taskStartTime?: Date;
2135
2398
  /**
2399
+ * @public
2136
2400
  * <p>The time the result (finding) was discovered.</p>
2137
2401
  */
2138
2402
  findingTime?: Date;
2139
2403
  /**
2404
+ * @public
2140
2405
  * <p>The severity of the result (finding).</p>
2141
2406
  */
2142
2407
  severity?: AuditFindingSeverity | string;
2143
2408
  /**
2409
+ * @public
2144
2410
  * <p>The resource that was found to be noncompliant with the
2145
2411
  * audit check.</p>
2146
2412
  */
2147
2413
  nonCompliantResource?: NonCompliantResource;
2148
2414
  /**
2415
+ * @public
2149
2416
  * <p>The list of related resources.</p>
2150
2417
  */
2151
2418
  relatedResources?: RelatedResource[];
2152
2419
  /**
2420
+ * @public
2153
2421
  * <p>The reason the resource was noncompliant.</p>
2154
2422
  */
2155
2423
  reasonForNonCompliance?: string;
2156
2424
  /**
2425
+ * @public
2157
2426
  * <p>A code that indicates the reason that the resource was noncompliant.</p>
2158
2427
  */
2159
2428
  reasonForNonComplianceCode?: string;
2160
2429
  /**
2430
+ * @public
2161
2431
  * <p>
2162
2432
  * Indicates whether the audit finding was suppressed or not during reporting.
2163
2433
  * </p>
@@ -2200,38 +2470,47 @@ export type AuditMitigationActionsExecutionStatus = (typeof AuditMitigationActio
2200
2470
  */
2201
2471
  export interface AuditMitigationActionExecutionMetadata {
2202
2472
  /**
2473
+ * @public
2203
2474
  * <p>The unique identifier for the task that applies the mitigation action.</p>
2204
2475
  */
2205
2476
  taskId?: string;
2206
2477
  /**
2478
+ * @public
2207
2479
  * <p>The unique identifier for the findings to which the task and associated mitigation action are applied.</p>
2208
2480
  */
2209
2481
  findingId?: string;
2210
2482
  /**
2483
+ * @public
2211
2484
  * <p>The friendly name of the mitigation action being applied by the task.</p>
2212
2485
  */
2213
2486
  actionName?: string;
2214
2487
  /**
2488
+ * @public
2215
2489
  * <p>The unique identifier for the mitigation action being applied by the task.</p>
2216
2490
  */
2217
2491
  actionId?: string;
2218
2492
  /**
2493
+ * @public
2219
2494
  * <p>The current status of the task being executed.</p>
2220
2495
  */
2221
2496
  status?: AuditMitigationActionsExecutionStatus | string;
2222
2497
  /**
2498
+ * @public
2223
2499
  * <p>The date and time when the task was started.</p>
2224
2500
  */
2225
2501
  startTime?: Date;
2226
2502
  /**
2503
+ * @public
2227
2504
  * <p>The date and time when the task was completed or canceled. Blank if the task is still running.</p>
2228
2505
  */
2229
2506
  endTime?: Date;
2230
2507
  /**
2508
+ * @public
2231
2509
  * <p>If an error occurred, the code that indicates which type of error occurred.</p>
2232
2510
  */
2233
2511
  errorCode?: string;
2234
2512
  /**
2513
+ * @public
2235
2514
  * <p>If an error occurred, a message that describes the error.</p>
2236
2515
  */
2237
2516
  message?: string;
@@ -2256,14 +2535,17 @@ export type AuditMitigationActionsTaskStatus = (typeof AuditMitigationActionsTas
2256
2535
  */
2257
2536
  export interface AuditMitigationActionsTaskMetadata {
2258
2537
  /**
2538
+ * @public
2259
2539
  * <p>The unique identifier for the task.</p>
2260
2540
  */
2261
2541
  taskId?: string;
2262
2542
  /**
2543
+ * @public
2263
2544
  * <p>The time at which the audit mitigation actions task was started.</p>
2264
2545
  */
2265
2546
  startTime?: Date;
2266
2547
  /**
2548
+ * @public
2267
2549
  * <p>The current state of the audit mitigation actions task.</p>
2268
2550
  */
2269
2551
  taskStatus?: AuditMitigationActionsTaskStatus | string;
@@ -2274,22 +2556,27 @@ export interface AuditMitigationActionsTaskMetadata {
2274
2556
  */
2275
2557
  export interface TaskStatisticsForAuditCheck {
2276
2558
  /**
2559
+ * @public
2277
2560
  * <p>The total number of findings to which a task is being applied.</p>
2278
2561
  */
2279
2562
  totalFindingsCount?: number;
2280
2563
  /**
2564
+ * @public
2281
2565
  * <p>The number of findings for which at least one of the actions failed when applied.</p>
2282
2566
  */
2283
2567
  failedFindingsCount?: number;
2284
2568
  /**
2569
+ * @public
2285
2570
  * <p>The number of findings for which all mitigation actions succeeded when applied.</p>
2286
2571
  */
2287
2572
  succeededFindingsCount?: number;
2288
2573
  /**
2574
+ * @public
2289
2575
  * <p>The number of findings skipped because of filter conditions provided in the parameters to the command.</p>
2290
2576
  */
2291
2577
  skippedFindingsCount?: number;
2292
2578
  /**
2579
+ * @public
2293
2580
  * <p>The number of findings to which the mitigation action task was canceled when applied.</p>
2294
2581
  */
2295
2582
  canceledFindingsCount?: number;
@@ -2300,14 +2587,17 @@ export interface TaskStatisticsForAuditCheck {
2300
2587
  */
2301
2588
  export interface AuditMitigationActionsTaskTarget {
2302
2589
  /**
2590
+ * @public
2303
2591
  * <p>If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.</p>
2304
2592
  */
2305
2593
  auditTaskId?: string;
2306
2594
  /**
2595
+ * @public
2307
2596
  * <p>If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.</p>
2308
2597
  */
2309
2598
  findingIds?: string[];
2310
2599
  /**
2600
+ * @public
2311
2601
  * <p>Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.</p>
2312
2602
  */
2313
2603
  auditCheckToReasonCodeFilter?: Record<string, string[]>;
@@ -2318,14 +2608,17 @@ export interface AuditMitigationActionsTaskTarget {
2318
2608
  */
2319
2609
  export interface AuditNotificationTarget {
2320
2610
  /**
2611
+ * @public
2321
2612
  * <p>The ARN of the target (SNS topic) to which audit notifications are sent.</p>
2322
2613
  */
2323
2614
  targetArn?: string;
2324
2615
  /**
2616
+ * @public
2325
2617
  * <p>The ARN of the role that grants permission to send notifications to the target.</p>
2326
2618
  */
2327
2619
  roleArn?: string;
2328
2620
  /**
2621
+ * @public
2329
2622
  * <p>True if notifications to the target are enabled.</p>
2330
2623
  */
2331
2624
  enabled?: boolean;
@@ -2347,6 +2640,7 @@ export type AuditNotificationType = (typeof AuditNotificationType)[keyof typeof
2347
2640
  */
2348
2641
  export interface AuditSuppression {
2349
2642
  /**
2643
+ * @public
2350
2644
  * <p>An audit check name. Checks must be enabled
2351
2645
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
2352
2646
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -2354,22 +2648,26 @@ export interface AuditSuppression {
2354
2648
  */
2355
2649
  checkName: string | undefined;
2356
2650
  /**
2651
+ * @public
2357
2652
  * <p>Information that identifies the noncompliant resource.</p>
2358
2653
  */
2359
2654
  resourceIdentifier: ResourceIdentifier | undefined;
2360
2655
  /**
2656
+ * @public
2361
2657
  * <p>
2362
2658
  * The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
2363
2659
  * </p>
2364
2660
  */
2365
2661
  expirationDate?: Date;
2366
2662
  /**
2663
+ * @public
2367
2664
  * <p>
2368
2665
  * Indicates whether a suppression should exist indefinitely or not.
2369
2666
  * </p>
2370
2667
  */
2371
2668
  suppressIndefinitely?: boolean;
2372
2669
  /**
2670
+ * @public
2373
2671
  * <p>
2374
2672
  * The description of the audit suppression.
2375
2673
  * </p>
@@ -2408,15 +2706,18 @@ export type AuditTaskType = (typeof AuditTaskType)[keyof typeof AuditTaskType];
2408
2706
  */
2409
2707
  export interface AuditTaskMetadata {
2410
2708
  /**
2709
+ * @public
2411
2710
  * <p>The ID of this audit.</p>
2412
2711
  */
2413
2712
  taskId?: string;
2414
2713
  /**
2714
+ * @public
2415
2715
  * <p>The status of this audit. One of "IN_PROGRESS", "COMPLETED",
2416
2716
  * "FAILED", or "CANCELED".</p>
2417
2717
  */
2418
2718
  taskStatus?: AuditTaskStatus | string;
2419
2719
  /**
2720
+ * @public
2420
2721
  * <p>The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".</p>
2421
2722
  */
2422
2723
  taskType?: AuditTaskType | string;
@@ -2440,10 +2741,12 @@ export type AuthDecision = (typeof AuthDecision)[keyof typeof AuthDecision];
2440
2741
  */
2441
2742
  export interface AuthInfo {
2442
2743
  /**
2744
+ * @public
2443
2745
  * <p>The type of action for which the principal is being authorized.</p>
2444
2746
  */
2445
2747
  actionType?: ActionType | string;
2446
2748
  /**
2749
+ * @public
2447
2750
  * <p>The resources for which the principal is being authorized to perform the specified
2448
2751
  * action.</p>
2449
2752
  */
@@ -2455,10 +2758,12 @@ export interface AuthInfo {
2455
2758
  */
2456
2759
  export interface AuthorizerConfig {
2457
2760
  /**
2761
+ * @public
2458
2762
  * <p>The name of the authorization service for a domain configuration.</p>
2459
2763
  */
2460
2764
  defaultAuthorizerName?: string;
2461
2765
  /**
2766
+ * @public
2462
2767
  * <p>A Boolean that specifies whether the domain configuration's authorization service can be overridden.</p>
2463
2768
  */
2464
2769
  allowAuthorizerOverride?: boolean;
@@ -2481,43 +2786,53 @@ export type AuthorizerStatus = (typeof AuthorizerStatus)[keyof typeof Authorizer
2481
2786
  */
2482
2787
  export interface AuthorizerDescription {
2483
2788
  /**
2789
+ * @public
2484
2790
  * <p>The authorizer name.</p>
2485
2791
  */
2486
2792
  authorizerName?: string;
2487
2793
  /**
2794
+ * @public
2488
2795
  * <p>The authorizer ARN.</p>
2489
2796
  */
2490
2797
  authorizerArn?: string;
2491
2798
  /**
2799
+ * @public
2492
2800
  * <p>The authorizer's Lambda function ARN.</p>
2493
2801
  */
2494
2802
  authorizerFunctionArn?: string;
2495
2803
  /**
2804
+ * @public
2496
2805
  * <p>The key used to extract the token from the HTTP headers.</p>
2497
2806
  */
2498
2807
  tokenKeyName?: string;
2499
2808
  /**
2809
+ * @public
2500
2810
  * <p>The public keys used to validate the token signature returned by your custom
2501
2811
  * authentication service.</p>
2502
2812
  */
2503
2813
  tokenSigningPublicKeys?: Record<string, string>;
2504
2814
  /**
2815
+ * @public
2505
2816
  * <p>The status of the authorizer.</p>
2506
2817
  */
2507
2818
  status?: AuthorizerStatus | string;
2508
2819
  /**
2820
+ * @public
2509
2821
  * <p>The UNIX timestamp of when the authorizer was created.</p>
2510
2822
  */
2511
2823
  creationDate?: Date;
2512
2824
  /**
2825
+ * @public
2513
2826
  * <p>The UNIX timestamp of when the authorizer was last updated.</p>
2514
2827
  */
2515
2828
  lastModifiedDate?: Date;
2516
2829
  /**
2830
+ * @public
2517
2831
  * <p>Specifies whether IoT validates the token signature in an authorization request.</p>
2518
2832
  */
2519
2833
  signingDisabled?: boolean;
2520
2834
  /**
2835
+ * @public
2521
2836
  * <p>When <code>true</code>, the result from the authorizer’s Lambda function is
2522
2837
  * cached for the time specified in <code>refreshAfterInSeconds</code>. The cached
2523
2838
  * result is used while the device reuses the same HTTP connection.</p>
@@ -2530,10 +2845,12 @@ export interface AuthorizerDescription {
2530
2845
  */
2531
2846
  export interface AuthorizerSummary {
2532
2847
  /**
2848
+ * @public
2533
2849
  * <p>The authorizer name.</p>
2534
2850
  */
2535
2851
  authorizerName?: string;
2536
2852
  /**
2853
+ * @public
2537
2854
  * <p>The authorizer ARN.</p>
2538
2855
  */
2539
2856
  authorizerArn?: string;
@@ -2544,6 +2861,7 @@ export interface AuthorizerSummary {
2544
2861
  */
2545
2862
  export interface ExplicitDeny {
2546
2863
  /**
2864
+ * @public
2547
2865
  * <p>The policies that denied the authorization.</p>
2548
2866
  */
2549
2867
  policies?: Policy[];
@@ -2555,6 +2873,7 @@ export interface ExplicitDeny {
2555
2873
  */
2556
2874
  export interface ImplicitDeny {
2557
2875
  /**
2876
+ * @public
2558
2877
  * <p>Policies that don't contain a matching allow or deny statement for the specified
2559
2878
  * action on the specified resource. </p>
2560
2879
  */
@@ -2566,12 +2885,14 @@ export interface ImplicitDeny {
2566
2885
  */
2567
2886
  export interface Denied {
2568
2887
  /**
2888
+ * @public
2569
2889
  * <p>Information that implicitly denies the authorization. When a policy doesn't
2570
2890
  * explicitly deny or allow an action on a resource it is considered an implicit
2571
2891
  * deny.</p>
2572
2892
  */
2573
2893
  implicitDeny?: ImplicitDeny;
2574
2894
  /**
2895
+ * @public
2575
2896
  * <p>Information that explicitly denies the authorization. </p>
2576
2897
  */
2577
2898
  explicitDeny?: ExplicitDeny;
@@ -2582,24 +2903,29 @@ export interface Denied {
2582
2903
  */
2583
2904
  export interface AuthResult {
2584
2905
  /**
2906
+ * @public
2585
2907
  * <p>Authorization information.</p>
2586
2908
  */
2587
2909
  authInfo?: AuthInfo;
2588
2910
  /**
2911
+ * @public
2589
2912
  * <p>The policies and statements that allowed the specified action.</p>
2590
2913
  */
2591
2914
  allowed?: Allowed;
2592
2915
  /**
2916
+ * @public
2593
2917
  * <p>The policies and statements that denied the specified action.</p>
2594
2918
  */
2595
2919
  denied?: Denied;
2596
2920
  /**
2921
+ * @public
2597
2922
  * <p>The final authorization decision of this scenario. Multiple statements are taken into
2598
2923
  * account when determining the authorization decision. An explicit deny statement can
2599
2924
  * override multiple allow statements.</p>
2600
2925
  */
2601
2926
  authDecision?: AuthDecision | string;
2602
2927
  /**
2928
+ * @public
2603
2929
  * <p>Contains any missing context values found while evaluating policy.</p>
2604
2930
  */
2605
2931
  missingContextValues?: string[];
@@ -2621,6 +2947,7 @@ export type AutoRegistrationStatus = (typeof AutoRegistrationStatus)[keyof typeo
2621
2947
  */
2622
2948
  export interface CancelAuditMitigationActionsTaskRequest {
2623
2949
  /**
2950
+ * @public
2624
2951
  * <p>The unique identifier for the task that you want to cancel. </p>
2625
2952
  */
2626
2953
  taskId: string | undefined;
@@ -2635,6 +2962,7 @@ export interface CancelAuditMitigationActionsTaskResponse {
2635
2962
  */
2636
2963
  export interface CancelAuditTaskRequest {
2637
2964
  /**
2965
+ * @public
2638
2966
  * <p>The ID of the audit you want to cancel. You can only cancel an
2639
2967
  * audit that is "IN_PROGRESS".</p>
2640
2968
  */
@@ -2651,6 +2979,7 @@ export interface CancelAuditTaskResponse {
2651
2979
  */
2652
2980
  export interface CancelCertificateTransferRequest {
2653
2981
  /**
2982
+ * @public
2654
2983
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
2655
2984
  * certificate ID.)</p>
2656
2985
  */
@@ -2661,6 +2990,7 @@ export interface CancelCertificateTransferRequest {
2661
2990
  */
2662
2991
  export interface CancelDetectMitigationActionsTaskRequest {
2663
2992
  /**
2993
+ * @public
2664
2994
  * <p>
2665
2995
  * The unique identifier of the task.
2666
2996
  * </p>
@@ -2677,18 +3007,22 @@ export interface CancelDetectMitigationActionsTaskResponse {
2677
3007
  */
2678
3008
  export interface CancelJobRequest {
2679
3009
  /**
3010
+ * @public
2680
3011
  * <p>The unique identifier you assigned to this job when it was created.</p>
2681
3012
  */
2682
3013
  jobId: string | undefined;
2683
3014
  /**
3015
+ * @public
2684
3016
  * <p>(Optional)A reason code string that explains why the job was canceled.</p>
2685
3017
  */
2686
3018
  reasonCode?: string;
2687
3019
  /**
3020
+ * @public
2688
3021
  * <p>An optional comment string describing why the job was canceled.</p>
2689
3022
  */
2690
3023
  comment?: string;
2691
3024
  /**
3025
+ * @public
2692
3026
  * <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED"
2693
3027
  * are canceled, otherwise only job executions with status "QUEUED" are canceled. The default
2694
3028
  * is <code>false</code>.</p>
@@ -2703,14 +3037,17 @@ export interface CancelJobRequest {
2703
3037
  */
2704
3038
  export interface CancelJobResponse {
2705
3039
  /**
3040
+ * @public
2706
3041
  * <p>The job ARN.</p>
2707
3042
  */
2708
3043
  jobArn?: string;
2709
3044
  /**
3045
+ * @public
2710
3046
  * <p>The unique identifier you assigned to this job when it was created.</p>
2711
3047
  */
2712
3048
  jobId?: string;
2713
3049
  /**
3050
+ * @public
2714
3051
  * <p>A short text description of the job.</p>
2715
3052
  */
2716
3053
  description?: string;
@@ -2720,14 +3057,17 @@ export interface CancelJobResponse {
2720
3057
  */
2721
3058
  export interface CancelJobExecutionRequest {
2722
3059
  /**
3060
+ * @public
2723
3061
  * <p>The ID of the job to be canceled.</p>
2724
3062
  */
2725
3063
  jobId: string | undefined;
2726
3064
  /**
3065
+ * @public
2727
3066
  * <p>The name of the thing whose execution of the job will be canceled.</p>
2728
3067
  */
2729
3068
  thingName: string | undefined;
2730
3069
  /**
3070
+ * @public
2731
3071
  * <p>(Optional) If <code>true</code> the job execution will be canceled if it has status
2732
3072
  * IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status
2733
3073
  * QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set
@@ -2739,6 +3079,7 @@ export interface CancelJobExecutionRequest {
2739
3079
  */
2740
3080
  force?: boolean;
2741
3081
  /**
3082
+ * @public
2742
3083
  * <p>(Optional) The expected current version of the job execution. Each time you update the job
2743
3084
  * execution, its version is incremented. If the version of the job execution stored in Jobs does
2744
3085
  * not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that
@@ -2748,6 +3089,7 @@ export interface CancelJobExecutionRequest {
2748
3089
  */
2749
3090
  expectedVersion?: number;
2750
3091
  /**
3092
+ * @public
2751
3093
  * <p>A collection of name/value pairs that describe the status of the job execution. If not
2752
3094
  * specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.</p>
2753
3095
  */
@@ -2782,6 +3124,7 @@ export interface ClearDefaultAuthorizerResponse {
2782
3124
  */
2783
3125
  export interface ConfirmTopicRuleDestinationRequest {
2784
3126
  /**
3127
+ * @public
2785
3128
  * <p>The token used to confirm ownership or access to the topic rule confirmation URL.</p>
2786
3129
  */
2787
3130
  confirmationToken: string | undefined;
@@ -2821,6 +3164,7 @@ export declare class InternalException extends __BaseException {
2821
3164
  */
2822
3165
  export interface CreateAuditSuppressionRequest {
2823
3166
  /**
3167
+ * @public
2824
3168
  * <p>An audit check name. Checks must be enabled
2825
3169
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
2826
3170
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -2828,28 +3172,33 @@ export interface CreateAuditSuppressionRequest {
2828
3172
  */
2829
3173
  checkName: string | undefined;
2830
3174
  /**
3175
+ * @public
2831
3176
  * <p>Information that identifies the noncompliant resource.</p>
2832
3177
  */
2833
3178
  resourceIdentifier: ResourceIdentifier | undefined;
2834
3179
  /**
3180
+ * @public
2835
3181
  * <p>
2836
3182
  * The epoch timestamp in seconds at which this suppression expires.
2837
3183
  * </p>
2838
3184
  */
2839
3185
  expirationDate?: Date;
2840
3186
  /**
3187
+ * @public
2841
3188
  * <p>
2842
3189
  * Indicates whether a suppression should exist indefinitely or not.
2843
3190
  * </p>
2844
3191
  */
2845
3192
  suppressIndefinitely?: boolean;
2846
3193
  /**
3194
+ * @public
2847
3195
  * <p>
2848
3196
  * The description of the audit suppression.
2849
3197
  * </p>
2850
3198
  */
2851
3199
  description?: string;
2852
3200
  /**
3201
+ * @public
2853
3202
  * <p>
2854
3203
  * Each audit supression must have a unique client request token. If you try to create a new audit
2855
3204
  * suppression with the same token as one that already exists, an exception occurs. If you omit this
@@ -2870,10 +3219,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
2870
3219
  readonly name: "ResourceAlreadyExistsException";
2871
3220
  readonly $fault: "client";
2872
3221
  /**
3222
+ * @public
2873
3223
  * <p>The ID of the resource that caused the exception.</p>
2874
3224
  */
2875
3225
  resourceId?: string;
2876
3226
  /**
3227
+ * @public
2877
3228
  * <p>The ARN of the resource that caused the exception.</p>
2878
3229
  */
2879
3230
  resourceArn?: string;
@@ -2888,10 +3239,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
2888
3239
  */
2889
3240
  export interface Tag {
2890
3241
  /**
3242
+ * @public
2891
3243
  * <p>The tag's key.</p>
2892
3244
  */
2893
3245
  Key: string | undefined;
2894
3246
  /**
3247
+ * @public
2895
3248
  * <p>The tag's value.</p>
2896
3249
  */
2897
3250
  Value?: string;
@@ -2901,27 +3254,33 @@ export interface Tag {
2901
3254
  */
2902
3255
  export interface CreateAuthorizerRequest {
2903
3256
  /**
3257
+ * @public
2904
3258
  * <p>The authorizer name.</p>
2905
3259
  */
2906
3260
  authorizerName: string | undefined;
2907
3261
  /**
3262
+ * @public
2908
3263
  * <p>The ARN of the authorizer's Lambda function.</p>
2909
3264
  */
2910
3265
  authorizerFunctionArn: string | undefined;
2911
3266
  /**
3267
+ * @public
2912
3268
  * <p>The name of the token key used to extract the token from the HTTP headers.</p>
2913
3269
  */
2914
3270
  tokenKeyName?: string;
2915
3271
  /**
3272
+ * @public
2916
3273
  * <p>The public keys used to verify the digital signature returned by your custom
2917
3274
  * authentication service.</p>
2918
3275
  */
2919
3276
  tokenSigningPublicKeys?: Record<string, string>;
2920
3277
  /**
3278
+ * @public
2921
3279
  * <p>The status of the create authorizer request.</p>
2922
3280
  */
2923
3281
  status?: AuthorizerStatus | string;
2924
3282
  /**
3283
+ * @public
2925
3284
  * <p>Metadata which can be used to manage the custom authorizer.</p>
2926
3285
  * <note>
2927
3286
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -2933,10 +3292,12 @@ export interface CreateAuthorizerRequest {
2933
3292
  */
2934
3293
  tags?: Tag[];
2935
3294
  /**
3295
+ * @public
2936
3296
  * <p>Specifies whether IoT validates the token signature in an authorization request.</p>
2937
3297
  */
2938
3298
  signingDisabled?: boolean;
2939
3299
  /**
3300
+ * @public
2940
3301
  * <p>When <code>true</code>, the result from the authorizer’s Lambda function is
2941
3302
  * cached for clients that use persistent HTTP connections. The results are cached for the time
2942
3303
  * specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value
@@ -2950,10 +3311,12 @@ export interface CreateAuthorizerRequest {
2950
3311
  */
2951
3312
  export interface CreateAuthorizerResponse {
2952
3313
  /**
3314
+ * @public
2953
3315
  * <p>The authorizer's name.</p>
2954
3316
  */
2955
3317
  authorizerName?: string;
2956
3318
  /**
3319
+ * @public
2957
3320
  * <p>The authorizer ARN.</p>
2958
3321
  */
2959
3322
  authorizerArn?: string;
@@ -2964,6 +3327,7 @@ export interface CreateAuthorizerResponse {
2964
3327
  */
2965
3328
  export interface BillingGroupProperties {
2966
3329
  /**
3330
+ * @public
2967
3331
  * <p>The description of the billing group.</p>
2968
3332
  */
2969
3333
  billingGroupDescription?: string;
@@ -2973,14 +3337,17 @@ export interface BillingGroupProperties {
2973
3337
  */
2974
3338
  export interface CreateBillingGroupRequest {
2975
3339
  /**
3340
+ * @public
2976
3341
  * <p>The name you wish to give to the billing group.</p>
2977
3342
  */
2978
3343
  billingGroupName: string | undefined;
2979
3344
  /**
3345
+ * @public
2980
3346
  * <p>The properties of the billing group.</p>
2981
3347
  */
2982
3348
  billingGroupProperties?: BillingGroupProperties;
2983
3349
  /**
3350
+ * @public
2984
3351
  * <p>Metadata which can be used to manage the billing group.</p>
2985
3352
  */
2986
3353
  tags?: Tag[];
@@ -2990,14 +3357,17 @@ export interface CreateBillingGroupRequest {
2990
3357
  */
2991
3358
  export interface CreateBillingGroupResponse {
2992
3359
  /**
3360
+ * @public
2993
3361
  * <p>The name you gave to the billing group.</p>
2994
3362
  */
2995
3363
  billingGroupName?: string;
2996
3364
  /**
3365
+ * @public
2997
3366
  * <p>The ARN of the billing group.</p>
2998
3367
  */
2999
3368
  billingGroupArn?: string;
3000
3369
  /**
3370
+ * @public
3001
3371
  * <p>The ID of the billing group.</p>
3002
3372
  */
3003
3373
  billingGroupId?: string;
@@ -3008,10 +3378,12 @@ export interface CreateBillingGroupResponse {
3008
3378
  */
3009
3379
  export interface CreateCertificateFromCsrRequest {
3010
3380
  /**
3381
+ * @public
3011
3382
  * <p>The certificate signing request (CSR).</p>
3012
3383
  */
3013
3384
  certificateSigningRequest: string | undefined;
3014
3385
  /**
3386
+ * @public
3015
3387
  * <p>Specifies whether the certificate is active.</p>
3016
3388
  */
3017
3389
  setAsActive?: boolean;
@@ -3022,16 +3394,19 @@ export interface CreateCertificateFromCsrRequest {
3022
3394
  */
3023
3395
  export interface CreateCertificateFromCsrResponse {
3024
3396
  /**
3397
+ * @public
3025
3398
  * <p>The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal
3026
3399
  * for policy operations.</p>
3027
3400
  */
3028
3401
  certificateArn?: string;
3029
3402
  /**
3403
+ * @public
3030
3404
  * <p>The ID of the certificate. Certificate management operations only take a
3031
3405
  * certificateId.</p>
3032
3406
  */
3033
3407
  certificateId?: string;
3034
3408
  /**
3409
+ * @public
3035
3410
  * <p>The certificate data, in PEM format.</p>
3036
3411
  */
3037
3412
  certificatePem?: string;
@@ -3055,18 +3430,21 @@ export type CustomMetricType = (typeof CustomMetricType)[keyof typeof CustomMetr
3055
3430
  */
3056
3431
  export interface CreateCustomMetricRequest {
3057
3432
  /**
3433
+ * @public
3058
3434
  * <p> The name of the custom metric. This will be used in the metric report submitted from the
3059
3435
  * device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you
3060
3436
  * define it.</p>
3061
3437
  */
3062
3438
  metricName: string | undefined;
3063
3439
  /**
3440
+ * @public
3064
3441
  * <p> The friendly name in the console for the custom metric. This name doesn't have to be
3065
3442
  * unique. Don't use this name as the metric identifier in the device metric report. You can
3066
3443
  * update the friendly name after you define it.</p>
3067
3444
  */
3068
3445
  displayName?: string;
3069
3446
  /**
3447
+ * @public
3070
3448
  * <p> The type of the custom metric. </p>
3071
3449
  * <important>
3072
3450
  * <p>The type <code>number</code> only takes a single metric value as an input, but when you
@@ -3076,12 +3454,14 @@ export interface CreateCustomMetricRequest {
3076
3454
  */
3077
3455
  metricType: CustomMetricType | string | undefined;
3078
3456
  /**
3457
+ * @public
3079
3458
  * <p>
3080
3459
  * Metadata that can be used to manage the custom metric.
3081
3460
  * </p>
3082
3461
  */
3083
3462
  tags?: Tag[];
3084
3463
  /**
3464
+ * @public
3085
3465
  * <p>Each custom
3086
3466
  * metric must have a unique client request token. If you try to create a new custom metric that
3087
3467
  * already exists with a different token,
@@ -3095,12 +3475,14 @@ export interface CreateCustomMetricRequest {
3095
3475
  */
3096
3476
  export interface CreateCustomMetricResponse {
3097
3477
  /**
3478
+ * @public
3098
3479
  * <p>
3099
3480
  * The name of the custom metric to be used in the metric report.
3100
3481
  * </p>
3101
3482
  */
3102
3483
  metricName?: string;
3103
3484
  /**
3485
+ * @public
3104
3486
  * <p> The Amazon Resource Number (ARN) of the custom metric. For example,
3105
3487
  * <code>arn:<i>aws-partition</i>:iot:<i>region</i>:<i>accountId</i>:custommetric/<i>metricName</i>
3106
3488
  * </code>
@@ -3124,23 +3506,28 @@ export type DimensionType = (typeof DimensionType)[keyof typeof DimensionType];
3124
3506
  */
3125
3507
  export interface CreateDimensionRequest {
3126
3508
  /**
3509
+ * @public
3127
3510
  * <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>
3128
3511
  */
3129
3512
  name: string | undefined;
3130
3513
  /**
3514
+ * @public
3131
3515
  * <p>Specifies the type of dimension. Supported types: <code>TOPIC_FILTER.</code>
3132
3516
  * </p>
3133
3517
  */
3134
3518
  type: DimensionType | string | undefined;
3135
3519
  /**
3520
+ * @public
3136
3521
  * <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>
3137
3522
  */
3138
3523
  stringValues: string[] | undefined;
3139
3524
  /**
3525
+ * @public
3140
3526
  * <p>Metadata that can be used to manage the dimension.</p>
3141
3527
  */
3142
3528
  tags?: Tag[];
3143
3529
  /**
3530
+ * @public
3144
3531
  * <p>Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs.
3145
3532
  * If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
3146
3533
  */
@@ -3151,10 +3538,12 @@ export interface CreateDimensionRequest {
3151
3538
  */
3152
3539
  export interface CreateDimensionResponse {
3153
3540
  /**
3541
+ * @public
3154
3542
  * <p>A unique identifier for the dimension.</p>
3155
3543
  */
3156
3544
  name?: string;
3157
3545
  /**
3546
+ * @public
3158
3547
  * <p>The Amazon Resource Name
3159
3548
  * (ARN)
3160
3549
  * of
@@ -3193,6 +3582,7 @@ export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType];
3193
3582
  */
3194
3583
  export interface TlsConfig {
3195
3584
  /**
3585
+ * @public
3196
3586
  * <p>The security policy for a domain configuration. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table">Security
3197
3587
  * policies </a> in the <i>Amazon Web Services IoT Core developer
3198
3588
  * guide</i>.</p>
@@ -3204,28 +3594,34 @@ export interface TlsConfig {
3204
3594
  */
3205
3595
  export interface CreateDomainConfigurationRequest {
3206
3596
  /**
3597
+ * @public
3207
3598
  * <p>The name of the domain configuration. This value must be unique to a region.</p>
3208
3599
  */
3209
3600
  domainConfigurationName: string | undefined;
3210
3601
  /**
3602
+ * @public
3211
3603
  * <p>The name of the domain.</p>
3212
3604
  */
3213
3605
  domainName?: string;
3214
3606
  /**
3607
+ * @public
3215
3608
  * <p>The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN.
3216
3609
  * This value is not required for Amazon Web Services-managed domains.</p>
3217
3610
  */
3218
3611
  serverCertificateArns?: string[];
3219
3612
  /**
3613
+ * @public
3220
3614
  * <p>The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority.
3221
3615
  * This value is not required for Amazon Web Services-managed domains.</p>
3222
3616
  */
3223
3617
  validationCertificateArn?: string;
3224
3618
  /**
3619
+ * @public
3225
3620
  * <p>An object that specifies the authorization service for a domain.</p>
3226
3621
  */
3227
3622
  authorizerConfig?: AuthorizerConfig;
3228
3623
  /**
3624
+ * @public
3229
3625
  * <p>The type of service delivered by the endpoint.</p>
3230
3626
  * <note>
3231
3627
  * <p>Amazon Web Services IoT Core currently supports only the <code>DATA</code> service type.</p>
@@ -3233,6 +3629,7 @@ export interface CreateDomainConfigurationRequest {
3233
3629
  */
3234
3630
  serviceType?: ServiceType | string;
3235
3631
  /**
3632
+ * @public
3236
3633
  * <p>Metadata which can be used to manage the domain configuration.</p>
3237
3634
  * <note>
3238
3635
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -3244,6 +3641,7 @@ export interface CreateDomainConfigurationRequest {
3244
3641
  */
3245
3642
  tags?: Tag[];
3246
3643
  /**
3644
+ * @public
3247
3645
  * <p>An object that specifies the TLS configuration for a domain.</p>
3248
3646
  */
3249
3647
  tlsConfig?: TlsConfig;
@@ -3253,10 +3651,12 @@ export interface CreateDomainConfigurationRequest {
3253
3651
  */
3254
3652
  export interface CreateDomainConfigurationResponse {
3255
3653
  /**
3654
+ * @public
3256
3655
  * <p>The name of the domain configuration.</p>
3257
3656
  */
3258
3657
  domainConfigurationName?: string;
3259
3658
  /**
3659
+ * @public
3260
3660
  * <p>The ARN of the domain configuration.</p>
3261
3661
  */
3262
3662
  domainConfigurationArn?: string;
@@ -3267,10 +3667,12 @@ export interface CreateDomainConfigurationResponse {
3267
3667
  */
3268
3668
  export interface ThingGroupProperties {
3269
3669
  /**
3670
+ * @public
3270
3671
  * <p>The thing group description.</p>
3271
3672
  */
3272
3673
  thingGroupDescription?: string;
3273
3674
  /**
3675
+ * @public
3274
3676
  * <p>The thing group attributes in JSON format.</p>
3275
3677
  */
3276
3678
  attributePayload?: AttributePayload;
@@ -3280,14 +3682,17 @@ export interface ThingGroupProperties {
3280
3682
  */
3281
3683
  export interface CreateDynamicThingGroupRequest {
3282
3684
  /**
3685
+ * @public
3283
3686
  * <p>The dynamic thing group name to create.</p>
3284
3687
  */
3285
3688
  thingGroupName: string | undefined;
3286
3689
  /**
3690
+ * @public
3287
3691
  * <p>The dynamic thing group properties.</p>
3288
3692
  */
3289
3693
  thingGroupProperties?: ThingGroupProperties;
3290
3694
  /**
3695
+ * @public
3291
3696
  * <p>The dynamic thing group index name.</p>
3292
3697
  * <note>
3293
3698
  * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
@@ -3295,11 +3700,13 @@ export interface CreateDynamicThingGroupRequest {
3295
3700
  */
3296
3701
  indexName?: string;
3297
3702
  /**
3703
+ * @public
3298
3704
  * <p>The dynamic thing group search query string.</p>
3299
3705
  * <p>See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query Syntax</a> for information about query string syntax.</p>
3300
3706
  */
3301
3707
  queryString: string | undefined;
3302
3708
  /**
3709
+ * @public
3303
3710
  * <p>The dynamic thing group query version.</p>
3304
3711
  * <note>
3305
3712
  * <p>Currently one query version is supported: "2017-09-30". If not specified, the
@@ -3308,6 +3715,7 @@ export interface CreateDynamicThingGroupRequest {
3308
3715
  */
3309
3716
  queryVersion?: string;
3310
3717
  /**
3718
+ * @public
3311
3719
  * <p>Metadata which can be used to manage the dynamic thing group.</p>
3312
3720
  */
3313
3721
  tags?: Tag[];
@@ -3317,26 +3725,32 @@ export interface CreateDynamicThingGroupRequest {
3317
3725
  */
3318
3726
  export interface CreateDynamicThingGroupResponse {
3319
3727
  /**
3728
+ * @public
3320
3729
  * <p>The dynamic thing group name.</p>
3321
3730
  */
3322
3731
  thingGroupName?: string;
3323
3732
  /**
3733
+ * @public
3324
3734
  * <p>The dynamic thing group ARN.</p>
3325
3735
  */
3326
3736
  thingGroupArn?: string;
3327
3737
  /**
3738
+ * @public
3328
3739
  * <p>The dynamic thing group ID.</p>
3329
3740
  */
3330
3741
  thingGroupId?: string;
3331
3742
  /**
3743
+ * @public
3332
3744
  * <p>The dynamic thing group index name.</p>
3333
3745
  */
3334
3746
  indexName?: string;
3335
3747
  /**
3748
+ * @public
3336
3749
  * <p>The dynamic thing group search query string.</p>
3337
3750
  */
3338
3751
  queryString?: string;
3339
3752
  /**
3753
+ * @public
3340
3754
  * <p>The dynamic thing group query version.</p>
3341
3755
  */
3342
3756
  queryVersion?: string;
@@ -3395,43 +3809,53 @@ export type FleetMetricUnit = (typeof FleetMetricUnit)[keyof typeof FleetMetricU
3395
3809
  */
3396
3810
  export interface CreateFleetMetricRequest {
3397
3811
  /**
3812
+ * @public
3398
3813
  * <p>The name of the fleet metric to create.</p>
3399
3814
  */
3400
3815
  metricName: string | undefined;
3401
3816
  /**
3817
+ * @public
3402
3818
  * <p>The search query string.</p>
3403
3819
  */
3404
3820
  queryString: string | undefined;
3405
3821
  /**
3822
+ * @public
3406
3823
  * <p>The type of the aggregation query.</p>
3407
3824
  */
3408
3825
  aggregationType: AggregationType | undefined;
3409
3826
  /**
3827
+ * @public
3410
3828
  * <p>The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.</p>
3411
3829
  */
3412
3830
  period: number | undefined;
3413
3831
  /**
3832
+ * @public
3414
3833
  * <p>The field to aggregate.</p>
3415
3834
  */
3416
3835
  aggregationField: string | undefined;
3417
3836
  /**
3837
+ * @public
3418
3838
  * <p>The fleet metric description.</p>
3419
3839
  */
3420
3840
  description?: string;
3421
3841
  /**
3842
+ * @public
3422
3843
  * <p>The query version.</p>
3423
3844
  */
3424
3845
  queryVersion?: string;
3425
3846
  /**
3847
+ * @public
3426
3848
  * <p>The name of the index to search.</p>
3427
3849
  */
3428
3850
  indexName?: string;
3429
3851
  /**
3852
+ * @public
3430
3853
  * <p>Used to support unit transformation such as milliseconds to seconds. The unit must be
3431
3854
  * supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. Default to null.</p>
3432
3855
  */
3433
3856
  unit?: FleetMetricUnit | string;
3434
3857
  /**
3858
+ * @public
3435
3859
  * <p>Metadata, which can be used to manage the fleet metric.</p>
3436
3860
  */
3437
3861
  tags?: Tag[];
@@ -3441,10 +3865,12 @@ export interface CreateFleetMetricRequest {
3441
3865
  */
3442
3866
  export interface CreateFleetMetricResponse {
3443
3867
  /**
3868
+ * @public
3444
3869
  * <p>The name of the fleet metric to create.</p>
3445
3870
  */
3446
3871
  metricName?: string;
3447
3872
  /**
3873
+ * @public
3448
3874
  * <p>The Amazon Resource Name (ARN) of the new fleet metric.</p>
3449
3875
  */
3450
3876
  metricArn?: string;
@@ -3493,10 +3919,12 @@ export type RetryableFailureType = (typeof RetryableFailureType)[keyof typeof Re
3493
3919
  */
3494
3920
  export interface RetryCriteria {
3495
3921
  /**
3922
+ * @public
3496
3923
  * <p>The type of job execution failures that can initiate a job retry.</p>
3497
3924
  */
3498
3925
  failureType: RetryableFailureType | string | undefined;
3499
3926
  /**
3927
+ * @public
3500
3928
  * <p>The number of retries allowed for a failure type for the job.</p>
3501
3929
  */
3502
3930
  numberOfRetries: number | undefined;
@@ -3508,6 +3936,7 @@ export interface RetryCriteria {
3508
3936
  */
3509
3937
  export interface JobExecutionsRetryConfig {
3510
3938
  /**
3939
+ * @public
3511
3940
  * <p>The list of criteria that determines how many retries are allowed for each failure
3512
3941
  * type for a job.</p>
3513
3942
  */
@@ -3519,10 +3948,12 @@ export interface JobExecutionsRetryConfig {
3519
3948
  */
3520
3949
  export interface RateIncreaseCriteria {
3521
3950
  /**
3951
+ * @public
3522
3952
  * <p>The threshold for number of notified things that will initiate the increase in rate of rollout.</p>
3523
3953
  */
3524
3954
  numberOfNotifiedThings?: number;
3525
3955
  /**
3956
+ * @public
3526
3957
  * <p>The threshold for number of succeeded things that will initiate the increase in rate of rollout.</p>
3527
3958
  */
3528
3959
  numberOfSucceededThings?: number;
@@ -3533,16 +3964,19 @@ export interface RateIncreaseCriteria {
3533
3964
  */
3534
3965
  export interface ExponentialRolloutRate {
3535
3966
  /**
3967
+ * @public
3536
3968
  * <p>The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
3537
3969
  * This parameter allows you to define the initial rate of rollout.</p>
3538
3970
  */
3539
3971
  baseRatePerMinute: number | undefined;
3540
3972
  /**
3973
+ * @public
3541
3974
  * <p>The exponential factor to increase the rate of rollout for a job.</p>
3542
3975
  * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
3543
3976
  */
3544
3977
  incrementFactor: number | undefined;
3545
3978
  /**
3979
+ * @public
3546
3980
  * <p>The criteria to initiate the increase in rate of rollout for a job.</p>
3547
3981
  */
3548
3982
  rateIncreaseCriteria: RateIncreaseCriteria | undefined;
@@ -3553,11 +3987,13 @@ export interface ExponentialRolloutRate {
3553
3987
  */
3554
3988
  export interface JobExecutionsRolloutConfig {
3555
3989
  /**
3990
+ * @public
3556
3991
  * <p>The maximum number of things that will be notified of a pending job, per minute.
3557
3992
  * This parameter allows you to create a staged rollout.</p>
3558
3993
  */
3559
3994
  maximumPerMinute?: number;
3560
3995
  /**
3996
+ * @public
3561
3997
  * <p>The rate of increase for a job rollout.
3562
3998
  * This parameter allows you to define an exponential rate for a job rollout.</p>
3563
3999
  */
@@ -3569,6 +4005,7 @@ export interface JobExecutionsRolloutConfig {
3569
4005
  */
3570
4006
  export interface PresignedUrlConfig {
3571
4007
  /**
4008
+ * @public
3572
4009
  * <p>The ARN of an IAM role that grants permission to download files from the S3 bucket
3573
4010
  * where the job data/updates are stored. The role must also grant permission for IoT to
3574
4011
  * download the files.</p>
@@ -3579,6 +4016,7 @@ export interface PresignedUrlConfig {
3579
4016
  */
3580
4017
  roleArn?: string;
3581
4018
  /**
4019
+ * @public
3582
4020
  * <p>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600
3583
4021
  * seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.</p>
3584
4022
  */
@@ -3603,10 +4041,12 @@ export type JobEndBehavior = (typeof JobEndBehavior)[keyof typeof JobEndBehavior
3603
4041
  */
3604
4042
  export interface MaintenanceWindow {
3605
4043
  /**
4044
+ * @public
3606
4045
  * <p>Displays the start time of the next maintenance window.</p>
3607
4046
  */
3608
4047
  startTime: string | undefined;
3609
4048
  /**
4049
+ * @public
3610
4050
  * <p>Displays the duration of the next maintenance window.</p>
3611
4051
  */
3612
4052
  durationInMinutes: number | undefined;
@@ -3617,6 +4057,7 @@ export interface MaintenanceWindow {
3617
4057
  */
3618
4058
  export interface SchedulingConfig {
3619
4059
  /**
4060
+ * @public
3620
4061
  * <p>The time a job will begin rollout of the job document to all devices in the target
3621
4062
  * group for a job. The <code>startTime</code> can be scheduled up to a year in advance and
3622
4063
  * must be scheduled a minimum of thirty minutes from the current time. The date and time
@@ -3625,6 +4066,7 @@ export interface SchedulingConfig {
3625
4066
  */
3626
4067
  startTime?: string;
3627
4068
  /**
4069
+ * @public
3628
4070
  * <p>The time a job will stop rollout of the job document to all devices in the target
3629
4071
  * group for a job. The <code>endTime</code> must take place no later than two years from
3630
4072
  * the current time and be scheduled a minimum of thirty minutes from the current time. The
@@ -3635,12 +4077,14 @@ export interface SchedulingConfig {
3635
4077
  */
3636
4078
  endTime?: string;
3637
4079
  /**
4080
+ * @public
3638
4081
  * <p>Specifies the end behavior for all job executions after a job reaches the selected
3639
4082
  * <code>endTime</code>. If <code>endTime</code> is not selected when creating the job,
3640
4083
  * then <code>endBehavior</code> does not apply.</p>
3641
4084
  */
3642
4085
  endBehavior?: JobEndBehavior | string;
3643
4086
  /**
4087
+ * @public
3644
4088
  * <p>An optional configuration within the <code>SchedulingConfig</code> to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.</p>
3645
4089
  */
3646
4090
  maintenanceWindows?: MaintenanceWindow[];
@@ -3666,6 +4110,7 @@ export type TargetSelection = (typeof TargetSelection)[keyof typeof TargetSelect
3666
4110
  */
3667
4111
  export interface TimeoutConfig {
3668
4112
  /**
4113
+ * @public
3669
4114
  * <p>Specifies the amount of time, in minutes, this device has to finish execution of this job.
3670
4115
  * The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The
3671
4116
  * in progress timer can't be updated and will apply to all job executions for the job. Whenever a job
@@ -3679,15 +4124,18 @@ export interface TimeoutConfig {
3679
4124
  */
3680
4125
  export interface CreateJobRequest {
3681
4126
  /**
4127
+ * @public
3682
4128
  * <p>A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric
3683
4129
  * characters, "-" and "_" are valid for use here.</p>
3684
4130
  */
3685
4131
  jobId: string | undefined;
3686
4132
  /**
4133
+ * @public
3687
4134
  * <p>A list of things and thing groups to which the job should be sent.</p>
3688
4135
  */
3689
4136
  targets: string[] | undefined;
3690
4137
  /**
4138
+ * @public
3691
4139
  * <p>An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for <code>document</code>.</p>
3692
4140
  * <p>For example, <code>--document-source https://s3.<i>region-code</i>.amazonaws.com/example-firmware/device-firmware.1.0</code>
3693
4141
  * </p>
@@ -3695,18 +4143,22 @@ export interface CreateJobRequest {
3695
4143
  */
3696
4144
  documentSource?: string;
3697
4145
  /**
4146
+ * @public
3698
4147
  * <p>The job document. Required if you don't specify a value for <code>documentSource</code>.</p>
3699
4148
  */
3700
4149
  document?: string;
3701
4150
  /**
4151
+ * @public
3702
4152
  * <p>A short text description of the job.</p>
3703
4153
  */
3704
4154
  description?: string;
3705
4155
  /**
4156
+ * @public
3706
4157
  * <p>Configuration information for pre-signed S3 URLs.</p>
3707
4158
  */
3708
4159
  presignedUrlConfig?: PresignedUrlConfig;
3709
4160
  /**
4161
+ * @public
3710
4162
  * <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things
3711
4163
  * specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
3712
4164
  * when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
@@ -3719,14 +4171,17 @@ export interface CreateJobRequest {
3719
4171
  */
3720
4172
  targetSelection?: TargetSelection | string;
3721
4173
  /**
4174
+ * @public
3722
4175
  * <p>Allows you to create a staged rollout of the job.</p>
3723
4176
  */
3724
4177
  jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
3725
4178
  /**
4179
+ * @public
3726
4180
  * <p>Allows you to create the criteria to abort a job.</p>
3727
4181
  */
3728
4182
  abortConfig?: AbortConfig;
3729
4183
  /**
4184
+ * @public
3730
4185
  * <p>Specifies the amount of time each device has to finish its execution of the job. The timer
3731
4186
  * is started when the job execution status is set to <code>IN_PROGRESS</code>. If the job
3732
4187
  * execution status is not set to another terminal state before the time expires, it will be
@@ -3734,10 +4189,12 @@ export interface CreateJobRequest {
3734
4189
  */
3735
4190
  timeoutConfig?: TimeoutConfig;
3736
4191
  /**
4192
+ * @public
3737
4193
  * <p>Metadata which can be used to manage the job.</p>
3738
4194
  */
3739
4195
  tags?: Tag[];
3740
4196
  /**
4197
+ * @public
3741
4198
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
3742
4199
  * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
3743
4200
  * contain the value in the following format.</p>
@@ -3750,14 +4207,17 @@ export interface CreateJobRequest {
3750
4207
  */
3751
4208
  namespaceId?: string;
3752
4209
  /**
4210
+ * @public
3753
4211
  * <p>The ARN of the job template used to create the job.</p>
3754
4212
  */
3755
4213
  jobTemplateArn?: string;
3756
4214
  /**
4215
+ * @public
3757
4216
  * <p>Allows you to create the criteria to retry a job.</p>
3758
4217
  */
3759
4218
  jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
3760
4219
  /**
4220
+ * @public
3761
4221
  * <p>Parameters of an Amazon Web Services managed template that you can specify to create the job document.</p>
3762
4222
  * <note>
3763
4223
  * <p>
@@ -3768,11 +4228,13 @@ export interface CreateJobRequest {
3768
4228
  */
3769
4229
  documentParameters?: Record<string, string>;
3770
4230
  /**
4231
+ * @public
3771
4232
  * <p>The configuration that allows you to schedule a job for a future date and time in
3772
4233
  * addition to specifying the end behavior for each job execution.</p>
3773
4234
  */
3774
4235
  schedulingConfig?: SchedulingConfig;
3775
4236
  /**
4237
+ * @public
3776
4238
  * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
3777
4239
  * job successfully completes. </p>
3778
4240
  * <p>
@@ -3786,14 +4248,17 @@ export interface CreateJobRequest {
3786
4248
  */
3787
4249
  export interface CreateJobResponse {
3788
4250
  /**
4251
+ * @public
3789
4252
  * <p>The job ARN.</p>
3790
4253
  */
3791
4254
  jobArn?: string;
3792
4255
  /**
4256
+ * @public
3793
4257
  * <p>The unique identifier you assigned to this job.</p>
3794
4258
  */
3795
4259
  jobId?: string;
3796
4260
  /**
4261
+ * @public
3797
4262
  * <p>The job description.</p>
3798
4263
  */
3799
4264
  description?: string;
@@ -3806,6 +4271,7 @@ export declare class ConflictException extends __BaseException {
3806
4271
  readonly name: "ConflictException";
3807
4272
  readonly $fault: "client";
3808
4273
  /**
4274
+ * @public
3809
4275
  * <p>A resource with the same name already exists.</p>
3810
4276
  */
3811
4277
  resourceId?: string;
@@ -3819,15 +4285,18 @@ export declare class ConflictException extends __BaseException {
3819
4285
  */
3820
4286
  export interface CreateJobTemplateRequest {
3821
4287
  /**
4288
+ * @public
3822
4289
  * <p>A unique identifier for the job template. We recommend using a UUID. Alpha-numeric
3823
4290
  * characters, "-", and "_" are valid for use here.</p>
3824
4291
  */
3825
4292
  jobTemplateId: string | undefined;
3826
4293
  /**
4294
+ * @public
3827
4295
  * <p>The ARN of the job to use as the basis for the job template.</p>
3828
4296
  */
3829
4297
  jobArn?: string;
3830
4298
  /**
4299
+ * @public
3831
4300
  * <p>An S3 link to the job document to use in the template. Required if you don't specify a value for <code>document</code>.</p>
3832
4301
  * <note>
3833
4302
  * <p>If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.</p>
@@ -3840,26 +4309,32 @@ export interface CreateJobTemplateRequest {
3840
4309
  */
3841
4310
  documentSource?: string;
3842
4311
  /**
4312
+ * @public
3843
4313
  * <p>The job document. Required if you don't specify a value for <code>documentSource</code>.</p>
3844
4314
  */
3845
4315
  document?: string;
3846
4316
  /**
4317
+ * @public
3847
4318
  * <p>A description of the job document.</p>
3848
4319
  */
3849
4320
  description: string | undefined;
3850
4321
  /**
4322
+ * @public
3851
4323
  * <p>Configuration for pre-signed S3 URLs.</p>
3852
4324
  */
3853
4325
  presignedUrlConfig?: PresignedUrlConfig;
3854
4326
  /**
4327
+ * @public
3855
4328
  * <p>Allows you to create a staged rollout of a job.</p>
3856
4329
  */
3857
4330
  jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
3858
4331
  /**
4332
+ * @public
3859
4333
  * <p>The criteria that determine when and how a job abort takes place.</p>
3860
4334
  */
3861
4335
  abortConfig?: AbortConfig;
3862
4336
  /**
4337
+ * @public
3863
4338
  * <p>Specifies the amount of time each device has to finish its execution of the job. A timer
3864
4339
  * is started when the job execution status is set to <code>IN_PROGRESS</code>. If the job
3865
4340
  * execution status is not set to another terminal state before the timer expires, it will
@@ -3867,18 +4342,22 @@ export interface CreateJobTemplateRequest {
3867
4342
  */
3868
4343
  timeoutConfig?: TimeoutConfig;
3869
4344
  /**
4345
+ * @public
3870
4346
  * <p>Metadata that can be used to manage the job template.</p>
3871
4347
  */
3872
4348
  tags?: Tag[];
3873
4349
  /**
4350
+ * @public
3874
4351
  * <p>Allows you to create the criteria to retry a job.</p>
3875
4352
  */
3876
4353
  jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
3877
4354
  /**
4355
+ * @public
3878
4356
  * <p>Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.</p>
3879
4357
  */
3880
4358
  maintenanceWindows?: MaintenanceWindow[];
3881
4359
  /**
4360
+ * @public
3882
4361
  * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
3883
4362
  * <p>
3884
4363
  * <b>Note:</b>The following Length Constraints relates to a single string.
@@ -3891,10 +4370,12 @@ export interface CreateJobTemplateRequest {
3891
4370
  */
3892
4371
  export interface CreateJobTemplateResponse {
3893
4372
  /**
4373
+ * @public
3894
4374
  * <p>The ARN of the job template.</p>
3895
4375
  */
3896
4376
  jobTemplateArn?: string;
3897
4377
  /**
4378
+ * @public
3898
4379
  * <p>The unique identifier of the job template.</p>
3899
4380
  */
3900
4381
  jobTemplateId?: string;
@@ -3906,6 +4387,7 @@ export interface CreateJobTemplateResponse {
3906
4387
  */
3907
4388
  export interface CreateKeysAndCertificateRequest {
3908
4389
  /**
4390
+ * @public
3909
4391
  * <p>Specifies whether the certificate is active.</p>
3910
4392
  */
3911
4393
  setAsActive?: boolean;
@@ -3916,10 +4398,12 @@ export interface CreateKeysAndCertificateRequest {
3916
4398
  */
3917
4399
  export interface KeyPair {
3918
4400
  /**
4401
+ * @public
3919
4402
  * <p>The public key.</p>
3920
4403
  */
3921
4404
  PublicKey?: string;
3922
4405
  /**
4406
+ * @public
3923
4407
  * <p>The private key.</p>
3924
4408
  */
3925
4409
  PrivateKey?: string;
@@ -3930,19 +4414,23 @@ export interface KeyPair {
3930
4414
  */
3931
4415
  export interface CreateKeysAndCertificateResponse {
3932
4416
  /**
4417
+ * @public
3933
4418
  * <p>The ARN of the certificate.</p>
3934
4419
  */
3935
4420
  certificateArn?: string;
3936
4421
  /**
4422
+ * @public
3937
4423
  * <p>The ID of the certificate. IoT issues a default subject name for the certificate
3938
4424
  * (for example, IoT Certificate).</p>
3939
4425
  */
3940
4426
  certificateId?: string;
3941
4427
  /**
4428
+ * @public
3942
4429
  * <p>The certificate data, in PEM format.</p>
3943
4430
  */
3944
4431
  certificatePem?: string;
3945
4432
  /**
4433
+ * @public
3946
4434
  * <p>The generated key pair.</p>
3947
4435
  */
3948
4436
  keyPair?: KeyPair;
@@ -3968,10 +4456,12 @@ export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
3968
4456
  */
3969
4457
  export interface EnableIoTLoggingParams {
3970
4458
  /**
4459
+ * @public
3971
4460
  * <p>The Amazon Resource Name (ARN) of the IAM role used for logging.</p>
3972
4461
  */
3973
4462
  roleArnForLogging: string | undefined;
3974
4463
  /**
4464
+ * @public
3975
4465
  * <p>Specifies the type of information to be logged.</p>
3976
4466
  */
3977
4467
  logLevel: LogLevel | string | undefined;
@@ -3982,6 +4472,7 @@ export interface EnableIoTLoggingParams {
3982
4472
  */
3983
4473
  export interface PublishFindingToSnsParams {
3984
4474
  /**
4475
+ * @public
3985
4476
  * <p>The ARN of the topic to which you want to publish the findings.</p>
3986
4477
  */
3987
4478
  topicArn: string | undefined;
@@ -4003,6 +4494,7 @@ export type PolicyTemplateName = (typeof PolicyTemplateName)[keyof typeof Policy
4003
4494
  */
4004
4495
  export interface ReplaceDefaultPolicyVersionParams {
4005
4496
  /**
4497
+ * @public
4006
4498
  * <p>The name of the template to be applied. The only supported value is <code>BLANK_POLICY</code>.</p>
4007
4499
  */
4008
4500
  templateName: PolicyTemplateName | string | undefined;
@@ -4024,6 +4516,7 @@ export type CACertificateUpdateAction = (typeof CACertificateUpdateAction)[keyof
4024
4516
  */
4025
4517
  export interface UpdateCACertificateParams {
4026
4518
  /**
4519
+ * @public
4027
4520
  * <p>The action that you want to apply to the CA certificate. The only supported value is <code>DEACTIVATE</code>.</p>
4028
4521
  */
4029
4522
  action: CACertificateUpdateAction | string | undefined;
@@ -4045,6 +4538,7 @@ export type DeviceCertificateUpdateAction = (typeof DeviceCertificateUpdateActio
4045
4538
  */
4046
4539
  export interface UpdateDeviceCertificateParams {
4047
4540
  /**
4541
+ * @public
4048
4542
  * <p>The action that you want to apply to the device certificate. The only supported value is <code>DEACTIVATE</code>.</p>
4049
4543
  */
4050
4544
  action: DeviceCertificateUpdateAction | string | undefined;
@@ -4055,26 +4549,32 @@ export interface UpdateDeviceCertificateParams {
4055
4549
  */
4056
4550
  export interface MitigationActionParams {
4057
4551
  /**
4552
+ * @public
4058
4553
  * <p>Parameters to define a mitigation action that changes the state of the device certificate to inactive.</p>
4059
4554
  */
4060
4555
  updateDeviceCertificateParams?: UpdateDeviceCertificateParams;
4061
4556
  /**
4557
+ * @public
4062
4558
  * <p>Parameters to define a mitigation action that changes the state of the CA certificate to inactive.</p>
4063
4559
  */
4064
4560
  updateCACertificateParams?: UpdateCACertificateParams;
4065
4561
  /**
4562
+ * @public
4066
4563
  * <p>Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.</p>
4067
4564
  */
4068
4565
  addThingsToThingGroupParams?: AddThingsToThingGroupParams;
4069
4566
  /**
4567
+ * @public
4070
4568
  * <p>Parameters to define a mitigation action that adds a blank policy to restrict permissions.</p>
4071
4569
  */
4072
4570
  replaceDefaultPolicyVersionParams?: ReplaceDefaultPolicyVersionParams;
4073
4571
  /**
4572
+ * @public
4074
4573
  * <p>Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.</p>
4075
4574
  */
4076
4575
  enableIoTLoggingParams?: EnableIoTLoggingParams;
4077
4576
  /**
4577
+ * @public
4078
4578
  * <p>Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.</p>
4079
4579
  */
4080
4580
  publishFindingToSnsParams?: PublishFindingToSnsParams;
@@ -4084,18 +4584,22 @@ export interface MitigationActionParams {
4084
4584
  */
4085
4585
  export interface CreateMitigationActionRequest {
4086
4586
  /**
4587
+ * @public
4087
4588
  * <p>A friendly name for the action. Choose a friendly name that accurately describes the action (for example, <code>EnableLoggingAction</code>).</p>
4088
4589
  */
4089
4590
  actionName: string | undefined;
4090
4591
  /**
4592
+ * @public
4091
4593
  * <p>The ARN of the IAM role that is used to apply the mitigation action.</p>
4092
4594
  */
4093
4595
  roleArn: string | undefined;
4094
4596
  /**
4597
+ * @public
4095
4598
  * <p>Defines the type of action and the parameters for that action.</p>
4096
4599
  */
4097
4600
  actionParams: MitigationActionParams | undefined;
4098
4601
  /**
4602
+ * @public
4099
4603
  * <p>Metadata that can be used to manage the mitigation action.</p>
4100
4604
  */
4101
4605
  tags?: Tag[];
@@ -4105,10 +4609,12 @@ export interface CreateMitigationActionRequest {
4105
4609
  */
4106
4610
  export interface CreateMitigationActionResponse {
4107
4611
  /**
4612
+ * @public
4108
4613
  * <p>The ARN for the new mitigation action.</p>
4109
4614
  */
4110
4615
  actionArn?: string;
4111
4616
  /**
4617
+ * @public
4112
4618
  * <p>A unique identifier for the new mitigation action.</p>
4113
4619
  */
4114
4620
  actionId?: string;
@@ -4144,19 +4650,23 @@ export type AwsJobAbortCriteriaFailureType = (typeof AwsJobAbortCriteriaFailureT
4144
4650
  */
4145
4651
  export interface AwsJobAbortCriteria {
4146
4652
  /**
4653
+ * @public
4147
4654
  * <p>The type of job execution failures that can initiate a job abort.</p>
4148
4655
  */
4149
4656
  failureType: AwsJobAbortCriteriaFailureType | string | undefined;
4150
4657
  /**
4658
+ * @public
4151
4659
  * <p>The type of job action to take to initiate the job abort.</p>
4152
4660
  */
4153
4661
  action: AwsJobAbortCriteriaAbortAction | string | undefined;
4154
4662
  /**
4663
+ * @public
4155
4664
  * <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p>
4156
4665
  * <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>
4157
4666
  */
4158
4667
  thresholdPercentage: number | undefined;
4159
4668
  /**
4669
+ * @public
4160
4670
  * <p>The minimum number of things which must receive job execution notifications before the job
4161
4671
  * can be aborted.</p>
4162
4672
  */
@@ -4168,6 +4678,7 @@ export interface AwsJobAbortCriteria {
4168
4678
  */
4169
4679
  export interface AwsJobAbortConfig {
4170
4680
  /**
4681
+ * @public
4171
4682
  * <p>The list of criteria that determine when and how to abort the job.</p>
4172
4683
  */
4173
4684
  abortCriteriaList: AwsJobAbortCriteria[] | undefined;
@@ -4178,11 +4689,13 @@ export interface AwsJobAbortConfig {
4178
4689
  */
4179
4690
  export interface AwsJobRateIncreaseCriteria {
4180
4691
  /**
4692
+ * @public
4181
4693
  * <p>When this number of things have been notified, it will initiate an increase in the rollout
4182
4694
  * rate.</p>
4183
4695
  */
4184
4696
  numberOfNotifiedThings?: number;
4185
4697
  /**
4698
+ * @public
4186
4699
  * <p>When this number of things have succeeded in their job execution, it will initiate an
4187
4700
  * increase in the rollout rate.</p>
4188
4701
  */
@@ -4195,16 +4708,19 @@ export interface AwsJobRateIncreaseCriteria {
4195
4708
  */
4196
4709
  export interface AwsJobExponentialRolloutRate {
4197
4710
  /**
4711
+ * @public
4198
4712
  * <p>The minimum number of things that will be notified of a pending job, per minute, at the start
4199
4713
  * of the job rollout. This is the initial rate of the rollout.</p>
4200
4714
  */
4201
4715
  baseRatePerMinute: number | undefined;
4202
4716
  /**
4717
+ * @public
4203
4718
  * <p>The rate of increase for a job rollout. The number of things notified is multiplied by this
4204
4719
  * factor.</p>
4205
4720
  */
4206
4721
  incrementFactor: number | undefined;
4207
4722
  /**
4723
+ * @public
4208
4724
  * <p>The criteria to initiate the increase in rate of rollout for a job.</p>
4209
4725
  * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
4210
4726
  */
@@ -4216,10 +4732,12 @@ export interface AwsJobExponentialRolloutRate {
4216
4732
  */
4217
4733
  export interface AwsJobExecutionsRolloutConfig {
4218
4734
  /**
4735
+ * @public
4219
4736
  * <p>The maximum number of OTA update job executions started per minute.</p>
4220
4737
  */
4221
4738
  maximumPerMinute?: number;
4222
4739
  /**
4740
+ * @public
4223
4741
  * <p>The rate of increase for a job rollout. This parameter allows you to define an exponential rate
4224
4742
  * increase for a job rollout.</p>
4225
4743
  */
@@ -4232,6 +4750,7 @@ export interface AwsJobExecutionsRolloutConfig {
4232
4750
  */
4233
4751
  export interface AwsJobPresignedUrlConfig {
4234
4752
  /**
4753
+ * @public
4235
4754
  * <p>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800
4236
4755
  * seconds. Pre-signed URLs are generated when a request for the job document is received.</p>
4237
4756
  */
@@ -4246,6 +4765,7 @@ export interface AwsJobPresignedUrlConfig {
4246
4765
  */
4247
4766
  export interface AwsJobTimeoutConfig {
4248
4767
  /**
4768
+ * @public
4249
4769
  * <p>Specifies the amount of time, in minutes, this device has to finish execution of this job. The
4250
4770
  * timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress
4251
4771
  * timer can't be updated and will apply to all job executions for the job. Whenever a job execution
@@ -4260,10 +4780,12 @@ export interface AwsJobTimeoutConfig {
4260
4780
  */
4261
4781
  export interface CodeSigningCertificateChain {
4262
4782
  /**
4783
+ * @public
4263
4784
  * <p>The name of the certificate.</p>
4264
4785
  */
4265
4786
  certificateName?: string;
4266
4787
  /**
4788
+ * @public
4267
4789
  * <p>A base64 encoded binary representation of the code signing certificate chain.</p>
4268
4790
  */
4269
4791
  inlineDocument?: string;
@@ -4274,6 +4796,7 @@ export interface CodeSigningCertificateChain {
4274
4796
  */
4275
4797
  export interface CodeSigningSignature {
4276
4798
  /**
4799
+ * @public
4277
4800
  * <p>A base64 encoded binary representation of the code signing signature.</p>
4278
4801
  */
4279
4802
  inlineDocument?: Uint8Array;
@@ -4284,18 +4807,22 @@ export interface CodeSigningSignature {
4284
4807
  */
4285
4808
  export interface CustomCodeSigning {
4286
4809
  /**
4810
+ * @public
4287
4811
  * <p>The signature for the file.</p>
4288
4812
  */
4289
4813
  signature?: CodeSigningSignature;
4290
4814
  /**
4815
+ * @public
4291
4816
  * <p>The certificate chain.</p>
4292
4817
  */
4293
4818
  certificateChain?: CodeSigningCertificateChain;
4294
4819
  /**
4820
+ * @public
4295
4821
  * <p>The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>SHA256</code> or <code>SHA1</code>, so you can pass either of them based on which was used for generating the signature.</p>
4296
4822
  */
4297
4823
  hashAlgorithm?: string;
4298
4824
  /**
4825
+ * @public
4299
4826
  * <p>The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>ECDSA</code> or <code>RSA</code>, so you can pass either of them based on which was used for generating the signature.</p>
4300
4827
  */
4301
4828
  signatureAlgorithm?: string;
@@ -4306,10 +4833,12 @@ export interface CustomCodeSigning {
4306
4833
  */
4307
4834
  export interface S3Destination {
4308
4835
  /**
4836
+ * @public
4309
4837
  * <p>The S3 bucket that contains the updated firmware.</p>
4310
4838
  */
4311
4839
  bucket?: string;
4312
4840
  /**
4841
+ * @public
4313
4842
  * <p>The S3 prefix.</p>
4314
4843
  */
4315
4844
  prefix?: string;
@@ -4320,6 +4849,7 @@ export interface S3Destination {
4320
4849
  */
4321
4850
  export interface Destination {
4322
4851
  /**
4852
+ * @public
4323
4853
  * <p>Describes the location in S3 of the updated firmware.</p>
4324
4854
  */
4325
4855
  s3Destination?: S3Destination;
@@ -4330,14 +4860,17 @@ export interface Destination {
4330
4860
  */
4331
4861
  export interface SigningProfileParameter {
4332
4862
  /**
4863
+ * @public
4333
4864
  * <p>Certificate ARN.</p>
4334
4865
  */
4335
4866
  certificateArn?: string;
4336
4867
  /**
4868
+ * @public
4337
4869
  * <p>The hardware platform of your device.</p>
4338
4870
  */
4339
4871
  platform?: string;
4340
4872
  /**
4873
+ * @public
4341
4874
  * <p>The location of the code-signing certificate on your device.</p>
4342
4875
  */
4343
4876
  certificatePathOnDevice?: string;
@@ -4348,14 +4881,17 @@ export interface SigningProfileParameter {
4348
4881
  */
4349
4882
  export interface StartSigningJobParameter {
4350
4883
  /**
4884
+ * @public
4351
4885
  * <p>Describes the code-signing profile.</p>
4352
4886
  */
4353
4887
  signingProfileParameter?: SigningProfileParameter;
4354
4888
  /**
4889
+ * @public
4355
4890
  * <p>The code-signing profile name.</p>
4356
4891
  */
4357
4892
  signingProfileName?: string;
4358
4893
  /**
4894
+ * @public
4359
4895
  * <p>The location to write the code-signed file.</p>
4360
4896
  */
4361
4897
  destination?: Destination;
@@ -4366,14 +4902,17 @@ export interface StartSigningJobParameter {
4366
4902
  */
4367
4903
  export interface CodeSigning {
4368
4904
  /**
4905
+ * @public
4369
4906
  * <p>The ID of the <code>AWSSignerJob</code> which was created to sign the file.</p>
4370
4907
  */
4371
4908
  awsSignerJobId?: string;
4372
4909
  /**
4910
+ * @public
4373
4911
  * <p>Describes the code-signing job.</p>
4374
4912
  */
4375
4913
  startSigningJobParameter?: StartSigningJobParameter;
4376
4914
  /**
4915
+ * @public
4377
4916
  * <p>A custom method for code signing a file.</p>
4378
4917
  */
4379
4918
  customCodeSigning?: CustomCodeSigning;
@@ -4384,14 +4923,17 @@ export interface CodeSigning {
4384
4923
  */
4385
4924
  export interface S3Location {
4386
4925
  /**
4926
+ * @public
4387
4927
  * <p>The S3 bucket.</p>
4388
4928
  */
4389
4929
  bucket?: string;
4390
4930
  /**
4931
+ * @public
4391
4932
  * <p>The S3 key.</p>
4392
4933
  */
4393
4934
  key?: string;
4394
4935
  /**
4936
+ * @public
4395
4937
  * <p>The S3 bucket version.</p>
4396
4938
  */
4397
4939
  version?: string;
@@ -4402,10 +4944,12 @@ export interface S3Location {
4402
4944
  */
4403
4945
  export interface _Stream {
4404
4946
  /**
4947
+ * @public
4405
4948
  * <p>The stream ID.</p>
4406
4949
  */
4407
4950
  streamId?: string;
4408
4951
  /**
4952
+ * @public
4409
4953
  * <p>The ID of a file associated with a stream.</p>
4410
4954
  */
4411
4955
  fileId?: number;
@@ -4416,10 +4960,12 @@ export interface _Stream {
4416
4960
  */
4417
4961
  export interface FileLocation {
4418
4962
  /**
4963
+ * @public
4419
4964
  * <p>The stream that contains the OTA update.</p>
4420
4965
  */
4421
4966
  stream?: _Stream;
4422
4967
  /**
4968
+ * @public
4423
4969
  * <p>The location of the updated firmware in S3.</p>
4424
4970
  */
4425
4971
  s3Location?: S3Location;
@@ -4430,27 +4976,33 @@ export interface FileLocation {
4430
4976
  */
4431
4977
  export interface OTAUpdateFile {
4432
4978
  /**
4979
+ * @public
4433
4980
  * <p>The name of the file.</p>
4434
4981
  */
4435
4982
  fileName?: string;
4436
4983
  /**
4984
+ * @public
4437
4985
  * <p>An integer value you can include in the job document to allow your devices to identify the type of file received
4438
4986
  * from the cloud.</p>
4439
4987
  */
4440
4988
  fileType?: number;
4441
4989
  /**
4990
+ * @public
4442
4991
  * <p>The file version.</p>
4443
4992
  */
4444
4993
  fileVersion?: string;
4445
4994
  /**
4995
+ * @public
4446
4996
  * <p>The location of the updated firmware.</p>
4447
4997
  */
4448
4998
  fileLocation?: FileLocation;
4449
4999
  /**
5000
+ * @public
4450
5001
  * <p>The code signing method of the file.</p>
4451
5002
  */
4452
5003
  codeSigning?: CodeSigning;
4453
5004
  /**
5005
+ * @public
4454
5006
  * <p>A list of name/attribute pairs.</p>
4455
5007
  */
4456
5008
  attributes?: Record<string, string>;
@@ -4472,23 +5024,28 @@ export type Protocol = (typeof Protocol)[keyof typeof Protocol];
4472
5024
  */
4473
5025
  export interface CreateOTAUpdateRequest {
4474
5026
  /**
5027
+ * @public
4475
5028
  * <p>The ID of the OTA update to be created.</p>
4476
5029
  */
4477
5030
  otaUpdateId: string | undefined;
4478
5031
  /**
5032
+ * @public
4479
5033
  * <p>The description of the OTA update.</p>
4480
5034
  */
4481
5035
  description?: string;
4482
5036
  /**
5037
+ * @public
4483
5038
  * <p>The devices targeted to receive OTA updates.</p>
4484
5039
  */
4485
5040
  targets: string[] | undefined;
4486
5041
  /**
5042
+ * @public
4487
5043
  * <p>The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both
4488
5044
  * HTTP and MQTT are specified, the target device can choose the protocol.</p>
4489
5045
  */
4490
5046
  protocols?: (Protocol | string)[];
4491
5047
  /**
5048
+ * @public
4492
5049
  * <p>Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things
4493
5050
  * specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a
4494
5051
  * thing when a change is detected in a target. For example, an update will run on a thing when the thing is
@@ -4497,18 +5054,22 @@ export interface CreateOTAUpdateRequest {
4497
5054
  */
4498
5055
  targetSelection?: TargetSelection | string;
4499
5056
  /**
5057
+ * @public
4500
5058
  * <p>Configuration for the rollout of OTA updates.</p>
4501
5059
  */
4502
5060
  awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
4503
5061
  /**
5062
+ * @public
4504
5063
  * <p>Configuration information for pre-signed URLs.</p>
4505
5064
  */
4506
5065
  awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig;
4507
5066
  /**
5067
+ * @public
4508
5068
  * <p>The criteria that determine when and how a job abort takes place.</p>
4509
5069
  */
4510
5070
  awsJobAbortConfig?: AwsJobAbortConfig;
4511
5071
  /**
5072
+ * @public
4512
5073
  * <p>Specifies the amount of time each device has to finish its execution of the job. A timer is
4513
5074
  * started when the job execution status is set to <code>IN_PROGRESS</code>. If the job execution
4514
5075
  * status is not set to another terminal state before the timer expires, it will be automatically
@@ -4516,19 +5077,23 @@ export interface CreateOTAUpdateRequest {
4516
5077
  */
4517
5078
  awsJobTimeoutConfig?: AwsJobTimeoutConfig;
4518
5079
  /**
5080
+ * @public
4519
5081
  * <p>The files to be streamed by the OTA update.</p>
4520
5082
  */
4521
5083
  files: OTAUpdateFile[] | undefined;
4522
5084
  /**
5085
+ * @public
4523
5086
  * <p>The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources
4524
5087
  * to create an OTA update job.</p>
4525
5088
  */
4526
5089
  roleArn: string | undefined;
4527
5090
  /**
5091
+ * @public
4528
5092
  * <p>A list of additional OTA update parameters which are name-value pairs.</p>
4529
5093
  */
4530
5094
  additionalParameters?: Record<string, string>;
4531
5095
  /**
5096
+ * @public
4532
5097
  * <p>Metadata which can be used to manage updates.</p>
4533
5098
  */
4534
5099
  tags?: Tag[];
@@ -4554,22 +5119,27 @@ export type OTAUpdateStatus = (typeof OTAUpdateStatus)[keyof typeof OTAUpdateSta
4554
5119
  */
4555
5120
  export interface CreateOTAUpdateResponse {
4556
5121
  /**
5122
+ * @public
4557
5123
  * <p>The OTA update ID.</p>
4558
5124
  */
4559
5125
  otaUpdateId?: string;
4560
5126
  /**
5127
+ * @public
4561
5128
  * <p>The IoT job ID associated with the OTA update.</p>
4562
5129
  */
4563
5130
  awsIotJobId?: string;
4564
5131
  /**
5132
+ * @public
4565
5133
  * <p>The OTA update ARN.</p>
4566
5134
  */
4567
5135
  otaUpdateArn?: string;
4568
5136
  /**
5137
+ * @public
4569
5138
  * <p>The IoT job ARN associated with the OTA update.</p>
4570
5139
  */
4571
5140
  awsIotJobArn?: string;
4572
5141
  /**
5142
+ * @public
4573
5143
  * <p>The OTA update status.</p>
4574
5144
  */
4575
5145
  otaUpdateStatus?: OTAUpdateStatus | string;
@@ -4579,18 +5149,22 @@ export interface CreateOTAUpdateResponse {
4579
5149
  */
4580
5150
  export interface CreatePackageRequest {
4581
5151
  /**
5152
+ * @public
4582
5153
  * <p>The name of the new package.</p>
4583
5154
  */
4584
5155
  packageName: string | undefined;
4585
5156
  /**
5157
+ * @public
4586
5158
  * <p>A summary of the package being created. This can be used to outline the package's contents or purpose.</p>
4587
5159
  */
4588
5160
  description?: string;
4589
5161
  /**
5162
+ * @public
4590
5163
  * <p>Metadata that can be used to manage the package.</p>
4591
5164
  */
4592
5165
  tags?: Record<string, string>;
4593
5166
  /**
5167
+ * @public
4594
5168
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
4595
5169
  * Don't reuse this client token if a new idempotent request is required.</p>
4596
5170
  */
@@ -4601,14 +5175,17 @@ export interface CreatePackageRequest {
4601
5175
  */
4602
5176
  export interface CreatePackageResponse {
4603
5177
  /**
5178
+ * @public
4604
5179
  * <p>The name of the package.</p>
4605
5180
  */
4606
5181
  packageName?: string;
4607
5182
  /**
5183
+ * @public
4608
5184
  * <p>The Amazon Resource Name (ARN) for the package.</p>
4609
5185
  */
4610
5186
  packageArn?: string;
4611
5187
  /**
5188
+ * @public
4612
5189
  * <p>The package description.</p>
4613
5190
  */
4614
5191
  description?: string;
@@ -4655,27 +5232,33 @@ export declare class ValidationException extends __BaseException {
4655
5232
  */
4656
5233
  export interface CreatePackageVersionRequest {
4657
5234
  /**
5235
+ * @public
4658
5236
  * <p>The name of the associated package.</p>
4659
5237
  */
4660
5238
  packageName: string | undefined;
4661
5239
  /**
5240
+ * @public
4662
5241
  * <p>The name of the new package version.</p>
4663
5242
  */
4664
5243
  versionName: string | undefined;
4665
5244
  /**
5245
+ * @public
4666
5246
  * <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
4667
5247
  */
4668
5248
  description?: string;
4669
5249
  /**
5250
+ * @public
4670
5251
  * <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>
4671
5252
  * <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
4672
5253
  */
4673
5254
  attributes?: Record<string, string>;
4674
5255
  /**
5256
+ * @public
4675
5257
  * <p>Metadata that can be used to manage the package version.</p>
4676
5258
  */
4677
5259
  tags?: Record<string, string>;
4678
5260
  /**
5261
+ * @public
4679
5262
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
4680
5263
  * Don't reuse this client token if a new idempotent request is required.</p>
4681
5264
  */
@@ -4699,30 +5282,37 @@ export type PackageVersionStatus = (typeof PackageVersionStatus)[keyof typeof Pa
4699
5282
  */
4700
5283
  export interface CreatePackageVersionResponse {
4701
5284
  /**
5285
+ * @public
4702
5286
  * <p>The Amazon Resource Name (ARN) for the package.</p>
4703
5287
  */
4704
5288
  packageVersionArn?: string;
4705
5289
  /**
5290
+ * @public
4706
5291
  * <p>The name of the associated package.</p>
4707
5292
  */
4708
5293
  packageName?: string;
4709
5294
  /**
5295
+ * @public
4710
5296
  * <p>The name of the new package version.</p>
4711
5297
  */
4712
5298
  versionName?: string;
4713
5299
  /**
5300
+ * @public
4714
5301
  * <p>The package version description.</p>
4715
5302
  */
4716
5303
  description?: string;
4717
5304
  /**
5305
+ * @public
4718
5306
  * <p>Metadata that were added to the package version that can be used to define a package version’s configuration.</p>
4719
5307
  */
4720
5308
  attributes?: Record<string, string>;
4721
5309
  /**
5310
+ * @public
4722
5311
  * <p>The status of the package version. 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>
4723
5312
  */
4724
5313
  status?: PackageVersionStatus | string;
4725
5314
  /**
5315
+ * @public
4726
5316
  * <p>Error reason for a package version failure during creation or update.</p>
4727
5317
  */
4728
5318
  errorReason?: string;
@@ -4733,15 +5323,18 @@ export interface CreatePackageVersionResponse {
4733
5323
  */
4734
5324
  export interface CreatePolicyRequest {
4735
5325
  /**
5326
+ * @public
4736
5327
  * <p>The policy name.</p>
4737
5328
  */
4738
5329
  policyName: string | undefined;
4739
5330
  /**
5331
+ * @public
4740
5332
  * <p>The JSON document that describes the policy. <b>policyDocument</b> must have a minimum length of 1, with a maximum length of
4741
5333
  * 2048, excluding whitespace.</p>
4742
5334
  */
4743
5335
  policyDocument: string | undefined;
4744
5336
  /**
5337
+ * @public
4745
5338
  * <p>Metadata which can be used to manage the policy.</p>
4746
5339
  * <note>
4747
5340
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -4759,18 +5352,22 @@ export interface CreatePolicyRequest {
4759
5352
  */
4760
5353
  export interface CreatePolicyResponse {
4761
5354
  /**
5355
+ * @public
4762
5356
  * <p>The policy name.</p>
4763
5357
  */
4764
5358
  policyName?: string;
4765
5359
  /**
5360
+ * @public
4766
5361
  * <p>The policy ARN.</p>
4767
5362
  */
4768
5363
  policyArn?: string;
4769
5364
  /**
5365
+ * @public
4770
5366
  * <p>The JSON document that describes the policy.</p>
4771
5367
  */
4772
5368
  policyDocument?: string;
4773
5369
  /**
5370
+ * @public
4774
5371
  * <p>The policy version ID.</p>
4775
5372
  */
4776
5373
  policyVersionId?: string;
@@ -4793,15 +5390,18 @@ export declare class MalformedPolicyException extends __BaseException {
4793
5390
  */
4794
5391
  export interface CreatePolicyVersionRequest {
4795
5392
  /**
5393
+ * @public
4796
5394
  * <p>The policy name.</p>
4797
5395
  */
4798
5396
  policyName: string | undefined;
4799
5397
  /**
5398
+ * @public
4800
5399
  * <p>The JSON document that describes the policy. Minimum length of 1. Maximum length of
4801
5400
  * 2048, excluding whitespace.</p>
4802
5401
  */
4803
5402
  policyDocument: string | undefined;
4804
5403
  /**
5404
+ * @public
4805
5405
  * <p>Specifies whether the policy version is set as the default. When this parameter is
4806
5406
  * true, the new policy version becomes the operative version (that is, the version that is in
4807
5407
  * effect for the certificates to which the policy is attached).</p>
@@ -4814,18 +5414,22 @@ export interface CreatePolicyVersionRequest {
4814
5414
  */
4815
5415
  export interface CreatePolicyVersionResponse {
4816
5416
  /**
5417
+ * @public
4817
5418
  * <p>The policy ARN.</p>
4818
5419
  */
4819
5420
  policyArn?: string;
4820
5421
  /**
5422
+ * @public
4821
5423
  * <p>The JSON document that describes the policy.</p>
4822
5424
  */
4823
5425
  policyDocument?: string;
4824
5426
  /**
5427
+ * @public
4825
5428
  * <p>The policy version ID.</p>
4826
5429
  */
4827
5430
  policyVersionId?: string;
4828
5431
  /**
5432
+ * @public
4829
5433
  * <p>Specifies whether the policy version is the default.</p>
4830
5434
  */
4831
5435
  isDefaultVersion?: boolean;
@@ -4847,6 +5451,7 @@ export declare class VersionsLimitExceededException extends __BaseException {
4847
5451
  */
4848
5452
  export interface CreateProvisioningClaimRequest {
4849
5453
  /**
5454
+ * @public
4850
5455
  * <p>The name of the provisioning template to use.</p>
4851
5456
  */
4852
5457
  templateName: string | undefined;
@@ -4856,18 +5461,22 @@ export interface CreateProvisioningClaimRequest {
4856
5461
  */
4857
5462
  export interface CreateProvisioningClaimResponse {
4858
5463
  /**
5464
+ * @public
4859
5465
  * <p>The ID of the certificate.</p>
4860
5466
  */
4861
5467
  certificateId?: string;
4862
5468
  /**
5469
+ * @public
4863
5470
  * <p>The provisioning claim certificate.</p>
4864
5471
  */
4865
5472
  certificatePem?: string;
4866
5473
  /**
5474
+ * @public
4867
5475
  * <p>The provisioning claim key pair.</p>
4868
5476
  */
4869
5477
  keyPair?: KeyPair;
4870
5478
  /**
5479
+ * @public
4871
5480
  * <p>The provisioning claim expiration time.</p>
4872
5481
  */
4873
5482
  expiration?: Date;
@@ -4879,12 +5488,14 @@ export interface CreateProvisioningClaimResponse {
4879
5488
  */
4880
5489
  export interface ProvisioningHook {
4881
5490
  /**
5491
+ * @public
4882
5492
  * <p>The payload that was sent to the target function.</p>
4883
5493
  * <p>
4884
5494
  * <i>Note:</i> Only Lambda functions are currently supported.</p>
4885
5495
  */
4886
5496
  payloadVersion?: string;
4887
5497
  /**
5498
+ * @public
4888
5499
  * <p>The ARN of the target function.</p>
4889
5500
  * <p>
4890
5501
  * <i>Note:</i> Only Lambda functions are currently supported.</p>
@@ -4908,33 +5519,40 @@ export type TemplateType = (typeof TemplateType)[keyof typeof TemplateType];
4908
5519
  */
4909
5520
  export interface CreateProvisioningTemplateRequest {
4910
5521
  /**
5522
+ * @public
4911
5523
  * <p>The name of the provisioning template.</p>
4912
5524
  */
4913
5525
  templateName: string | undefined;
4914
5526
  /**
5527
+ * @public
4915
5528
  * <p>The description of the provisioning template.</p>
4916
5529
  */
4917
5530
  description?: string;
4918
5531
  /**
5532
+ * @public
4919
5533
  * <p>The JSON formatted contents of the provisioning template.</p>
4920
5534
  */
4921
5535
  templateBody: string | undefined;
4922
5536
  /**
5537
+ * @public
4923
5538
  * <p>True to enable the provisioning template, otherwise false.</p>
4924
5539
  */
4925
5540
  enabled?: boolean;
4926
5541
  /**
5542
+ * @public
4927
5543
  * <p>The role ARN for the role associated with the provisioning template. This IoT role
4928
5544
  * grants permission to provision a device.</p>
4929
5545
  */
4930
5546
  provisioningRoleArn: string | undefined;
4931
5547
  /**
5548
+ * @public
4932
5549
  * <p>Creates a pre-provisioning hook template. Only supports template of type
4933
5550
  * <code>FLEET_PROVISIONING</code>. For more information about provisioning template types,
4934
5551
  * see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type">type</a>.</p>
4935
5552
  */
4936
5553
  preProvisioningHook?: ProvisioningHook;
4937
5554
  /**
5555
+ * @public
4938
5556
  * <p>Metadata which can be used to manage the provisioning template.</p>
4939
5557
  * <note>
4940
5558
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -4946,6 +5564,7 @@ export interface CreateProvisioningTemplateRequest {
4946
5564
  */
4947
5565
  tags?: Tag[];
4948
5566
  /**
5567
+ * @public
4949
5568
  * <p>The type you define in a provisioning template. You can create a template with only one type.
4950
5569
  * You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>.
4951
5570
  * For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.
@@ -4958,14 +5577,17 @@ export interface CreateProvisioningTemplateRequest {
4958
5577
  */
4959
5578
  export interface CreateProvisioningTemplateResponse {
4960
5579
  /**
5580
+ * @public
4961
5581
  * <p>The ARN that identifies the provisioning template.</p>
4962
5582
  */
4963
5583
  templateArn?: string;
4964
5584
  /**
5585
+ * @public
4965
5586
  * <p>The name of the provisioning template.</p>
4966
5587
  */
4967
5588
  templateName?: string;
4968
5589
  /**
5590
+ * @public
4969
5591
  * <p>The default version of the provisioning template.</p>
4970
5592
  */
4971
5593
  defaultVersionId?: number;
@@ -4975,14 +5597,17 @@ export interface CreateProvisioningTemplateResponse {
4975
5597
  */
4976
5598
  export interface CreateProvisioningTemplateVersionRequest {
4977
5599
  /**
5600
+ * @public
4978
5601
  * <p>The name of the provisioning template.</p>
4979
5602
  */
4980
5603
  templateName: string | undefined;
4981
5604
  /**
5605
+ * @public
4982
5606
  * <p>The JSON formatted contents of the provisioning template.</p>
4983
5607
  */
4984
5608
  templateBody: string | undefined;
4985
5609
  /**
5610
+ * @public
4986
5611
  * <p>Sets a fleet provision template version as the default version.</p>
4987
5612
  */
4988
5613
  setAsDefault?: boolean;
@@ -4992,18 +5617,22 @@ export interface CreateProvisioningTemplateVersionRequest {
4992
5617
  */
4993
5618
  export interface CreateProvisioningTemplateVersionResponse {
4994
5619
  /**
5620
+ * @public
4995
5621
  * <p>The ARN that identifies the provisioning template.</p>
4996
5622
  */
4997
5623
  templateArn?: string;
4998
5624
  /**
5625
+ * @public
4999
5626
  * <p>The name of the provisioning template.</p>
5000
5627
  */
5001
5628
  templateName?: string;
5002
5629
  /**
5630
+ * @public
5003
5631
  * <p>The version of the provisioning template.</p>
5004
5632
  */
5005
5633
  versionId?: number;
5006
5634
  /**
5635
+ * @public
5007
5636
  * <p>True if the provisioning template version is the default version, otherwise
5008
5637
  * false.</p>
5009
5638
  */
@@ -5014,21 +5643,25 @@ export interface CreateProvisioningTemplateVersionResponse {
5014
5643
  */
5015
5644
  export interface CreateRoleAliasRequest {
5016
5645
  /**
5646
+ * @public
5017
5647
  * <p>The role alias that points to a role ARN. This allows you to change the role without
5018
5648
  * having to update the device.</p>
5019
5649
  */
5020
5650
  roleAlias: string | undefined;
5021
5651
  /**
5652
+ * @public
5022
5653
  * <p>The role ARN.</p>
5023
5654
  */
5024
5655
  roleArn: string | undefined;
5025
5656
  /**
5657
+ * @public
5026
5658
  * <p>How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.</p>
5027
5659
  * <p>This value must be less than or equal to the maximum session duration of the IAM role
5028
5660
  * that the role alias references.</p>
5029
5661
  */
5030
5662
  credentialDurationSeconds?: number;
5031
5663
  /**
5664
+ * @public
5032
5665
  * <p>Metadata which can be used to manage the role alias.</p>
5033
5666
  * <note>
5034
5667
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -5045,10 +5678,12 @@ export interface CreateRoleAliasRequest {
5045
5678
  */
5046
5679
  export interface CreateRoleAliasResponse {
5047
5680
  /**
5681
+ * @public
5048
5682
  * <p>The role alias.</p>
5049
5683
  */
5050
5684
  roleAlias?: string;
5051
5685
  /**
5686
+ * @public
5052
5687
  * <p>The role alias ARN.</p>
5053
5688
  */
5054
5689
  roleAliasArn?: string;
@@ -5075,6 +5710,7 @@ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
5075
5710
  */
5076
5711
  export interface CreateScheduledAuditRequest {
5077
5712
  /**
5713
+ * @public
5078
5714
  * <p>How often the scheduled audit takes
5079
5715
  * place, either
5080
5716
  * <code>DAILY</code>,
@@ -5083,6 +5719,7 @@ export interface CreateScheduledAuditRequest {
5083
5719
  */
5084
5720
  frequency: AuditFrequency | string | undefined;
5085
5721
  /**
5722
+ * @public
5086
5723
  * <p>The day of the month on which the scheduled audit takes place.
5087
5724
  * This
5088
5725
  * can be "1" through "31" or "LAST". This field is required if the "frequency"
@@ -5094,6 +5731,7 @@ export interface CreateScheduledAuditRequest {
5094
5731
  */
5095
5732
  dayOfMonth?: string;
5096
5733
  /**
5734
+ * @public
5097
5735
  * <p>The day of the week on which the scheduled audit takes
5098
5736
  * place,
5099
5737
  * either
@@ -5103,6 +5741,7 @@ export interface CreateScheduledAuditRequest {
5103
5741
  */
5104
5742
  dayOfWeek?: DayOfWeek | string;
5105
5743
  /**
5744
+ * @public
5106
5745
  * <p>Which checks are performed during the scheduled audit. Checks must be enabled
5107
5746
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
5108
5747
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -5110,10 +5749,12 @@ export interface CreateScheduledAuditRequest {
5110
5749
  */
5111
5750
  targetCheckNames: string[] | undefined;
5112
5751
  /**
5752
+ * @public
5113
5753
  * <p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>
5114
5754
  */
5115
5755
  scheduledAuditName: string | undefined;
5116
5756
  /**
5757
+ * @public
5117
5758
  * <p>Metadata that can be used to manage the scheduled audit.</p>
5118
5759
  */
5119
5760
  tags?: Tag[];
@@ -5123,6 +5764,7 @@ export interface CreateScheduledAuditRequest {
5123
5764
  */
5124
5765
  export interface CreateScheduledAuditResponse {
5125
5766
  /**
5767
+ * @public
5126
5768
  * <p>The ARN of the scheduled audit.</p>
5127
5769
  */
5128
5770
  scheduledAuditArn?: string;
@@ -5132,23 +5774,28 @@ export interface CreateScheduledAuditResponse {
5132
5774
  */
5133
5775
  export interface CreateSecurityProfileRequest {
5134
5776
  /**
5777
+ * @public
5135
5778
  * <p>The name you are giving to the security profile.</p>
5136
5779
  */
5137
5780
  securityProfileName: string | undefined;
5138
5781
  /**
5782
+ * @public
5139
5783
  * <p>A description of the security profile.</p>
5140
5784
  */
5141
5785
  securityProfileDescription?: string;
5142
5786
  /**
5787
+ * @public
5143
5788
  * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
5144
5789
  */
5145
5790
  behaviors?: Behavior[];
5146
5791
  /**
5792
+ * @public
5147
5793
  * <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the
5148
5794
  * console.) Alerts are generated when a device (thing) violates a behavior.</p>
5149
5795
  */
5150
5796
  alertTargets?: Record<string, AlertTarget>;
5151
5797
  /**
5798
+ * @public
5152
5799
  * @deprecated
5153
5800
  *
5154
5801
  * <p>
@@ -5160,10 +5807,12 @@ export interface CreateSecurityProfileRequest {
5160
5807
  */
5161
5808
  additionalMetricsToRetain?: string[];
5162
5809
  /**
5810
+ * @public
5163
5811
  * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
5164
5812
  */
5165
5813
  additionalMetricsToRetainV2?: MetricToRetain[];
5166
5814
  /**
5815
+ * @public
5167
5816
  * <p>Metadata that can be used to manage the security profile.</p>
5168
5817
  */
5169
5818
  tags?: Tag[];
@@ -5173,10 +5822,12 @@ export interface CreateSecurityProfileRequest {
5173
5822
  */
5174
5823
  export interface CreateSecurityProfileResponse {
5175
5824
  /**
5825
+ * @public
5176
5826
  * <p>The name you gave to the security profile.</p>
5177
5827
  */
5178
5828
  securityProfileName?: string;
5179
5829
  /**
5830
+ * @public
5180
5831
  * <p>The ARN of the security profile.</p>
5181
5832
  */
5182
5833
  securityProfileArn?: string;
@@ -5187,10 +5838,12 @@ export interface CreateSecurityProfileResponse {
5187
5838
  */
5188
5839
  export interface StreamFile {
5189
5840
  /**
5841
+ * @public
5190
5842
  * <p>The file ID.</p>
5191
5843
  */
5192
5844
  fileId?: number;
5193
5845
  /**
5846
+ * @public
5194
5847
  * <p>The location of the file in S3.</p>
5195
5848
  */
5196
5849
  s3Location?: S3Location;
@@ -5200,22 +5853,27 @@ export interface StreamFile {
5200
5853
  */
5201
5854
  export interface CreateStreamRequest {
5202
5855
  /**
5856
+ * @public
5203
5857
  * <p>The stream ID.</p>
5204
5858
  */
5205
5859
  streamId: string | undefined;
5206
5860
  /**
5861
+ * @public
5207
5862
  * <p>A description of the stream.</p>
5208
5863
  */
5209
5864
  description?: string;
5210
5865
  /**
5866
+ * @public
5211
5867
  * <p>The files to stream.</p>
5212
5868
  */
5213
5869
  files: StreamFile[] | undefined;
5214
5870
  /**
5871
+ * @public
5215
5872
  * <p>An IAM role that allows the IoT service principal to access your S3 files.</p>
5216
5873
  */
5217
5874
  roleArn: string | undefined;
5218
5875
  /**
5876
+ * @public
5219
5877
  * <p>Metadata which can be used to manage streams.</p>
5220
5878
  */
5221
5879
  tags?: Tag[];
@@ -5225,18 +5883,22 @@ export interface CreateStreamRequest {
5225
5883
  */
5226
5884
  export interface CreateStreamResponse {
5227
5885
  /**
5886
+ * @public
5228
5887
  * <p>The stream ID.</p>
5229
5888
  */
5230
5889
  streamId?: string;
5231
5890
  /**
5891
+ * @public
5232
5892
  * <p>The stream ARN.</p>
5233
5893
  */
5234
5894
  streamArn?: string;
5235
5895
  /**
5896
+ * @public
5236
5897
  * <p>A description of the stream.</p>
5237
5898
  */
5238
5899
  description?: string;
5239
5900
  /**
5901
+ * @public
5240
5902
  * <p>The version of the stream.</p>
5241
5903
  */
5242
5904
  streamVersion?: number;
@@ -5247,16 +5909,19 @@ export interface CreateStreamResponse {
5247
5909
  */
5248
5910
  export interface CreateThingRequest {
5249
5911
  /**
5912
+ * @public
5250
5913
  * <p>The name of the thing to create.</p>
5251
5914
  * <p>You can't change a thing's name after you create it. To change a thing's name, you must create a
5252
5915
  * new thing, give it the new name, and then delete the old thing.</p>
5253
5916
  */
5254
5917
  thingName: string | undefined;
5255
5918
  /**
5919
+ * @public
5256
5920
  * <p>The name of the thing type associated with the new thing.</p>
5257
5921
  */
5258
5922
  thingTypeName?: string;
5259
5923
  /**
5924
+ * @public
5260
5925
  * <p>The attribute payload, which consists of up to three name/value pairs in a JSON
5261
5926
  * document. For example:</p>
5262
5927
  * <p>
@@ -5265,6 +5930,7 @@ export interface CreateThingRequest {
5265
5930
  */
5266
5931
  attributePayload?: AttributePayload;
5267
5932
  /**
5933
+ * @public
5268
5934
  * <p>The name of the billing group the thing will be added to.</p>
5269
5935
  */
5270
5936
  billingGroupName?: string;
@@ -5275,14 +5941,17 @@ export interface CreateThingRequest {
5275
5941
  */
5276
5942
  export interface CreateThingResponse {
5277
5943
  /**
5944
+ * @public
5278
5945
  * <p>The name of the new thing.</p>
5279
5946
  */
5280
5947
  thingName?: string;
5281
5948
  /**
5949
+ * @public
5282
5950
  * <p>The ARN of the new thing.</p>
5283
5951
  */
5284
5952
  thingArn?: string;
5285
5953
  /**
5954
+ * @public
5286
5955
  * <p>The thing ID.</p>
5287
5956
  */
5288
5957
  thingId?: string;
@@ -5292,18 +5961,22 @@ export interface CreateThingResponse {
5292
5961
  */
5293
5962
  export interface CreateThingGroupRequest {
5294
5963
  /**
5964
+ * @public
5295
5965
  * <p>The thing group name to create.</p>
5296
5966
  */
5297
5967
  thingGroupName: string | undefined;
5298
5968
  /**
5969
+ * @public
5299
5970
  * <p>The name of the parent thing group.</p>
5300
5971
  */
5301
5972
  parentGroupName?: string;
5302
5973
  /**
5974
+ * @public
5303
5975
  * <p>The thing group properties.</p>
5304
5976
  */
5305
5977
  thingGroupProperties?: ThingGroupProperties;
5306
5978
  /**
5979
+ * @public
5307
5980
  * <p>Metadata which can be used to manage the thing group.</p>
5308
5981
  */
5309
5982
  tags?: Tag[];
@@ -5313,14 +5986,17 @@ export interface CreateThingGroupRequest {
5313
5986
  */
5314
5987
  export interface CreateThingGroupResponse {
5315
5988
  /**
5989
+ * @public
5316
5990
  * <p>The thing group name.</p>
5317
5991
  */
5318
5992
  thingGroupName?: string;
5319
5993
  /**
5994
+ * @public
5320
5995
  * <p>The thing group ARN.</p>
5321
5996
  */
5322
5997
  thingGroupArn?: string;
5323
5998
  /**
5999
+ * @public
5324
6000
  * <p>The thing group ID.</p>
5325
6001
  */
5326
6002
  thingGroupId?: string;
@@ -5332,10 +6008,12 @@ export interface CreateThingGroupResponse {
5332
6008
  */
5333
6009
  export interface ThingTypeProperties {
5334
6010
  /**
6011
+ * @public
5335
6012
  * <p>The description of the thing type.</p>
5336
6013
  */
5337
6014
  thingTypeDescription?: string;
5338
6015
  /**
6016
+ * @public
5339
6017
  * <p>A list of searchable thing attribute names.</p>
5340
6018
  */
5341
6019
  searchableAttributes?: string[];
@@ -5346,16 +6024,19 @@ export interface ThingTypeProperties {
5346
6024
  */
5347
6025
  export interface CreateThingTypeRequest {
5348
6026
  /**
6027
+ * @public
5349
6028
  * <p>The name of the thing type.</p>
5350
6029
  */
5351
6030
  thingTypeName: string | undefined;
5352
6031
  /**
6032
+ * @public
5353
6033
  * <p>The ThingTypeProperties for the thing type to create. It contains information about
5354
6034
  * the new thing type including a description, and a list of searchable thing attribute
5355
6035
  * names.</p>
5356
6036
  */
5357
6037
  thingTypeProperties?: ThingTypeProperties;
5358
6038
  /**
6039
+ * @public
5359
6040
  * <p>Metadata which can be used to manage the thing type.</p>
5360
6041
  */
5361
6042
  tags?: Tag[];
@@ -5366,14 +6047,17 @@ export interface CreateThingTypeRequest {
5366
6047
  */
5367
6048
  export interface CreateThingTypeResponse {
5368
6049
  /**
6050
+ * @public
5369
6051
  * <p>The name of the thing type.</p>
5370
6052
  */
5371
6053
  thingTypeName?: string;
5372
6054
  /**
6055
+ * @public
5373
6056
  * <p>The Amazon Resource Name (ARN) of the thing type.</p>
5374
6057
  */
5375
6058
  thingTypeArn?: string;
5376
6059
  /**
6060
+ * @public
5377
6061
  * <p>The thing type ID.</p>
5378
6062
  */
5379
6063
  thingTypeId?: string;
@@ -5384,27 +6068,33 @@ export interface CreateThingTypeResponse {
5384
6068
  */
5385
6069
  export interface TopicRulePayload {
5386
6070
  /**
6071
+ * @public
5387
6072
  * <p>The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html">IoT SQL
5388
6073
  * Reference</a> in the <i>IoT Developer Guide</i>.</p>
5389
6074
  */
5390
6075
  sql: string | undefined;
5391
6076
  /**
6077
+ * @public
5392
6078
  * <p>The description of the rule.</p>
5393
6079
  */
5394
6080
  description?: string;
5395
6081
  /**
6082
+ * @public
5396
6083
  * <p>The actions associated with the rule.</p>
5397
6084
  */
5398
6085
  actions: Action[] | undefined;
5399
6086
  /**
6087
+ * @public
5400
6088
  * <p>Specifies whether the rule is disabled.</p>
5401
6089
  */
5402
6090
  ruleDisabled?: boolean;
5403
6091
  /**
6092
+ * @public
5404
6093
  * <p>The version of the SQL rules engine to use when evaluating the rule.</p>
5405
6094
  */
5406
6095
  awsIotSqlVersion?: string;
5407
6096
  /**
6097
+ * @public
5408
6098
  * <p>The action to take when an error occurs.</p>
5409
6099
  */
5410
6100
  errorAction?: Action;
@@ -5415,14 +6105,17 @@ export interface TopicRulePayload {
5415
6105
  */
5416
6106
  export interface CreateTopicRuleRequest {
5417
6107
  /**
6108
+ * @public
5418
6109
  * <p>The name of the rule.</p>
5419
6110
  */
5420
6111
  ruleName: string | undefined;
5421
6112
  /**
6113
+ * @public
5422
6114
  * <p>The rule payload.</p>
5423
6115
  */
5424
6116
  topicRulePayload: TopicRulePayload | undefined;
5425
6117
  /**
6118
+ * @public
5426
6119
  * <p>Metadata which can be used to manage the topic rule.</p>
5427
6120
  * <note>
5428
6121
  * <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p>
@@ -5452,6 +6145,7 @@ export declare class SqlParseException extends __BaseException {
5452
6145
  */
5453
6146
  export interface HttpUrlDestinationConfiguration {
5454
6147
  /**
6148
+ * @public
5455
6149
  * <p>The URL IoT uses to confirm ownership of or access to the topic rule destination
5456
6150
  * URL.</p>
5457
6151
  */
@@ -5463,18 +6157,22 @@ export interface HttpUrlDestinationConfiguration {
5463
6157
  */
5464
6158
  export interface VpcDestinationConfiguration {
5465
6159
  /**
6160
+ * @public
5466
6161
  * <p>The subnet IDs of the VPC destination.</p>
5467
6162
  */
5468
6163
  subnetIds: string[] | undefined;
5469
6164
  /**
6165
+ * @public
5470
6166
  * <p>The security groups of the VPC destination.</p>
5471
6167
  */
5472
6168
  securityGroups?: string[];
5473
6169
  /**
6170
+ * @public
5474
6171
  * <p>The ID of the VPC.</p>
5475
6172
  */
5476
6173
  vpcId: string | undefined;
5477
6174
  /**
6175
+ * @public
5478
6176
  * <p>The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).</p>
5479
6177
  */
5480
6178
  roleArn: string | undefined;
@@ -5485,10 +6183,12 @@ export interface VpcDestinationConfiguration {
5485
6183
  */
5486
6184
  export interface TopicRuleDestinationConfiguration {
5487
6185
  /**
6186
+ * @public
5488
6187
  * <p>Configuration of the HTTP URL.</p>
5489
6188
  */
5490
6189
  httpUrlConfiguration?: HttpUrlDestinationConfiguration;
5491
6190
  /**
6191
+ * @public
5492
6192
  * <p>Configuration of the virtual private cloud (VPC) connection.</p>
5493
6193
  */
5494
6194
  vpcConfiguration?: VpcDestinationConfiguration;
@@ -5498,6 +6198,7 @@ export interface TopicRuleDestinationConfiguration {
5498
6198
  */
5499
6199
  export interface CreateTopicRuleDestinationRequest {
5500
6200
  /**
6201
+ * @public
5501
6202
  * <p>The topic rule destination configuration.</p>
5502
6203
  */
5503
6204
  destinationConfiguration: TopicRuleDestinationConfiguration | undefined;
@@ -5508,6 +6209,7 @@ export interface CreateTopicRuleDestinationRequest {
5508
6209
  */
5509
6210
  export interface HttpUrlDestinationProperties {
5510
6211
  /**
6212
+ * @public
5511
6213
  * <p>The URL used to confirm the HTTP topic rule destination URL.</p>
5512
6214
  */
5513
6215
  confirmationUrl?: string;
@@ -5533,18 +6235,22 @@ export type TopicRuleDestinationStatus = (typeof TopicRuleDestinationStatus)[key
5533
6235
  */
5534
6236
  export interface VpcDestinationProperties {
5535
6237
  /**
6238
+ * @public
5536
6239
  * <p>The subnet IDs of the VPC destination.</p>
5537
6240
  */
5538
6241
  subnetIds?: string[];
5539
6242
  /**
6243
+ * @public
5540
6244
  * <p>The security groups of the VPC destination.</p>
5541
6245
  */
5542
6246
  securityGroups?: string[];
5543
6247
  /**
6248
+ * @public
5544
6249
  * <p>The ID of the VPC.</p>
5545
6250
  */
5546
6251
  vpcId?: string;
5547
6252
  /**
6253
+ * @public
5548
6254
  * <p>The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).</p>
5549
6255
  */
5550
6256
  roleArn?: string;
@@ -5555,10 +6261,12 @@ export interface VpcDestinationProperties {
5555
6261
  */
5556
6262
  export interface TopicRuleDestination {
5557
6263
  /**
6264
+ * @public
5558
6265
  * <p>The topic rule destination URL.</p>
5559
6266
  */
5560
6267
  arn?: string;
5561
6268
  /**
6269
+ * @public
5562
6270
  * <p>The status of the topic rule destination. Valid values are:</p>
5563
6271
  * <dl>
5564
6272
  * <dt>IN_PROGRESS</dt>
@@ -5594,23 +6302,28 @@ export interface TopicRuleDestination {
5594
6302
  */
5595
6303
  status?: TopicRuleDestinationStatus | string;
5596
6304
  /**
6305
+ * @public
5597
6306
  * <p>The date and time when the topic rule destination was created.</p>
5598
6307
  */
5599
6308
  createdAt?: Date;
5600
6309
  /**
6310
+ * @public
5601
6311
  * <p>The date and time when the topic rule destination was last updated.</p>
5602
6312
  */
5603
6313
  lastUpdatedAt?: Date;
5604
6314
  /**
6315
+ * @public
5605
6316
  * <p>Additional details or reason why the topic rule destination is in the current
5606
6317
  * status.</p>
5607
6318
  */
5608
6319
  statusReason?: string;
5609
6320
  /**
6321
+ * @public
5610
6322
  * <p>Properties of the HTTP URL.</p>
5611
6323
  */
5612
6324
  httpUrlProperties?: HttpUrlDestinationProperties;
5613
6325
  /**
6326
+ * @public
5614
6327
  * <p>Properties of the virtual private cloud (VPC) connection.</p>
5615
6328
  */
5616
6329
  vpcProperties?: VpcDestinationProperties;
@@ -5620,6 +6333,7 @@ export interface TopicRuleDestination {
5620
6333
  */
5621
6334
  export interface CreateTopicRuleDestinationResponse {
5622
6335
  /**
6336
+ * @public
5623
6337
  * <p>The topic rule destination.</p>
5624
6338
  */
5625
6339
  topicRuleDestination?: TopicRuleDestination;
@@ -5629,6 +6343,7 @@ export interface CreateTopicRuleDestinationResponse {
5629
6343
  */
5630
6344
  export interface DeleteAccountAuditConfigurationRequest {
5631
6345
  /**
6346
+ * @public
5632
6347
  * <p>If true, all scheduled audits are deleted.</p>
5633
6348
  */
5634
6349
  deleteScheduledAudits?: boolean;
@@ -5643,6 +6358,7 @@ export interface DeleteAccountAuditConfigurationResponse {
5643
6358
  */
5644
6359
  export interface DeleteAuditSuppressionRequest {
5645
6360
  /**
6361
+ * @public
5646
6362
  * <p>An audit check name. Checks must be enabled
5647
6363
  * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
5648
6364
  * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
@@ -5650,6 +6366,7 @@ export interface DeleteAuditSuppressionRequest {
5650
6366
  */
5651
6367
  checkName: string | undefined;
5652
6368
  /**
6369
+ * @public
5653
6370
  * <p>Information that identifies the noncompliant resource.</p>
5654
6371
  */
5655
6372
  resourceIdentifier: ResourceIdentifier | undefined;
@@ -5664,6 +6381,7 @@ export interface DeleteAuditSuppressionResponse {
5664
6381
  */
5665
6382
  export interface DeleteAuthorizerRequest {
5666
6383
  /**
6384
+ * @public
5667
6385
  * <p>The name of the authorizer to delete.</p>
5668
6386
  */
5669
6387
  authorizerName: string | undefined;
@@ -5691,10 +6409,12 @@ export declare class DeleteConflictException extends __BaseException {
5691
6409
  */
5692
6410
  export interface DeleteBillingGroupRequest {
5693
6411
  /**
6412
+ * @public
5694
6413
  * <p>The name of the billing group.</p>
5695
6414
  */
5696
6415
  billingGroupName: string | undefined;
5697
6416
  /**
6417
+ * @public
5698
6418
  * <p>The expected version of the billing group. If the version of the billing group does
5699
6419
  * not match the expected version specified in the request, the
5700
6420
  * <code>DeleteBillingGroup</code> request is rejected with a
@@ -5725,6 +6445,7 @@ export declare class CertificateStateException extends __BaseException {
5725
6445
  */
5726
6446
  export interface DeleteCACertificateRequest {
5727
6447
  /**
6448
+ * @public
5728
6449
  * <p>The ID of the certificate to delete. (The last part of the certificate ARN contains
5729
6450
  * the certificate ID.)</p>
5730
6451
  */
@@ -5742,11 +6463,13 @@ export interface DeleteCACertificateResponse {
5742
6463
  */
5743
6464
  export interface DeleteCertificateRequest {
5744
6465
  /**
6466
+ * @public
5745
6467
  * <p>The ID of the certificate. (The last part of the certificate ARN contains the
5746
6468
  * certificate ID.)</p>
5747
6469
  */
5748
6470
  certificateId: string | undefined;
5749
6471
  /**
6472
+ * @public
5750
6473
  * <p>Forces the deletion of a certificate if it is inactive and is not attached to an IoT
5751
6474
  * thing.</p>
5752
6475
  */
@@ -5757,6 +6480,7 @@ export interface DeleteCertificateRequest {
5757
6480
  */
5758
6481
  export interface DeleteCustomMetricRequest {
5759
6482
  /**
6483
+ * @public
5760
6484
  * <p>
5761
6485
  * The name of the custom metric.
5762
6486
  * </p>
@@ -5773,6 +6497,7 @@ export interface DeleteCustomMetricResponse {
5773
6497
  */
5774
6498
  export interface DeleteDimensionRequest {
5775
6499
  /**
6500
+ * @public
5776
6501
  * <p>The unique identifier for the dimension that you want to delete.</p>
5777
6502
  */
5778
6503
  name: string | undefined;
@@ -5787,6 +6512,7 @@ export interface DeleteDimensionResponse {
5787
6512
  */
5788
6513
  export interface DeleteDomainConfigurationRequest {
5789
6514
  /**
6515
+ * @public
5790
6516
  * <p>The name of the domain configuration to be deleted.</p>
5791
6517
  */
5792
6518
  domainConfigurationName: string | undefined;
@@ -5801,10 +6527,12 @@ export interface DeleteDomainConfigurationResponse {
5801
6527
  */
5802
6528
  export interface DeleteDynamicThingGroupRequest {
5803
6529
  /**
6530
+ * @public
5804
6531
  * <p>The name of the dynamic thing group to delete.</p>
5805
6532
  */
5806
6533
  thingGroupName: string | undefined;
5807
6534
  /**
6535
+ * @public
5808
6536
  * <p>The expected version of the dynamic thing group to delete.</p>
5809
6537
  */
5810
6538
  expectedVersion?: number;