Skip to content

Commit ef2e181

Browse files
author
awstools
committed
docs(client-resource-explorer-2): Documentation-only update for CreateView option correction
1 parent 7c92ddd commit ef2e181

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

clients/client-resource-explorer-2/src/models/models_0.ts

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ export interface IncludedProperty {
243243
* <ul>
244244
* <li>
245245
* <p>
246-
* <code>Tags</code>
246+
* <code>tags</code>
247247
* </p>
248248
* </li>
249249
* </ul>
@@ -1304,8 +1304,20 @@ export interface ListManagedViewsOutput {
13041304
*/
13051305
export interface ListResourcesInput {
13061306
/**
1307-
* <p>A search filter defines which resources can be part of a search query result
1308-
* set.</p>
1307+
* <p>An array of strings that specify which resources are included in the results of
1308+
* queries made using this view. When you use this view in a <a>Search</a>
1309+
* operation, the filter string is combined with the search's <code>QueryString</code>
1310+
* parameter using a logical <code>AND</code> operator.</p>
1311+
* <p>For information about the supported syntax, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query reference for
1312+
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
1313+
* <important>
1314+
* <p>This query string in the context of this operation supports only <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters">filter
1315+
* prefixes</a> with optional <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators">operators</a>. It doesn't support free-form text. For example, the
1316+
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
1317+
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
1318+
* <i>not</i> tagged with a key <code>Stage</code> that has the value
1319+
* <code>prod</code>.</p>
1320+
* </important>
13091321
* @public
13101322
*/
13111323
Filters?: SearchFilter | undefined;
@@ -1342,6 +1354,10 @@ export interface ListResourcesInput {
13421354
* indicates that more output is available. Set this parameter to the value of the previous
13431355
* call's <code>NextToken</code> response to indicate where the output should continue
13441356
* from. The pagination tokens expire after 24 hours.</p>
1357+
* <note>
1358+
* <p>The <code>ListResources</code> operation
1359+
* does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p>
1360+
* </note>
13451361
* @public
13461362
*/
13471363
NextToken?: string | undefined;

codegen/sdk-codegen/aws-models/resource-explorer-2.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -952,7 +952,7 @@
952952
"Name": {
953953
"target": "smithy.api#String",
954954
"traits": {
955-
"smithy.api#documentation": "<p>The name of the property that is included in this view.</p>\n <p>You can specify the following property names for this field:</p>\n <ul>\n <li>\n <p>\n <code>Tags</code>\n </p>\n </li>\n </ul>",
955+
"smithy.api#documentation": "<p>The name of the property that is included in this view.</p>\n <p>You can specify the following property names for this field:</p>\n <ul>\n <li>\n <p>\n <code>tags</code>\n </p>\n </li>\n </ul>",
956956
"smithy.api#length": {
957957
"min": 1,
958958
"max": 1011
@@ -1400,7 +1400,10 @@
14001400
"type": "structure",
14011401
"members": {
14021402
"Filters": {
1403-
"target": "com.amazonaws.resourceexplorer2#SearchFilter"
1403+
"target": "com.amazonaws.resourceexplorer2#SearchFilter",
1404+
"traits": {
1405+
"smithy.api#documentation": "<p>An array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a <a>Search</a> \n operation, the filter string is combined with the search's <code>QueryString</code> \n parameter using a logical <code>AND</code> operator.</p>\n <p>For information about the supported syntax, see <a href=\"https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html\">Search query reference for\n Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>\n <important>\n <p>This query string in the context of this operation supports only <a href=\"https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters\">filter\n prefixes</a> with optional <a href=\"https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators\">operators</a>. It doesn't support free-form text. For example, the \n string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is\n <i>not</i> tagged with a key <code>Stage</code> that has the value\n <code>prod</code>.</p>\n </important>"
1406+
}
14041407
},
14051408
"MaxResults": {
14061409
"target": "smithy.api#Integer",
@@ -1425,7 +1428,7 @@
14251428
"NextToken": {
14261429
"target": "smithy.api#String",
14271430
"traits": {
1428-
"smithy.api#documentation": "<p>The parameter for receiving additional results if you receive a \n <code>NextToken</code> response in a previous request. A <code>NextToken</code> response \n indicates that more output is available. Set this parameter to the value of the previous \n call's <code>NextToken</code> response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.</p>",
1431+
"smithy.api#documentation": "<p>The parameter for receiving additional results if you receive a \n <code>NextToken</code> response in a previous request. A <code>NextToken</code> response \n indicates that more output is available. Set this parameter to the value of the previous \n call's <code>NextToken</code> response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.</p>\n <note>\n <p>The <code>ListResources</code> operation \n does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p>\n </note>",
14291432
"smithy.api#length": {
14301433
"min": 1,
14311434
"max": 2048

0 commit comments

Comments
 (0)