Skip to content

Commit 1ebc3aa

Browse files
author
awstools
committed
feat(client-iot): This release reduces the maximum results returned per 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.
1 parent 46e974e commit 1ebc3aa

File tree

4 files changed

+55
-20
lines changed

4 files changed

+55
-20
lines changed

clients/client-iot/src/models/models_0.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -2332,7 +2332,10 @@ export interface AssociateTargetsWithJobRequest {
23322332
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
23332333
* </p>
23342334
* <note>
2335-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
2335+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
2336+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
2337+
* up IoT Greengrass core devices.</a>
2338+
* </p>
23362339
* </note>
23372340
*/
23382341
namespaceId?: string;
@@ -5010,7 +5013,10 @@ export interface CreateJobRequest {
50105013
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
50115014
* </p>
50125015
* <note>
5013-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
5016+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
5017+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
5018+
* up IoT Greengrass core devices.</a>
5019+
* </p>
50145020
* </note>
50155021
*/
50165022
namespaceId?: string;

clients/client-iot/src/models/models_1.ts

+19-5
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,10 @@ export interface DeleteJobRequest {
196196
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
197197
* </p>
198198
* <note>
199-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
199+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
200+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
201+
* up IoT Greengrass core devices.</a>
202+
* </p>
200203
* </note>
201204
*/
202205
namespaceId?: string;
@@ -249,7 +252,10 @@ export interface DeleteJobExecutionRequest {
249252
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
250253
* </p>
251254
* <note>
252-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
255+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
256+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
257+
* up IoT Greengrass core devices.</a>
258+
* </p>
253259
* </note>
254260
*/
255261
namespaceId?: string;
@@ -2498,7 +2504,10 @@ export interface Job {
24982504
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
24992505
* </p>
25002506
* <note>
2501-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
2507+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
2508+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
2509+
* up IoT Greengrass core devices.</a>
2510+
* </p>
25022511
* </note>
25032512
*/
25042513
namespaceId?: string;
@@ -6893,7 +6902,10 @@ export interface ListJobExecutionsForThingRequest {
68936902
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
68946903
* </p>
68956904
* <note>
6896-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
6905+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
6906+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
6907+
* up IoT Greengrass core devices.</a>
6908+
* </p>
68976909
* </note>
68986910
*/
68996911
namespaceId?: string;
@@ -7010,7 +7022,9 @@ export interface ListJobsRequest {
70107022
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
70117023
* </p>
70127024
* <note>
7013-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
7025+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
7026+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
7027+
* </p>
70147028
* </note>
70157029
*/
70167030
namespaceId?: string;

clients/client-iot/src/models/models_2.ts

+10-3
Original file line numberDiff line numberDiff line change
@@ -2618,8 +2618,12 @@ export interface SearchIndexRequest {
26182618

26192619
/**
26202620
* @public
2621-
* <p>The maximum number of results to return per page at one time. The response might
2622-
* contain fewer results but will never contain more.</p>
2621+
* <p>The maximum number of results to return per page at one time. This maximum number
2622+
* cannot exceed 100. The response might contain fewer results but will never contain more. You
2623+
* can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken">
2624+
* <code>nextToken</code>
2625+
* </a> to retrieve the next set of results until
2626+
* <code>nextToken</code> returns <code>NULL</code>.</p>
26232627
*/
26242628
maxResults?: number;
26252629

@@ -4129,7 +4133,10 @@ export interface UpdateJobRequest {
41294133
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
41304134
* </p>
41314135
* <note>
4132-
* <p>The <code>namespaceId</code> feature is in public preview.</p>
4136+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
4137+
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
4138+
* up IoT Greengrass core devices.</a>
4139+
* </p>
41334140
* </note>
41344141
*/
41354142
namespaceId?: string;

codegen/sdk-codegen/aws-models/iot.json

+18-10
Original file line numberDiff line numberDiff line change
@@ -2787,7 +2787,7 @@
27872787
"namespaceId": {
27882788
"target": "com.amazonaws.iot#NamespaceId",
27892789
"traits": {
2790-
"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>",
2790+
"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>",
27912791
"smithy.api#httpQuery": "namespaceId"
27922792
}
27932793
}
@@ -7424,7 +7424,7 @@
74247424
"namespaceId": {
74257425
"target": "com.amazonaws.iot#NamespaceId",
74267426
"traits": {
7427-
"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>"
7427+
"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>"
74287428
}
74297429
},
74307430
"jobTemplateArn": {
@@ -10587,7 +10587,7 @@
1058710587
"namespaceId": {
1058810588
"target": "com.amazonaws.iot#NamespaceId",
1058910589
"traits": {
10590-
"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>",
10590+
"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>",
1059110591
"smithy.api#httpQuery": "namespaceId"
1059210592
}
1059310593
}
@@ -10618,7 +10618,7 @@
1061810618
"namespaceId": {
1061910619
"target": "com.amazonaws.iot#NamespaceId",
1062010620
"traits": {
10621-
"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>",
10621+
"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>",
1062210622
"smithy.api#httpQuery": "namespaceId"
1062310623
}
1062410624
}
@@ -19141,7 +19141,7 @@
1914119141
"namespaceId": {
1914219142
"target": "com.amazonaws.iot#NamespaceId",
1914319143
"traits": {
19144-
"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>"
19144+
"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>"
1914519145
}
1914619146
},
1914719147
"jobTemplateArn": {
@@ -22055,7 +22055,7 @@
2205522055
"namespaceId": {
2205622056
"target": "com.amazonaws.iot#NamespaceId",
2205722057
"traits": {
22058-
"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>",
22058+
"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>",
2205922059
"smithy.api#httpQuery": "namespaceId"
2206022060
}
2206122061
},
@@ -22266,7 +22266,7 @@
2226622266
"namespaceId": {
2226722267
"target": "com.amazonaws.iot#NamespaceId",
2226822268
"traits": {
22269-
"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>",
22269+
"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>",
2227022270
"smithy.api#httpQuery": "namespaceId"
2227122271
}
2227222272
}
@@ -29589,9 +29589,9 @@
2958929589
}
2959029590
},
2959129591
"maxResults": {
29592-
"target": "com.amazonaws.iot#QueryMaxResults",
29592+
"target": "com.amazonaws.iot#SearchQueryMaxResults",
2959329593
"traits": {
29594-
"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>"
29594+
"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>"
2959529595
}
2959629596
},
2959729597
"queryVersion": {
@@ -29631,6 +29631,14 @@
2963129631
"smithy.api#output": {}
2963229632
}
2963329633
},
29634+
"com.amazonaws.iot#SearchQueryMaxResults": {
29635+
"type": "integer",
29636+
"traits": {
29637+
"smithy.api#range": {
29638+
"min": 1
29639+
}
29640+
}
29641+
},
2963429642
"com.amazonaws.iot#SearchableAttributes": {
2963529643
"type": "list",
2963629644
"member": {
@@ -34470,7 +34478,7 @@
3447034478
"namespaceId": {
3447134479
"target": "com.amazonaws.iot#NamespaceId",
3447234480
"traits": {
34473-
"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>",
34481+
"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>",
3447434482
"smithy.api#httpQuery": "namespaceId"
3447534483
}
3447634484
},

0 commit comments

Comments
 (0)