feat(client-iot): This release reduces the maximum results returned p…

…er query invocation from 500 to 100 for the SearchIndex API. This change has no implications as long as the API is invoked until the nextToken is NULL.
aws · Feb 28, 2024 · 1ebc3aa · 1ebc3aa
1 parent 46e974e
commit 1ebc3aa
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 20 deletions.
diff --git a/clients/client-iot/src/models/models_0.ts b/clients/client-iot/src/models/models_0.ts
@@ -2332,7 +2332,10 @@ export interface AssociateTargetsWithJobRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;
@@ -5010,7 +5013,10 @@ export interface CreateJobRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;

diff --git a/clients/client-iot/src/models/models_1.ts b/clients/client-iot/src/models/models_1.ts
@@ -196,7 +196,10 @@ export interface DeleteJobRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;
@@ -249,7 +252,10 @@ export interface DeleteJobExecutionRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;
@@ -2498,7 +2504,10 @@ export interface Job {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;
@@ -6893,7 +6902,10 @@ export interface ListJobExecutionsForThingRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;
@@ -7010,7 +7022,9 @@ export interface ListJobsRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
+   *                 more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;

diff --git a/clients/client-iot/src/models/models_2.ts b/clients/client-iot/src/models/models_2.ts
@@ -2618,8 +2618,12 @@ export interface SearchIndexRequest {
 
   /**
    * @public
-   * <p>The maximum number of results to return per page at one time. The response might
-   *       contain fewer results but will never contain more.</p>
+   * <p>The maximum number of results to return per page at one time. This maximum number
+   *       cannot exceed 100. The response might contain fewer results but will never contain more. You
+   *       can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken">
+   *                <code>nextToken</code>
+   *             </a> to retrieve the next set of results until
+   *         <code>nextToken</code> returns <code>NULL</code>.</p>
    */
   maxResults?: number;
 
@@ -4129,7 +4133,10 @@ export interface UpdateJobRequest {
    *             <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
    *          </p>
    *          <note>
-   *             <p>The <code>namespaceId</code> feature is in public preview.</p>
+   *             <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
+   *                 this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
+   *                     up IoT Greengrass core devices.</a>
+   *             </p>
    *          </note>
    */
   namespaceId?: string;

diff --git a/codegen/sdk-codegen/aws-models/iot.json b/codegen/sdk-codegen/aws-models/iot.json
@@ -2787,7 +2787,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         }
@@ -7424,7 +7424,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>"
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>"
           }
         },
         "jobTemplateArn": {
@@ -10587,7 +10587,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         }
@@ -10618,7 +10618,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         }
@@ -19141,7 +19141,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>"
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>"
           }
         },
         "jobTemplateArn": {
@@ -22055,7 +22055,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         },
@@ -22266,7 +22266,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For\n                more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         }
@@ -29589,9 +29589,9 @@
           }
         },
         "maxResults": {
-          "target": "com.amazonaws.iot#QueryMaxResults",
+          "target": "com.amazonaws.iot#SearchQueryMaxResults",
           "traits": {
-            "smithy.api#documentation": "<p>The maximum number of results to return per page at one time. The response might\n      contain fewer results but will never contain more.</p>"
+            "smithy.api#documentation": "<p>The maximum number of results to return per page at one time. This maximum number\n      cannot exceed 100. The response might contain fewer results but will never contain more. You\n      can use <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken\">\n               <code>nextToken</code>\n            </a> to retrieve the next set of results until\n        <code>nextToken</code> returns <code>NULL</code>.</p>"
           }
         },
         "queryVersion": {
@@ -29631,6 +29631,14 @@
         "smithy.api#output": {}
       }
     },
+    "com.amazonaws.iot#SearchQueryMaxResults": {
+      "type": "integer",
+      "traits": {
+        "smithy.api#range": {
+          "min": 1
+        }
+      }
+    },
     "com.amazonaws.iot#SearchableAttributes": {
       "type": "list",
       "member": {
@@ -34470,7 +34478,7 @@
         "namespaceId": {
           "target": "com.amazonaws.iot#NamespaceId",
           "traits": {
-            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is in public preview.</p>\n         </note>",
+            "smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n         <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n            contain the value in the following format.</p>\n         <p>\n            <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n         </p>\n         <note>\n            <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at\n                this time. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html\">Setting\n                    up IoT Greengrass core devices.</a>\n            </p>\n         </note>",
             "smithy.api#httpQuery": "namespaceId"
           }
         },