@aws-sdk/client-iot 3.449.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 (53) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/protocols/Aws_restJson1.js +7 -0
  3. package/dist-es/protocols/Aws_restJson1.js +7 -0
  4. package/dist-types/commands/AttachSecurityProfileCommand.d.ts +1 -1
  5. package/dist-types/commands/CancelAuditMitigationActionsTaskCommand.d.ts +2 -3
  6. package/dist-types/commands/CancelAuditTaskCommand.d.ts +2 -1
  7. package/dist-types/commands/CancelDetectMitigationActionsTaskCommand.d.ts +1 -3
  8. package/dist-types/commands/CreateCustomMetricCommand.d.ts +1 -4
  9. package/dist-types/commands/CreateDimensionCommand.d.ts +4 -2
  10. package/dist-types/commands/CreateMitigationActionCommand.d.ts +4 -2
  11. package/dist-types/commands/CreateScheduledAuditCommand.d.ts +1 -2
  12. package/dist-types/commands/CreateSecurityProfileCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateThingGroupCommand.d.ts +3 -0
  14. package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +3 -2
  15. package/dist-types/commands/DeleteCustomMetricCommand.d.ts +4 -8
  16. package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +1 -2
  17. package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +3 -3
  18. package/dist-types/commands/DescribeAuditFindingCommand.d.ts +1 -3
  19. package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +3 -1
  20. package/dist-types/commands/DescribeCustomMetricCommand.d.ts +1 -3
  21. package/dist-types/commands/DescribeDetectMitigationActionsTaskCommand.d.ts +1 -3
  22. package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +6 -0
  23. package/dist-types/commands/DetachSecurityProfileCommand.d.ts +2 -1
  24. package/dist-types/commands/GetBehaviorModelTrainingSummariesCommand.d.ts +1 -3
  25. package/dist-types/commands/ListActiveViolationsCommand.d.ts +1 -0
  26. package/dist-types/commands/ListAuditFindingsCommand.d.ts +2 -2
  27. package/dist-types/commands/ListAuditMitigationActionsExecutionsCommand.d.ts +1 -2
  28. package/dist-types/commands/ListAuditTasksCommand.d.ts +2 -2
  29. package/dist-types/commands/ListCustomMetricsCommand.d.ts +1 -3
  30. package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +1 -3
  31. package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -3
  32. package/dist-types/commands/ListMetricValuesCommand.d.ts +2 -2
  33. package/dist-types/commands/ListPolicyVersionsCommand.d.ts +1 -2
  34. package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +6 -6
  35. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +4 -4
  36. package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +2 -1
  37. package/dist-types/commands/ListViolationEventsCommand.d.ts +4 -3
  38. package/dist-types/commands/StartDetectMitigationActionsTaskCommand.d.ts +1 -3
  39. package/dist-types/commands/UpdateAccountAuditConfigurationCommand.d.ts +3 -3
  40. package/dist-types/commands/UpdateCustomMetricCommand.d.ts +1 -2
  41. package/dist-types/commands/UpdateDimensionCommand.d.ts +2 -6
  42. package/dist-types/commands/UpdateScheduledAuditCommand.d.ts +2 -2
  43. package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +13 -0
  44. package/dist-types/commands/ValidateSecurityProfileBehaviorsCommand.d.ts +1 -0
  45. package/dist-types/models/models_0.d.ts +79 -73
  46. package/dist-types/models/models_1.d.ts +164 -203
  47. package/dist-types/models/models_2.d.ts +163 -172
  48. package/dist-types/ts3.4/commands/DeleteDynamicThingGroupCommand.d.ts +4 -2
  49. package/dist-types/ts3.4/commands/ListPolicyVersionsCommand.d.ts +4 -2
  50. package/dist-types/ts3.4/models/models_0.d.ts +7 -4
  51. package/dist-types/ts3.4/models/models_1.d.ts +6 -3
  52. package/dist-types/ts3.4/models/models_2.d.ts +7 -0
  53. package/package.json +35 -35
package/README.md CHANGED
@@ -178,7 +178,7 @@ try {
178
178
  const data = await client.send(command);
179
179
  // process data.
180
180
  } catch (error) {
181
- const { requestId, cfId, extendedRequestId } = error.$$metadata;
181
+ const { requestId, cfId, extendedRequestId } = error.$metadata;
182
182
  console.log({ requestId, cfId, extendedRequestId });
183
183
  /**
184
184
  * The keys within exceptions are also parsed.
@@ -986,6 +986,7 @@ const se_CreateSecurityProfileCommand = async (input, context) => {
986
986
  additionalMetricsToRetainV2: (_) => (0, smithy_client_1._json)(_),
987
987
  alertTargets: (_) => (0, smithy_client_1._json)(_),
988
988
  behaviors: (_) => se_Behaviors(_, context),
989
+ metricsExportConfig: (_) => (0, smithy_client_1._json)(_),
989
990
  securityProfileDescription: [],
990
991
  tags: (_) => (0, smithy_client_1._json)(_),
991
992
  }));
@@ -5425,6 +5426,8 @@ const se_UpdateSecurityProfileCommand = async (input, context) => {
5425
5426
  deleteAdditionalMetricsToRetain: [],
5426
5427
  deleteAlertTargets: [],
5427
5428
  deleteBehaviors: [],
5429
+ deleteMetricsExportConfig: [],
5430
+ metricsExportConfig: (_) => (0, smithy_client_1._json)(_),
5428
5431
  securityProfileDescription: [],
5429
5432
  }));
5430
5433
  return new protocol_http_1.HttpRequest({
@@ -10581,6 +10584,7 @@ const de_DescribeSecurityProfileCommand = async (output, context) => {
10581
10584
  behaviors: (_) => de_Behaviors(_, context),
10582
10585
  creationDate: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
10583
10586
  lastModifiedDate: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
10587
+ metricsExportConfig: smithy_client_1._json,
10584
10588
  securityProfileArn: smithy_client_1.expectString,
10585
10589
  securityProfileDescription: smithy_client_1.expectString,
10586
10590
  securityProfileName: smithy_client_1.expectString,
@@ -16832,6 +16836,7 @@ const de_UpdateSecurityProfileCommand = async (output, context) => {
16832
16836
  behaviors: (_) => de_Behaviors(_, context),
16833
16837
  creationDate: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
16834
16838
  lastModifiedDate: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
16839
+ metricsExportConfig: smithy_client_1._json,
16835
16840
  securityProfileArn: smithy_client_1.expectString,
16836
16841
  securityProfileDescription: smithy_client_1.expectString,
16837
16842
  securityProfileName: smithy_client_1.expectString,
@@ -17629,6 +17634,7 @@ const se_AwsJobExponentialRolloutRate = (input, context) => {
17629
17634
  const se_Behavior = (input, context) => {
17630
17635
  return (0, smithy_client_1.take)(input, {
17631
17636
  criteria: (_) => se_BehaviorCriteria(_, context),
17637
+ exportMetric: [],
17632
17638
  metric: [],
17633
17639
  metricDimension: smithy_client_1._json,
17634
17640
  name: [],
@@ -17889,6 +17895,7 @@ const de_AwsJobExponentialRolloutRate = (output, context) => {
17889
17895
  const de_Behavior = (output, context) => {
17890
17896
  return (0, smithy_client_1.take)(output, {
17891
17897
  criteria: (_) => de_BehaviorCriteria(_, context),
17898
+ exportMetric: smithy_client_1.expectBoolean,
17892
17899
  metric: smithy_client_1.expectString,
17893
17900
  metricDimension: smithy_client_1._json,
17894
17901
  name: smithy_client_1.expectString,
@@ -935,6 +935,7 @@ export const se_CreateSecurityProfileCommand = async (input, context) => {
935
935
  additionalMetricsToRetainV2: (_) => _json(_),
936
936
  alertTargets: (_) => _json(_),
937
937
  behaviors: (_) => se_Behaviors(_, context),
938
+ metricsExportConfig: (_) => _json(_),
938
939
  securityProfileDescription: [],
939
940
  tags: (_) => _json(_),
940
941
  }));
@@ -5170,6 +5171,8 @@ export const se_UpdateSecurityProfileCommand = async (input, context) => {
5170
5171
  deleteAdditionalMetricsToRetain: [],
5171
5172
  deleteAlertTargets: [],
5172
5173
  deleteBehaviors: [],
5174
+ deleteMetricsExportConfig: [],
5175
+ metricsExportConfig: (_) => _json(_),
5173
5176
  securityProfileDescription: [],
5174
5177
  }));
5175
5178
  return new __HttpRequest({
@@ -10212,6 +10215,7 @@ export const de_DescribeSecurityProfileCommand = async (output, context) => {
10212
10215
  behaviors: (_) => de_Behaviors(_, context),
10213
10216
  creationDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
10214
10217
  lastModifiedDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
10218
+ metricsExportConfig: _json,
10215
10219
  securityProfileArn: __expectString,
10216
10220
  securityProfileDescription: __expectString,
10217
10221
  securityProfileName: __expectString,
@@ -16327,6 +16331,7 @@ export const de_UpdateSecurityProfileCommand = async (output, context) => {
16327
16331
  behaviors: (_) => de_Behaviors(_, context),
16328
16332
  creationDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
16329
16333
  lastModifiedDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
16334
+ metricsExportConfig: _json,
16330
16335
  securityProfileArn: __expectString,
16331
16336
  securityProfileDescription: __expectString,
16332
16337
  securityProfileName: __expectString,
@@ -17117,6 +17122,7 @@ const se_AwsJobExponentialRolloutRate = (input, context) => {
17117
17122
  const se_Behavior = (input, context) => {
17118
17123
  return take(input, {
17119
17124
  criteria: (_) => se_BehaviorCriteria(_, context),
17125
+ exportMetric: [],
17120
17126
  metric: [],
17121
17127
  metricDimension: _json,
17122
17128
  name: [],
@@ -17377,6 +17383,7 @@ const de_AwsJobExponentialRolloutRate = (output, context) => {
17377
17383
  const de_Behavior = (output, context) => {
17378
17384
  return take(output, {
17379
17385
  criteria: (_) => de_BehaviorCriteria(_, context),
17386
+ exportMetric: __expectBoolean,
17380
17387
  metric: __expectString,
17381
17388
  metricDimension: _json,
17382
17389
  name: __expectString,
@@ -24,7 +24,7 @@ export interface AttachSecurityProfileCommandOutput extends AttachSecurityProfil
24
24
  /**
25
25
  * @public
26
26
  * <p>Associates a Device Defender security profile with a thing group or this account. Each
27
- * thing group or account can have up to five security profiles associated with it.</p>
27
+ * thing group or account can have up to five security profiles associated with it.</p>
28
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AttachSecurityProfile</a> action.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,8 @@ export interface CancelAuditMitigationActionsTaskCommandOutput extends CancelAud
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Cancels a mitigation action task that is in progress. If the task
27
- * is not
28
- * in progress, an InvalidRequestException occurs.</p>
26
+ * <p>Cancels a mitigation action task that is in progress. If the task is not in progress, an
27
+ * InvalidRequestException occurs.</p>
29
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditMitigationActionsTask</a> action.</p>
30
29
  * @example
31
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,8 @@ export interface CancelAuditTaskCommandOutput extends CancelAuditTaskResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.</p>
26
+ * <p>Cancels an audit that is in progress. The audit can be either scheduled or on demand. If
27
+ * the audit isn't in progress, an "InvalidRequestException" occurs.</p>
27
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditTask</a> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface CancelDetectMitigationActionsTaskCommandOutput extends CancelDe
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Cancels a Device Defender ML Detect mitigation action.
28
- * </p>
26
+ * <p> Cancels a Device Defender ML Detect mitigation action. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelDetectMitigationActionsTask</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,10 +23,7 @@ export interface CreateCustomMetricCommandOutput extends CreateCustomMetricRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Use this API to define a
27
- * Custom
28
- * Metric
29
- * published by your devices to Device Defender. </p>
26
+ * <p> Use this API to define a Custom Metric published by your devices to Device Defender. </p>
30
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateCustomMetric</a> action.</p>
31
28
  * @example
32
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,10 @@ export interface CreateDimensionCommandOutput extends CreateDimensionResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.
27
- * For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</p>
26
+ * <p>Create a dimension that you can use to limit the scope of a metric used in a security
27
+ * profile for IoT Device Defender. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow
28
+ * down the scope of the metric only to MQTT topics whose name match the pattern specified in the
29
+ * dimension.</p>
28
30
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateDimension</a> action.</p>
29
31
  * @example
30
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,10 @@ export interface CreateMitigationActionCommandOutput extends CreateMitigationAct
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names.
27
- * For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation actions</a>. Each mitigation action can apply only one type of change.</p>
26
+ * <p>Defines an action that can be applied to audit findings by using
27
+ * StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to
28
+ * specific check names. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation
29
+ * actions</a>. Each mitigation action can apply only one type of change.</p>
28
30
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateMitigationAction</a> action.</p>
29
31
  * @example
30
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,7 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates a scheduled audit that is run at a specified
27
- * time interval.</p>
26
+ * <p>Creates a scheduled audit that is run at a specified time interval.</p>
28
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateScheduledAudit</a> action.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -71,6 +71,7 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
71
71
  * },
72
72
  * },
73
73
  * suppressAlerts: true || false,
74
+ * exportMetric: true || false,
74
75
  * },
75
76
  * ],
76
77
  * alertTargets: { // AlertTargets
@@ -89,6 +90,7 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
89
90
  * dimensionName: "STRING_VALUE", // required
90
91
  * operator: "IN" || "NOT_IN",
91
92
  * },
93
+ * exportMetric: true || false,
92
94
  * },
93
95
  * ],
94
96
  * tags: [ // TagList
@@ -97,6 +99,10 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
97
99
  * Value: "STRING_VALUE",
98
100
  * },
99
101
  * ],
102
+ * metricsExportConfig: { // MetricsExportConfig
103
+ * mqttTopic: "STRING_VALUE", // required
104
+ * roleArn: "STRING_VALUE", // required
105
+ * },
100
106
  * };
101
107
  * const command = new CreateSecurityProfileCommand(input);
102
108
  * const response = await client.send(command);
@@ -27,6 +27,9 @@ export interface CreateThingGroupCommandOutput extends CreateThingGroupResponse,
27
27
  * <note>
28
28
  * <p>This is a control plane operation. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for
29
29
  * information about authorizing control plane actions.</p>
30
+ * <p>If the <code>ThingGroup</code> that you create has the exact same attributes as an existing
31
+ * <code>ThingGroup</code>, you will get a 200 success response.
32
+ * </p>
30
33
  * </note>
31
34
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateThingGroup</a> action.</p>
32
35
  * @example
@@ -24,8 +24,9 @@ export interface DeleteAccountAuditConfigurationCommandOutput extends DeleteAcco
24
24
  /**
25
25
  * @public
26
26
  * <p>Restores the default settings for Device Defender audits for this account. Any
27
- * configuration data you entered is deleted and all audit checks are reset to
28
- * disabled. </p>
27
+ * configuration data you entered is deleted and all audit checks are reset to disabled.
28
+ *
29
+ * </p>
29
30
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteAccountAuditConfiguration</a> action.</p>
30
31
  * @example
31
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,17 +23,13 @@ export interface DeleteCustomMetricCommandOutput extends DeleteCustomMetricRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Deletes a Device Defender detect custom metric.
28
- * </p>
26
+ * <p> Deletes a Device Defender detect custom metric. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteCustomMetric</a> action.</p>
30
28
  * <note>
31
29
  * <p>Before you can delete a custom metric, you must first remove the custom metric from all
32
- * security profiles it's a part of.
33
- * The
34
- * security
35
- * profile associated with the custom metric can be found using the <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html">ListSecurityProfiles</a>
36
- * API with <code>metricName</code> set to your custom metric name.</p>
30
+ * security profiles it's a part of. The security profile associated with the custom metric can
31
+ * be found using the <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html">ListSecurityProfiles</a>
32
+ * API with <code>metricName</code> set to your custom metric name.</p>
37
33
  * </note>
38
34
  * @example
39
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -2,8 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
2
  import { Command as $Command } from "@smithy/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
4
  import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
5
- import { DeleteDynamicThingGroupRequest } from "../models/models_0";
6
- import { DeleteDynamicThingGroupResponse } from "../models/models_1";
5
+ import { DeleteDynamicThingGroupRequest, DeleteDynamicThingGroupResponse } from "../models/models_1";
7
6
  /**
8
7
  * @public
9
8
  */
@@ -23,9 +23,9 @@ export interface DescribeAccountAuditConfigurationCommandOutput extends Describe
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Gets information about the Device Defender audit settings for this account.
27
- * Settings include how audit notifications are sent and which audit checks are
28
- * enabled or disabled.</p>
26
+ * <p>Gets information about the Device Defender audit settings for this account. Settings
27
+ * include how audit notifications are sent and which audit checks are enabled or
28
+ * disabled.</p>
29
29
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAccountAuditConfiguration</a> action.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,9 +24,7 @@ export interface DescribeAuditFindingCommandOutput extends DescribeAuditFindingR
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets information about a single audit finding. Properties include the reason for
27
- * noncompliance, the severity of the issue,
28
- * and the start time
29
- * when the audit that returned the
27
+ * noncompliance, the severity of the issue, and the start time when the audit that returned the
30
28
  * finding.</p>
31
29
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAuditFinding</a> action.</p>
32
30
  * @example
@@ -23,7 +23,9 @@ export interface DescribeAuditMitigationActionsTaskCommandOutput extends Describ
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.</p>
26
+ * <p>Gets information about an audit mitigation task that is used to apply mitigation actions
27
+ * to a set of audit findings. Properties include the actions being applied, the audit checks to
28
+ * which they're being applied, the task status, and aggregated task statistics.</p>
27
29
  * @example
28
30
  * Use a bare-bones client and the command you need to make an API call.
29
31
  * ```javascript
@@ -23,9 +23,7 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Gets information about a Device Defender detect custom metric.
28
- * </p>
26
+ * <p> Gets information about a Device Defender detect custom metric. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeCustomMetric</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput extends Descri
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Gets information about a Device Defender ML Detect mitigation action.
28
- * </p>
26
+ * <p> Gets information about a Device Defender ML Detect mitigation action. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeDetectMitigationActionsTask</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -77,6 +77,7 @@ export interface DescribeSecurityProfileCommandOutput extends DescribeSecurityPr
77
77
  * // },
78
78
  * // },
79
79
  * // suppressAlerts: true || false,
80
+ * // exportMetric: true || false,
80
81
  * // },
81
82
  * // ],
82
83
  * // alertTargets: { // AlertTargets
@@ -95,11 +96,16 @@ export interface DescribeSecurityProfileCommandOutput extends DescribeSecurityPr
95
96
  * // dimensionName: "STRING_VALUE", // required
96
97
  * // operator: "IN" || "NOT_IN",
97
98
  * // },
99
+ * // exportMetric: true || false,
98
100
  * // },
99
101
  * // ],
100
102
  * // version: Number("long"),
101
103
  * // creationDate: new Date("TIMESTAMP"),
102
104
  * // lastModifiedDate: new Date("TIMESTAMP"),
105
+ * // metricsExportConfig: { // MetricsExportConfig
106
+ * // mqttTopic: "STRING_VALUE", // required
107
+ * // roleArn: "STRING_VALUE", // required
108
+ * // },
103
109
  * // };
104
110
  *
105
111
  * ```
@@ -23,7 +23,8 @@ export interface DetachSecurityProfileCommandOutput extends DetachSecurityProfil
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Disassociates a Device Defender security profile from a thing group or from this account.</p>
26
+ * <p>Disassociates a Device Defender security profile from a thing group or from this
27
+ * account.</p>
27
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachSecurityProfile</a> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface GetBehaviorModelTrainingSummariesCommandOutput extends GetBehav
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Returns a Device Defender's ML Detect Security Profile training model's status.
28
- * </p>
26
+ * <p> Returns a Device Defender's ML Detect Security Profile training model's status. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetBehaviorModelTrainingSummaries</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -84,6 +84,7 @@ export interface ListActiveViolationsCommandOutput extends ListActiveViolationsR
84
84
  * // },
85
85
  * // },
86
86
  * // suppressAlerts: true || false,
87
+ * // exportMetric: true || false,
87
88
  * // },
88
89
  * // lastViolationValue: {
89
90
  * // count: Number("long"),
@@ -23,8 +23,8 @@ export interface ListAuditFindingsCommandOutput extends ListAuditFindingsRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the findings (results) of a Device Defender audit or of the audits
27
- * performed during a specified time period. (Findings are retained for 90 days.)</p>
26
+ * <p>Lists the findings (results) of a Device Defender audit or of the audits performed during
27
+ * a specified time period. (Findings are retained for 90 days.)</p>
28
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditFindings</a> action.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,7 @@ export interface ListAuditMitigationActionsExecutionsCommandOutput extends ListA
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Gets the status of audit mitigation action tasks that were
27
- * executed.</p>
26
+ * <p>Gets the status of audit mitigation action tasks that were executed.</p>
28
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditMitigationActionsExecutions</a> action.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,8 @@ export interface ListAuditTasksCommandOutput extends ListAuditTasksResponse, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the Device Defender audits that have been performed during a given
27
- * time period.</p>
26
+ * <p>Lists the Device Defender audits that have been performed during a given time
27
+ * period.</p>
28
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditTasks</a> action.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface ListCustomMetricsCommandOutput extends ListCustomMetricsRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Lists your Device Defender detect custom metrics.
28
- * </p>
26
+ * <p> Lists your Device Defender detect custom metrics. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListCustomMetrics</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface ListDetectMitigationActionsExecutionsCommandOutput extends List
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
28
- * </p>
26
+ * <p> Lists mitigation actions executions for a Device Defender ML Detect Security Profile. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsExecutions</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,7 @@ export interface ListDetectMitigationActionsTasksCommandOutput extends ListDetec
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * List of Device Defender ML Detect mitigation actions tasks.
28
- * </p>
26
+ * <p> List of Device Defender ML Detect mitigation actions tasks. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsTasks</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,8 +23,8 @@ export interface ListMetricValuesCommandOutput extends ListMetricValuesResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric)
27
- * by the given thing during the specified time period.</p>
26
+ * <p>Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric,
27
+ * or custom metric) by the given thing during the specified time period.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -2,8 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
2
  import { Command as $Command } from "@smithy/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
4
  import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
5
- import { ListPolicyVersionsRequest } from "../models/models_1";
6
- import { ListPolicyVersionsResponse } from "../models/models_2";
5
+ import { ListPolicyVersionsRequest, ListPolicyVersionsResponse } from "../models/models_2";
7
6
  /**
8
7
  * @public
9
8
  */
@@ -23,8 +23,8 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput extends ListRe
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>The related resources of an Audit finding.
27
- * The following resources can be returned from calling this API:</p>
26
+ * <p>The related resources of an Audit finding. The following resources can be returned from
27
+ * calling this API:</p>
28
28
  * <ul>
29
29
  * <li>
30
30
  * <p>DEVICE_CERTIFICATE</p>
@@ -55,10 +55,10 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput extends ListRe
55
55
  * </li>
56
56
  * </ul>
57
57
  * <note>
58
- * <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a>
59
- * but provides pagination and is not limited to 10 resources.
60
- * When calling <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">DescribeAuditFinding</a> for the intermediate CA revoked for
61
- * active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.</p>
58
+ * <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a> but
59
+ * provides pagination and is not limited to 10 resources. When calling <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">DescribeAuditFinding</a> for the intermediate CA revoked for active device
60
+ * certificates check, RelatedResources will not be populated. You must use this API,
61
+ * ListRelatedResourcesForAuditFinding, to list the certificates.</p>
62
62
  * </note>
63
63
  * @example
64
64
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,13 +23,13 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the Device Defender security profiles
27
- * you've
28
- * created. You can filter security profiles by dimension or custom metric.</p>
26
+ * <p>Lists the Device Defender security profiles you've created. You can filter security
27
+ * profiles by dimension or custom metric.</p>
29
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSecurityProfiles</a> action.</p>
30
29
  * <note>
31
30
  * <p>
32
- * <code>dimensionName</code> and <code>metricName</code> cannot be used in the same request.</p>
31
+ * <code>dimensionName</code> and <code>metricName</code> cannot be used in the same
32
+ * request.</p>
33
33
  * </note>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,8 @@ export interface ListTargetsForSecurityProfileCommandOutput extends ListTargetsF
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the targets (thing groups) associated with a given Device Defender security profile.</p>
26
+ * <p>Lists the targets (thing groups) associated with a given Device Defender security
27
+ * profile.</p>
27
28
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTargetsForSecurityProfile</a> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,9 +23,9 @@ export interface ListViolationEventsCommandOutput extends ListViolationEventsRes
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the Device Defender security profile violations discovered during the given time period.
27
- * You can use filters to limit the results to those alerts issued for a particular security profile,
28
- * behavior, or thing (device).</p>
26
+ * <p>Lists the Device Defender security profile violations discovered during the given time
27
+ * period. You can use filters to limit the results to those alerts issued for a particular
28
+ * security profile, behavior, or thing (device).</p>
29
29
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListViolationEvents</a> action.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -88,6 +88,7 @@ export interface ListViolationEventsCommandOutput extends ListViolationEventsRes
88
88
  * // },
89
89
  * // },
90
90
  * // suppressAlerts: true || false,
91
+ * // exportMetric: true || false,
91
92
  * // },
92
93
  * // metricValue: {
93
94
  * // count: Number("long"),
@@ -23,9 +23,7 @@ export interface StartDetectMitigationActionsTaskCommandOutput extends StartDete
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Starts a Device Defender ML Detect mitigation actions task.
28
- * </p>
26
+ * <p> Starts a Device Defender ML Detect mitigation actions task. </p>
29
27
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartDetectMitigationActionsTask</a> action.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.