@aws-sdk/client-iot 3.87.0 → 3.90.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.90.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.89.0...v3.90.0) (2022-05-12)
+
+**Note:** Version bump only for package @aws-sdk/client-iot
+
+
+
+
+
 # [3.87.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.86.0...v3.87.0) (2022-05-09)
 
 **Note:** Version bump only for package @aws-sdk/client-iot

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

@@ -3770,6 +3770,11 @@ export interface CreateJobRequest {
      *             specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
      *             when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
      *             target group, even after the job was completed by all things originally in the group.</p>
+     *         <note>
+     *             <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
+     *                 By using continuous jobs, devices that join the group receive the job execution even after the job has
+     *                 been created.</p>
+     *         </note>
      */
     targetSelection?: TargetSelection | string;
     /**
@@ -3812,7 +3817,13 @@ export interface CreateJobRequest {
      */
     jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
     /**
-     * <p>Parameters of a managed template that you can specify to create the job document.</p>
+     * <p>Parameters of an Amazon Web Services managed template that you can specify to create the job document.</p>
+     *         <note>
+     *             <p>
+     *                <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
+     *                 managed templates. This parameter can't be used with custom job templates or to
+     *                 create jobs from them.</p>
+     *         </note>
      */
     documentParameters?: {
         [key: string]: string;
@@ -4375,11 +4386,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;
 }

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

@@ -1622,6 +1622,11 @@ export interface Job {
      *             when a change is detected in a target. For example, a job will run on a device when the thing representing
      *             the device is added to a target group, even after the job was completed by all things originally in the
      *             group. </p>
+     *         <note>
+     *             <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
+     *                 By using continuous jobs, devices that join the group receive the job execution even after the job has
+     *                 been created.</p>
+     *         </note>
      */
     targetSelection?: TargetSelection | string;
     /**
@@ -1709,6 +1714,12 @@ export interface Job {
      * <p>A key-value map that pairs the patterns that need to be replaced in a managed
      *             template job document schema. You can use the description of each key as a guidance
      *             to specify the inputs during runtime when creating a job.</p>
+     *         <note>
+     *             <p>
+     *                <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
+     *                 managed templates. This parameter can't be used with custom job templates or to
+     *                 create jobs from them.</p>
+     *         </note>
      */
     documentParameters?: {
         [key: string]: string;
@@ -1949,6 +1960,12 @@ export declare namespace DescribeManagedJobTemplateRequest {
  * <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
  *             template job document schema. You can use the description of each key as a guidance to specify
  *             the inputs during runtime when creating a job.</p>
+ *         <note>
+ *             <p>
+ *                <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
+ *                 managed templates. This parameter can't be used with custom job templates or to
+ *                 create jobs from them.</p>
+ *         </note>
  */
 export interface DocumentParameter {
     /**
@@ -2007,6 +2024,12 @@ export interface DescribeManagedJobTemplateResponse {
     /**
      * <p>A map of key-value pairs that you can use as guidance to specify the inputs for creating
      *             a job from a managed template.</p>
+     *         <note>
+     *             <p>
+     *                <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
+     *                 managed templates. This parameter can't be used with custom job templates or to
+     *                 create jobs from them.</p>
+     *         </note>
      */
     documentParameters?: DocumentParameter[];
     /**
@@ -5235,6 +5258,11 @@ export interface ListJobsRequest {
      *             specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
      *             when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
      *             target group, even after the job was completed by all things originally in the group. </p>
+     *         <note>
+     *             <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
+     *                 By using continuous jobs, devices that join the group receive the job execution even after the job has
+     *                 been created.</p>
+     *         </note>
      */
     targetSelection?: TargetSelection | string;
     /**
@@ -5293,6 +5321,11 @@ export interface JobSummary {
      *             specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
      *             when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
      *             target group, even after the job was completed by all things originally in the group.</p>
+     *         <note>
+     *             <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
+     *                 By using continuous jobs, devices that join the group receive the job execution even after the job has
+     *                 been created.</p>
+     *         </note>
      */
     targetSelection?: TargetSelection | string;
     /**

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.87.0",
+  "version": "3.90.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",