Skip to content

Commit 189cd02

Browse files
Documentation-only update for CreateView option correction
1 parent 40c3c81 commit 189cd02

File tree

4 files changed

+39
-8
lines changed

4 files changed

+39
-8
lines changed

generator/ServiceModels/resource-explorer-2/resource-explorer-2-2022-07-28.docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@
229229
"IncludedPropertyNameString": {
230230
"base": null,
231231
"refs": {
232-
"IncludedProperty$Name": "<p>The name of the property that is included in this view.</p> <p>You can specify the following property names for this field:</p> <ul> <li> <p> <code>Tags</code> </p> </li> </ul>"
232+
"IncludedProperty$Name": "<p>The name of the property that is included in this view.</p> <p>You can specify the following property names for this field:</p> <ul> <li> <p> <code>tags</code> </p> </li> </ul>"
233233
}
234234
},
235235
"Index": {
@@ -367,7 +367,7 @@
367367
"ListResourcesInputNextTokenString": {
368368
"base": null,
369369
"refs": {
370-
"ListResourcesInput$NextToken": "<p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p>"
370+
"ListResourcesInput$NextToken": "<p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p> <note> <p>The <code>ListResources</code> operation does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p> </note>"
371371
}
372372
},
373373
"ListResourcesInputViewArnString": {
@@ -530,7 +530,7 @@
530530
"base": "<p>A search filter defines which resources can be part of a search query result set.</p>",
531531
"refs": {
532532
"CreateViewInput$Filters": "<p>An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a <a>Search</a> operation, the filter string is combined with the search's <code>QueryString</code> parameter using a logical <code>AND</code> operator.</p> <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 Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p> <important> <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 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 string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is <i>not</i> tagged with a key <code>Stage</code> that has the value <code>prod</code>.</p> </important>",
533-
"ListResourcesInput$Filters": null,
533+
"ListResourcesInput$Filters": "<p>An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a <a>Search</a> operation, the filter string is combined with the search's <code>QueryString</code> parameter using a logical <code>AND</code> operator.</p> <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 Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p> <important> <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 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 string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is <i>not</i> tagged with a key <code>Stage</code> that has the value <code>prod</code>.</p> </important>",
534534
"ManagedView$Filters": null,
535535
"UpdateViewInput$Filters": "<p>An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a <a>Search</a> operation, the filter string is combined with the search's <code>QueryString</code> parameter using a logical <code>AND</code> operator.</p> <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 Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p> <important> <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 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 string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is <i>not</i> tagged with a key <code>Stage</code> that has the value <code>prod</code>.</p> </important>",
536536
"View$Filters": "<p>An array of <a>SearchFilter</a> objects that specify which resources can be included in the results of queries made using this view.</p>"

generator/ServiceModels/resource-explorer-2/resource-explorer-2-2022-07-28.normal.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@
823823
"members":{
824824
"Name":{
825825
"shape":"IncludedPropertyNameString",
826-
"documentation":"<p>The name of the property that is included in this view.</p> <p>You can specify the following property names for this field:</p> <ul> <li> <p> <code>Tags</code> </p> </li> </ul>"
826+
"documentation":"<p>The name of the property that is included in this view.</p> <p>You can specify the following property names for this field:</p> <ul> <li> <p> <code>tags</code> </p> </li> </ul>"
827827
}
828828
},
829829
"documentation":"<p>Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.</p>"
@@ -1034,14 +1034,17 @@
10341034
"ListResourcesInput":{
10351035
"type":"structure",
10361036
"members":{
1037-
"Filters":{"shape":"SearchFilter"},
1037+
"Filters":{
1038+
"shape":"SearchFilter",
1039+
"documentation":"<p>An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a <a>Search</a> operation, the filter string is combined with the search's <code>QueryString</code> parameter using a logical <code>AND</code> operator.</p> <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 Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p> <important> <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 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 string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is <i>not</i> tagged with a key <code>Stage</code> that has the value <code>prod</code>.</p> </important>"
1040+
},
10381041
"MaxResults":{
10391042
"shape":"ListResourcesInputMaxResultsInteger",
10401043
"documentation":"<p>The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results.</p> <note> <p>An API operation can return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> </note>"
10411044
},
10421045
"NextToken":{
10431046
"shape":"ListResourcesInputNextTokenString",
1044-
"documentation":"<p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p>"
1047+
"documentation":"<p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p> <note> <p>The <code>ListResources</code> operation does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p> </note>"
10451048
},
10461049
"ViewArn":{
10471050
"shape":"ListResourcesInputViewArnString",

sdk/src/Services/ResourceExplorer2/Generated/Model/IncludedProperty.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public partial class IncludedProperty
4949
/// </para>
5050
/// <ul> <li>
5151
/// <para>
52-
/// <c>Tags</c>
52+
/// <c>tags</c>
5353
/// </para>
5454
/// </li> </ul>
5555
/// </summary>

sdk/src/Services/ResourceExplorer2/Generated/Model/ListResourcesRequest.cs

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,29 @@ public partial class ListResourcesRequest : AmazonResourceExplorer2Request
4343
private string _viewArn;
4444

4545
/// <summary>
46-
/// Gets and sets the property Filters.
46+
/// Gets and sets the property Filters.
47+
/// <para>
48+
/// An array of strings that specify which resources are included in the results of queries
49+
/// made using this view. When you use this view in a <a>Search</a> operation, the filter
50+
/// string is combined with the search's <c>QueryString</c> parameter using a logical
51+
/// <c>AND</c> operator.
52+
/// </para>
53+
///
54+
/// <para>
55+
/// For information about the supported syntax, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search
56+
/// query reference for Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer
57+
/// User Guide</i>.
58+
/// </para>
59+
/// <important>
60+
/// <para>
61+
/// 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
62+
/// 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>.
63+
/// It doesn't support free-form text. For example, the string <c>region:us* service:ec2
64+
/// -tag:stage=prod</c> includes all Amazon EC2 resources in any Amazon Web Services Region
65+
/// that begins with the letters <c>us</c> and is <i>not</i> tagged with a key <c>Stage</c>
66+
/// that has the value <c>prod</c>.
67+
/// </para>
68+
/// </important>
4769
/// </summary>
4870
[AWSProperty(Sensitive=true)]
4971
public SearchFilter Filters
@@ -98,6 +120,12 @@ internal bool IsSetMaxResults()
98120
/// indicate where the output should continue from. The pagination tokens expire after
99121
/// 24 hours.
100122
/// </para>
123+
/// <note>
124+
/// <para>
125+
/// The <c>ListResources</c> operation does not generate a <c>NextToken</c> if you set
126+
/// <c>MaxResults</c> to 1000.
127+
/// </para>
128+
/// </note>
101129
/// </summary>
102130
[AWSProperty(Min=1, Max=2048)]
103131
public string NextToken

0 commit comments

Comments
 (0)