@aws-sdk/client-iot 3.58.0 → 3.60.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.60.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.59.0...v3.60.0) (2022-03-30)
+
+**Note:** Version bump only for package @aws-sdk/client-iot
+
+
+
+
+
 # [3.58.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.57.0...v3.58.0) (2022-03-28)
 
 **Note:** Version bump only for package @aws-sdk/client-iot

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

@@ -3165,24 +3165,24 @@ export declare enum CustomMetricType {
 }
 export interface CreateCustomMetricRequest {
     /**
-     * <p> The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with <code>aws:</code>.
-     *       Cannot be updated
-     *       once defined.</p>
+     * <p> The name of the custom metric. This will be used in the metric report submitted from the
+     *       device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you
+     *       define it.</p>
      */
     metricName: string | undefined;
     /**
-     * <p>
-     *       Field
-     *       represents a friendly name in the console for the custom metric;
-     *       it
-     *       doesn't have to be unique. Don't use this name as the metric identifier in
-     *       the device metric report. Can be updated once defined.</p>
+     * <p> The friendly name in the console for the custom metric. This name doesn't have to be
+     *       unique. Don't use this name as the metric identifier in the device metric report. You can
+     *       update the friendly name after you define it.</p>
      */
     displayName?: string;
     /**
-     * <p>
-     *       The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>.
-     *     </p>
+     * <p> The type of the custom metric. </p>
+     *          <important>
+     *             <p>The type <code>number</code> only takes a single metric value as an input, but when you
+     *         submit the metrics value in the DeviceMetrics report, you must pass it as an array with a
+     *         single value.</p>
+     *          </important>
      */
     metricType: CustomMetricType | string | undefined;
     /**
@@ -3214,8 +3214,8 @@ export interface CreateCustomMetricResponse {
      */
     metricName?: string;
     /**
-     * <p>
-     *       The Amazon Resource Number (ARN) of the custom metric, e.g. <code>arn:<i>aws-partition</i>:iot:<i>region</i>:<i>accountId</i>:custommetric/<i>metricName</i>
+     * <p> The Amazon Resource Number (ARN) of the custom metric. For example,
+     *           <code>arn:<i>aws-partition</i>:iot:<i>region</i>:<i>accountId</i>:custommetric/<i>metricName</i>
      *             </code>
      *          </p>
      */
@@ -4375,11 +4375,11 @@ export interface CustomCodeSigning {
      */
     certificateChain?: CodeSigningCertificateChain;
     /**
-     * <p>The hash algorithm used to code sign the file.</p>
+     * <p>The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>SHA256</code> or <code>SHA1</code>, so you can pass either of them based on which was used for generating the signature.</p>
      */
     hashAlgorithm?: string;
     /**
-     * <p>The signature algorithm used to code sign the file.</p>
+     * <p>The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>ECDSA</code> or <code>RSA</code>, so you can pass either of them based on which was used for generating the signature.</p>
      */
     signatureAlgorithm?: string;
 }
@@ -5014,6 +5014,8 @@ export interface CreateRoleAliasRequest {
     roleArn: string | undefined;
     /**
      * <p>How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.</p>
+     *          <p>This value must be less than or equal to the maximum session duration of the IAM role
+     *       that the role alias references.</p>
      */
     credentialDurationSeconds?: number;
     /**

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

@@ -906,9 +906,10 @@ export interface DescribeCustomMetricResponse {
      */
     metricArn?: string;
     /**
-     * <p>
-     *       The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>.
-     *     </p>
+     * <p> The type of the custom metric. </p>
+     *          <important>
+     *             <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>
+     *          </important>
      */
     metricType?: CustomMetricType | string;
     /**

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

@@ -803,6 +803,8 @@ export interface RegisterCACertificateRequest {
     verificationCertificate: string | undefined;
     /**
      * <p>A boolean value that specifies if the CA certificate is set to active.</p>
+     *          <p>Valid values: <code>ACTIVE | INACTIVE</code>
+     *          </p>
      */
     setAsActive?: boolean;
     /**
@@ -891,10 +893,13 @@ export interface RegisterCertificateRequest {
      * @deprecated
      *
      * <p>A boolean value that specifies if the certificate is set to active.</p>
+     *          <p>Valid values: <code>ACTIVE | INACTIVE</code>
+     *          </p>
      */
     setAsActive?: boolean;
     /**
-     * <p>The status of the register certificate request.</p>
+     * <p>The status of the register certificate request. Valid values that you can use include
+     *          <code>ACTIVE</code>, <code>INACTIVE</code>, and <code>REVOKED</code>.</p>
      */
     status?: CertificateStatus | string;
 }
@@ -2142,9 +2147,10 @@ export interface UpdateCustomMetricResponse {
      */
     metricArn?: string;
     /**
-     * <p>
-     *       The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>.
-     *     </p>
+     * <p> The type of the custom metric. </p>
+     *          <important>
+     *             <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>
+     *          </important>
      */
     metricType?: CustomMetricType | string;
     /**
@@ -2552,6 +2558,8 @@ export interface UpdateRoleAliasRequest {
     roleArn?: string;
     /**
      * <p>The number of seconds the credential will be valid.</p>
+     *          <p>This value must be less than or equal to the maximum session duration of the IAM role
+     *          that the role alias references.</p>
      */
     credentialDurationSeconds?: number;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iot",
   "description": "AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native",
-  "version": "3.58.0",
+  "version": "3.60.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",