@aws-sdk/client-iot 3.451.0 → 3.453.0

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

@@ -3001,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;
 }
@@ -3029,7 +3029,9 @@ 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;
 }
@@ -3491,14 +3493,18 @@ 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;
 }
@@ -3508,7 +3514,9 @@ 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;
     /**
@@ -3537,8 +3545,7 @@ 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;
     /**
@@ -3549,8 +3556,7 @@ 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;
     /**
@@ -3560,9 +3566,8 @@ 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;
 }
@@ -3577,7 +3582,10 @@ 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;
 }
@@ -4272,8 +4280,8 @@ export interface CreateJobRequest {
      * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
      *         job successfully completes. </p>
      *          <p>
-     *             <b>Note:</b>The following Length Constraints relates to a single string.
-     *         Up to five strings are allowed.</p>
+     *             <b>Note:</b>The following Length Constraints relates to a single ARN.
+     *         Up to 25  package version ARNs are allowed.</p>
      */
     destinationPackageVersions?: string[];
 }
@@ -4387,10 +4395,11 @@ export interface CreateJobTemplateRequest {
     maintenanceWindows?: MaintenanceWindow[];
     /**
      * @public
-     * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
+     * <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
+     *             job successfully completes. </p>
      *          <p>
-     *             <b>Note:</b>The following Length Constraints relates to a single string.
-     *         Up to five strings are allowed.</p>
+     *             <b>Note:</b>The following Length Constraints relates to a single ARN.
+     *             Up to 25  package version ARNs are allowed.</p>
      */
     destinationPackageVersions?: string[];
 }
@@ -4614,8 +4623,7 @@ 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;
     /**
@@ -5742,33 +5750,41 @@ 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;
     /**
@@ -5826,14 +5842,13 @@ 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>>;
     /**
@@ -5841,19 +5856,16 @@ 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[];
     /**
@@ -6531,7 +6543,9 @@ 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;
 }