@aws-sdk/client-iot 3.451.0 → 3.454.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 (45) hide show
  1. package/dist-cjs/models/models_1.js +5 -1
  2. package/dist-es/models/models_1.js +4 -0
  3. package/dist-types/commands/AttachSecurityProfileCommand.d.ts +1 -1
  4. package/dist-types/commands/CancelAuditMitigationActionsTaskCommand.d.ts +3 -2
  5. package/dist-types/commands/CancelAuditTaskCommand.d.ts +1 -2
  6. package/dist-types/commands/CancelDetectMitigationActionsTaskCommand.d.ts +3 -1
  7. package/dist-types/commands/CreateCustomMetricCommand.d.ts +4 -1
  8. package/dist-types/commands/CreateDimensionCommand.d.ts +2 -4
  9. package/dist-types/commands/CreateMitigationActionCommand.d.ts +2 -4
  10. package/dist-types/commands/CreateScheduledAuditCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +2 -3
  12. package/dist-types/commands/DeleteCustomMetricCommand.d.ts +8 -4
  13. package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +3 -3
  14. package/dist-types/commands/DescribeAuditFindingCommand.d.ts +3 -1
  15. package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +1 -3
  16. package/dist-types/commands/DescribeCustomMetricCommand.d.ts +3 -1
  17. package/dist-types/commands/DescribeDetectMitigationActionsTaskCommand.d.ts +3 -1
  18. package/dist-types/commands/DetachSecurityProfileCommand.d.ts +1 -2
  19. package/dist-types/commands/GetBehaviorModelTrainingSummariesCommand.d.ts +3 -1
  20. package/dist-types/commands/GetIndexingConfigurationCommand.d.ts +6 -0
  21. package/dist-types/commands/ListAuditFindingsCommand.d.ts +2 -2
  22. package/dist-types/commands/ListAuditMitigationActionsExecutionsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListAuditTasksCommand.d.ts +2 -2
  24. package/dist-types/commands/ListCustomMetricsCommand.d.ts +3 -1
  25. package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +3 -1
  26. package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +3 -1
  27. package/dist-types/commands/ListMetricValuesCommand.d.ts +2 -2
  28. package/dist-types/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +6 -6
  30. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +4 -4
  31. package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +1 -2
  32. package/dist-types/commands/ListViolationEventsCommand.d.ts +3 -3
  33. package/dist-types/commands/StartDetectMitigationActionsTaskCommand.d.ts +3 -1
  34. package/dist-types/commands/UpdateAccountAuditConfigurationCommand.d.ts +3 -3
  35. package/dist-types/commands/UpdateCustomMetricCommand.d.ts +2 -1
  36. package/dist-types/commands/UpdateDimensionCommand.d.ts +6 -2
  37. package/dist-types/commands/UpdateIndexingConfigurationCommand.d.ts +6 -0
  38. package/dist-types/commands/UpdateScheduledAuditCommand.d.ts +2 -2
  39. package/dist-types/models/models_0.d.ts +64 -50
  40. package/dist-types/models/models_1.d.ts +272 -192
  41. package/dist-types/models/models_2.d.ts +216 -136
  42. package/dist-types/ts3.4/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/models/models_1.d.ts +11 -10
  44. package/dist-types/ts3.4/models/models_2.d.ts +10 -0
  45. package/package.json +2 -2
@@ -337,9 +337,9 @@ export interface DeleteSecurityProfileRequest {
337
337
  securityProfileName: string | undefined;
338
338
  /**
339
339
  * @public
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>
340
+ * <p>The expected version of the security profile. A new version is generated whenever
341
+ * the security profile is updated. If you specify a value that is different from the actual
342
+ * version, a <code>VersionConflictException</code> is thrown.</p>
343
343
  */
344
344
  expectedVersion?: number;
345
345
  }
@@ -518,16 +518,17 @@ export interface DescribeAccountAuditConfigurationRequest {
518
518
  export interface DescribeAccountAuditConfigurationResponse {
519
519
  /**
520
520
  * @public
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>
521
+ * <p>The ARN of the role that grants permission to IoT to access information
522
+ * about your devices, policies, certificates, and other items as required when
523
+ * performing an audit.</p>
524
+ * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
525
+ * this parameter is required.</p>
525
526
  */
526
527
  roleArn?: string;
527
528
  /**
528
529
  * @public
529
- * <p>Information about the targets to which audit notifications are sent for this
530
- * account.</p>
530
+ * <p>Information about the targets to which audit notifications are sent for
531
+ * this account.</p>
531
532
  */
532
533
  auditNotificationTargetConfigurations?: Partial<Record<AuditNotificationType, AuditNotificationTarget>>;
533
534
  /**
@@ -542,8 +543,7 @@ export interface DescribeAccountAuditConfigurationResponse {
542
543
  export interface DescribeAuditFindingRequest {
543
544
  /**
544
545
  * @public
545
- * <p>A unique identifier for a single audit finding. You can use this identifier to apply
546
- * mitigation actions to the finding.</p>
546
+ * <p>A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.</p>
547
547
  */
548
548
  findingId: string | undefined;
549
549
  }
@@ -614,14 +614,12 @@ export interface DescribeAuditMitigationActionsTaskResponse {
614
614
  endTime?: Date;
615
615
  /**
616
616
  * @public
617
- * <p>Aggregate counts of the results when the mitigation tasks were applied to the findings for
618
- * this audit mitigation actions task.</p>
617
+ * <p>Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.</p>
619
618
  */
620
619
  taskStatistics?: Record<string, TaskStatisticsForAuditCheck>;
621
620
  /**
622
621
  * @public
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>
622
+ * <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>
625
623
  */
626
624
  target?: AuditMitigationActionsTaskTarget;
627
625
  /**
@@ -631,8 +629,7 @@ export interface DescribeAuditMitigationActionsTaskResponse {
631
629
  auditCheckToActionsMapping?: Record<string, string[]>;
632
630
  /**
633
631
  * @public
634
- * <p>Specifies the mitigation actions and their parameters that are applied as part of this
635
- * task.</p>
632
+ * <p>Specifies the mitigation actions and their parameters that are applied as part of this task.</p>
636
633
  */
637
634
  actionsDefinition?: MitigationAction[];
638
635
  }
@@ -750,8 +747,8 @@ export interface TaskStatistics {
750
747
  export interface DescribeAuditTaskResponse {
751
748
  /**
752
749
  * @public
753
- * <p>The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or
754
- * "CANCELED".</p>
750
+ * <p>The status of the audit: one of "IN_PROGRESS", "COMPLETED",
751
+ * "FAILED", or "CANCELED".</p>
755
752
  */
756
753
  taskStatus?: AuditTaskStatus;
757
754
  /**
@@ -1176,7 +1173,9 @@ export interface DescribeCertificateResponse {
1176
1173
  export interface DescribeCustomMetricRequest {
1177
1174
  /**
1178
1175
  * @public
1179
- * <p> The name of the custom metric. </p>
1176
+ * <p>
1177
+ * The name of the custom metric.
1178
+ * </p>
1180
1179
  */
1181
1180
  metricName: string | undefined;
1182
1181
  }
@@ -1186,39 +1185,45 @@ export interface DescribeCustomMetricRequest {
1186
1185
  export interface DescribeCustomMetricResponse {
1187
1186
  /**
1188
1187
  * @public
1189
- * <p> The name of the custom metric. </p>
1188
+ * <p>
1189
+ * The name of the custom metric.
1190
+ * </p>
1190
1191
  */
1191
1192
  metricName?: string;
1192
1193
  /**
1193
1194
  * @public
1194
- * <p> The Amazon Resource Number (ARN) of the custom metric. </p>
1195
+ * <p>
1196
+ * The Amazon Resource Number (ARN) of the custom metric.
1197
+ * </p>
1195
1198
  */
1196
1199
  metricArn?: string;
1197
1200
  /**
1198
1201
  * @public
1199
1202
  * <p> The type of the custom metric. </p>
1200
1203
  * <important>
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>
1204
+ * <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>
1204
1205
  * </important>
1205
1206
  */
1206
1207
  metricType?: CustomMetricType;
1207
1208
  /**
1208
1209
  * @public
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>
1210
+ * <p>
1211
+ * 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.
1212
+ * </p>
1212
1213
  */
1213
1214
  displayName?: string;
1214
1215
  /**
1215
1216
  * @public
1216
- * <p> The creation date of the custom metric in milliseconds since epoch. </p>
1217
+ * <p>
1218
+ * The creation date of the custom metric in milliseconds since epoch.
1219
+ * </p>
1217
1220
  */
1218
1221
  creationDate?: Date;
1219
1222
  /**
1220
1223
  * @public
1221
- * <p> The time the custom metric was last modified in milliseconds since epoch. </p>
1224
+ * <p>
1225
+ * The time the custom metric was last modified in milliseconds since epoch.
1226
+ * </p>
1222
1227
  */
1223
1228
  lastModifiedDate?: Date;
1224
1229
  }
@@ -1243,7 +1248,9 @@ export interface DescribeDefaultAuthorizerResponse {
1243
1248
  export interface DescribeDetectMitigationActionsTaskRequest {
1244
1249
  /**
1245
1250
  * @public
1246
- * <p> The unique identifier of the task. </p>
1251
+ * <p>
1252
+ * The unique identifier of the task.
1253
+ * </p>
1247
1254
  */
1248
1255
  taskId: string | undefined;
1249
1256
  }
@@ -1425,7 +1432,9 @@ export interface DetectMitigationActionsTaskSummary {
1425
1432
  export interface DescribeDetectMitigationActionsTaskResponse {
1426
1433
  /**
1427
1434
  * @public
1428
- * <p> The description of a task. </p>
1435
+ * <p>
1436
+ * The description of a task.
1437
+ * </p>
1429
1438
  */
1430
1439
  taskSummary?: DetectMitigationActionsTaskSummary;
1431
1440
  }
@@ -1450,7 +1459,10 @@ export interface DescribeDimensionResponse {
1450
1459
  name?: string;
1451
1460
  /**
1452
1461
  * @public
1453
- * <p>The Amazon Resource Name (ARN) for the dimension.</p>
1462
+ * <p>The Amazon Resource Name
1463
+ * (ARN)
1464
+ * for
1465
+ * the dimension.</p>
1454
1466
  */
1455
1467
  arn?: string;
1456
1468
  /**
@@ -1460,8 +1472,7 @@ export interface DescribeDimensionResponse {
1460
1472
  type?: DimensionType;
1461
1473
  /**
1462
1474
  * @public
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>
1475
+ * <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>
1465
1476
  */
1466
1477
  stringValues?: string[];
1467
1478
  /**
@@ -2100,10 +2111,11 @@ export interface Job {
2100
2111
  scheduledJobRollouts?: ScheduledJobRollout[];
2101
2112
  /**
2102
2113
  * @public
2103
- * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
2114
+ * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
2115
+ * job successfully completes. </p>
2104
2116
  * <p>
2105
- * <b>Note:</b>The following Length Constraints relates to a single string.
2106
- * Up to five strings are allowed.</p>
2117
+ * <b>Note:</b>The following Length Constraints relates to a single ARN.
2118
+ * Up to 25 package version ARNs are allowed.</p>
2107
2119
  */
2108
2120
  destinationPackageVersions?: string[];
2109
2121
  }
@@ -2331,10 +2343,11 @@ export interface DescribeJobTemplateResponse {
2331
2343
  maintenanceWindows?: MaintenanceWindow[];
2332
2344
  /**
2333
2345
  * @public
2334
- * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
2346
+ * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
2347
+ * job successfully completes. </p>
2335
2348
  * <p>
2336
- * <b>Note:</b>The following Length Constraints relates to a single string.
2337
- * Up to five strings are allowed.</p>
2349
+ * <b>Note:</b>The following Length Constraints relates to a single ARN.
2350
+ * Up to 25 package version ARNs are allowed.</p>
2338
2351
  */
2339
2352
  destinationPackageVersions?: string[];
2340
2353
  }
@@ -2502,8 +2515,7 @@ export interface DescribeMitigationActionResponse {
2502
2515
  roleArn?: string;
2503
2516
  /**
2504
2517
  * @public
2505
- * <p>Parameters that control how the mitigation action is applied, specific to the type of
2506
- * mitigation action.</p>
2518
+ * <p>Parameters that control how the mitigation action is applied, specific to the type of mitigation action.</p>
2507
2519
  */
2508
2520
  actionParams?: MitigationActionParams;
2509
2521
  /**
@@ -2708,32 +2720,38 @@ export interface DescribeScheduledAuditRequest {
2708
2720
  export interface DescribeScheduledAuditResponse {
2709
2721
  /**
2710
2722
  * @public
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>
2723
+ * <p>How often the scheduled audit takes
2724
+ * place, either
2725
+ * one of <code>DAILY</code>,
2726
+ * <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined by the
2727
+ * system.</p>
2714
2728
  */
2715
2729
  frequency?: AuditFrequency;
2716
2730
  /**
2717
2731
  * @public
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>
2732
+ * <p>The day of the month on which the scheduled audit takes place.
2733
+ * This is
2734
+ * will be <code>1</code>
2735
+ * through <code>31</code> or <code>LAST</code>. If days
2736
+ * <code>29</code>-<code>31</code>
2737
+ * are specified, and the month does not have that many days, the audit takes place on the <code>LAST</code>
2738
+ * day of the month.</p>
2722
2739
  */
2723
2740
  dayOfMonth?: string;
2724
2741
  /**
2725
2742
  * @public
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>
2743
+ * <p>The day of the week on which the scheduled audit takes
2744
+ * place,
2745
+ * either one of
2746
+ * <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>.</p>
2729
2747
  */
2730
2748
  dayOfWeek?: DayOfWeek;
2731
2749
  /**
2732
2750
  * @public
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>
2751
+ * <p>Which checks are performed during the scheduled audit. Checks must be
2752
+ * enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
2753
+ * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
2754
+ * to select which checks are enabled.)</p>
2737
2755
  */
2738
2756
  targetCheckNames?: string[];
2739
2757
  /**
@@ -2753,7 +2771,8 @@ export interface DescribeScheduledAuditResponse {
2753
2771
  export interface DescribeSecurityProfileRequest {
2754
2772
  /**
2755
2773
  * @public
2756
- * <p>The name of the security profile whose information you want to get.</p>
2774
+ * <p>The name of the security profile
2775
+ * whose information you want to get.</p>
2757
2776
  */
2758
2777
  securityProfileName: string | undefined;
2759
2778
  }
@@ -2773,14 +2792,13 @@ export interface DescribeSecurityProfileResponse {
2773
2792
  securityProfileArn?: string;
2774
2793
  /**
2775
2794
  * @public
2776
- * <p>A description of the security profile (associated with the security profile when it was
2777
- * created or updated).</p>
2795
+ * <p>A description of the security profile (associated with the security profile
2796
+ * when it was created or updated).</p>
2778
2797
  */
2779
2798
  securityProfileDescription?: string;
2780
2799
  /**
2781
2800
  * @public
2782
- * <p>Specifies the behaviors that, when violated by a device (thing), cause an
2783
- * alert.</p>
2801
+ * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
2784
2802
  */
2785
2803
  behaviors?: Behavior[];
2786
2804
  /**
@@ -2793,25 +2811,29 @@ export interface DescribeSecurityProfileResponse {
2793
2811
  * @deprecated
2794
2812
  *
2795
2813
  * <p>
2796
- * <i>Please use <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a>
2814
+ * <i>Please use
2815
+ * <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a>
2797
2816
  * instead.</i>
2798
2817
  * </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>
2818
+ * <p>A list of metrics
2819
+ * whose data is retained (stored). By default, data is retained for any metric
2820
+ * used in the profile's <code>behaviors</code>, but
2821
+ * it is
2822
+ * also retained for any metric specified here.</p>
2802
2823
  */
2803
2824
  additionalMetricsToRetain?: string[];
2804
2825
  /**
2805
2826
  * @public
2806
2827
  * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
2807
- * metric used in the profile's behaviors, but it is also retained for any metric specified
2808
- * here.</p>
2828
+ * metric used in the profile's behaviors, but
2829
+ * it is
2830
+ * also retained for any metric specified here.</p>
2809
2831
  */
2810
2832
  additionalMetricsToRetainV2?: MetricToRetain[];
2811
2833
  /**
2812
2834
  * @public
2813
- * <p>The version of the security profile. A new version is generated whenever the security
2814
- * profile is updated.</p>
2835
+ * <p>The version of the security profile. A new version is generated whenever the
2836
+ * security profile is updated.</p>
2815
2837
  */
2816
2838
  version?: number;
2817
2839
  /**
@@ -3339,17 +3361,23 @@ export interface EnableTopicRuleRequest {
3339
3361
  export interface GetBehaviorModelTrainingSummariesRequest {
3340
3362
  /**
3341
3363
  * @public
3342
- * <p> The name of the security profile. </p>
3364
+ * <p>
3365
+ * The name of the security profile.
3366
+ * </p>
3343
3367
  */
3344
3368
  securityProfileName?: string;
3345
3369
  /**
3346
3370
  * @public
3347
- * <p> The maximum number of results to return at one time. The default is 10. </p>
3371
+ * <p>
3372
+ * The maximum number of results to return at one time. The default is 10.
3373
+ * </p>
3348
3374
  */
3349
3375
  maxResults?: number;
3350
3376
  /**
3351
3377
  * @public
3352
- * <p> The token for the next set of results. </p>
3378
+ * <p>
3379
+ * The token for the next set of results.
3380
+ * </p>
3353
3381
  */
3354
3382
  nextToken?: string;
3355
3383
  }
@@ -3422,14 +3450,16 @@ export interface BehaviorModelTrainingSummary {
3422
3450
  export interface GetBehaviorModelTrainingSummariesResponse {
3423
3451
  /**
3424
3452
  * @public
3425
- * <p> A list of all ML Detect behaviors and their model status for a given Security Profile.
3453
+ * <p>
3454
+ * A list of all ML Detect behaviors and their model status for a given Security Profile.
3426
3455
  * </p>
3427
3456
  */
3428
3457
  summaries?: BehaviorModelTrainingSummary[];
3429
3458
  /**
3430
3459
  * @public
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>
3460
+ * <p>
3461
+ * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
3462
+ * </p>
3433
3463
  */
3434
3464
  nextToken?: string;
3435
3465
  }
@@ -3693,9 +3723,56 @@ export declare const DeviceDefenderIndexingMode: {
3693
3723
  export type DeviceDefenderIndexingMode = (typeof DeviceDefenderIndexingMode)[keyof typeof DeviceDefenderIndexingMode];
3694
3724
  /**
3695
3725
  * @public
3696
- * <p>Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter.
3697
- * To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to be <code>ON</code> and
3698
- * specify your shadow names in <code>filter</code>.</p>
3726
+ * @enum
3727
+ */
3728
+ export declare const TargetFieldOrder: {
3729
+ readonly LatLon: "LatLon";
3730
+ readonly LonLat: "LonLat";
3731
+ };
3732
+ /**
3733
+ * @public
3734
+ */
3735
+ export type TargetFieldOrder = (typeof TargetFieldOrder)[keyof typeof TargetFieldOrder];
3736
+ /**
3737
+ * @public
3738
+ * <p>A geolocation target that you select to index. Each geolocation target contains a
3739
+ * <code>name</code> and <code>order</code> key-value pair that specifies the geolocation
3740
+ * target fields.</p>
3741
+ */
3742
+ export interface GeoLocationTarget {
3743
+ /**
3744
+ * @public
3745
+ * <p>The <code>name</code> of the geolocation target field. If the target field is part of a
3746
+ * named shadow, you must select the named shadow using the <code>namedShadow</code> filter.</p>
3747
+ */
3748
+ name?: string;
3749
+ /**
3750
+ * @public
3751
+ * <p>The <code>order</code> of the geolocation target field. This field is optional. The
3752
+ * default value is <code>LatLon</code>.</p>
3753
+ */
3754
+ order?: TargetFieldOrder;
3755
+ }
3756
+ /**
3757
+ * @public
3758
+ * <p>Provides additional selections for named shadows and geolocation data. </p>
3759
+ * <p>To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to
3760
+ * be ON and specify your shadow names in <code>namedShadowNames</code> filter.</p>
3761
+ * <p>To add geolocation data to your fleet indexing configuration: </p>
3762
+ * <ul>
3763
+ * <li>
3764
+ * <p>If you store geolocation data in a class/unnamed shadow, set
3765
+ * <code>thingIndexingMode</code> to be <code>REGISTRY_AND_SHADOW</code> and specify your
3766
+ * geolocation data in <code>geoLocations</code> filter. </p>
3767
+ * </li>
3768
+ * <li>
3769
+ * <p>If you store geolocation data in a named shadow, set
3770
+ * <code>namedShadowIndexingMode</code> to be <code>ON</code>, add the shadow name in
3771
+ * <code>namedShadowNames</code> filter, and specify your geolocation data in
3772
+ * <code>geoLocations</code> filter. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html">Managing fleet
3773
+ * indexing</a>.</p>
3774
+ * </li>
3775
+ * </ul>
3699
3776
  */
3700
3777
  export interface IndexingFilter {
3701
3778
  /**
@@ -3706,6 +3783,13 @@ export interface IndexingFilter {
3706
3783
  * </p>
3707
3784
  */
3708
3785
  namedShadowNames?: string[];
3786
+ /**
3787
+ * @public
3788
+ * <p>The list of geolocation targets that you select to index. The default maximum number of
3789
+ * geolocation targets for indexing is <code>1</code>. To increase the limit, see <a href="https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits">Amazon Web Services IoT Device
3790
+ * Management Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
3791
+ */
3792
+ geoLocations?: GeoLocationTarget[];
3709
3793
  }
3710
3794
  /**
3711
3795
  * @public
@@ -3831,9 +3915,23 @@ export interface ThingIndexingConfiguration {
3831
3915
  customFields?: Field[];
3832
3916
  /**
3833
3917
  * @public
3834
- * <p>Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter.
3835
- * To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to be <code>ON</code> and
3836
- * specify your shadow names in <code>filter</code>.</p>
3918
+ * <p>Provides additional selections for named shadows and geolocation data. </p>
3919
+ * <p>To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to
3920
+ * be ON and specify your shadow names in <code>namedShadowNames</code> filter.</p>
3921
+ * <p>To add geolocation data to your fleet indexing configuration: </p>
3922
+ * <ul>
3923
+ * <li>
3924
+ * <p>If you store geolocation data in a class/unnamed shadow, set
3925
+ * <code>thingIndexingMode</code> to be <code>REGISTRY_AND_SHADOW</code> and specify your
3926
+ * geolocation data in <code>geoLocations</code> filter. </p>
3927
+ * </li>
3928
+ * <li>
3929
+ * <p>If you store geolocation data in a named shadow, set <code>namedShadowIndexingMode</code>
3930
+ * to be <code>ON</code>, add the shadow name in <code>namedShadowNames</code> filter, and
3931
+ * specify your geolocation data in <code>geoLocations</code> filter. For more information, see
3932
+ * <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html">Managing fleet indexing</a>.</p>
3933
+ * </li>
3934
+ * </ul>
3837
3935
  */
3838
3936
  filter?: IndexingFilter;
3839
3937
  }
@@ -4599,12 +4697,16 @@ export interface ListActiveViolationsRequest {
4599
4697
  securityProfileName?: string;
4600
4698
  /**
4601
4699
  * @public
4602
- * <p> The criteria for a behavior. </p>
4700
+ * <p>
4701
+ * The criteria for a behavior.
4702
+ * </p>
4603
4703
  */
4604
4704
  behaviorCriteriaType?: BehaviorCriteriaType;
4605
4705
  /**
4606
4706
  * @public
4607
- * <p> A list of all suppressed alerts. </p>
4707
+ * <p>
4708
+ * A list of all suppressed alerts.
4709
+ * </p>
4608
4710
  */
4609
4711
  listSuppressedAlerts?: boolean;
4610
4712
  /**
@@ -4634,8 +4736,8 @@ export interface ListActiveViolationsResponse {
4634
4736
  activeViolations?: ActiveViolation[];
4635
4737
  /**
4636
4738
  * @public
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>
4739
+ * <p>A token that can be used to retrieve the next set of results,
4740
+ * or <code>null</code> if there are no additional results.</p>
4639
4741
  */
4640
4742
  nextToken?: string;
4641
4743
  }
@@ -4686,8 +4788,8 @@ export interface ListAttachedPoliciesResponse {
4686
4788
  export interface ListAuditFindingsRequest {
4687
4789
  /**
4688
4790
  * @public
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>
4791
+ * <p>A filter to limit results to the audit with the specified ID. You must
4792
+ * specify either the taskId or the startTime and endTime, but not both.</p>
4691
4793
  */
4692
4794
  taskId?: string;
4693
4795
  /**
@@ -4712,14 +4814,14 @@ export interface ListAuditFindingsRequest {
4712
4814
  nextToken?: string;
4713
4815
  /**
4714
4816
  * @public
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>
4817
+ * <p>A filter to limit results to those found after the specified time. You must
4818
+ * specify either the startTime and endTime or the taskId, but not both.</p>
4717
4819
  */
4718
4820
  startTime?: Date;
4719
4821
  /**
4720
4822
  * @public
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>
4823
+ * <p>A filter to limit results to those found before the specified time. You must
4824
+ * specify either the startTime and endTime or the taskId, but not both.</p>
4723
4825
  */
4724
4826
  endTime?: Date;
4725
4827
  /**
@@ -4741,8 +4843,8 @@ export interface ListAuditFindingsResponse {
4741
4843
  findings?: AuditFinding[];
4742
4844
  /**
4743
4845
  * @public
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>
4846
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
4847
+ * if there are no additional results.</p>
4746
4848
  */
4747
4849
  nextToken?: string;
4748
4850
  }
@@ -4752,8 +4854,7 @@ export interface ListAuditFindingsResponse {
4752
4854
  export interface ListAuditMitigationActionsExecutionsRequest {
4753
4855
  /**
4754
4856
  * @public
4755
- * <p>Specify this filter to limit results to actions for a specific audit mitigation actions
4756
- * task.</p>
4857
+ * <p>Specify this filter to limit results to actions for a specific audit mitigation actions task.</p>
4757
4858
  */
4758
4859
  taskId: string | undefined;
4759
4860
  /**
@@ -4763,8 +4864,7 @@ export interface ListAuditMitigationActionsExecutionsRequest {
4763
4864
  actionStatus?: AuditMitigationActionsExecutionStatus;
4764
4865
  /**
4765
4866
  * @public
4766
- * <p>Specify this filter to limit results to those that were applied to a specific audit
4767
- * finding.</p>
4867
+ * <p>Specify this filter to limit results to those that were applied to a specific audit finding.</p>
4768
4868
  */
4769
4869
  findingId: string | undefined;
4770
4870
  /**
@@ -4784,8 +4884,7 @@ export interface ListAuditMitigationActionsExecutionsRequest {
4784
4884
  export interface ListAuditMitigationActionsExecutionsResponse {
4785
4885
  /**
4786
4886
  * @public
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>
4887
+ * <p>A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.</p>
4789
4888
  */
4790
4889
  actionsExecutions?: AuditMitigationActionExecutionMetadata[];
4791
4890
  /**
@@ -4800,14 +4899,12 @@ export interface ListAuditMitigationActionsExecutionsResponse {
4800
4899
  export interface ListAuditMitigationActionsTasksRequest {
4801
4900
  /**
4802
4901
  * @public
4803
- * <p>Specify this filter to limit results to tasks that were applied to results for a specific
4804
- * audit.</p>
4902
+ * <p>Specify this filter to limit results to tasks that were applied to results for a specific audit.</p>
4805
4903
  */
4806
4904
  auditTaskId?: string;
4807
4905
  /**
4808
4906
  * @public
4809
- * <p>Specify this filter to limit results to tasks that were applied to a specific audit
4810
- * finding.</p>
4907
+ * <p>Specify this filter to limit results to tasks that were applied to a specific audit finding.</p>
4811
4908
  */
4812
4909
  findingId?: string;
4813
4910
  /**
@@ -4827,14 +4924,12 @@ export interface ListAuditMitigationActionsTasksRequest {
4827
4924
  nextToken?: string;
4828
4925
  /**
4829
4926
  * @public
4830
- * <p>Specify this filter to limit results to tasks that began on or after a specific date and
4831
- * time.</p>
4927
+ * <p>Specify this filter to limit results to tasks that began on or after a specific date and time.</p>
4832
4928
  */
4833
4929
  startTime: Date | undefined;
4834
4930
  /**
4835
4931
  * @public
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>
4932
+ * <p>Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.</p>
4838
4933
  */
4839
4934
  endTime: Date | undefined;
4840
4935
  }
@@ -4917,9 +5012,9 @@ export interface ListAuditSuppressionsResponse {
4917
5012
  export interface ListAuditTasksRequest {
4918
5013
  /**
4919
5014
  * @public
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>
5015
+ * <p>The beginning of the time period. Audit information is retained for a
5016
+ * limited time (90 days). Requesting a start time prior to what is retained
5017
+ * results in an "InvalidRequestException".</p>
4923
5018
  */
4924
5019
  startTime: Date | undefined;
4925
5020
  /**
@@ -4930,13 +5025,13 @@ export interface ListAuditTasksRequest {
4930
5025
  /**
4931
5026
  * @public
4932
5027
  * <p>A filter to limit the output to the specified type of audit: can be one of
4933
- * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</p>
5028
+ * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</p>
4934
5029
  */
4935
5030
  taskType?: AuditTaskType;
4936
5031
  /**
4937
5032
  * @public
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>
5033
+ * <p>A filter to limit the output to audits with the specified completion
5034
+ * status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</p>
4940
5035
  */
4941
5036
  taskStatus?: AuditTaskStatus;
4942
5037
  /**
@@ -4961,8 +5056,8 @@ export interface ListAuditTasksResponse {
4961
5056
  tasks?: AuditTaskMetadata[];
4962
5057
  /**
4963
5058
  * @public
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>
5059
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
5060
+ * if there are no additional results.</p>
4966
5061
  */
4967
5062
  nextToken?: string;
4968
5063
  }
@@ -5245,12 +5340,16 @@ export interface ListCertificatesByCAResponse {
5245
5340
  export interface ListCustomMetricsRequest {
5246
5341
  /**
5247
5342
  * @public
5248
- * <p> The token for the next set of results. </p>
5343
+ * <p>
5344
+ * The token for the next set of results.
5345
+ * </p>
5249
5346
  */
5250
5347
  nextToken?: string;
5251
5348
  /**
5252
5349
  * @public
5253
- * <p> The maximum number of results to return at one time. The default is 25. </p>
5350
+ * <p>
5351
+ * The maximum number of results to return at one time. The default is 25.
5352
+ * </p>
5254
5353
  */
5255
5354
  maxResults?: number;
5256
5355
  }
@@ -5260,13 +5359,17 @@ export interface ListCustomMetricsRequest {
5260
5359
  export interface ListCustomMetricsResponse {
5261
5360
  /**
5262
5361
  * @public
5263
- * <p> The name of the custom metric. </p>
5362
+ * <p>
5363
+ * The name of the custom metric.
5364
+ * </p>
5264
5365
  */
5265
5366
  metricNames?: string[];
5266
5367
  /**
5267
5368
  * @public
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>
5369
+ * <p>
5370
+ * A token that can be used to retrieve the next set of results,
5371
+ * or <code>null</code> if there are no additional results.
5372
+ * </p>
5270
5373
  */
5271
5374
  nextToken?: string;
5272
5375
  }
@@ -5276,39 +5379,52 @@ export interface ListCustomMetricsResponse {
5276
5379
  export interface ListDetectMitigationActionsExecutionsRequest {
5277
5380
  /**
5278
5381
  * @public
5279
- * <p> The unique identifier of the task. </p>
5382
+ * <p>
5383
+ * The unique identifier of the task.
5384
+ * </p>
5280
5385
  */
5281
5386
  taskId?: string;
5282
5387
  /**
5283
5388
  * @public
5284
- * <p> The unique identifier of the violation. </p>
5389
+ * <p>
5390
+ * The unique identifier of the violation.
5391
+ * </p>
5285
5392
  */
5286
5393
  violationId?: string;
5287
5394
  /**
5288
5395
  * @public
5289
- * <p> The name of the thing whose mitigation actions are listed. </p>
5396
+ * <p>
5397
+ * The name of the thing whose mitigation actions are listed.
5398
+ * </p>
5290
5399
  */
5291
5400
  thingName?: string;
5292
5401
  /**
5293
5402
  * @public
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>
5403
+ * <p>
5404
+ * A filter to limit results to those found after the specified time. You must
5405
+ * specify either the startTime and endTime or the taskId, but not both.
5406
+ * </p>
5296
5407
  */
5297
5408
  startTime?: Date;
5298
5409
  /**
5299
5410
  * @public
5300
- * <p> The end of the time period for which ML Detect mitigation actions executions are
5301
- * returned. </p>
5411
+ * <p>
5412
+ * The end of the time period for which ML Detect mitigation actions executions are returned.
5413
+ * </p>
5302
5414
  */
5303
5415
  endTime?: Date;
5304
5416
  /**
5305
5417
  * @public
5306
- * <p> The maximum number of results to return at one time. The default is 25. </p>
5418
+ * <p>
5419
+ * The maximum number of results to return at one time. The default is 25.
5420
+ * </p>
5307
5421
  */
5308
5422
  maxResults?: number;
5309
5423
  /**
5310
5424
  * @public
5311
- * <p> The token for the next set of results. </p>
5425
+ * <p>
5426
+ * The token for the next set of results.
5427
+ * </p>
5312
5428
  */
5313
5429
  nextToken?: string;
5314
5430
  }
@@ -5403,13 +5519,16 @@ export interface DetectMitigationActionExecution {
5403
5519
  export interface ListDetectMitigationActionsExecutionsResponse {
5404
5520
  /**
5405
5521
  * @public
5406
- * <p> List of actions executions. </p>
5522
+ * <p>
5523
+ * List of actions executions.
5524
+ * </p>
5407
5525
  */
5408
5526
  actionsExecutions?: DetectMitigationActionExecution[];
5409
5527
  /**
5410
5528
  * @public
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>
5529
+ * <p>
5530
+ * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
5531
+ * </p>
5413
5532
  */
5414
5533
  nextToken?: string;
5415
5534
  }
@@ -5424,18 +5543,23 @@ export interface ListDetectMitigationActionsTasksRequest {
5424
5543
  maxResults?: number;
5425
5544
  /**
5426
5545
  * @public
5427
- * <p> The token for the next set of results. </p>
5546
+ * <p>
5547
+ * The token for the next set of results.
5548
+ * </p>
5428
5549
  */
5429
5550
  nextToken?: string;
5430
5551
  /**
5431
5552
  * @public
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>
5553
+ * <p>
5554
+ * A filter to limit results to those found after the specified time. You must
5555
+ * specify either the startTime and endTime or the taskId, but not both.
5556
+ * </p>
5434
5557
  */
5435
5558
  startTime: Date | undefined;
5436
5559
  /**
5437
5560
  * @public
5438
- * <p> The end of the time period for which ML Detect mitigation actions tasks are returned.
5561
+ * <p>
5562
+ * The end of the time period for which ML Detect mitigation actions tasks are returned.
5439
5563
  * </p>
5440
5564
  */
5441
5565
  endTime: Date | undefined;
@@ -5446,13 +5570,16 @@ export interface ListDetectMitigationActionsTasksRequest {
5446
5570
  export interface ListDetectMitigationActionsTasksResponse {
5447
5571
  /**
5448
5572
  * @public
5449
- * <p> The collection of ML Detect mitigation tasks that matched the filter criteria. </p>
5573
+ * <p>
5574
+ * The collection of ML Detect mitigation tasks that matched the filter criteria.
5575
+ * </p>
5450
5576
  */
5451
5577
  tasks?: DetectMitigationActionsTaskSummary[];
5452
5578
  /**
5453
5579
  * @public
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>
5580
+ * <p>
5581
+ * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
5582
+ * </p>
5456
5583
  */
5457
5584
  nextToken?: string;
5458
5585
  }
@@ -5477,14 +5604,12 @@ export interface ListDimensionsRequest {
5477
5604
  export interface ListDimensionsResponse {
5478
5605
  /**
5479
5606
  * @public
5480
- * <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get
5481
- * details for a dimension.</p>
5607
+ * <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
5482
5608
  */
5483
5609
  dimensionNames?: string[];
5484
5610
  /**
5485
5611
  * @public
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>
5612
+ * <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>
5488
5613
  */
5489
5614
  nextToken?: string;
5490
5615
  }
@@ -6137,8 +6262,8 @@ export interface ListMetricValuesResponse {
6137
6262
  metricDatumList?: MetricDatum[];
6138
6263
  /**
6139
6264
  * @public
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>
6265
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code>
6266
+ * if there are no additional results.</p>
6142
6267
  */
6143
6268
  nextToken?: string;
6144
6269
  }
@@ -6148,8 +6273,7 @@ export interface ListMetricValuesResponse {
6148
6273
  export interface ListMitigationActionsRequest {
6149
6274
  /**
6150
6275
  * @public
6151
- * <p>Specify a value to limit the result to mitigation actions with a specific action
6152
- * type.</p>
6276
+ * <p>Specify a value to limit the result to mitigation actions with a specific action type.</p>
6153
6277
  */
6154
6278
  actionType?: MitigationActionType;
6155
6279
  /**
@@ -6495,50 +6619,6 @@ export interface ListPoliciesResponse {
6495
6619
  */
6496
6620
  nextMarker?: string;
6497
6621
  }
6498
- /**
6499
- * @public
6500
- * <p>The input for the ListPolicyPrincipals operation.</p>
6501
- */
6502
- export interface ListPolicyPrincipalsRequest {
6503
- /**
6504
- * @public
6505
- * <p>The policy name.</p>
6506
- */
6507
- policyName: string | undefined;
6508
- /**
6509
- * @public
6510
- * <p>The marker for the next set of results.</p>
6511
- */
6512
- marker?: string;
6513
- /**
6514
- * @public
6515
- * <p>The result page size.</p>
6516
- */
6517
- pageSize?: number;
6518
- /**
6519
- * @public
6520
- * <p>Specifies the order for results. If true, the results are returned in ascending
6521
- * creation order.</p>
6522
- */
6523
- ascendingOrder?: boolean;
6524
- }
6525
- /**
6526
- * @public
6527
- * <p>The output from the ListPolicyPrincipals operation.</p>
6528
- */
6529
- export interface ListPolicyPrincipalsResponse {
6530
- /**
6531
- * @public
6532
- * <p>The descriptions of the principals.</p>
6533
- */
6534
- principals?: string[];
6535
- /**
6536
- * @public
6537
- * <p>The marker for the next set of results, or null if there are no additional
6538
- * results.</p>
6539
- */
6540
- nextMarker?: string;
6541
- }
6542
6622
  /**
6543
6623
  * @internal
6544
6624
  */