@aws-sdk/client-iot 3.450.0 → 3.451.0

package/dist-types/commands/UpdateCustomMetricCommand.d.ts

@@ -23,8 +23,7 @@ export interface UpdateCustomMetricCommandOutput extends UpdateCustomMetricRespo
 }
 /**
  * @public
- * <p>Updates a
- *       Device Defender detect custom metric. </p>
+ * <p>Updates a Device Defender detect custom metric. </p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateCustomMetric</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/UpdateDimensionCommand.d.ts

@@ -23,12 +23,8 @@ export interface UpdateDimensionCommandOutput extends UpdateDimensionResponse, _
 }
 /**
  * @public
- * <p>Updates the definition for a dimension. You
- *       cannot
- *       change the type of a dimension after
- *       it is created (you can delete it and
- *       recreate
- *       it).</p>
+ * <p>Updates the definition for a dimension. You cannot change the type of a dimension after it
+ *       is created (you can delete it and recreate it).</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDimension</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/UpdateScheduledAuditCommand.d.ts

@@ -23,8 +23,8 @@ export interface UpdateScheduledAuditCommandOutput extends UpdateScheduledAuditR
 }
 /**
  * @public
- * <p>Updates a scheduled audit, including which checks are performed and
- *           how often the audit takes place.</p>
+ * <p>Updates a scheduled audit, including which checks are performed and how often the audit
+ *       takes place.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateScheduledAudit</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/UpdateSecurityProfileCommand.d.ts

@@ -71,6 +71,7 @@ export interface UpdateSecurityProfileCommandOutput extends UpdateSecurityProfil
  *         },
  *       },
  *       suppressAlerts: true || false,
+ *       exportMetric: true || false,
  *     },
  *   ],
  *   alertTargets: { // AlertTargets
@@ -89,12 +90,18 @@ export interface UpdateSecurityProfileCommandOutput extends UpdateSecurityProfil
  *         dimensionName: "STRING_VALUE", // required
  *         operator: "IN" || "NOT_IN",
  *       },
+ *       exportMetric: true || false,
  *     },
  *   ],
  *   deleteBehaviors: true || false,
  *   deleteAlertTargets: true || false,
  *   deleteAdditionalMetricsToRetain: true || false,
  *   expectedVersion: Number("long"),
+ *   metricsExportConfig: { // MetricsExportConfig
+ *     mqttTopic: "STRING_VALUE", // required
+ *     roleArn: "STRING_VALUE", // required
+ *   },
+ *   deleteMetricsExportConfig: true || false,
  * };
  * const command = new UpdateSecurityProfileCommand(input);
  * const response = await client.send(command);
@@ -139,6 +146,7 @@ export interface UpdateSecurityProfileCommandOutput extends UpdateSecurityProfil
  * //         },
  * //       },
  * //       suppressAlerts: true || false,
+ * //       exportMetric: true || false,
  * //     },
  * //   ],
  * //   alertTargets: { // AlertTargets
@@ -157,11 +165,16 @@ export interface UpdateSecurityProfileCommandOutput extends UpdateSecurityProfil
  * //         dimensionName: "STRING_VALUE", // required
  * //         operator: "IN" || "NOT_IN",
  * //       },
+ * //       exportMetric: true || false,
  * //     },
  * //   ],
  * //   version: Number("long"),
  * //   creationDate: new Date("TIMESTAMP"),
  * //   lastModifiedDate: new Date("TIMESTAMP"),
+ * //   metricsExportConfig: { // MetricsExportConfig
+ * //     mqttTopic: "STRING_VALUE", // required
+ * //     roleArn: "STRING_VALUE", // required
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/ValidateSecurityProfileBehaviorsCommand.d.ts

@@ -69,6 +69,7 @@ export interface ValidateSecurityProfileBehaviorsCommandOutput extends ValidateS
  *         },
  *       },
  *       suppressAlerts: true || false,
+ *       exportMetric: true || false,
  *     },
  *   ],
  * };

package/dist-types/models/models_0.d.ts

@@ -1703,6 +1703,11 @@ export interface Behavior {
      *         </p>
      */
     suppressAlerts?: boolean;
+    /**
+     * @public
+     * <p>Value indicates exporting metrics related to the behavior when it is true.</p>
+     */
+    exportMetric?: boolean;
 }
 /**
  * @public
@@ -1806,6 +1811,12 @@ export interface MetricToRetain {
      * <p>The dimension of a metric. This can't be used with custom metrics.</p>
      */
     metricDimension?: MetricDimension;
+    /**
+     * @public
+     * <p>Value added in both Behavior and AdditionalMetricsToRetainV2 to indicate if Device
+     *             Defender Detect should export the corresponding metrics.</p>
+     */
+    exportMetric?: boolean;
 }
 /**
  * @public
@@ -2990,8 +3001,8 @@ export interface CancelAuditMitigationActionsTaskResponse {
 export interface CancelAuditTaskRequest {
     /**
      * @public
-     * <p>The ID of the audit you want to cancel. You can only cancel an
-     *               audit that is "IN_PROGRESS".</p>
+     * <p>The ID of the audit you want to cancel. You can only cancel an audit that is
+     *       "IN_PROGRESS".</p>
      */
     taskId: string | undefined;
 }
@@ -3018,9 +3029,7 @@ export interface CancelCertificateTransferRequest {
 export interface CancelDetectMitigationActionsTaskRequest {
     /**
      * @public
-     * <p>
-     *       The unique identifier of the task.
-     *     </p>
+     * <p> The unique identifier of the task. </p>
      */
     taskId: string | undefined;
 }
@@ -3482,18 +3491,14 @@ export interface CreateCustomMetricRequest {
     metricType: CustomMetricType | undefined;
     /**
      * @public
-     * <p>
-     *       Metadata that can be used to manage the custom metric.
-     *     </p>
+     * <p> Metadata that can be used to manage the custom metric. </p>
      */
     tags?: Tag[];
     /**
      * @public
-     * <p>Each custom
-     *       metric must have a unique client request token. If you try to create a new custom metric that
-     *       already exists with a different token,
-     *       an exception
-     *       occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. </p>
+     * <p>Each custom metric must have a unique client request token. If you try to create a new
+     *       custom metric that already exists with a different token, an exception occurs. If you omit
+     *       this value, Amazon Web Services SDKs will automatically generate a unique client request. </p>
      */
     clientRequestToken?: string;
 }
@@ -3503,9 +3508,7 @@ export interface CreateCustomMetricRequest {
 export interface CreateCustomMetricResponse {
     /**
      * @public
-     * <p>
-     *       The name of the custom metric to be used in the metric report.
-     *     </p>
+     * <p> The name of the custom metric to be used in the metric report. </p>
      */
     metricName?: string;
     /**
@@ -3534,7 +3537,8 @@ export type DimensionType = (typeof DimensionType)[keyof typeof DimensionType];
 export interface CreateDimensionRequest {
     /**
      * @public
-     * <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>
+     * <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>
      */
     name: string | undefined;
     /**
@@ -3545,7 +3549,8 @@ export interface CreateDimensionRequest {
     type: DimensionType | undefined;
     /**
      * @public
-     * <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>
+     * <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>
      */
     stringValues: string[] | undefined;
     /**
@@ -3555,8 +3560,9 @@ export interface CreateDimensionRequest {
     tags?: Tag[];
     /**
      * @public
-     * <p>Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs.
-     *       If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
+     * <p>Each dimension must have a unique client request token. If you try to create a new
+     *       dimension with the same token as a dimension that already exists, an exception occurs. If you
+     *       omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
      */
     clientRequestToken?: string;
 }
@@ -3571,10 +3577,7 @@ export interface CreateDimensionResponse {
     name?: string;
     /**
      * @public
-     * <p>The Amazon Resource Name
-     *       (ARN)
-     *       of
-     *       the created dimension.</p>
+     * <p>The Amazon Resource Name (ARN) of the created dimension.</p>
      */
     arn?: string;
 }
@@ -4611,7 +4614,8 @@ export interface MitigationActionParams {
 export interface CreateMitigationActionRequest {
     /**
      * @public
-     * <p>A friendly name for the action. Choose a friendly name that accurately describes the action (for example, <code>EnableLoggingAction</code>).</p>
+     * <p>A friendly name for the action. Choose a friendly name that accurately describes the
+     *       action (for example, <code>EnableLoggingAction</code>).</p>
      */
     actionName: string | undefined;
     /**
@@ -5738,41 +5742,33 @@ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
 export interface CreateScheduledAuditRequest {
     /**
      * @public
-     * <p>How often the scheduled audit takes
-     *       place, either
-     *       <code>DAILY</code>,
-     *       <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is
-     *       determined by the system.</p>
+     * <p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>,
+     *         <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is determined by
+     *       the system.</p>
      */
     frequency: AuditFrequency | undefined;
     /**
      * @public
-     * <p>The day of the month on which the scheduled audit takes place.
-     *       This
-     *       can be "1" through "31" or "LAST". This field is required if the "frequency"
-     *       parameter is set to <code>MONTHLY</code>. If days
-     *       29
-     *       to 31 are specified, and the month
-     *       doesn't
-     *       have that many days, the audit takes place on the <code>LAST</code> day of the month.</p>
+     * <p>The day of the month on which the scheduled audit takes place. This can be "1" through
+     *       "31" or "LAST". This field is required if the "frequency" parameter is set to
+     *         <code>MONTHLY</code>. If days 29 to 31 are specified, and the month doesn't have that many
+     *       days, the audit takes place on the <code>LAST</code> day of the month.</p>
      */
     dayOfMonth?: string;
     /**
      * @public
-     * <p>The day of the week on which the scheduled audit takes
-     *       place,
-     *       either
-     *       <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 <code>frequency</code>
-     *       parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
+     * <p>The day of the week on which the scheduled audit takes place, either <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 <code>frequency</code> parameter is set to
+     *         <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
      */
     dayOfWeek?: DayOfWeek;
     /**
      * @public
-     * <p>Which checks are performed during the scheduled audit. Checks must be enabled
-     *             for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
-     *             of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
-     *             to select which checks are enabled.)</p>
+     * <p>Which checks are performed during the scheduled audit. Checks must be enabled for your
+     *       account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks,
+     *       including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select
+     *       which checks are enabled.)</p>
      */
     targetCheckNames: string[] | undefined;
     /**
@@ -5796,6 +5792,24 @@ export interface CreateScheduledAuditResponse {
      */
     scheduledAuditArn?: string;
 }
+/**
+ * @public
+ * <p>Set configurations for metrics export.</p>
+ */
+export interface MetricsExportConfig {
+    /**
+     * @public
+     * <p>The MQTT topic that Device Defender Detect should publish messages to for metrics
+     *       export.</p>
+     */
+    mqttTopic: string | undefined;
+    /**
+     * @public
+     * <p>This role ARN has permission to publish MQTT messages, after which Device Defender Detect
+     *       can assume the role and publish messages on your behalf.</p>
+     */
+    roleArn: string | undefined;
+}
 /**
  * @public
  */
@@ -5812,13 +5826,14 @@ export interface CreateSecurityProfileRequest {
     securityProfileDescription?: string;
     /**
      * @public
-     * <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
+     * <p>Specifies the behaviors that, when violated by a device (thing), cause an
+     *       alert.</p>
      */
     behaviors?: Behavior[];
     /**
      * @public
      * <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the
-     *         console.) Alerts are generated when a device (thing) violates a behavior.</p>
+     *       console.) Alerts are generated when a device (thing) violates a behavior.</p>
      */
     alertTargets?: Partial<Record<AlertTargetType, AlertTarget>>;
     /**
@@ -5826,16 +5841,19 @@ export interface CreateSecurityProfileRequest {
      * @deprecated
      *
      * <p>
-     *             <i>Please use <a>CreateSecurityProfileRequest$additionalMetricsToRetainV2</a> instead.</i>
+     *             <i>Please use <a>CreateSecurityProfileRequest$additionalMetricsToRetainV2</a>
+     *       instead.</i>
      *          </p>
-     *          <p>A list of metrics whose data is retained (stored). By default, data is retained
-     *         for any metric used in the profile's <code>behaviors</code>, but it is also retained for
-     *         any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
+     *          <p>A list of metrics whose data is retained (stored). By default, data is retained for any
+     *       metric used in the profile's <code>behaviors</code>, but it is also retained for any metric
+     *       specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
      */
     additionalMetricsToRetain?: string[];
     /**
      * @public
-     * <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
+     * <p>A list of metrics whose data is retained (stored). By default, data is retained for any
+     *       metric used in the profile's <code>behaviors</code>, but it is also retained for any metric
+     *       specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
      */
     additionalMetricsToRetainV2?: MetricToRetain[];
     /**
@@ -5843,6 +5861,11 @@ export interface CreateSecurityProfileRequest {
      * <p>Metadata that can be used to manage the security profile.</p>
      */
     tags?: Tag[];
+    /**
+     * @public
+     * <p>Specifies the MQTT topic and role ARN required for metric export.</p>
+     */
+    metricsExportConfig?: MetricsExportConfig;
 }
 /**
  * @public
@@ -6508,9 +6531,7 @@ export interface DeleteCertificateRequest {
 export interface DeleteCustomMetricRequest {
     /**
      * @public
-     * <p>
-     *       The name of the custom metric.
-     *     </p>
+     * <p> The name of the custom metric. </p>
      */
     metricName: string | undefined;
 }
@@ -6549,21 +6570,6 @@ export interface DeleteDomainConfigurationRequest {
  */
 export interface DeleteDomainConfigurationResponse {
 }
-/**
- * @public
- */
-export interface DeleteDynamicThingGroupRequest {
-    /**
-     * @public
-     * <p>The name of the dynamic thing group to delete.</p>
-     */
-    thingGroupName: string | undefined;
-    /**
-     * @public
-     * <p>The expected version of the dynamic thing group to delete.</p>
-     */
-    expectedVersion?: number;
-}
 /**
  * @internal
  */