@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,7 +1,18 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTServiceException as __BaseException } from "./IoTServiceException";
3
- import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricToRetain, MetricValue, MitigationActionParams, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, StreamFile, Tag, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0";
3
+ import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, StreamFile, Tag, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0";
4
4
  import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, LogTargetType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
5
+ /**
6
+ * @public
7
+ * <p>The input for the ListPolicyVersions operation.</p>
8
+ */
9
+ export interface ListPolicyVersionsRequest {
10
+ /**
11
+ * @public
12
+ * <p>The policy name.</p>
13
+ */
14
+ policyName: string | undefined;
15
+ }
5
16
  /**
6
17
  * @public
7
18
  * <p>Describes a policy version.</p>
@@ -259,8 +270,8 @@ export interface ListRelatedResourcesForAuditFindingRequest {
259
270
  findingId: string | undefined;
260
271
  /**
261
272
  * @public
262
- * <p>A token that can be used to retrieve the next set of results,
263
- * or <code>null</code> if there are no additional results.</p>
273
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
274
+ * there are no additional results.</p>
264
275
  */
265
276
  nextToken?: string;
266
277
  /**
@@ -280,8 +291,8 @@ export interface ListRelatedResourcesForAuditFindingResponse {
280
291
  relatedResources?: RelatedResource[];
281
292
  /**
282
293
  * @public
283
- * <p>A token that can be used to retrieve the next set of results,
284
- * or <code>null</code> for the first API call.</p>
294
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> for the
295
+ * first API call.</p>
285
296
  */
286
297
  nextToken?: string;
287
298
  }
@@ -381,8 +392,8 @@ export interface ListScheduledAuditsResponse {
381
392
  scheduledAudits?: ScheduledAuditMetadata[];
382
393
  /**
383
394
  * @public
384
- * <p>A token that can be used to retrieve the next set of results,
385
- * or <code>null</code> if there are no additional results.</p>
395
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
396
+ * there are no additional results.</p>
386
397
  */
387
398
  nextToken?: string;
388
399
  }
@@ -402,15 +413,14 @@ export interface ListSecurityProfilesRequest {
402
413
  maxResults?: number;
403
414
  /**
404
415
  * @public
405
- * <p>A filter to limit results to the security profiles that use the defined dimension.
406
- * Cannot be used with <code>metricName</code>
416
+ * <p>A filter to limit results to the security profiles that use the defined dimension. Cannot
417
+ * be used with <code>metricName</code>
407
418
  * </p>
408
419
  */
409
420
  dimensionName?: string;
410
421
  /**
411
422
  * @public
412
- * <p> The name of the custom metric.
413
- * Cannot be used with <code>dimensionName</code>. </p>
423
+ * <p> The name of the custom metric. Cannot be used with <code>dimensionName</code>. </p>
414
424
  */
415
425
  metricName?: string;
416
426
  }
@@ -441,8 +451,8 @@ export interface ListSecurityProfilesResponse {
441
451
  securityProfileIdentifiers?: SecurityProfileIdentifier[];
442
452
  /**
443
453
  * @public
444
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
445
- * additional results.</p>
454
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
455
+ * there are no additional results.</p>
446
456
  */
447
457
  nextToken?: string;
448
458
  }
@@ -467,7 +477,8 @@ export interface ListSecurityProfilesForTargetRequest {
467
477
  recursive?: boolean;
468
478
  /**
469
479
  * @public
470
- * <p>The ARN of the target (thing group) whose attached security profiles you want to get.</p>
480
+ * <p>The ARN of the target (thing group) whose attached security profiles you want to
481
+ * get.</p>
471
482
  */
472
483
  securityProfileTargetArn: string | undefined;
473
484
  }
@@ -510,8 +521,8 @@ export interface ListSecurityProfilesForTargetResponse {
510
521
  securityProfileTargetMappings?: SecurityProfileTargetMapping[];
511
522
  /**
512
523
  * @public
513
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
514
- * additional results.</p>
524
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
525
+ * there are no additional results.</p>
515
526
  */
516
527
  nextToken?: string;
517
528
  }
@@ -674,8 +685,8 @@ export interface ListTargetsForSecurityProfileResponse {
674
685
  securityProfileTargets?: SecurityProfileTarget[];
675
686
  /**
676
687
  * @public
677
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
678
- * additional results.</p>
688
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
689
+ * there are no additional results.</p>
679
690
  */
680
691
  nextToken?: string;
681
692
  }
@@ -1443,21 +1454,18 @@ export interface ListViolationEventsRequest {
1443
1454
  thingName?: string;
1444
1455
  /**
1445
1456
  * @public
1446
- * <p>A filter to limit results to those alerts generated by the specified security profile.</p>
1457
+ * <p>A filter to limit results to those alerts generated by the specified security
1458
+ * profile.</p>
1447
1459
  */
1448
1460
  securityProfileName?: string;
1449
1461
  /**
1450
1462
  * @public
1451
- * <p>
1452
- * The criteria for a behavior.
1453
- * </p>
1463
+ * <p> The criteria for a behavior. </p>
1454
1464
  */
1455
1465
  behaviorCriteriaType?: BehaviorCriteriaType;
1456
1466
  /**
1457
1467
  * @public
1458
- * <p>
1459
- * A list of all suppressed alerts.
1460
- * </p>
1468
+ * <p> A list of all suppressed alerts. </p>
1461
1469
  */
1462
1470
  listSuppressedAlerts?: boolean;
1463
1471
  /**
@@ -1553,14 +1561,15 @@ export interface ViolationEvent {
1553
1561
  export interface ListViolationEventsResponse {
1554
1562
  /**
1555
1563
  * @public
1556
- * <p>The security profile violation alerts issued for this account during the given time period,
1557
- * potentially filtered by security profile, behavior violated, or thing (device) violating.</p>
1564
+ * <p>The security profile violation alerts issued for this account during the given time
1565
+ * period, potentially filtered by security profile, behavior violated, or thing (device)
1566
+ * violating.</p>
1558
1567
  */
1559
1568
  violationEvents?: ViolationEvent[];
1560
1569
  /**
1561
1570
  * @public
1562
- * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
1563
- * additional results.</p>
1571
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
1572
+ * there are no additional results.</p>
1564
1573
  */
1565
1574
  nextToken?: string;
1566
1575
  }
@@ -1929,7 +1938,7 @@ export interface SearchIndexRequest {
1929
1938
  nextToken?: string;
1930
1939
  /**
1931
1940
  * @public
1932
- * <p>The maximum number of results to return at one time.</p>
1941
+ * <p>The maximum number of results to return at one time. The response might contain fewer results but will never contain more.</p>
1933
1942
  */
1934
1943
  maxResults?: number;
1935
1944
  /**
@@ -2171,25 +2180,28 @@ export interface SetV2LoggingOptionsRequest {
2171
2180
  export interface StartAuditMitigationActionsTaskRequest {
2172
2181
  /**
2173
2182
  * @public
2174
- * <p>A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.</p>
2183
+ * <p>A unique identifier for the task. You can use this identifier to check the status of the
2184
+ * task or to cancel it.</p>
2175
2185
  */
2176
2186
  taskId: string | undefined;
2177
2187
  /**
2178
2188
  * @public
2179
2189
  * <p>Specifies the audit findings to which the mitigation actions are applied. You can apply
2180
- * them to a type of audit check, to all findings from an audit, or to a
2181
- * specific set of
2190
+ * them to a type of audit check, to all findings from an audit, or to a specific set of
2182
2191
  * findings.</p>
2183
2192
  */
2184
2193
  target: AuditMitigationActionsTaskTarget | undefined;
2185
2194
  /**
2186
2195
  * @public
2187
- * <p>For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.</p>
2196
+ * <p>For an audit check, specifies which mitigation actions to apply. Those actions must be
2197
+ * defined in your Amazon Web Services accounts.</p>
2188
2198
  */
2189
2199
  auditCheckToActionsMapping: Record<string, string[]> | undefined;
2190
2200
  /**
2191
2201
  * @public
2192
- * <p>Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.</p>
2202
+ * <p>Each audit mitigation task must have a unique client request token. If you try to start a
2203
+ * new task with the same token as a task that already exists, an exception occurs. If you omit
2204
+ * this value, a unique client request token is generated automatically.</p>
2193
2205
  */
2194
2206
  clientRequestToken?: string;
2195
2207
  }
@@ -2199,7 +2211,8 @@ export interface StartAuditMitigationActionsTaskRequest {
2199
2211
  export interface StartAuditMitigationActionsTaskResponse {
2200
2212
  /**
2201
2213
  * @public
2202
- * <p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code> that you specified in the request.</p>
2214
+ * <p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code>
2215
+ * that you specified in the request.</p>
2203
2216
  */
2204
2217
  taskId?: string;
2205
2218
  }
@@ -2223,51 +2236,39 @@ export declare class TaskAlreadyExistsException extends __BaseException {
2223
2236
  export interface StartDetectMitigationActionsTaskRequest {
2224
2237
  /**
2225
2238
  * @public
2226
- * <p>
2227
- * The unique identifier of the task.
2228
- * </p>
2239
+ * <p> The unique identifier of the task. </p>
2229
2240
  */
2230
2241
  taskId: string | undefined;
2231
2242
  /**
2232
2243
  * @public
2233
- * <p>
2234
- * Specifies the ML Detect findings to which the mitigation actions are applied.
2235
- * </p>
2244
+ * <p> Specifies the ML Detect findings to which the mitigation actions are applied. </p>
2236
2245
  */
2237
2246
  target: DetectMitigationActionsTaskTarget | undefined;
2238
2247
  /**
2239
2248
  * @public
2240
- * <p>
2241
- * The actions to be performed when a device has unexpected behavior.
2242
- * </p>
2249
+ * <p> The actions to be performed when a device has unexpected behavior. </p>
2243
2250
  */
2244
2251
  actions: string[] | undefined;
2245
2252
  /**
2246
2253
  * @public
2247
- * <p>
2248
- * Specifies the time period of which violation events occurred between.
2249
- * </p>
2254
+ * <p> Specifies the time period of which violation events occurred between. </p>
2250
2255
  */
2251
2256
  violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
2252
2257
  /**
2253
2258
  * @public
2254
- * <p>
2255
- * Specifies to list only active violations.
2256
- * </p>
2259
+ * <p> Specifies to list only active violations. </p>
2257
2260
  */
2258
2261
  includeOnlyActiveViolations?: boolean;
2259
2262
  /**
2260
2263
  * @public
2261
- * <p>
2262
- * Specifies to include suppressed alerts.
2263
- * </p>
2264
+ * <p> Specifies to include suppressed alerts. </p>
2264
2265
  */
2265
2266
  includeSuppressedAlerts?: boolean;
2266
2267
  /**
2267
2268
  * @public
2268
- * <p>
2269
- * Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
2270
- * </p>
2269
+ * <p> Each mitigation action task must have a unique client request token. If you try to create
2270
+ * a new task with the same token as a task that already exists, an exception occurs. If you omit
2271
+ * this value, Amazon Web Services SDKs will automatically generate a unique client request. </p>
2271
2272
  */
2272
2273
  clientRequestToken?: string;
2273
2274
  }
@@ -2277,9 +2278,7 @@ export interface StartDetectMitigationActionsTaskRequest {
2277
2278
  export interface StartDetectMitigationActionsTaskResponse {
2278
2279
  /**
2279
2280
  * @public
2280
- * <p>
2281
- * The unique identifier of the task.
2282
- * </p>
2281
+ * <p> The unique identifier of the task. </p>
2283
2282
  */
2284
2283
  taskId?: string;
2285
2284
  }
@@ -2289,10 +2288,10 @@ export interface StartDetectMitigationActionsTaskResponse {
2289
2288
  export interface StartOnDemandAuditTaskRequest {
2290
2289
  /**
2291
2290
  * @public
2292
- * <p>Which checks are performed during the audit. The checks you specify must be enabled
2293
- * for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code>
2294
- * to see the list of all checks, including those that are enabled or
2295
- * <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>
2291
+ * <p>Which checks are performed during the audit. The checks you specify must be enabled for
2292
+ * your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see
2293
+ * the list of all checks, including those that are enabled or
2294
+ * <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>
2296
2295
  */
2297
2296
  targetCheckNames: string[] | undefined;
2298
2297
  }
@@ -2624,14 +2623,9 @@ export interface UntagResourceResponse {
2624
2623
  export interface UpdateAccountAuditConfigurationRequest {
2625
2624
  /**
2626
2625
  * @public
2627
- * <p>The Amazon
2628
- * Resource Name
2629
- * (ARN)
2630
- * of the role that grants permission
2631
- * to
2632
- * IoT to access information about your devices, policies,
2633
- * certificates,
2634
- * and other items as required when performing an audit.</p>
2626
+ * <p>The Amazon Resource Name (ARN) of the role that grants permission to IoT to access
2627
+ * information about your devices, policies, certificates, and other items as required when
2628
+ * performing an audit.</p>
2635
2629
  */
2636
2630
  roleArn?: string;
2637
2631
  /**
@@ -2642,18 +2636,14 @@ export interface UpdateAccountAuditConfigurationRequest {
2642
2636
  /**
2643
2637
  * @public
2644
2638
  * <p>Specifies which audit checks are enabled and disabled for this account. Use
2645
- * <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those
2646
- * that are currently enabled.</p>
2647
- * <p>Some data collection might start immediately when certain checks are enabled.
2648
- * When a check is disabled, any data collected so far in relation to the check is deleted.</p>
2649
- * <p>You
2650
- * cannot
2651
- * disable a check if
2652
- * it's
2653
- * used by any scheduled audit. You must first delete the check from the scheduled audit or
2654
- * delete the scheduled audit itself.</p>
2655
- * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
2656
- * this parameter is required and must specify at least one enabled check.</p>
2639
+ * <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including
2640
+ * those that are currently enabled.</p>
2641
+ * <p>Some data collection might start immediately when certain checks are enabled. When a check
2642
+ * is disabled, any data collected so far in relation to the check is deleted.</p>
2643
+ * <p>You cannot disable a check if it's used by any scheduled audit. You must first delete the
2644
+ * check from the scheduled audit or delete the scheduled audit itself.</p>
2645
+ * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>, this parameter is
2646
+ * required and must specify at least one enabled check.</p>
2657
2647
  */
2658
2648
  auditCheckConfigurations?: Record<string, AuditCheckConfiguration>;
2659
2649
  }
@@ -2856,20 +2846,14 @@ export interface UpdateCertificateRequest {
2856
2846
  export interface UpdateCustomMetricRequest {
2857
2847
  /**
2858
2848
  * @public
2859
- * <p> The name of the custom metric.
2860
- * Cannot be updated. </p>
2849
+ * <p> The name of the custom metric. Cannot be updated. </p>
2861
2850
  */
2862
2851
  metricName: string | undefined;
2863
2852
  /**
2864
2853
  * @public
2865
- * <p>
2866
- * Field
2867
- * represents a friendly name in the console for the custom metric,
2868
- * it
2869
- * doesn't have to be unique. Don't use this name as the metric identifier in
2870
- * the device metric report.
2871
- * Can
2872
- * be updated. </p>
2854
+ * <p> Field represents a friendly name in the console for the custom metric, it doesn't have to
2855
+ * be unique. Don't use this name as the metric identifier in the device metric report. Can be
2856
+ * updated. </p>
2873
2857
  */
2874
2858
  displayName: string | undefined;
2875
2859
  }
@@ -2879,45 +2863,37 @@ export interface UpdateCustomMetricRequest {
2879
2863
  export interface UpdateCustomMetricResponse {
2880
2864
  /**
2881
2865
  * @public
2882
- * <p>
2883
- * The name of the custom metric.
2884
- * </p>
2866
+ * <p> The name of the custom metric. </p>
2885
2867
  */
2886
2868
  metricName?: string;
2887
2869
  /**
2888
2870
  * @public
2889
- * <p>
2890
- * The Amazon Resource Number (ARN) of the custom metric.
2891
- * </p>
2871
+ * <p> The Amazon Resource Number (ARN) of the custom metric. </p>
2892
2872
  */
2893
2873
  metricArn?: string;
2894
2874
  /**
2895
2875
  * @public
2896
2876
  * <p> The type of the custom metric. </p>
2897
2877
  * <important>
2898
- * <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>
2878
+ * <p>The type <code>number</code> only takes a single metric value as an input, but while
2879
+ * submitting the metrics value in the DeviceMetrics report, it must be passed as an array with
2880
+ * a single value.</p>
2899
2881
  * </important>
2900
2882
  */
2901
2883
  metricType?: CustomMetricType;
2902
2884
  /**
2903
2885
  * @public
2904
- * <p>
2905
- * A friendly name in the console for the custom metric
2906
- * </p>
2886
+ * <p> A friendly name in the console for the custom metric </p>
2907
2887
  */
2908
2888
  displayName?: string;
2909
2889
  /**
2910
2890
  * @public
2911
- * <p>
2912
- * The creation date of the custom metric in milliseconds since epoch.
2913
- * </p>
2891
+ * <p> The creation date of the custom metric in milliseconds since epoch. </p>
2914
2892
  */
2915
2893
  creationDate?: Date;
2916
2894
  /**
2917
2895
  * @public
2918
- * <p>
2919
- * The time the custom metric was last modified in milliseconds since epoch.
2920
- * </p>
2896
+ * <p> The time the custom metric was last modified in milliseconds since epoch. </p>
2921
2897
  */
2922
2898
  lastModifiedDate?: Date;
2923
2899
  }
@@ -2927,12 +2903,14 @@ export interface UpdateCustomMetricResponse {
2927
2903
  export interface UpdateDimensionRequest {
2928
2904
  /**
2929
2905
  * @public
2930
- * <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>
2906
+ * <p>A unique identifier for the dimension. Choose something that describes the type and value
2907
+ * to make it easy to remember what it does.</p>
2931
2908
  */
2932
2909
  name: string | undefined;
2933
2910
  /**
2934
2911
  * @public
2935
- * <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>
2912
+ * <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code>
2913
+ * dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>
2936
2914
  */
2937
2915
  stringValues: string[] | undefined;
2938
2916
  }
@@ -2947,9 +2925,7 @@ export interface UpdateDimensionResponse {
2947
2925
  name?: string;
2948
2926
  /**
2949
2927
  * @public
2950
- * <p>The Amazon Resource
2951
- * Name (ARN)of
2952
- * the created dimension.</p>
2928
+ * <p>The Amazon Resource Name (ARN)of the created dimension.</p>
2953
2929
  */
2954
2930
  arn?: string;
2955
2931
  /**
@@ -2959,17 +2935,20 @@ export interface UpdateDimensionResponse {
2959
2935
  type?: DimensionType;
2960
2936
  /**
2961
2937
  * @public
2962
- * <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>
2938
+ * <p>The value or list of values used to scope the dimension. For example, for topic filters,
2939
+ * this is the pattern used to match the MQTT topic name.</p>
2963
2940
  */
2964
2941
  stringValues?: string[];
2965
2942
  /**
2966
2943
  * @public
2967
- * <p>The date and time, in milliseconds since epoch, when the dimension was initially created.</p>
2944
+ * <p>The date and time, in milliseconds since epoch, when the dimension was initially
2945
+ * created.</p>
2968
2946
  */
2969
2947
  creationDate?: Date;
2970
2948
  /**
2971
2949
  * @public
2972
- * <p>The date and time, in milliseconds since epoch, when the dimension was most recently updated.</p>
2950
+ * <p>The date and time, in milliseconds since epoch, when the dimension was most recently
2951
+ * updated.</p>
2973
2952
  */
2974
2953
  lastModifiedDate?: Date;
2975
2954
  }
@@ -3222,9 +3201,8 @@ export interface UpdateMitigationActionRequest {
3222
3201
  /**
3223
3202
  * @public
3224
3203
  * <p>The friendly name for the mitigation action. You cannot change the name by using
3225
- * <code>UpdateMitigationAction</code>. Instead, you must delete and
3226
- * recreate the
3227
- * mitigation action with the new name.</p>
3204
+ * <code>UpdateMitigationAction</code>. Instead, you must delete and recreate the mitigation
3205
+ * action with the new name.</p>
3228
3206
  */
3229
3207
  actionName: string | undefined;
3230
3208
  /**
@@ -3465,38 +3443,34 @@ export interface UpdateRoleAliasResponse {
3465
3443
  export interface UpdateScheduledAuditRequest {
3466
3444
  /**
3467
3445
  * @public
3468
- * <p>How often the scheduled audit takes
3469
- * place,
3470
- * either <code>DAILY</code>,
3471
- * <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined by the
3472
- * system.</p>
3446
+ * <p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>,
3447
+ * <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined
3448
+ * by the system.</p>
3473
3449
  */
3474
3450
  frequency?: AuditFrequency;
3475
3451
  /**
3476
3452
  * @public
3477
- * <p>The day of the month on which the scheduled audit takes place.
3478
- * This
3479
- * can
3480
- * be <code>1</code> through <code>31</code> or <code>LAST</code>. This field is required if the <code>frequency</code> parameter is set to
3481
- * <code>MONTHLY</code>. If days 29-31 are specified, and the month does not have that many days, the audit
3482
- * takes place on the "LAST" day of the month.</p>
3453
+ * <p>The day of the month on which the scheduled audit takes place. This can be <code>1</code>
3454
+ * through <code>31</code> or <code>LAST</code>. This field is required if the
3455
+ * <code>frequency</code> parameter is set to <code>MONTHLY</code>. If days 29-31 are
3456
+ * specified, and the month does not have that many days, the audit takes place on the "LAST" day
3457
+ * of the month.</p>
3483
3458
  */
3484
3459
  dayOfMonth?: string;
3485
3460
  /**
3486
3461
  * @public
3487
- * <p>The day of the week on which the scheduled audit takes place.
3488
- * This
3489
- * can
3490
- * be one of <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the
3491
- * "frequency" parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
3462
+ * <p>The day of the week on which the scheduled audit takes place. This can be one of
3463
+ * <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>,
3464
+ * <code>FRI</code>, or <code>SAT</code>. This field is required if the "frequency" parameter
3465
+ * is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
3492
3466
  */
3493
3467
  dayOfWeek?: DayOfWeek;
3494
3468
  /**
3495
3469
  * @public
3496
- * <p>Which checks are performed during the scheduled audit. Checks must be enabled
3497
- * for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
3498
- * of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
3499
- * to select which checks are enabled.)</p>
3470
+ * <p>Which checks are performed during the scheduled audit. Checks must be enabled for your
3471
+ * account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks,
3472
+ * including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select
3473
+ * which checks are enabled.)</p>
3500
3474
  */
3501
3475
  targetCheckNames?: string[];
3502
3476
  /**
@@ -3531,7 +3505,8 @@ export interface UpdateSecurityProfileRequest {
3531
3505
  securityProfileDescription?: string;
3532
3506
  /**
3533
3507
  * @public
3534
- * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3508
+ * <p>Specifies the behaviors that, when violated by a device (thing), cause an
3509
+ * alert.</p>
3535
3510
  */
3536
3511
  behaviors?: Behavior[];
3537
3512
  /**
@@ -3544,48 +3519,58 @@ export interface UpdateSecurityProfileRequest {
3544
3519
  * @deprecated
3545
3520
  *
3546
3521
  * <p>
3547
- * <i>Please use
3548
- * <a>UpdateSecurityProfileRequest$additionalMetricsToRetainV2</a>
3549
- * instead.</i>
3522
+ * <i>Please use <a>UpdateSecurityProfileRequest$additionalMetricsToRetainV2</a>
3523
+ * instead.</i>
3550
3524
  * </p>
3551
- * <p>A list of metrics
3552
- * whose data is retained (stored). By default, data is retained for any metric
3553
- * used in the profile's <code>behaviors</code>, but
3554
- * it is
3555
- * also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3525
+ * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
3526
+ * metric used in the profile's <code>behaviors</code>, but it is also retained for any metric
3527
+ * specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3556
3528
  */
3557
3529
  additionalMetricsToRetain?: string[];
3558
3530
  /**
3559
3531
  * @public
3560
- * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3532
+ * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
3533
+ * metric used in the profile's behaviors, but it is also retained for any metric specified here.
3534
+ * Can be used with custom metrics; cannot be used with dimensions.</p>
3561
3535
  */
3562
3536
  additionalMetricsToRetainV2?: MetricToRetain[];
3563
3537
  /**
3564
3538
  * @public
3565
- * <p>If true, delete all <code>behaviors</code> defined for this security profile.
3566
- * If any <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>
3539
+ * <p>If true, delete all <code>behaviors</code> defined for this security profile. If any
3540
+ * <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>
3567
3541
  */
3568
3542
  deleteBehaviors?: boolean;
3569
3543
  /**
3570
3544
  * @public
3571
- * <p>If true, delete all <code>alertTargets</code> defined for this security profile.
3572
- * If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.</p>
3545
+ * <p>If true, delete all <code>alertTargets</code> defined for this security profile. If any
3546
+ * <code>alertTargets</code> are defined in the current invocation, an exception
3547
+ * occurs.</p>
3573
3548
  */
3574
3549
  deleteAlertTargets?: boolean;
3575
3550
  /**
3576
3551
  * @public
3577
- * <p>If true, delete all <code>additionalMetricsToRetain</code> defined for this
3578
- * security profile. If any <code>additionalMetricsToRetain</code> are defined in the current
3579
- * invocation, an exception occurs.</p>
3552
+ * <p>If true, delete all <code>additionalMetricsToRetain</code> defined for this security
3553
+ * profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation,
3554
+ * an exception occurs.</p>
3580
3555
  */
3581
3556
  deleteAdditionalMetricsToRetain?: boolean;
3582
3557
  /**
3583
3558
  * @public
3584
- * <p>The expected version of the security profile. A new version is generated whenever
3585
- * the security profile is updated. If you specify a value that is different from the actual
3586
- * version, a <code>VersionConflictException</code> is thrown.</p>
3559
+ * <p>The expected version of the security profile. A new version is generated whenever the
3560
+ * security profile is updated. If you specify a value that is different from the actual version,
3561
+ * a <code>VersionConflictException</code> is thrown.</p>
3587
3562
  */
3588
3563
  expectedVersion?: number;
3564
+ /**
3565
+ * @public
3566
+ * <p>Specifies the MQTT topic and role ARN required for metric export.</p>
3567
+ */
3568
+ metricsExportConfig?: MetricsExportConfig;
3569
+ /**
3570
+ * @public
3571
+ * <p>Set the value as true to delete metrics export related configurations.</p>
3572
+ */
3573
+ deleteMetricsExportConfig?: boolean;
3589
3574
  }
3590
3575
  /**
3591
3576
  * @public
@@ -3608,7 +3593,8 @@ export interface UpdateSecurityProfileResponse {
3608
3593
  securityProfileDescription?: string;
3609
3594
  /**
3610
3595
  * @public
3611
- * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3596
+ * <p>Specifies the behaviors that, when violated by a device (thing), cause an
3597
+ * alert.</p>
3612
3598
  */
3613
3599
  behaviors?: Behavior[];
3614
3600
  /**
@@ -3621,20 +3607,19 @@ export interface UpdateSecurityProfileResponse {
3621
3607
  * @deprecated
3622
3608
  *
3623
3609
  * <p>
3624
- * <i>Please use
3625
- * <a>UpdateSecurityProfileResponse$additionalMetricsToRetainV2</a>
3626
- * instead.</i>
3610
+ * <i>Please use <a>UpdateSecurityProfileResponse$additionalMetricsToRetainV2</a>
3611
+ * instead.</i>
3627
3612
  * </p>
3628
- * <p>A list of metrics
3629
- * whose data is retained (stored). By default, data is retained for any metric
3630
- * used in the security profile's <code>behaviors</code>, but
3631
- * it is
3632
- * also retained for any metric specified here.</p>
3613
+ * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
3614
+ * metric used in the security profile's <code>behaviors</code>, but it is also retained for any
3615
+ * metric specified here.</p>
3633
3616
  */
3634
3617
  additionalMetricsToRetain?: string[];
3635
3618
  /**
3636
3619
  * @public
3637
- * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
3620
+ * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
3621
+ * metric used in the profile's behaviors, but it is also retained for any metric specified here.
3622
+ * Can be used with custom metrics; cannot be used with dimensions.</p>
3638
3623
  */
3639
3624
  additionalMetricsToRetainV2?: MetricToRetain[];
3640
3625
  /**
@@ -3652,6 +3637,11 @@ export interface UpdateSecurityProfileResponse {
3652
3637
  * <p>The time the security profile was last modified.</p>
3653
3638
  */
3654
3639
  lastModifiedDate?: Date;
3640
+ /**
3641
+ * @public
3642
+ * <p>Specifies the MQTT topic and role ARN required for metric export.</p>
3643
+ */
3644
+ metricsExportConfig?: MetricsExportConfig;
3655
3645
  }
3656
3646
  /**
3657
3647
  * @public
@@ -3872,7 +3862,8 @@ export interface UpdateTopicRuleDestinationResponse {
3872
3862
  export interface ValidateSecurityProfileBehaviorsRequest {
3873
3863
  /**
3874
3864
  * @public
3875
- * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
3865
+ * <p>Specifies the behaviors that, when violated by a device (thing), cause an
3866
+ * alert.</p>
3876
3867
  */
3877
3868
  behaviors: Behavior[] | undefined;
3878
3869
  }