@aws-sdk/client-iot 3.450.0 → 3.451.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/dist-cjs/protocols/Aws_restJson1.js +7 -0
  2. package/dist-es/protocols/Aws_restJson1.js +7 -0
  3. package/dist-types/commands/AttachSecurityProfileCommand.d.ts +1 -1
  4. package/dist-types/commands/CancelAuditMitigationActionsTaskCommand.d.ts +2 -3
  5. package/dist-types/commands/CancelAuditTaskCommand.d.ts +2 -1
  6. package/dist-types/commands/CancelDetectMitigationActionsTaskCommand.d.ts +1 -3
  7. package/dist-types/commands/CreateCustomMetricCommand.d.ts +1 -4
  8. package/dist-types/commands/CreateDimensionCommand.d.ts +4 -2
  9. package/dist-types/commands/CreateMitigationActionCommand.d.ts +4 -2
  10. package/dist-types/commands/CreateScheduledAuditCommand.d.ts +1 -2
  11. package/dist-types/commands/CreateSecurityProfileCommand.d.ts +6 -0
  12. package/dist-types/commands/CreateThingGroupCommand.d.ts +3 -0
  13. package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +3 -2
  14. package/dist-types/commands/DeleteCustomMetricCommand.d.ts +4 -8
  15. package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +1 -2
  16. package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +3 -3
  17. package/dist-types/commands/DescribeAuditFindingCommand.d.ts +1 -3
  18. package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +3 -1
  19. package/dist-types/commands/DescribeCustomMetricCommand.d.ts +1 -3
  20. package/dist-types/commands/DescribeDetectMitigationActionsTaskCommand.d.ts +1 -3
  21. package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +6 -0
  22. package/dist-types/commands/DetachSecurityProfileCommand.d.ts +2 -1
  23. package/dist-types/commands/GetBehaviorModelTrainingSummariesCommand.d.ts +1 -3
  24. package/dist-types/commands/ListActiveViolationsCommand.d.ts +1 -0
  25. package/dist-types/commands/ListAuditFindingsCommand.d.ts +2 -2
  26. package/dist-types/commands/ListAuditMitigationActionsExecutionsCommand.d.ts +1 -2
  27. package/dist-types/commands/ListAuditTasksCommand.d.ts +2 -2
  28. package/dist-types/commands/ListCustomMetricsCommand.d.ts +1 -3
  29. package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +1 -3
  30. package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -3
  31. package/dist-types/commands/ListMetricValuesCommand.d.ts +2 -2
  32. package/dist-types/commands/ListPolicyVersionsCommand.d.ts +1 -2
  33. package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +6 -6
  34. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +4 -4
  35. package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +2 -1
  36. package/dist-types/commands/ListViolationEventsCommand.d.ts +4 -3
  37. package/dist-types/commands/StartDetectMitigationActionsTaskCommand.d.ts +1 -3
  38. package/dist-types/commands/UpdateAccountAuditConfigurationCommand.d.ts +3 -3
  39. package/dist-types/commands/UpdateCustomMetricCommand.d.ts +1 -2
  40. package/dist-types/commands/UpdateDimensionCommand.d.ts +2 -6
  41. package/dist-types/commands/UpdateScheduledAuditCommand.d.ts +2 -2
  42. package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +13 -0
  43. package/dist-types/commands/ValidateSecurityProfileBehaviorsCommand.d.ts +1 -0
  44. package/dist-types/models/models_0.d.ts +79 -73
  45. package/dist-types/models/models_1.d.ts +164 -203
  46. package/dist-types/models/models_2.d.ts +163 -172
  47. package/dist-types/ts3.4/commands/DeleteDynamicThingGroupCommand.d.ts +4 -2
  48. package/dist-types/ts3.4/commands/ListPolicyVersionsCommand.d.ts +4 -2
  49. package/dist-types/ts3.4/models/models_0.d.ts +7 -4
  50. package/dist-types/ts3.4/models/models_1.d.ts +6 -3
  51. package/dist-types/ts3.4/models/models_2.d.ts +7 -0
  52. package/package.json +35 -35
@@ -1,6 +1,21 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTServiceException as __BaseException } from "./IoTServiceException";
3
- import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0";
3
+ import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface DeleteDynamicThingGroupRequest {
8
+ /**
9
+ * @public
10
+ * <p>The name of the dynamic thing group to delete.</p>
11
+ */
12
+ thingGroupName: string | undefined;
13
+ /**
14
+ * @public
15
+ * <p>The expected version of the dynamic thing group to delete.</p>
16
+ */
17
+ expectedVersion?: number;
18
+ }
4
19
  /**
5
20
  * @public
6
21
  */
@@ -322,9 +337,9 @@ export interface DeleteSecurityProfileRequest {
322
337
  securityProfileName: string | undefined;
323
338
  /**
324
339
  * @public
325
- * <p>The expected version of the security profile. A new version is generated whenever
326
- * the security profile is updated. If you specify a value that is different from the actual
327
- * version, a <code>VersionConflictException</code> is thrown.</p>
340
+ * <p>The expected version of the security profile. A new version is generated whenever the
341
+ * security profile is updated. If you specify a value that is different from the actual version,
342
+ * a <code>VersionConflictException</code> is thrown.</p>
328
343
  */
329
344
  expectedVersion?: number;
330
345
  }
@@ -503,17 +518,16 @@ export interface DescribeAccountAuditConfigurationRequest {
503
518
  export interface DescribeAccountAuditConfigurationResponse {
504
519
  /**
505
520
  * @public
506
- * <p>The ARN of the role that grants permission to IoT to access information
507
- * about your devices, policies, certificates, and other items as required when
508
- * performing an audit.</p>
509
- * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
510
- * this parameter is required.</p>
521
+ * <p>The ARN of the role that grants permission to IoT to access information about your
522
+ * devices, policies, certificates, and other items as required when performing an audit.</p>
523
+ * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>, this parameter is
524
+ * required.</p>
511
525
  */
512
526
  roleArn?: string;
513
527
  /**
514
528
  * @public
515
- * <p>Information about the targets to which audit notifications are sent for
516
- * this account.</p>
529
+ * <p>Information about the targets to which audit notifications are sent for this
530
+ * account.</p>
517
531
  */
518
532
  auditNotificationTargetConfigurations?: Partial<Record<AuditNotificationType, AuditNotificationTarget>>;
519
533
  /**
@@ -528,7 +542,8 @@ export interface DescribeAccountAuditConfigurationResponse {
528
542
  export interface DescribeAuditFindingRequest {
529
543
  /**
530
544
  * @public
531
- * <p>A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.</p>
545
+ * <p>A unique identifier for a single audit finding. You can use this identifier to apply
546
+ * mitigation actions to the finding.</p>
532
547
  */
533
548
  findingId: string | undefined;
534
549
  }
@@ -599,12 +614,14 @@ export interface DescribeAuditMitigationActionsTaskResponse {
599
614
  endTime?: Date;
600
615
  /**
601
616
  * @public
602
- * <p>Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.</p>
617
+ * <p>Aggregate counts of the results when the mitigation tasks were applied to the findings for
618
+ * this audit mitigation actions task.</p>
603
619
  */
604
620
  taskStatistics?: Record<string, TaskStatisticsForAuditCheck>;
605
621
  /**
606
622
  * @public
607
- * <p>Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.</p>
623
+ * <p>Identifies the findings to which the mitigation actions are applied. This can be by audit
624
+ * checks, by audit task, or a set of findings.</p>
608
625
  */
609
626
  target?: AuditMitigationActionsTaskTarget;
610
627
  /**
@@ -614,7 +631,8 @@ export interface DescribeAuditMitigationActionsTaskResponse {
614
631
  auditCheckToActionsMapping?: Record<string, string[]>;
615
632
  /**
616
633
  * @public
617
- * <p>Specifies the mitigation actions and their parameters that are applied as part of this task.</p>
634
+ * <p>Specifies the mitigation actions and their parameters that are applied as part of this
635
+ * task.</p>
618
636
  */
619
637
  actionsDefinition?: MitigationAction[];
620
638
  }
@@ -732,8 +750,8 @@ export interface TaskStatistics {
732
750
  export interface DescribeAuditTaskResponse {
733
751
  /**
734
752
  * @public
735
- * <p>The status of the audit: one of "IN_PROGRESS", "COMPLETED",
736
- * "FAILED", or "CANCELED".</p>
753
+ * <p>The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or
754
+ * "CANCELED".</p>
737
755
  */
738
756
  taskStatus?: AuditTaskStatus;
739
757
  /**
@@ -1158,9 +1176,7 @@ export interface DescribeCertificateResponse {
1158
1176
  export interface DescribeCustomMetricRequest {
1159
1177
  /**
1160
1178
  * @public
1161
- * <p>
1162
- * The name of the custom metric.
1163
- * </p>
1179
+ * <p> The name of the custom metric. </p>
1164
1180
  */
1165
1181
  metricName: string | undefined;
1166
1182
  }
@@ -1170,45 +1186,39 @@ export interface DescribeCustomMetricRequest {
1170
1186
  export interface DescribeCustomMetricResponse {
1171
1187
  /**
1172
1188
  * @public
1173
- * <p>
1174
- * The name of the custom metric.
1175
- * </p>
1189
+ * <p> The name of the custom metric. </p>
1176
1190
  */
1177
1191
  metricName?: string;
1178
1192
  /**
1179
1193
  * @public
1180
- * <p>
1181
- * The Amazon Resource Number (ARN) of the custom metric.
1182
- * </p>
1194
+ * <p> The Amazon Resource Number (ARN) of the custom metric. </p>
1183
1195
  */
1184
1196
  metricArn?: string;
1185
1197
  /**
1186
1198
  * @public
1187
1199
  * <p> The type of the custom metric. </p>
1188
1200
  * <important>
1189
- * <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p>
1201
+ * <p>The type <code>number</code> only takes a single metric value as an input, but while
1202
+ * submitting the metrics value in the DeviceMetrics report, it must be passed as an array with
1203
+ * a single value.</p>
1190
1204
  * </important>
1191
1205
  */
1192
1206
  metricType?: CustomMetricType;
1193
1207
  /**
1194
1208
  * @public
1195
- * <p>
1196
- * Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
1197
- * </p>
1209
+ * <p> Field represents a friendly name in the console for the custom metric; doesn't have to be
1210
+ * unique. Don't use this name as the metric identifier in the device metric report. Can be
1211
+ * updated. </p>
1198
1212
  */
1199
1213
  displayName?: string;
1200
1214
  /**
1201
1215
  * @public
1202
- * <p>
1203
- * The creation date of the custom metric in milliseconds since epoch.
1204
- * </p>
1216
+ * <p> The creation date of the custom metric in milliseconds since epoch. </p>
1205
1217
  */
1206
1218
  creationDate?: Date;
1207
1219
  /**
1208
1220
  * @public
1209
- * <p>
1210
- * The time the custom metric was last modified in milliseconds since epoch.
1211
- * </p>
1221
+ * <p> The time the custom metric was last modified in milliseconds since epoch. </p>
1212
1222
  */
1213
1223
  lastModifiedDate?: Date;
1214
1224
  }
@@ -1233,9 +1243,7 @@ export interface DescribeDefaultAuthorizerResponse {
1233
1243
  export interface DescribeDetectMitigationActionsTaskRequest {
1234
1244
  /**
1235
1245
  * @public
1236
- * <p>
1237
- * The unique identifier of the task.
1238
- * </p>
1246
+ * <p> The unique identifier of the task. </p>
1239
1247
  */
1240
1248
  taskId: string | undefined;
1241
1249
  }
@@ -1417,9 +1425,7 @@ export interface DetectMitigationActionsTaskSummary {
1417
1425
  export interface DescribeDetectMitigationActionsTaskResponse {
1418
1426
  /**
1419
1427
  * @public
1420
- * <p>
1421
- * The description of a task.
1422
- * </p>
1428
+ * <p> The description of a task. </p>
1423
1429
  */
1424
1430
  taskSummary?: DetectMitigationActionsTaskSummary;
1425
1431
  }
@@ -1444,10 +1450,7 @@ export interface DescribeDimensionResponse {
1444
1450
  name?: string;
1445
1451
  /**
1446
1452
  * @public
1447
- * <p>The Amazon Resource Name
1448
- * (ARN)
1449
- * for
1450
- * the dimension.</p>
1453
+ * <p>The Amazon Resource Name (ARN) for the dimension.</p>
1451
1454
  */
1452
1455
  arn?: string;
1453
1456
  /**
@@ -1457,7 +1460,8 @@ export interface DescribeDimensionResponse {
1457
1460
  type?: DimensionType;
1458
1461
  /**
1459
1462
  * @public
1460
- * <p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>
1463
+ * <p>The value or list of values used to scope the dimension. For example, for topic filters,
1464
+ * this is the pattern used to match the MQTT topic name.</p>
1461
1465
  */
1462
1466
  stringValues?: string[];
1463
1467
  /**
@@ -2498,7 +2502,8 @@ export interface DescribeMitigationActionResponse {
2498
2502
  roleArn?: string;
2499
2503
  /**
2500
2504
  * @public
2501
- * <p>Parameters that control how the mitigation action is applied, specific to the type of mitigation action.</p>
2505
+ * <p>Parameters that control how the mitigation action is applied, specific to the type of
2506
+ * mitigation action.</p>
2502
2507
  */
2503
2508
  actionParams?: MitigationActionParams;
2504
2509
  /**
@@ -2703,38 +2708,32 @@ export interface DescribeScheduledAuditRequest {
2703
2708
  export interface DescribeScheduledAuditResponse {
2704
2709
  /**
2705
2710
  * @public
2706
- * <p>How often the scheduled audit takes
2707
- * place, either
2708
- * one of <code>DAILY</code>,
2709
- * <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined by the
2710
- * system.</p>
2711
+ * <p>How often the scheduled audit takes place, either one of <code>DAILY</code>,
2712
+ * <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each
2713
+ * audit is determined by the system.</p>
2711
2714
  */
2712
2715
  frequency?: AuditFrequency;
2713
2716
  /**
2714
2717
  * @public
2715
- * <p>The day of the month on which the scheduled audit takes place.
2716
- * This is
2717
- * will be <code>1</code>
2718
- * through <code>31</code> or <code>LAST</code>. If days
2719
- * <code>29</code>-<code>31</code>
2720
- * are specified, and the month does not have that many days, the audit takes place on the <code>LAST</code>
2721
- * day of the month.</p>
2718
+ * <p>The day of the month on which the scheduled audit takes place. This is will be
2719
+ * <code>1</code> through <code>31</code> or <code>LAST</code>. If days
2720
+ * <code>29</code>-<code>31</code> are specified, and the month does not have that many days,
2721
+ * the audit takes place on the <code>LAST</code> day of the month.</p>
2722
2722
  */
2723
2723
  dayOfMonth?: string;
2724
2724
  /**
2725
2725
  * @public
2726
- * <p>The day of the week on which the scheduled audit takes
2727
- * place,
2728
- * either one of
2729
- * <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>.</p>
2726
+ * <p>The day of the week on which the scheduled audit takes place, either one of
2727
+ * <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>,
2728
+ * <code>FRI</code>, or <code>SAT</code>.</p>
2730
2729
  */
2731
2730
  dayOfWeek?: DayOfWeek;
2732
2731
  /**
2733
2732
  * @public
2734
- * <p>Which checks are performed during the scheduled audit. Checks must be
2735
- * enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
2736
- * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
2737
- * to select which checks are enabled.)</p>
2733
+ * <p>Which checks are performed during the scheduled audit. Checks must be enabled for your
2734
+ * account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks,
2735
+ * including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select
2736
+ * which checks are enabled.)</p>
2738
2737
  */
2739
2738
  targetCheckNames?: string[];
2740
2739
  /**
@@ -2754,8 +2753,7 @@ export interface DescribeScheduledAuditResponse {
2754
2753
  export interface DescribeSecurityProfileRequest {
2755
2754
  /**
2756
2755
  * @public
2757
- * <p>The name of the security profile
2758
- * whose information you want to get.</p>
2756
+ * <p>The name of the security profile whose information you want to get.</p>
2759
2757
  */
2760
2758
  securityProfileName: string | undefined;
2761
2759
  }
@@ -2775,13 +2773,14 @@ export interface DescribeSecurityProfileResponse {
2775
2773
  securityProfileArn?: string;
2776
2774
  /**
2777
2775
  * @public
2778
- * <p>A description of the security profile (associated with the security profile
2779
- * when it was created or updated).</p>
2776
+ * <p>A description of the security profile (associated with the security profile when it was
2777
+ * created or updated).</p>
2780
2778
  */
2781
2779
  securityProfileDescription?: string;
2782
2780
  /**
2783
2781
  * @public
2784
- * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
2782
+ * <p>Specifies the behaviors that, when violated by a device (thing), cause an
2783
+ * alert.</p>
2785
2784
  */
2786
2785
  behaviors?: Behavior[];
2787
2786
  /**
@@ -2794,29 +2793,25 @@ export interface DescribeSecurityProfileResponse {
2794
2793
  * @deprecated
2795
2794
  *
2796
2795
  * <p>
2797
- * <i>Please use
2798
- * <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a>
2796
+ * <i>Please use <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a>
2799
2797
  * instead.</i>
2800
2798
  * </p>
2801
- * <p>A list of metrics
2802
- * whose data is retained (stored). By default, data is retained for any metric
2803
- * used in the profile's <code>behaviors</code>, but
2804
- * it is
2805
- * also retained for any metric specified here.</p>
2799
+ * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
2800
+ * metric used in the profile's <code>behaviors</code>, but it is also retained for any metric
2801
+ * specified here.</p>
2806
2802
  */
2807
2803
  additionalMetricsToRetain?: string[];
2808
2804
  /**
2809
2805
  * @public
2810
2806
  * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
2811
- * metric used in the profile's behaviors, but
2812
- * it is
2813
- * also retained for any metric specified here.</p>
2807
+ * metric used in the profile's behaviors, but it is also retained for any metric specified
2808
+ * here.</p>
2814
2809
  */
2815
2810
  additionalMetricsToRetainV2?: MetricToRetain[];
2816
2811
  /**
2817
2812
  * @public
2818
- * <p>The version of the security profile. A new version is generated whenever the
2819
- * security profile is updated.</p>
2813
+ * <p>The version of the security profile. A new version is generated whenever the security
2814
+ * profile is updated.</p>
2820
2815
  */
2821
2816
  version?: number;
2822
2817
  /**
@@ -2829,6 +2824,11 @@ export interface DescribeSecurityProfileResponse {
2829
2824
  * <p>The time the security profile was last modified.</p>
2830
2825
  */
2831
2826
  lastModifiedDate?: Date;
2827
+ /**
2828
+ * @public
2829
+ * <p>Specifies the MQTT topic and role ARN required for metric export.</p>
2830
+ */
2831
+ metricsExportConfig?: MetricsExportConfig;
2832
2832
  }
2833
2833
  /**
2834
2834
  * @public
@@ -3339,23 +3339,17 @@ export interface EnableTopicRuleRequest {
3339
3339
  export interface GetBehaviorModelTrainingSummariesRequest {
3340
3340
  /**
3341
3341
  * @public
3342
- * <p>
3343
- * The name of the security profile.
3344
- * </p>
3342
+ * <p> The name of the security profile. </p>
3345
3343
  */
3346
3344
  securityProfileName?: string;
3347
3345
  /**
3348
3346
  * @public
3349
- * <p>
3350
- * The maximum number of results to return at one time. The default is 10.
3351
- * </p>
3347
+ * <p> The maximum number of results to return at one time. The default is 10. </p>
3352
3348
  */
3353
3349
  maxResults?: number;
3354
3350
  /**
3355
3351
  * @public
3356
- * <p>
3357
- * The token for the next set of results.
3358
- * </p>
3352
+ * <p> The token for the next set of results. </p>
3359
3353
  */
3360
3354
  nextToken?: string;
3361
3355
  }
@@ -3428,16 +3422,14 @@ export interface BehaviorModelTrainingSummary {
3428
3422
  export interface GetBehaviorModelTrainingSummariesResponse {
3429
3423
  /**
3430
3424
  * @public
3431
- * <p>
3432
- * A list of all ML Detect behaviors and their model status for a given Security Profile.
3425
+ * <p> A list of all ML Detect behaviors and their model status for a given Security Profile.
3433
3426
  * </p>
3434
3427
  */
3435
3428
  summaries?: BehaviorModelTrainingSummary[];
3436
3429
  /**
3437
3430
  * @public
3438
- * <p>
3439
- * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
3440
- * </p>
3431
+ * <p> A token that can be used to retrieve the next set of results, or <code>null</code> if
3432
+ * there are no additional results. </p>
3441
3433
  */
3442
3434
  nextToken?: string;
3443
3435
  }
@@ -3674,6 +3666,9 @@ export interface ThingGroupIndexingConfiguration {
3674
3666
  * @public
3675
3667
  * <p>Contains fields that are indexed and whose types are already known by the Fleet Indexing
3676
3668
  * service. This is an optional field. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.</p>
3669
+ * <note>
3670
+ * <p>You can't modify managed fields by updating fleet indexing configuration.</p>
3671
+ * </note>
3677
3672
  */
3678
3673
  managedFields?: Field[];
3679
3674
  /**
@@ -3823,7 +3818,10 @@ export interface ThingIndexingConfiguration {
3823
3818
  /**
3824
3819
  * @public
3825
3820
  * <p>Contains fields that are indexed and whose types are already known by the Fleet Indexing
3826
- * service.</p>
3821
+ * service. This is an optional field. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.</p>
3822
+ * <note>
3823
+ * <p>You can't modify managed fields by updating fleet indexing configuration.</p>
3824
+ * </note>
3827
3825
  */
3828
3826
  managedFields?: Field[];
3829
3827
  /**
@@ -4601,16 +4599,12 @@ export interface ListActiveViolationsRequest {
4601
4599
  securityProfileName?: string;
4602
4600
  /**
4603
4601
  * @public
4604
- * <p>
4605
- * The criteria for a behavior.
4606
- * </p>
4602
+ * <p> The criteria for a behavior. </p>
4607
4603
  */
4608
4604
  behaviorCriteriaType?: BehaviorCriteriaType;
4609
4605
  /**
4610
4606
  * @public
4611
- * <p>
4612
- * A list of all suppressed alerts.
4613
- * </p>
4607
+ * <p> A list of all suppressed alerts. </p>
4614
4608
  */
4615
4609
  listSuppressedAlerts?: boolean;
4616
4610
  /**
@@ -4640,8 +4634,8 @@ export interface ListActiveViolationsResponse {
4640
4634
  activeViolations?: ActiveViolation[];
4641
4635
  /**
4642
4636
  * @public
4643
- * <p>A token that can be used to retrieve the next set of results,
4644
- * or <code>null</code> if there are no additional results.</p>
4637
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
4638
+ * there are no additional results.</p>
4645
4639
  */
4646
4640
  nextToken?: string;
4647
4641
  }
@@ -4692,8 +4686,8 @@ export interface ListAttachedPoliciesResponse {
4692
4686
  export interface ListAuditFindingsRequest {
4693
4687
  /**
4694
4688
  * @public
4695
- * <p>A filter to limit results to the audit with the specified ID. You must
4696
- * specify either the taskId or the startTime and endTime, but not both.</p>
4689
+ * <p>A filter to limit results to the audit with the specified ID. You must specify either the
4690
+ * taskId or the startTime and endTime, but not both.</p>
4697
4691
  */
4698
4692
  taskId?: string;
4699
4693
  /**
@@ -4718,14 +4712,14 @@ export interface ListAuditFindingsRequest {
4718
4712
  nextToken?: string;
4719
4713
  /**
4720
4714
  * @public
4721
- * <p>A filter to limit results to those found after the specified time. You must
4722
- * specify either the startTime and endTime or the taskId, but not both.</p>
4715
+ * <p>A filter to limit results to those found after the specified time. You must specify either
4716
+ * the startTime and endTime or the taskId, but not both.</p>
4723
4717
  */
4724
4718
  startTime?: Date;
4725
4719
  /**
4726
4720
  * @public
4727
- * <p>A filter to limit results to those found before the specified time. You must
4728
- * specify either the startTime and endTime or the taskId, but not both.</p>
4721
+ * <p>A filter to limit results to those found before the specified time. You must specify
4722
+ * either the startTime and endTime or the taskId, but not both.</p>
4729
4723
  */
4730
4724
  endTime?: Date;
4731
4725
  /**
@@ -4747,8 +4741,8 @@ export interface ListAuditFindingsResponse {
4747
4741
  findings?: AuditFinding[];
4748
4742
  /**
4749
4743
  * @public
4750
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
4751
- * if there are no additional results.</p>
4744
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
4745
+ * there are no additional results.</p>
4752
4746
  */
4753
4747
  nextToken?: string;
4754
4748
  }
@@ -4758,7 +4752,8 @@ export interface ListAuditFindingsResponse {
4758
4752
  export interface ListAuditMitigationActionsExecutionsRequest {
4759
4753
  /**
4760
4754
  * @public
4761
- * <p>Specify this filter to limit results to actions for a specific audit mitigation actions task.</p>
4755
+ * <p>Specify this filter to limit results to actions for a specific audit mitigation actions
4756
+ * task.</p>
4762
4757
  */
4763
4758
  taskId: string | undefined;
4764
4759
  /**
@@ -4768,7 +4763,8 @@ export interface ListAuditMitigationActionsExecutionsRequest {
4768
4763
  actionStatus?: AuditMitigationActionsExecutionStatus;
4769
4764
  /**
4770
4765
  * @public
4771
- * <p>Specify this filter to limit results to those that were applied to a specific audit finding.</p>
4766
+ * <p>Specify this filter to limit results to those that were applied to a specific audit
4767
+ * finding.</p>
4772
4768
  */
4773
4769
  findingId: string | undefined;
4774
4770
  /**
@@ -4788,7 +4784,8 @@ export interface ListAuditMitigationActionsExecutionsRequest {
4788
4784
  export interface ListAuditMitigationActionsExecutionsResponse {
4789
4785
  /**
4790
4786
  * @public
4791
- * <p>A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.</p>
4787
+ * <p>A set of task execution results based on the input parameters. Details include the
4788
+ * mitigation action applied, start time, and task status.</p>
4792
4789
  */
4793
4790
  actionsExecutions?: AuditMitigationActionExecutionMetadata[];
4794
4791
  /**
@@ -4803,12 +4800,14 @@ export interface ListAuditMitigationActionsExecutionsResponse {
4803
4800
  export interface ListAuditMitigationActionsTasksRequest {
4804
4801
  /**
4805
4802
  * @public
4806
- * <p>Specify this filter to limit results to tasks that were applied to results for a specific audit.</p>
4803
+ * <p>Specify this filter to limit results to tasks that were applied to results for a specific
4804
+ * audit.</p>
4807
4805
  */
4808
4806
  auditTaskId?: string;
4809
4807
  /**
4810
4808
  * @public
4811
- * <p>Specify this filter to limit results to tasks that were applied to a specific audit finding.</p>
4809
+ * <p>Specify this filter to limit results to tasks that were applied to a specific audit
4810
+ * finding.</p>
4812
4811
  */
4813
4812
  findingId?: string;
4814
4813
  /**
@@ -4828,12 +4827,14 @@ export interface ListAuditMitigationActionsTasksRequest {
4828
4827
  nextToken?: string;
4829
4828
  /**
4830
4829
  * @public
4831
- * <p>Specify this filter to limit results to tasks that began on or after a specific date and time.</p>
4830
+ * <p>Specify this filter to limit results to tasks that began on or after a specific date and
4831
+ * time.</p>
4832
4832
  */
4833
4833
  startTime: Date | undefined;
4834
4834
  /**
4835
4835
  * @public
4836
- * <p>Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.</p>
4836
+ * <p>Specify this filter to limit results to tasks that were completed or canceled on or before
4837
+ * a specific date and time.</p>
4837
4838
  */
4838
4839
  endTime: Date | undefined;
4839
4840
  }
@@ -4916,9 +4917,9 @@ export interface ListAuditSuppressionsResponse {
4916
4917
  export interface ListAuditTasksRequest {
4917
4918
  /**
4918
4919
  * @public
4919
- * <p>The beginning of the time period. Audit information is retained for a
4920
- * limited time (90 days). Requesting a start time prior to what is retained
4921
- * results in an "InvalidRequestException".</p>
4920
+ * <p>The beginning of the time period. Audit information is retained for a limited time (90
4921
+ * days). Requesting a start time prior to what is retained results in an
4922
+ * "InvalidRequestException".</p>
4922
4923
  */
4923
4924
  startTime: Date | undefined;
4924
4925
  /**
@@ -4929,13 +4930,13 @@ export interface ListAuditTasksRequest {
4929
4930
  /**
4930
4931
  * @public
4931
4932
  * <p>A filter to limit the output to the specified type of audit: can be one of
4932
- * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</p>
4933
+ * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</p>
4933
4934
  */
4934
4935
  taskType?: AuditTaskType;
4935
4936
  /**
4936
4937
  * @public
4937
- * <p>A filter to limit the output to audits with the specified completion
4938
- * status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</p>
4938
+ * <p>A filter to limit the output to audits with the specified completion status: can be one of
4939
+ * "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</p>
4939
4940
  */
4940
4941
  taskStatus?: AuditTaskStatus;
4941
4942
  /**
@@ -4960,8 +4961,8 @@ export interface ListAuditTasksResponse {
4960
4961
  tasks?: AuditTaskMetadata[];
4961
4962
  /**
4962
4963
  * @public
4963
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
4964
- * if there are no additional results.</p>
4964
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
4965
+ * there are no additional results.</p>
4965
4966
  */
4966
4967
  nextToken?: string;
4967
4968
  }
@@ -5244,16 +5245,12 @@ export interface ListCertificatesByCAResponse {
5244
5245
  export interface ListCustomMetricsRequest {
5245
5246
  /**
5246
5247
  * @public
5247
- * <p>
5248
- * The token for the next set of results.
5249
- * </p>
5248
+ * <p> The token for the next set of results. </p>
5250
5249
  */
5251
5250
  nextToken?: string;
5252
5251
  /**
5253
5252
  * @public
5254
- * <p>
5255
- * The maximum number of results to return at one time. The default is 25.
5256
- * </p>
5253
+ * <p> The maximum number of results to return at one time. The default is 25. </p>
5257
5254
  */
5258
5255
  maxResults?: number;
5259
5256
  }
@@ -5263,17 +5260,13 @@ export interface ListCustomMetricsRequest {
5263
5260
  export interface ListCustomMetricsResponse {
5264
5261
  /**
5265
5262
  * @public
5266
- * <p>
5267
- * The name of the custom metric.
5268
- * </p>
5263
+ * <p> The name of the custom metric. </p>
5269
5264
  */
5270
5265
  metricNames?: string[];
5271
5266
  /**
5272
5267
  * @public
5273
- * <p>
5274
- * A token that can be used to retrieve the next set of results,
5275
- * or <code>null</code> if there are no additional results.
5276
- * </p>
5268
+ * <p> A token that can be used to retrieve the next set of results, or <code>null</code> if
5269
+ * there are no additional results. </p>
5277
5270
  */
5278
5271
  nextToken?: string;
5279
5272
  }
@@ -5283,52 +5276,39 @@ export interface ListCustomMetricsResponse {
5283
5276
  export interface ListDetectMitigationActionsExecutionsRequest {
5284
5277
  /**
5285
5278
  * @public
5286
- * <p>
5287
- * The unique identifier of the task.
5288
- * </p>
5279
+ * <p> The unique identifier of the task. </p>
5289
5280
  */
5290
5281
  taskId?: string;
5291
5282
  /**
5292
5283
  * @public
5293
- * <p>
5294
- * The unique identifier of the violation.
5295
- * </p>
5284
+ * <p> The unique identifier of the violation. </p>
5296
5285
  */
5297
5286
  violationId?: string;
5298
5287
  /**
5299
5288
  * @public
5300
- * <p>
5301
- * The name of the thing whose mitigation actions are listed.
5302
- * </p>
5289
+ * <p> The name of the thing whose mitigation actions are listed. </p>
5303
5290
  */
5304
5291
  thingName?: string;
5305
5292
  /**
5306
5293
  * @public
5307
- * <p>
5308
- * A filter to limit results to those found after the specified time. You must
5309
- * specify either the startTime and endTime or the taskId, but not both.
5310
- * </p>
5294
+ * <p> A filter to limit results to those found after the specified time. You must specify
5295
+ * either the startTime and endTime or the taskId, but not both. </p>
5311
5296
  */
5312
5297
  startTime?: Date;
5313
5298
  /**
5314
5299
  * @public
5315
- * <p>
5316
- * The end of the time period for which ML Detect mitigation actions executions are returned.
5317
- * </p>
5300
+ * <p> The end of the time period for which ML Detect mitigation actions executions are
5301
+ * returned. </p>
5318
5302
  */
5319
5303
  endTime?: Date;
5320
5304
  /**
5321
5305
  * @public
5322
- * <p>
5323
- * The maximum number of results to return at one time. The default is 25.
5324
- * </p>
5306
+ * <p> The maximum number of results to return at one time. The default is 25. </p>
5325
5307
  */
5326
5308
  maxResults?: number;
5327
5309
  /**
5328
5310
  * @public
5329
- * <p>
5330
- * The token for the next set of results.
5331
- * </p>
5311
+ * <p> The token for the next set of results. </p>
5332
5312
  */
5333
5313
  nextToken?: string;
5334
5314
  }
@@ -5423,16 +5403,13 @@ export interface DetectMitigationActionExecution {
5423
5403
  export interface ListDetectMitigationActionsExecutionsResponse {
5424
5404
  /**
5425
5405
  * @public
5426
- * <p>
5427
- * List of actions executions.
5428
- * </p>
5406
+ * <p> List of actions executions. </p>
5429
5407
  */
5430
5408
  actionsExecutions?: DetectMitigationActionExecution[];
5431
5409
  /**
5432
5410
  * @public
5433
- * <p>
5434
- * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
5435
- * </p>
5411
+ * <p> A token that can be used to retrieve the next set of results, or <code>null</code> if
5412
+ * there are no additional results. </p>
5436
5413
  */
5437
5414
  nextToken?: string;
5438
5415
  }
@@ -5447,23 +5424,18 @@ export interface ListDetectMitigationActionsTasksRequest {
5447
5424
  maxResults?: number;
5448
5425
  /**
5449
5426
  * @public
5450
- * <p>
5451
- * The token for the next set of results.
5452
- * </p>
5427
+ * <p> The token for the next set of results. </p>
5453
5428
  */
5454
5429
  nextToken?: string;
5455
5430
  /**
5456
5431
  * @public
5457
- * <p>
5458
- * A filter to limit results to those found after the specified time. You must
5459
- * specify either the startTime and endTime or the taskId, but not both.
5460
- * </p>
5432
+ * <p> A filter to limit results to those found after the specified time. You must specify
5433
+ * either the startTime and endTime or the taskId, but not both. </p>
5461
5434
  */
5462
5435
  startTime: Date | undefined;
5463
5436
  /**
5464
5437
  * @public
5465
- * <p>
5466
- * The end of the time period for which ML Detect mitigation actions tasks are returned.
5438
+ * <p> The end of the time period for which ML Detect mitigation actions tasks are returned.
5467
5439
  * </p>
5468
5440
  */
5469
5441
  endTime: Date | undefined;
@@ -5474,16 +5446,13 @@ export interface ListDetectMitigationActionsTasksRequest {
5474
5446
  export interface ListDetectMitigationActionsTasksResponse {
5475
5447
  /**
5476
5448
  * @public
5477
- * <p>
5478
- * The collection of ML Detect mitigation tasks that matched the filter criteria.
5479
- * </p>
5449
+ * <p> The collection of ML Detect mitigation tasks that matched the filter criteria. </p>
5480
5450
  */
5481
5451
  tasks?: DetectMitigationActionsTaskSummary[];
5482
5452
  /**
5483
5453
  * @public
5484
- * <p>
5485
- * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
5486
- * </p>
5454
+ * <p> A token that can be used to retrieve the next set of results, or <code>null</code> if
5455
+ * there are no additional results. </p>
5487
5456
  */
5488
5457
  nextToken?: string;
5489
5458
  }
@@ -5508,12 +5477,14 @@ export interface ListDimensionsRequest {
5508
5477
  export interface ListDimensionsResponse {
5509
5478
  /**
5510
5479
  * @public
5511
- * <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
5480
+ * <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get
5481
+ * details for a dimension.</p>
5512
5482
  */
5513
5483
  dimensionNames?: string[];
5514
5484
  /**
5515
5485
  * @public
5516
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>
5486
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
5487
+ * there are no additional results.</p>
5517
5488
  */
5518
5489
  nextToken?: string;
5519
5490
  }
@@ -6166,8 +6137,8 @@ export interface ListMetricValuesResponse {
6166
6137
  metricDatumList?: MetricDatum[];
6167
6138
  /**
6168
6139
  * @public
6169
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
6170
- * if there are no additional results.</p>
6140
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
6141
+ * there are no additional results.</p>
6171
6142
  */
6172
6143
  nextToken?: string;
6173
6144
  }
@@ -6177,7 +6148,8 @@ export interface ListMetricValuesResponse {
6177
6148
  export interface ListMitigationActionsRequest {
6178
6149
  /**
6179
6150
  * @public
6180
- * <p>Specify a value to limit the result to mitigation actions with a specific action type.</p>
6151
+ * <p>Specify a value to limit the result to mitigation actions with a specific action
6152
+ * type.</p>
6181
6153
  */
6182
6154
  actionType?: MitigationActionType;
6183
6155
  /**
@@ -6567,17 +6539,6 @@ export interface ListPolicyPrincipalsResponse {
6567
6539
  */
6568
6540
  nextMarker?: string;
6569
6541
  }
6570
- /**
6571
- * @public
6572
- * <p>The input for the ListPolicyVersions operation.</p>
6573
- */
6574
- export interface ListPolicyVersionsRequest {
6575
- /**
6576
- * @public
6577
- * <p>The policy name.</p>
6578
- */
6579
- policyName: string | undefined;
6580
- }
6581
6542
  /**
6582
6543
  * @internal
6583
6544
  */