@aws-sdk/client-resource-explorer-2 3.206.0 → 3.209.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -16
- package/dist-cjs/runtimeConfig.shared.js +2 -1
- package/dist-es/runtimeConfig.shared.js +2 -1
- package/dist-types/ResourceExplorer2.d.ts +37 -56
- package/dist-types/ResourceExplorer2Client.d.ts +3 -19
- package/dist-types/commands/AssociateDefaultViewCommand.d.ts +1 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +13 -16
- package/dist-types/commands/CreateViewCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateDefaultViewCommand.d.ts +1 -1
- package/dist-types/commands/ListViewsCommand.d.ts +1 -1
- package/dist-types/commands/SearchCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIndexTypeCommand.d.ts +13 -13
- package/dist-types/models/models_0.d.ts +27 -27
- package/dist-types/runtimeConfig.shared.d.ts +2 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -3
- package/package.json +32 -34
package/README.md
CHANGED
|
@@ -28,24 +28,8 @@ aggregator index. Therefore, the Region with the aggregator index has a copy of
|
|
|
28
28
|
information for all Regions in the account where you turned on Resource Explorer. As a result,
|
|
29
29
|
views in the aggregator index Region include resources from all of the indexed Regions in your
|
|
30
30
|
account.</p>
|
|
31
|
-
|
|
32
31
|
<p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
|
|
33
32
|
service, see the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/">Amazon Web Services Resource Explorer User Guide</a>.</p>
|
|
34
|
-
<note>
|
|
35
|
-
<p>The example HTTP query requests and responses in this guide are displayed with the
|
|
36
|
-
<a href="https://json.org">JSON</a> formatted across multiple lines for
|
|
37
|
-
readability. The actual query responses from the Resource Explorer service do not include this
|
|
38
|
-
extra whitespace.</p>
|
|
39
|
-
</note>
|
|
40
|
-
<p>
|
|
41
|
-
<b>We want your feedback about this documentation</b>
|
|
42
|
-
</p>
|
|
43
|
-
<p>Our goal is to help you get everything you can from Resource Explorer. If this guide helps you to
|
|
44
|
-
do that, then let us know. If the guide isn't helping you, then we want to hear from you
|
|
45
|
-
so we can address the issue. Use the <b>Feedback</b> link
|
|
46
|
-
that's in the upper-right corner of every page. That sends your comments directly to the
|
|
47
|
-
writers of this guide. We review every submission, looking for opportunities to improve
|
|
48
|
-
the documentation. Thank you in advance for your help!</p>
|
|
49
33
|
|
|
50
34
|
## Installing
|
|
51
35
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getRuntimeConfig = void 0;
|
|
4
|
+
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
4
5
|
const url_parser_1 = require("@aws-sdk/url-parser");
|
|
5
6
|
const util_base64_1 = require("@aws-sdk/util-base64");
|
|
6
7
|
const endpointResolver_1 = require("./endpoint/endpointResolver");
|
|
@@ -10,7 +11,7 @@ const getRuntimeConfig = (config) => ({
|
|
|
10
11
|
base64Encoder: config?.base64Encoder ?? util_base64_1.toBase64,
|
|
11
12
|
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
12
13
|
endpointProvider: config?.endpointProvider ?? endpointResolver_1.defaultEndpointResolver,
|
|
13
|
-
logger: config?.logger ??
|
|
14
|
+
logger: config?.logger ?? new smithy_client_1.NoOpLogger(),
|
|
14
15
|
serviceId: config?.serviceId ?? "Resource Explorer 2",
|
|
15
16
|
urlParser: config?.urlParser ?? url_parser_1.parseUrl,
|
|
16
17
|
});
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NoOpLogger } from "@aws-sdk/smithy-client";
|
|
1
2
|
import { parseUrl } from "@aws-sdk/url-parser";
|
|
2
3
|
import { fromBase64, toBase64 } from "@aws-sdk/util-base64";
|
|
3
4
|
import { defaultEndpointResolver } from "./endpoint/endpointResolver";
|
|
@@ -7,7 +8,7 @@ export const getRuntimeConfig = (config) => ({
|
|
|
7
8
|
base64Encoder: config?.base64Encoder ?? toBase64,
|
|
8
9
|
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
9
10
|
endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
|
|
10
|
-
logger: config?.logger ??
|
|
11
|
+
logger: config?.logger ?? new NoOpLogger(),
|
|
11
12
|
serviceId: config?.serviceId ?? "Resource Explorer 2",
|
|
12
13
|
urlParser: config?.urlParser ?? parseUrl,
|
|
13
14
|
});
|
|
@@ -26,11 +26,11 @@ import { ResourceExplorer2Client } from "./ResourceExplorer2Client";
|
|
|
26
26
|
* tables. You can search for your resources using resource metadata like names, tags, and
|
|
27
27
|
* IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn
|
|
28
28
|
* the service on, to simplify your cross-Region workloads.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which
|
|
30
30
|
* you turn on Resource Explorer. Resource Explorer <a href="https://docs.aws.amazon.com/arexug/mainline/getting-started-terms-and-concepts.html#term-index">creates and
|
|
31
31
|
* maintains an index</a> in each Region, with the details of that Region's
|
|
32
32
|
* resources.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>You can <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">search across all of the indexed
|
|
34
34
|
* Regions in your account</a> by designating one of your Amazon Web Services Regions to contain
|
|
35
35
|
* the aggregator index for the account. When you <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region-turn-on.html">promote a local index in
|
|
36
36
|
* a Region to become the aggregator index for the account</a>, Resource Explorer automatically
|
|
@@ -39,24 +39,8 @@ import { ResourceExplorer2Client } from "./ResourceExplorer2Client";
|
|
|
39
39
|
* information for all Regions in the account where you turned on Resource Explorer. As a result,
|
|
40
40
|
* views in the aggregator index Region include resources from all of the indexed Regions in your
|
|
41
41
|
* account.</p>
|
|
42
|
-
*
|
|
43
|
-
* <p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
|
|
42
|
+
* <p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
|
|
44
43
|
* service, see the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/">Amazon Web Services Resource Explorer User Guide</a>.</p>
|
|
45
|
-
* <note>
|
|
46
|
-
* <p>The example HTTP query requests and responses in this guide are displayed with the
|
|
47
|
-
* <a href="https://json.org">JSON</a> formatted across multiple lines for
|
|
48
|
-
* readability. The actual query responses from the Resource Explorer service do not include this
|
|
49
|
-
* extra whitespace.</p>
|
|
50
|
-
* </note>
|
|
51
|
-
* <p>
|
|
52
|
-
* <b>We want your feedback about this documentation</b>
|
|
53
|
-
* </p>
|
|
54
|
-
* <p>Our goal is to help you get everything you can from Resource Explorer. If this guide helps you to
|
|
55
|
-
* do that, then let us know. If the guide isn't helping you, then we want to hear from you
|
|
56
|
-
* so we can address the issue. Use the <b>Feedback</b> link
|
|
57
|
-
* that's in the upper-right corner of every page. That sends your comments directly to the
|
|
58
|
-
* writers of this guide. We review every submission, looking for opportunities to improve
|
|
59
|
-
* the documentation. Thank you in advance for your help!</p>
|
|
60
44
|
*/
|
|
61
45
|
export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
62
46
|
/**
|
|
@@ -64,7 +48,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
64
48
|
* operation. When a user performs a <a>Search</a> that doesn't explicitly
|
|
65
49
|
* specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for
|
|
66
50
|
* searches performed in this Amazon Web Services Region.</p>
|
|
67
|
-
*
|
|
51
|
+
* <p>If an Amazon Web Services Region doesn't have a default view
|
|
68
52
|
* configured, then users must explicitly specify a view with every <code>Search</code>
|
|
69
53
|
* operation performed in that Region.</p>
|
|
70
54
|
*/
|
|
@@ -81,51 +65,48 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
81
65
|
* <p>Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating
|
|
82
66
|
* an index. Resource Explorer begins discovering the resources in this Region and stores the details
|
|
83
67
|
* about the resources in the index so that they can be queried by using the <a>Search</a> operation. You can create only one index in a Region.</p>
|
|
84
|
-
*
|
|
68
|
+
* <note>
|
|
85
69
|
* <p>This operation creates only a <i>local</i> index. To promote the
|
|
86
70
|
* local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the
|
|
87
71
|
* <a>UpdateIndexType</a> operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search by creating an aggregator index</a> in the
|
|
88
72
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
89
|
-
*
|
|
90
|
-
*
|
|
73
|
+
* </note>
|
|
74
|
+
* <p>For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see
|
|
91
75
|
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html">Turn
|
|
92
76
|
* on Resource Explorer to index your resources in an Amazon Web Services Region</a> in the
|
|
93
77
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
94
|
-
*
|
|
78
|
+
* <p>If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then
|
|
95
79
|
* this operation also <a href="https://docs.aws.amazon.com/arexug/mainline/security_iam_service-linked-roles.html">creates a
|
|
96
80
|
* service-linked role</a> in your Amazon Web Services account that allows Resource Explorer to enumerate
|
|
97
81
|
* your resources to populate the index.</p>
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
* <ul>
|
|
82
|
+
* <ul>
|
|
102
83
|
* <li>
|
|
103
|
-
*
|
|
84
|
+
* <p>
|
|
104
85
|
* <b>Action</b>:
|
|
105
86
|
* <code>resource-explorer-2:CreateIndex</code>
|
|
106
87
|
* </p>
|
|
107
|
-
*
|
|
88
|
+
* <p>
|
|
108
89
|
* <b>Resource</b>: The ARN of the index (as it will
|
|
109
90
|
* exist after the operation completes) in the Amazon Web Services Region and account in which
|
|
110
91
|
* you're trying to create the index. Use the wildcard character (<code>*</code>)
|
|
111
92
|
* at the end of the string to match the eventual UUID. For example, the following
|
|
112
93
|
* <code>Resource</code> element restricts the role or user to creating an
|
|
113
94
|
* index in only the <code>us-east-2</code> Region of the specified account.</p>
|
|
114
|
-
*
|
|
95
|
+
* <p>
|
|
115
96
|
* <code>"Resource":
|
|
116
|
-
* "arn:aws:resource-explorer-2:us-
|
|
97
|
+
* "arn:aws:resource-explorer-2:us-west-2:<i><account-id></i>:index/*"</code>
|
|
117
98
|
* </p>
|
|
118
|
-
*
|
|
99
|
+
* <p>Alternatively, you can use <code>"Resource": "*"</code> to allow the role or
|
|
119
100
|
* user to create an index in any Region.</p>
|
|
120
101
|
* </li>
|
|
121
102
|
* <li>
|
|
122
|
-
*
|
|
103
|
+
* <p>
|
|
123
104
|
* <b>Action</b>:
|
|
124
105
|
* <code>iam:CreateServiceLinkedRole</code>
|
|
125
106
|
* </p>
|
|
126
|
-
*
|
|
107
|
+
* <p>
|
|
127
108
|
* <b>Resource</b>: No specific resource (*). </p>
|
|
128
|
-
*
|
|
109
|
+
* <p>This permission is required only the first time you create an index to turn on
|
|
129
110
|
* Resource Explorer in the account. Resource Explorer uses this to create the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html">service-linked
|
|
130
111
|
* role needed to index the resources in your account</a>. Resource Explorer uses the
|
|
131
112
|
* same service-linked role for all additional indexes you create
|
|
@@ -141,7 +122,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
141
122
|
* Results from queries that you make using this view include only resources that match the
|
|
142
123
|
* view's <code>Filters</code>. For more information about Amazon Web Services Resource Explorer views, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-views.html">Managing views</a>
|
|
143
124
|
* in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
144
|
-
*
|
|
125
|
+
* <p>Only the principals with an IAM identity-based policy that grants <code>Allow</code>
|
|
145
126
|
* to the <code>Search</code> action on a <code>Resource</code> with the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of
|
|
146
127
|
* this view can <a>Search</a> using views you create with this
|
|
147
128
|
* operation.</p>
|
|
@@ -162,7 +143,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
162
143
|
deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
163
144
|
/**
|
|
164
145
|
* <p>Deletes the specified view.</p>
|
|
165
|
-
*
|
|
146
|
+
* <p>If the specified view is the default view for its Amazon Web Services Region, then all <a>Search</a> operations in that Region must explicitly specify the view to use
|
|
166
147
|
* until you configure a new default by calling the <a>AssociateDefaultView</a>
|
|
167
148
|
* operation.</p>
|
|
168
149
|
*/
|
|
@@ -173,7 +154,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
173
154
|
* <p>After you call this operation, the affected Amazon Web Services Region no longer has a default view.
|
|
174
155
|
* All <a>Search</a> operations in that Region must explicitly specify a view or
|
|
175
156
|
* the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a> operation.</p>
|
|
176
|
-
*
|
|
157
|
+
* <p>If an Amazon Web Services Region doesn't have a default view
|
|
177
158
|
* configured, then users must explicitly specify a view with every <code>Search</code>
|
|
178
159
|
* operation performed in that Region.</p>
|
|
179
160
|
*/
|
|
@@ -222,7 +203,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
222
203
|
/**
|
|
223
204
|
* <p>Lists the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource names (ARNs)</a> of the views available in the Amazon Web Services Region in which you
|
|
224
205
|
* call this operation.</p>
|
|
225
|
-
*
|
|
206
|
+
* <note>
|
|
226
207
|
* <p>Always check the <code>NextToken</code> response parameter
|
|
227
208
|
* for a <code>null</code> value when calling a paginated operation. These operations can
|
|
228
209
|
* occasionally return an empty set of results even when there are more results available. The
|
|
@@ -237,15 +218,15 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
237
218
|
/**
|
|
238
219
|
* <p>Searches for resources and displays details about all resources that match the
|
|
239
220
|
* specified criteria. You must specify a query string.</p>
|
|
240
|
-
*
|
|
221
|
+
* <p>All search queries must use a view. If you don't explicitly specify a view, then
|
|
241
222
|
* Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
|
|
242
223
|
* The results are the logical intersection of the results that match both the
|
|
243
224
|
* <code>QueryString</code> parameter supplied to this operation and the
|
|
244
225
|
* <code>SearchFilter</code> parameter attached to the view.</p>
|
|
245
|
-
*
|
|
226
|
+
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
246
227
|
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
|
|
247
228
|
* query syntax reference for Resource Explorer</a>.</p>
|
|
248
|
-
*
|
|
229
|
+
* <p>If your search results are empty, or are missing results that you think should be
|
|
249
230
|
* there, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html">Troubleshooting Resource Explorer
|
|
250
231
|
* search</a>.</p>
|
|
251
232
|
*/
|
|
@@ -269,16 +250,16 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
269
250
|
* information about indexes and the role they perform in Amazon Web Services Resource Explorer, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">Turning on
|
|
270
251
|
* cross-Region search by creating an aggregator index</a> in the
|
|
271
252
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
272
|
-
*
|
|
253
|
+
* <ul>
|
|
273
254
|
* <li>
|
|
274
|
-
*
|
|
255
|
+
* <p>
|
|
275
256
|
* <b>
|
|
276
257
|
* <code>AGGREGATOR</code> index type</b>
|
|
277
258
|
* </p>
|
|
278
|
-
*
|
|
259
|
+
* <p>The index contains information about resources from all Amazon Web Services Regions in the
|
|
279
260
|
* Amazon Web Services account in which you've created a Resource Explorer index. Resource information from
|
|
280
261
|
* all other Regions is replicated to this Region's index.</p>
|
|
281
|
-
*
|
|
262
|
+
* <p>When you change the index type to <code>AGGREGATOR</code>, Resource Explorer turns on
|
|
282
263
|
* replication of all discovered resource information from the other Amazon Web Services Regions
|
|
283
264
|
* in your account to this index. You can then, from this Region only, perform
|
|
284
265
|
* resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.
|
|
@@ -289,21 +270,21 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
289
270
|
* <code>UPDATING</code> to <code>ACTIVE</code>. After that, you can start to
|
|
290
271
|
* see results from other Amazon Web Services Regions in query results. However, it can take
|
|
291
272
|
* several hours for replication from all other Regions to complete.</p>
|
|
292
|
-
*
|
|
293
|
-
*
|
|
273
|
+
* <important>
|
|
274
|
+
* <p>You can have only one aggregator index per Amazon Web Services account. Before you can
|
|
294
275
|
* promote a different index to be the aggregator index for the account, you must
|
|
295
276
|
* first demote the existing aggregator index to type <code>LOCAL</code>.</p>
|
|
296
|
-
*
|
|
277
|
+
* </important>
|
|
297
278
|
* </li>
|
|
298
279
|
* <li>
|
|
299
|
-
*
|
|
280
|
+
* <p>
|
|
300
281
|
* <b>
|
|
301
282
|
* <code>LOCAL</code> index type</b>
|
|
302
283
|
* </p>
|
|
303
|
-
*
|
|
284
|
+
* <p>The index contains information about resources in only the Amazon Web Services Region in
|
|
304
285
|
* which the index exists. If an aggregator index in another Region exists, then
|
|
305
286
|
* information in this local index is replicated to the aggregator index.</p>
|
|
306
|
-
*
|
|
287
|
+
* <p>When you change the index type to <code>LOCAL</code>, Resource Explorer turns off the
|
|
307
288
|
* replication of resource information from all other Amazon Web Services Regions in the
|
|
308
289
|
* Amazon Web Services account to this Region. The aggregator index remains in the
|
|
309
290
|
* <code>UPDATING</code> state until all replication with other Regions
|
|
@@ -315,11 +296,11 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
|
|
|
315
296
|
* index is deleted within 30 days by another background task. Until that
|
|
316
297
|
* asynchronous task completes, some results from other Regions can continue to
|
|
317
298
|
* appear in search results.</p>
|
|
318
|
-
*
|
|
319
|
-
*
|
|
299
|
+
* <important>
|
|
300
|
+
* <p>After you demote an aggregator index to a local index, you must wait
|
|
320
301
|
* 24 hours before you can promote another index to be the new
|
|
321
302
|
* aggregator index for the account.</p>
|
|
322
|
-
*
|
|
303
|
+
* </important>
|
|
323
304
|
* </li>
|
|
324
305
|
* </ul>
|
|
325
306
|
*/
|
|
@@ -148,11 +148,11 @@ export interface ResourceExplorer2ClientResolvedConfig extends ResourceExplorer2
|
|
|
148
148
|
* tables. You can search for your resources using resource metadata like names, tags, and
|
|
149
149
|
* IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn
|
|
150
150
|
* the service on, to simplify your cross-Region workloads.</p>
|
|
151
|
-
*
|
|
151
|
+
* <p>Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which
|
|
152
152
|
* you turn on Resource Explorer. Resource Explorer <a href="https://docs.aws.amazon.com/arexug/mainline/getting-started-terms-and-concepts.html#term-index">creates and
|
|
153
153
|
* maintains an index</a> in each Region, with the details of that Region's
|
|
154
154
|
* resources.</p>
|
|
155
|
-
*
|
|
155
|
+
* <p>You can <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">search across all of the indexed
|
|
156
156
|
* Regions in your account</a> by designating one of your Amazon Web Services Regions to contain
|
|
157
157
|
* the aggregator index for the account. When you <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region-turn-on.html">promote a local index in
|
|
158
158
|
* a Region to become the aggregator index for the account</a>, Resource Explorer automatically
|
|
@@ -161,24 +161,8 @@ export interface ResourceExplorer2ClientResolvedConfig extends ResourceExplorer2
|
|
|
161
161
|
* information for all Regions in the account where you turned on Resource Explorer. As a result,
|
|
162
162
|
* views in the aggregator index Region include resources from all of the indexed Regions in your
|
|
163
163
|
* account.</p>
|
|
164
|
-
*
|
|
165
|
-
* <p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
|
|
164
|
+
* <p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
|
|
166
165
|
* service, see the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/">Amazon Web Services Resource Explorer User Guide</a>.</p>
|
|
167
|
-
* <note>
|
|
168
|
-
* <p>The example HTTP query requests and responses in this guide are displayed with the
|
|
169
|
-
* <a href="https://json.org">JSON</a> formatted across multiple lines for
|
|
170
|
-
* readability. The actual query responses from the Resource Explorer service do not include this
|
|
171
|
-
* extra whitespace.</p>
|
|
172
|
-
* </note>
|
|
173
|
-
* <p>
|
|
174
|
-
* <b>We want your feedback about this documentation</b>
|
|
175
|
-
* </p>
|
|
176
|
-
* <p>Our goal is to help you get everything you can from Resource Explorer. If this guide helps you to
|
|
177
|
-
* do that, then let us know. If the guide isn't helping you, then we want to hear from you
|
|
178
|
-
* so we can address the issue. Use the <b>Feedback</b> link
|
|
179
|
-
* that's in the upper-right corner of every page. That sends your comments directly to the
|
|
180
|
-
* writers of this guide. We review every submission, looking for opportunities to improve
|
|
181
|
-
* the documentation. Thank you in advance for your help!</p>
|
|
182
166
|
*/
|
|
183
167
|
export declare class ResourceExplorer2Client extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ResourceExplorer2ClientResolvedConfig> {
|
|
184
168
|
/**
|
|
@@ -12,7 +12,7 @@ export interface AssociateDefaultViewCommandOutput extends AssociateDefaultViewO
|
|
|
12
12
|
* operation. When a user performs a <a>Search</a> that doesn't explicitly
|
|
13
13
|
* specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for
|
|
14
14
|
* searches performed in this Amazon Web Services Region.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If an Amazon Web Services Region doesn't have a default view
|
|
16
16
|
* configured, then users must explicitly specify a view with every <code>Search</code>
|
|
17
17
|
* operation performed in that Region.</p>
|
|
18
18
|
* @example
|
|
@@ -11,51 +11,48 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
|
|
|
11
11
|
* <p>Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating
|
|
12
12
|
* an index. Resource Explorer begins discovering the resources in this Region and stores the details
|
|
13
13
|
* about the resources in the index so that they can be queried by using the <a>Search</a> operation. You can create only one index in a Region.</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>This operation creates only a <i>local</i> index. To promote the
|
|
16
16
|
* local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the
|
|
17
17
|
* <a>UpdateIndexType</a> operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search by creating an aggregator index</a> in the
|
|
18
18
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* </note>
|
|
20
|
+
* <p>For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html">Turn
|
|
22
22
|
* on Resource Explorer to index your resources in an Amazon Web Services Region</a> in the
|
|
23
23
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then
|
|
25
25
|
* this operation also <a href="https://docs.aws.amazon.com/arexug/mainline/security_iam_service-linked-roles.html">creates a
|
|
26
26
|
* service-linked role</a> in your Amazon Web Services account that allows Resource Explorer to enumerate
|
|
27
27
|
* your resources to populate the index.</p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* <ul>
|
|
28
|
+
* <ul>
|
|
32
29
|
* <li>
|
|
33
|
-
*
|
|
30
|
+
* <p>
|
|
34
31
|
* <b>Action</b>:
|
|
35
32
|
* <code>resource-explorer-2:CreateIndex</code>
|
|
36
33
|
* </p>
|
|
37
|
-
*
|
|
34
|
+
* <p>
|
|
38
35
|
* <b>Resource</b>: The ARN of the index (as it will
|
|
39
36
|
* exist after the operation completes) in the Amazon Web Services Region and account in which
|
|
40
37
|
* you're trying to create the index. Use the wildcard character (<code>*</code>)
|
|
41
38
|
* at the end of the string to match the eventual UUID. For example, the following
|
|
42
39
|
* <code>Resource</code> element restricts the role or user to creating an
|
|
43
40
|
* index in only the <code>us-east-2</code> Region of the specified account.</p>
|
|
44
|
-
*
|
|
41
|
+
* <p>
|
|
45
42
|
* <code>"Resource":
|
|
46
|
-
* "arn:aws:resource-explorer-2:us-
|
|
43
|
+
* "arn:aws:resource-explorer-2:us-west-2:<i><account-id></i>:index/*"</code>
|
|
47
44
|
* </p>
|
|
48
|
-
*
|
|
45
|
+
* <p>Alternatively, you can use <code>"Resource": "*"</code> to allow the role or
|
|
49
46
|
* user to create an index in any Region.</p>
|
|
50
47
|
* </li>
|
|
51
48
|
* <li>
|
|
52
|
-
*
|
|
49
|
+
* <p>
|
|
53
50
|
* <b>Action</b>:
|
|
54
51
|
* <code>iam:CreateServiceLinkedRole</code>
|
|
55
52
|
* </p>
|
|
56
|
-
*
|
|
53
|
+
* <p>
|
|
57
54
|
* <b>Resource</b>: No specific resource (*). </p>
|
|
58
|
-
*
|
|
55
|
+
* <p>This permission is required only the first time you create an index to turn on
|
|
59
56
|
* Resource Explorer in the account. Resource Explorer uses this to create the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html">service-linked
|
|
60
57
|
* role needed to index the resources in your account</a>. Resource Explorer uses the
|
|
61
58
|
* same service-linked role for all additional indexes you create
|
|
@@ -12,7 +12,7 @@ export interface CreateViewCommandOutput extends CreateViewOutput, __MetadataBea
|
|
|
12
12
|
* Results from queries that you make using this view include only resources that match the
|
|
13
13
|
* view's <code>Filters</code>. For more information about Amazon Web Services Resource Explorer views, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-views.html">Managing views</a>
|
|
14
14
|
* in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Only the principals with an IAM identity-based policy that grants <code>Allow</code>
|
|
16
16
|
* to the <code>Search</code> action on a <code>Resource</code> with the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of
|
|
17
17
|
* this view can <a>Search</a> using views you create with this
|
|
18
18
|
* operation.</p>
|
|
@@ -9,7 +9,7 @@ export interface DeleteViewCommandOutput extends DeleteViewOutput, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified view.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If the specified view is the default view for its Amazon Web Services Region, then all <a>Search</a> operations in that Region must explicitly specify the view to use
|
|
13
13
|
* until you configure a new default by calling the <a>AssociateDefaultView</a>
|
|
14
14
|
* operation.</p>
|
|
15
15
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface DisassociateDefaultViewCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* <p>After you call this operation, the affected Amazon Web Services Region no longer has a default view.
|
|
11
11
|
* All <a>Search</a> operations in that Region must explicitly specify a view or
|
|
12
12
|
* the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a> operation.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If an Amazon Web Services Region doesn't have a default view
|
|
14
14
|
* configured, then users must explicitly specify a view with every <code>Search</code>
|
|
15
15
|
* operation performed in that Region.</p>
|
|
16
16
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface ListViewsCommandOutput extends ListViewsOutput, __MetadataBeare
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource names (ARNs)</a> of the views available in the Amazon Web Services Region in which you
|
|
12
12
|
* call this operation.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>Always check the <code>NextToken</code> response parameter
|
|
15
15
|
* for a <code>null</code> value when calling a paginated operation. These operations can
|
|
16
16
|
* occasionally return an empty set of results even when there are more results available. The
|
|
@@ -10,15 +10,15 @@ export interface SearchCommandOutput extends SearchOutput, __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Searches for resources and displays details about all resources that match the
|
|
12
12
|
* specified criteria. You must specify a query string.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>All search queries must use a view. If you don't explicitly specify a view, then
|
|
14
14
|
* Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
|
|
15
15
|
* The results are the logical intersection of the results that match both the
|
|
16
16
|
* <code>QueryString</code> parameter supplied to this operation and the
|
|
17
17
|
* <code>SearchFilter</code> parameter attached to the view.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
19
19
|
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
|
|
20
20
|
* query syntax reference for Resource Explorer</a>.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>If your search results are empty, or are missing results that you think should be
|
|
22
22
|
* there, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html">Troubleshooting Resource Explorer
|
|
23
23
|
* search</a>.</p>
|
|
24
24
|
* @example
|
|
@@ -12,16 +12,16 @@ export interface UpdateIndexTypeCommandOutput extends UpdateIndexTypeOutput, __M
|
|
|
12
12
|
* information about indexes and the role they perform in Amazon Web Services Resource Explorer, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">Turning on
|
|
13
13
|
* cross-Region search by creating an aggregator index</a> in the
|
|
14
14
|
* <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>
|
|
18
18
|
* <b>
|
|
19
19
|
* <code>AGGREGATOR</code> index type</b>
|
|
20
20
|
* </p>
|
|
21
|
-
*
|
|
21
|
+
* <p>The index contains information about resources from all Amazon Web Services Regions in the
|
|
22
22
|
* Amazon Web Services account in which you've created a Resource Explorer index. Resource information from
|
|
23
23
|
* all other Regions is replicated to this Region's index.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>When you change the index type to <code>AGGREGATOR</code>, Resource Explorer turns on
|
|
25
25
|
* replication of all discovered resource information from the other Amazon Web Services Regions
|
|
26
26
|
* in your account to this index. You can then, from this Region only, perform
|
|
27
27
|
* resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.
|
|
@@ -32,21 +32,21 @@ export interface UpdateIndexTypeCommandOutput extends UpdateIndexTypeOutput, __M
|
|
|
32
32
|
* <code>UPDATING</code> to <code>ACTIVE</code>. After that, you can start to
|
|
33
33
|
* see results from other Amazon Web Services Regions in query results. However, it can take
|
|
34
34
|
* several hours for replication from all other Regions to complete.</p>
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* <important>
|
|
36
|
+
* <p>You can have only one aggregator index per Amazon Web Services account. Before you can
|
|
37
37
|
* promote a different index to be the aggregator index for the account, you must
|
|
38
38
|
* first demote the existing aggregator index to type <code>LOCAL</code>.</p>
|
|
39
|
-
*
|
|
39
|
+
* </important>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>
|
|
43
43
|
* <b>
|
|
44
44
|
* <code>LOCAL</code> index type</b>
|
|
45
45
|
* </p>
|
|
46
|
-
*
|
|
46
|
+
* <p>The index contains information about resources in only the Amazon Web Services Region in
|
|
47
47
|
* which the index exists. If an aggregator index in another Region exists, then
|
|
48
48
|
* information in this local index is replicated to the aggregator index.</p>
|
|
49
|
-
*
|
|
49
|
+
* <p>When you change the index type to <code>LOCAL</code>, Resource Explorer turns off the
|
|
50
50
|
* replication of resource information from all other Amazon Web Services Regions in the
|
|
51
51
|
* Amazon Web Services account to this Region. The aggregator index remains in the
|
|
52
52
|
* <code>UPDATING</code> state until all replication with other Regions
|
|
@@ -58,11 +58,11 @@ export interface UpdateIndexTypeCommandOutput extends UpdateIndexTypeOutput, __M
|
|
|
58
58
|
* index is deleted within 30 days by another background task. Until that
|
|
59
59
|
* asynchronous task completes, some results from other Regions can continue to
|
|
60
60
|
* appear in search results.</p>
|
|
61
|
-
*
|
|
62
|
-
*
|
|
61
|
+
* <important>
|
|
62
|
+
* <p>After you demote an aggregator index to a local index, you must wait
|
|
63
63
|
* 24 hours before you can promote another index to be the new
|
|
64
64
|
* aggregator index for the account.</p>
|
|
65
|
-
*
|
|
65
|
+
* </important>
|
|
66
66
|
* </li>
|
|
67
67
|
* </ul>
|
|
68
68
|
* @example
|
|
@@ -140,10 +140,10 @@ export interface SearchFilter {
|
|
|
140
140
|
export interface IncludedProperty {
|
|
141
141
|
/**
|
|
142
142
|
* <p>The name of the property that is included in this view.</p>
|
|
143
|
-
*
|
|
144
|
-
*
|
|
143
|
+
* <p>You can specify the following property names for this field:</p>
|
|
144
|
+
* <ul>
|
|
145
145
|
* <li>
|
|
146
|
-
*
|
|
146
|
+
* <p>
|
|
147
147
|
* <code>Tags</code>
|
|
148
148
|
* </p>
|
|
149
149
|
* </li>
|
|
@@ -274,11 +274,11 @@ export interface CreateIndexOutput {
|
|
|
274
274
|
/**
|
|
275
275
|
* <p>Indicates the current state of the index. You can check for changes to the state for
|
|
276
276
|
* asynchronous operations by calling the <a>GetIndex</a> operation.</p>
|
|
277
|
-
*
|
|
277
|
+
* <note>
|
|
278
278
|
* <p>The state can remain in the <code>CREATING</code> or <code>UPDATING</code> state
|
|
279
279
|
* for several hours as Resource Explorer discovers the information about your resources and
|
|
280
280
|
* populates the index.</p>
|
|
281
|
-
*
|
|
281
|
+
* </note>
|
|
282
282
|
*/
|
|
283
283
|
State?: IndexState | string;
|
|
284
284
|
/**
|
|
@@ -296,9 +296,9 @@ export interface DeleteIndexOutput {
|
|
|
296
296
|
/**
|
|
297
297
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index that you successfully started the deletion
|
|
298
298
|
* process.</p>
|
|
299
|
-
*
|
|
299
|
+
* <note>
|
|
300
300
|
* <p>This operation is asynchronous. To check its status, call the <a>GetIndex</a> operation.</p>
|
|
301
|
-
*
|
|
301
|
+
* </note>
|
|
302
302
|
*/
|
|
303
303
|
Arn?: string;
|
|
304
304
|
/**
|
|
@@ -324,7 +324,7 @@ export interface ListIndexesInput {
|
|
|
324
324
|
/**
|
|
325
325
|
* <p>If specified, limits the output to only indexes of the specified Type, either
|
|
326
326
|
* <code>LOCAL</code> or <code>AGGREGATOR</code>.</p>
|
|
327
|
-
*
|
|
327
|
+
* <p>Use this option to discover the aggregator index for your account.</p>
|
|
328
328
|
*/
|
|
329
329
|
Type?: IndexType | string;
|
|
330
330
|
/**
|
|
@@ -359,7 +359,7 @@ export interface ListIndexesInput {
|
|
|
359
359
|
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
|
|
360
360
|
* resources that the service discovers. Creating an index in an Amazon Web Services Region turns on
|
|
361
361
|
* Resource Explorer and lets it discover your resources.</p>
|
|
362
|
-
*
|
|
362
|
+
* <p>By default, an index is <i>local</i>, meaning that it contains
|
|
363
363
|
* information about resources in only the same Region as the index. However, you can
|
|
364
364
|
* promote the index of one Region in the account by calling <a>UpdateIndexType</a> to convert it into an aggregator index. The aggregator index
|
|
365
365
|
* receives a replicated copy of the index information from all other Regions where Resource Explorer
|
|
@@ -378,14 +378,14 @@ export interface Index {
|
|
|
378
378
|
/**
|
|
379
379
|
* <p>The type of index. It can be one of the following
|
|
380
380
|
* values:</p>
|
|
381
|
-
*
|
|
381
|
+
* <ul>
|
|
382
382
|
* <li>
|
|
383
|
-
*
|
|
383
|
+
* <p>
|
|
384
384
|
* <b>LOCAL</b> – The index contains information
|
|
385
385
|
* about resources from only the same Amazon Web Services Region.</p>
|
|
386
386
|
* </li>
|
|
387
387
|
* <li>
|
|
388
|
-
*
|
|
388
|
+
* <p>
|
|
389
389
|
* <b>AGGREGATOR</b> – Resource Explorer replicates copies
|
|
390
390
|
* of the indexed information about resources in all other Amazon Web Services Regions to the
|
|
391
391
|
* aggregator index. This lets search results in the Region with the aggregator index to
|
|
@@ -469,7 +469,7 @@ export interface CreateViewInput {
|
|
|
469
469
|
ClientToken?: string;
|
|
470
470
|
/**
|
|
471
471
|
* <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p>
|
|
472
|
-
*
|
|
472
|
+
* <p>The name must be no more than 64 characters long, and can include letters, digits, and
|
|
473
473
|
* the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
|
|
474
474
|
*/
|
|
475
475
|
ViewName: string | undefined;
|
|
@@ -484,16 +484,16 @@ export interface CreateViewInput {
|
|
|
484
484
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
485
485
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
486
486
|
* parameter using a logical <code>AND</code> operator.</p>
|
|
487
|
-
*
|
|
487
|
+
* <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
|
|
488
488
|
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
489
|
-
*
|
|
489
|
+
* <important>
|
|
490
490
|
* <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
|
|
491
491
|
* 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
|
|
492
492
|
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
|
|
493
493
|
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
|
|
494
494
|
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
495
495
|
* <code>prod</code>.</p>
|
|
496
|
-
*
|
|
496
|
+
* </important>
|
|
497
497
|
*/
|
|
498
498
|
Filters?: SearchFilter;
|
|
499
499
|
/**
|
|
@@ -589,16 +589,16 @@ export interface UpdateViewInput {
|
|
|
589
589
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
590
590
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
591
591
|
* parameter using a logical <code>AND</code> operator.</p>
|
|
592
|
-
*
|
|
592
|
+
* <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
|
|
593
593
|
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
594
|
-
*
|
|
594
|
+
* <important>
|
|
595
595
|
* <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
|
|
596
596
|
* 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
|
|
597
597
|
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
|
|
598
598
|
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
|
|
599
599
|
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
600
600
|
* <code>prod</code>.</p>
|
|
601
|
-
*
|
|
601
|
+
* </important>
|
|
602
602
|
*/
|
|
603
603
|
Filters?: SearchFilter;
|
|
604
604
|
}
|
|
@@ -780,7 +780,7 @@ export interface Resource {
|
|
|
780
780
|
* <p>Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer
|
|
781
781
|
* doesn't count more than 1,000 matches for any query. This structure
|
|
782
782
|
* provides information about whether the query exceeded this limit.</p>
|
|
783
|
-
*
|
|
783
|
+
* <p>This field is included in every page when you paginate the results.</p>
|
|
784
784
|
*/
|
|
785
785
|
export interface ResourceCount {
|
|
786
786
|
/**
|
|
@@ -794,13 +794,13 @@ export interface ResourceCount {
|
|
|
794
794
|
/**
|
|
795
795
|
* <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count
|
|
796
796
|
* of search results.</p>
|
|
797
|
-
*
|
|
797
|
+
* <ul>
|
|
798
798
|
* <li>
|
|
799
|
-
*
|
|
799
|
+
* <p>If <code>True</code>, it indicates that the search was exhaustive. Every
|
|
800
800
|
* resource that matches the query was counted.</p>
|
|
801
801
|
* </li>
|
|
802
802
|
* <li>
|
|
803
|
-
*
|
|
803
|
+
* <p>If <code>False</code>, then the search reached the limit of
|
|
804
804
|
* 1,000 matching results, and stopped counting.</p>
|
|
805
805
|
* </li>
|
|
806
806
|
* </ul>
|
|
@@ -811,15 +811,15 @@ export interface SearchInput {
|
|
|
811
811
|
/**
|
|
812
812
|
* <p>A string that includes keywords and filters that specify the resources that you want
|
|
813
813
|
* to include in the results.</p>
|
|
814
|
-
*
|
|
814
|
+
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
815
815
|
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query syntax reference for Resource Explorer</a>.</p>
|
|
816
|
-
*
|
|
816
|
+
* <p>The search is completely case insensitive. You can specify an empty string to return
|
|
817
817
|
* all results up to the limit of 1,000 total results.</p>
|
|
818
|
-
*
|
|
818
|
+
* <note>
|
|
819
819
|
* <p>The operation can return only the first 1,000 results. If the
|
|
820
820
|
* resource you want is not included, then use a different value for
|
|
821
821
|
* <code>QueryString</code> to refine the results.</p>
|
|
822
|
-
*
|
|
822
|
+
* </note>
|
|
823
823
|
*/
|
|
824
824
|
QueryString: string | undefined;
|
|
825
825
|
/**
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Logger as __Logger } from "@aws-sdk/types";
|
|
2
1
|
import { ResourceExplorer2ClientConfig } from "./ResourceExplorer2Client";
|
|
3
2
|
/**
|
|
4
3
|
* @internal
|
|
@@ -9,9 +8,9 @@ export declare const getRuntimeConfig: (config: ResourceExplorer2ClientConfig) =
|
|
|
9
8
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
10
9
|
disableHostPrefix: boolean;
|
|
11
10
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
12
|
-
logger?:
|
|
11
|
+
logger?: import("@aws-sdk/types").Logger | undefined;
|
|
13
12
|
}) => import("@aws-sdk/types").EndpointV2;
|
|
14
|
-
logger:
|
|
13
|
+
logger: import("@aws-sdk/types").Logger;
|
|
15
14
|
serviceId: string;
|
|
16
15
|
urlParser: import("@aws-sdk/types").UrlParser;
|
|
17
16
|
};
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Logger as __Logger } from "@aws-sdk/types";
|
|
2
1
|
import { ResourceExplorer2ClientConfig } from "./ResourceExplorer2Client";
|
|
3
2
|
export declare const getRuntimeConfig: (
|
|
4
3
|
config: ResourceExplorer2ClientConfig
|
|
@@ -10,10 +9,10 @@ export declare const getRuntimeConfig: (
|
|
|
10
9
|
endpointProvider: (
|
|
11
10
|
endpointParams: import("./endpoint/EndpointParameters").EndpointParameters,
|
|
12
11
|
context?: {
|
|
13
|
-
logger?:
|
|
12
|
+
logger?: import("@aws-sdk/types").Logger | undefined;
|
|
14
13
|
}
|
|
15
14
|
) => import("@aws-sdk/types").EndpointV2;
|
|
16
|
-
logger:
|
|
15
|
+
logger: import("@aws-sdk/types").Logger;
|
|
17
16
|
serviceId: string;
|
|
18
17
|
urlParser: import("@aws-sdk/types").UrlParser;
|
|
19
18
|
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-resource-explorer-2",
|
|
3
3
|
"description": "AWS SDK for JavaScript Resource Explorer 2 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.209.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -19,45 +19,43 @@
|
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
21
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
-
"@aws-sdk/config-resolver": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
26
|
-
"@aws-sdk/hash-node": "3.
|
|
27
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
28
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
29
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
30
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
31
|
-
"@aws-sdk/middleware-logger": "3.
|
|
32
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
33
|
-
"@aws-sdk/middleware-retry": "3.
|
|
34
|
-
"@aws-sdk/middleware-serde": "3.
|
|
35
|
-
"@aws-sdk/middleware-signing": "3.
|
|
36
|
-
"@aws-sdk/middleware-stack": "3.
|
|
37
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
38
|
-
"@aws-sdk/node-config-provider": "3.
|
|
39
|
-
"@aws-sdk/node-http-handler": "3.
|
|
40
|
-
"@aws-sdk/protocol-http": "3.
|
|
41
|
-
"@aws-sdk/smithy-client": "3.
|
|
42
|
-
"@aws-sdk/types": "3.
|
|
43
|
-
"@aws-sdk/url-parser": "3.
|
|
44
|
-
"@aws-sdk/util-base64": "3.
|
|
45
|
-
"@aws-sdk/util-base64-browser": "3.188.0",
|
|
46
|
-
"@aws-sdk/util-base64-node": "3.201.0",
|
|
22
|
+
"@aws-sdk/client-sts": "3.209.0",
|
|
23
|
+
"@aws-sdk/config-resolver": "3.209.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.209.0",
|
|
25
|
+
"@aws-sdk/fetch-http-handler": "3.208.0",
|
|
26
|
+
"@aws-sdk/hash-node": "3.208.0",
|
|
27
|
+
"@aws-sdk/invalid-dependency": "3.208.0",
|
|
28
|
+
"@aws-sdk/middleware-content-length": "3.208.0",
|
|
29
|
+
"@aws-sdk/middleware-endpoint": "3.208.0",
|
|
30
|
+
"@aws-sdk/middleware-host-header": "3.208.0",
|
|
31
|
+
"@aws-sdk/middleware-logger": "3.208.0",
|
|
32
|
+
"@aws-sdk/middleware-recursion-detection": "3.208.0",
|
|
33
|
+
"@aws-sdk/middleware-retry": "3.209.0",
|
|
34
|
+
"@aws-sdk/middleware-serde": "3.208.0",
|
|
35
|
+
"@aws-sdk/middleware-signing": "3.208.0",
|
|
36
|
+
"@aws-sdk/middleware-stack": "3.208.0",
|
|
37
|
+
"@aws-sdk/middleware-user-agent": "3.208.0",
|
|
38
|
+
"@aws-sdk/node-config-provider": "3.209.0",
|
|
39
|
+
"@aws-sdk/node-http-handler": "3.208.0",
|
|
40
|
+
"@aws-sdk/protocol-http": "3.208.0",
|
|
41
|
+
"@aws-sdk/smithy-client": "3.209.0",
|
|
42
|
+
"@aws-sdk/types": "3.208.0",
|
|
43
|
+
"@aws-sdk/url-parser": "3.208.0",
|
|
44
|
+
"@aws-sdk/util-base64": "3.208.0",
|
|
47
45
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
48
|
-
"@aws-sdk/util-body-length-node": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
51
|
-
"@aws-sdk/util-endpoints": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
46
|
+
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
47
|
+
"@aws-sdk/util-defaults-mode-browser": "3.209.0",
|
|
48
|
+
"@aws-sdk/util-defaults-mode-node": "3.209.0",
|
|
49
|
+
"@aws-sdk/util-endpoints": "3.209.0",
|
|
50
|
+
"@aws-sdk/util-user-agent-browser": "3.208.0",
|
|
51
|
+
"@aws-sdk/util-user-agent-node": "3.209.0",
|
|
54
52
|
"@aws-sdk/util-utf8-browser": "3.188.0",
|
|
55
|
-
"@aws-sdk/util-utf8-node": "3.
|
|
53
|
+
"@aws-sdk/util-utf8-node": "3.208.0",
|
|
56
54
|
"tslib": "^2.3.1",
|
|
57
55
|
"uuid": "^8.3.2"
|
|
58
56
|
},
|
|
59
57
|
"devDependencies": {
|
|
60
|
-
"@aws-sdk/service-client-documentation-generator": "3.
|
|
58
|
+
"@aws-sdk/service-client-documentation-generator": "3.208.0",
|
|
61
59
|
"@tsconfig/node14": "1.0.3",
|
|
62
60
|
"@types/node": "^14.14.31",
|
|
63
61
|
"@types/uuid": "^8.3.0",
|