@aws-sdk/client-resource-explorer-2 3.899.0 → 3.904.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 +65 -21
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/index.js +475 -0
- package/dist-es/ResourceExplorer2.js +16 -0
- package/dist-es/commands/CreateResourceExplorerSetupCommand.js +22 -0
- package/dist-es/commands/DeleteResourceExplorerSetupCommand.js +22 -0
- package/dist-es/commands/GetResourceExplorerSetupCommand.js +23 -0
- package/dist-es/commands/GetServiceIndexCommand.js +22 -0
- package/dist-es/commands/GetServiceViewCommand.js +23 -0
- package/dist-es/commands/ListServiceIndexesCommand.js +22 -0
- package/dist-es/commands/ListServiceViewsCommand.js +22 -0
- package/dist-es/commands/ListStreamingAccessForServicesCommand.js +22 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +24 -0
- package/dist-es/pagination/GetResourceExplorerSetupPaginator.js +4 -0
- package/dist-es/pagination/ListServiceIndexesPaginator.js +4 -0
- package/dist-es/pagination/ListServiceViewsPaginator.js +4 -0
- package/dist-es/pagination/ListStreamingAccessForServicesPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +261 -0
- package/dist-types/ResourceExplorer2.d.ts +62 -21
- package/dist-types/ResourceExplorer2Client.d.ts +11 -23
- package/dist-types/commands/AssociateDefaultViewCommand.d.ts +6 -18
- package/dist-types/commands/BatchGetViewCommand.d.ts +4 -9
- package/dist-types/commands/CreateIndexCommand.d.ts +6 -67
- package/dist-types/commands/CreateResourceExplorerSetupCommand.d.ts +95 -0
- package/dist-types/commands/CreateViewCommand.d.ts +6 -24
- package/dist-types/commands/DeleteIndexCommand.d.ts +6 -23
- package/dist-types/commands/DeleteResourceExplorerSetupCommand.d.ts +92 -0
- package/dist-types/commands/DeleteViewCommand.d.ts +6 -15
- package/dist-types/commands/DisassociateDefaultViewCommand.d.ts +6 -17
- package/dist-types/commands/GetAccountLevelServiceConfigurationCommand.d.ts +5 -12
- package/dist-types/commands/GetDefaultViewCommand.d.ts +6 -13
- package/dist-types/commands/GetIndexCommand.d.ts +6 -13
- package/dist-types/commands/GetManagedViewCommand.d.ts +5 -11
- package/dist-types/commands/GetResourceExplorerSetupCommand.d.ts +129 -0
- package/dist-types/commands/GetServiceIndexCommand.d.ts +88 -0
- package/dist-types/commands/GetServiceViewCommand.d.ts +101 -0
- package/dist-types/commands/GetViewCommand.d.ts +5 -11
- package/dist-types/commands/ListIndexesCommand.d.ts +5 -11
- package/dist-types/commands/ListIndexesForMembersCommand.d.ts +5 -13
- package/dist-types/commands/ListManagedViewsCommand.d.ts +5 -12
- package/dist-types/commands/ListResourcesCommand.d.ts +6 -14
- package/dist-types/commands/ListServiceIndexesCommand.d.ts +97 -0
- package/dist-types/commands/ListServiceViewsCommand.d.ts +90 -0
- package/dist-types/commands/ListStreamingAccessForServicesCommand.d.ts +90 -0
- package/dist-types/commands/ListSupportedResourceTypesCommand.d.ts +4 -9
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -11
- package/dist-types/commands/ListViewsCommand.d.ts +5 -19
- package/dist-types/commands/SearchCommand.d.ts +6 -24
- package/dist-types/commands/TagResourceCommand.d.ts +5 -16
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -11
- package/dist-types/commands/UpdateIndexTypeCommand.d.ts +7 -75
- package/dist-types/commands/UpdateViewCommand.d.ts +5 -11
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/index.d.ts +1 -21
- package/dist-types/models/models_0.d.ts +473 -442
- package/dist-types/pagination/GetResourceExplorerSetupPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceIndexesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceViewsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStreamingAccessForServicesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/ts3.4/ResourceExplorer2.d.ts +141 -0
- package/dist-types/ts3.4/ResourceExplorer2Client.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateResourceExplorerSetupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteResourceExplorerSetupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetResourceExplorerSetupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetServiceIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetServiceViewCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListServiceIndexesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListServiceViewsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListStreamingAccessForServicesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +106 -0
- package/dist-types/ts3.4/pagination/GetResourceExplorerSetupPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceIndexesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceViewsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStreamingAccessForServicesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +38 -38
|
@@ -2,8 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { ResourceExplorer2ServiceException as __BaseException } from "./ResourceExplorer2ServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* <p>The credentials that you used to call this operation don't have the minimum required
|
|
6
|
-
* permissions.</p>
|
|
5
|
+
* <p>The credentials that you used to call this operation don't have the minimum required permissions.</p>
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
9
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -20,9 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
20
19
|
*/
|
|
21
20
|
export interface AssociateDefaultViewInput {
|
|
22
21
|
/**
|
|
23
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to set as the default for the Amazon Web Services Region and
|
|
24
|
-
* Amazon Web Services account in which you call this operation. The specified view must already exist in
|
|
25
|
-
* the called Region.</p>
|
|
22
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.</p>
|
|
26
23
|
* @public
|
|
27
24
|
*/
|
|
28
25
|
ViewArn: string | undefined;
|
|
@@ -32,15 +29,13 @@ export interface AssociateDefaultViewInput {
|
|
|
32
29
|
*/
|
|
33
30
|
export interface AssociateDefaultViewOutput {
|
|
34
31
|
/**
|
|
35
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that the operation set as the default for queries made
|
|
36
|
-
* in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.</p>
|
|
32
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.</p>
|
|
37
33
|
* @public
|
|
38
34
|
*/
|
|
39
35
|
ViewArn?: string | undefined;
|
|
40
36
|
}
|
|
41
37
|
/**
|
|
42
|
-
* <p>The request failed because of internal service error. Try your request again
|
|
43
|
-
* later.</p>
|
|
38
|
+
* <p>The request failed because of internal service error. Try your request again later.</p>
|
|
44
39
|
* @public
|
|
45
40
|
*/
|
|
46
41
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -53,8 +48,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
53
48
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
54
49
|
}
|
|
55
50
|
/**
|
|
56
|
-
* <p>You specified a resource that doesn't exist. Check the ID or ARN that you used to
|
|
57
|
-
* identity the resource, and try again.</p>
|
|
51
|
+
* <p>You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.</p>
|
|
58
52
|
* @public
|
|
59
53
|
*/
|
|
60
54
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -67,9 +61,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
67
61
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
68
62
|
}
|
|
69
63
|
/**
|
|
70
|
-
* <p>The request failed because you exceeded a rate limit for this operation. For more
|
|
71
|
-
* information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html">Quotas for
|
|
72
|
-
* Resource Explorer</a>.</p>
|
|
64
|
+
* <p>The request failed because you exceeded a rate limit for this operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html">Quotas for Resource Explorer</a>.</p>
|
|
73
65
|
* @public
|
|
74
66
|
*/
|
|
75
67
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -98,8 +90,7 @@ export interface ValidationExceptionField {
|
|
|
98
90
|
ValidationIssue: string | undefined;
|
|
99
91
|
}
|
|
100
92
|
/**
|
|
101
|
-
* <p>You provided an invalid value for one of the operation's parameters. Check the syntax
|
|
102
|
-
* for the operation, and try again.</p>
|
|
93
|
+
* <p>You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.</p>
|
|
103
94
|
* @public
|
|
104
95
|
*/
|
|
105
96
|
export declare class ValidationException extends __BaseException {
|
|
@@ -139,8 +130,7 @@ export interface BatchGetViewInput {
|
|
|
139
130
|
ViewArns?: string[] | undefined;
|
|
140
131
|
}
|
|
141
132
|
/**
|
|
142
|
-
* <p>A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve
|
|
143
|
-
* details.</p>
|
|
133
|
+
* <p>A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.</p>
|
|
144
134
|
* @public
|
|
145
135
|
*/
|
|
146
136
|
export interface BatchGetViewError {
|
|
@@ -156,48 +146,29 @@ export interface BatchGetViewError {
|
|
|
156
146
|
ErrorMessage: string | undefined;
|
|
157
147
|
}
|
|
158
148
|
/**
|
|
159
|
-
* <p>A search filter defines which resources can be part of a search query result
|
|
160
|
-
* set.</p>
|
|
149
|
+
* <p>A search filter defines which resources can be part of a search query result set.</p>
|
|
161
150
|
* @public
|
|
162
151
|
*/
|
|
163
152
|
export interface SearchFilter {
|
|
164
153
|
/**
|
|
165
|
-
* <p>The string that contains the search keywords, prefixes, and operators to control the
|
|
166
|
-
* results that can be returned by a <a>Search</a> operation. For more details,
|
|
167
|
-
* see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
|
|
168
|
-
* query syntax</a>.</p>
|
|
154
|
+
* <p>The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a <a>Search</a> operation. For more details, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search query syntax</a>.</p>
|
|
169
155
|
* @public
|
|
170
156
|
*/
|
|
171
157
|
FilterString: string | undefined;
|
|
172
158
|
}
|
|
173
159
|
/**
|
|
174
|
-
* <p>Information about an additional property that describes a resource, that you can
|
|
175
|
-
* optionally include in the view. This lets you view that property in search results, and
|
|
176
|
-
* filter your search results based on the value of the property.</p>
|
|
160
|
+
* <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>
|
|
177
161
|
* @public
|
|
178
162
|
*/
|
|
179
163
|
export interface IncludedProperty {
|
|
180
164
|
/**
|
|
181
|
-
* <p>The name of the property that is included in this view.</p>
|
|
182
|
-
* <p>You can specify the following property names for this field:</p>
|
|
183
|
-
* <ul>
|
|
184
|
-
* <li>
|
|
185
|
-
* <p>
|
|
186
|
-
* <code>tags</code>
|
|
187
|
-
* </p>
|
|
188
|
-
* </li>
|
|
189
|
-
* </ul>
|
|
165
|
+
* <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>
|
|
190
166
|
* @public
|
|
191
167
|
*/
|
|
192
168
|
Name: string | undefined;
|
|
193
169
|
}
|
|
194
170
|
/**
|
|
195
|
-
* <p>A view is a structure that defines a set of filters that provide a view into the
|
|
196
|
-
* information in the Amazon Web Services Resource Explorer index. The filters specify which information from the
|
|
197
|
-
* index is visible to the users of the view. For example, you can specify filters that
|
|
198
|
-
* include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in
|
|
199
|
-
* the results returned by this view. You could also create a second view that includes
|
|
200
|
-
* only resources that are tagged with "ENV" and "PRODUCTION".</p>
|
|
171
|
+
* <p>A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".</p>
|
|
201
172
|
* @public
|
|
202
173
|
*/
|
|
203
174
|
export interface View {
|
|
@@ -217,12 +188,7 @@ export interface View {
|
|
|
217
188
|
*/
|
|
218
189
|
LastUpdatedAt?: Date | undefined;
|
|
219
190
|
/**
|
|
220
|
-
* <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of an Amazon Web Services account, an organization, or an
|
|
221
|
-
* organizational unit (OU) that specifies whether this view includes resources from only
|
|
222
|
-
* the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in
|
|
223
|
-
* the specified OU.</p>
|
|
224
|
-
* <p>If not specified, the value defaults to the Amazon Web Services account used to call this
|
|
225
|
-
* operation.</p>
|
|
191
|
+
* <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.</p> <p>If not specified, the value defaults to the Amazon Web Services account used to call this operation.</p>
|
|
226
192
|
* @public
|
|
227
193
|
*/
|
|
228
194
|
Scope?: string | undefined;
|
|
@@ -232,8 +198,7 @@ export interface View {
|
|
|
232
198
|
*/
|
|
233
199
|
IncludedProperties?: IncludedProperty[] | undefined;
|
|
234
200
|
/**
|
|
235
|
-
* <p>An array of <a>SearchFilter</a> objects that specify which resources can be
|
|
236
|
-
* included in the results of queries made using this view.</p>
|
|
201
|
+
* <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>
|
|
237
202
|
* @public
|
|
238
203
|
*/
|
|
239
204
|
Filters?: SearchFilter | undefined;
|
|
@@ -243,14 +208,12 @@ export interface View {
|
|
|
243
208
|
*/
|
|
244
209
|
export interface BatchGetViewOutput {
|
|
245
210
|
/**
|
|
246
|
-
* <p>A structure with a list of objects with details for each of the specified
|
|
247
|
-
* views.</p>
|
|
211
|
+
* <p>A structure with a list of objects with details for each of the specified views.</p>
|
|
248
212
|
* @public
|
|
249
213
|
*/
|
|
250
214
|
Views?: View[] | undefined;
|
|
251
215
|
/**
|
|
252
|
-
* <p>If any of the specified ARNs result in an error, then this structure describes the
|
|
253
|
-
* error.</p>
|
|
216
|
+
* <p>If any of the specified ARNs result in an error, then this structure describes the error.</p>
|
|
254
217
|
* @public
|
|
255
218
|
*/
|
|
256
219
|
Errors?: BatchGetViewError[] | undefined;
|
|
@@ -269,13 +232,7 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
269
232
|
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
270
233
|
}
|
|
271
234
|
/**
|
|
272
|
-
* <p>If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the
|
|
273
|
-
* original request, or you attempted to create a view with a name that already exists in
|
|
274
|
-
* this Amazon Web Services Region.</p>
|
|
275
|
-
* <p>If you attempted to create an index, then the request failed because either you specified parameters that didn't match
|
|
276
|
-
* the original request, or an index already exists in the current Amazon Web Services Region.</p>
|
|
277
|
-
* <p>If you attempted to update an index type to <code>AGGREGATOR</code>, then the request failed because you already
|
|
278
|
-
* have an <code>AGGREGATOR</code> index in a different Amazon Web Services Region.</p>
|
|
235
|
+
* <p>If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.</p> <p>If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.</p> <p>If you attempted to update an index type to <code>AGGREGATOR</code>, then the request failed because you already have an <code>AGGREGATOR</code> index in a different Amazon Web Services Region.</p>
|
|
279
236
|
* @public
|
|
280
237
|
*/
|
|
281
238
|
export declare class ConflictException extends __BaseException {
|
|
@@ -292,15 +249,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
292
249
|
*/
|
|
293
250
|
export interface CreateIndexInput {
|
|
294
251
|
/**
|
|
295
|
-
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
296
|
-
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
297
|
-
* value</a> to ensure the uniqueness of your index.</p>
|
|
252
|
+
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type value</a> to ensure the uniqueness of your index.</p>
|
|
298
253
|
* @public
|
|
299
254
|
*/
|
|
300
255
|
ClientToken?: string | undefined;
|
|
301
256
|
/**
|
|
302
|
-
* <p>The specified tags are attached only to the index created in this Amazon Web Services Region. The
|
|
303
|
-
* tags aren't attached to any of the resources listed in the index.</p>
|
|
257
|
+
* <p>The specified tags are attached only to the index created in this Amazon Web Services Region. The tags aren't attached to any of the resources listed in the index.</p>
|
|
304
258
|
* @public
|
|
305
259
|
*/
|
|
306
260
|
Tags?: Record<string, string> | undefined;
|
|
@@ -340,21 +294,12 @@ export type IndexState = (typeof IndexState)[keyof typeof IndexState];
|
|
|
340
294
|
*/
|
|
341
295
|
export interface CreateIndexOutput {
|
|
342
296
|
/**
|
|
343
|
-
* <p>The ARN of the new local index for the Region. You can reference this ARN in IAM
|
|
344
|
-
* permission policies to authorize the following operations: <a>DeleteIndex</a>
|
|
345
|
-
* | <a>GetIndex</a> | <a>UpdateIndexType</a> | <a>CreateView</a>
|
|
346
|
-
* </p>
|
|
297
|
+
* <p>The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: <a>DeleteIndex</a> | <a>GetIndex</a> | <a>UpdateIndexType</a> | <a>CreateView</a> </p>
|
|
347
298
|
* @public
|
|
348
299
|
*/
|
|
349
300
|
Arn?: string | undefined;
|
|
350
301
|
/**
|
|
351
|
-
* <p>Indicates the current state of the index. You can check for changes to the state for
|
|
352
|
-
* asynchronous operations by calling the <a>GetIndex</a> operation.</p>
|
|
353
|
-
* <note>
|
|
354
|
-
* <p>The state can remain in the <code>CREATING</code> or <code>UPDATING</code> state
|
|
355
|
-
* for several hours as Resource Explorer discovers the information about your resources and
|
|
356
|
-
* populates the index.</p>
|
|
357
|
-
* </note>
|
|
302
|
+
* <p>Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the <a>GetIndex</a> operation.</p> <note> <p>The state can remain in the <code>CREATING</code> or <code>UPDATING</code> state for several hours as Resource Explorer discovers the information about your resources and populates the index.</p> </note>
|
|
358
303
|
* @public
|
|
359
304
|
*/
|
|
360
305
|
State?: IndexState | undefined;
|
|
@@ -379,11 +324,7 @@ export interface DeleteIndexInput {
|
|
|
379
324
|
*/
|
|
380
325
|
export interface DeleteIndexOutput {
|
|
381
326
|
/**
|
|
382
|
-
* <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
|
|
383
|
-
* process.</p>
|
|
384
|
-
* <note>
|
|
385
|
-
* <p>This operation is asynchronous. To check its status, call the <a>GetIndex</a> operation.</p>
|
|
386
|
-
* </note>
|
|
327
|
+
* <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 process.</p> <note> <p>This operation is asynchronous. To check its status, call the <a>GetIndex</a> operation.</p> </note>
|
|
387
328
|
* @public
|
|
388
329
|
*/
|
|
389
330
|
Arn?: string | undefined;
|
|
@@ -421,53 +362,28 @@ export type IndexType = (typeof IndexType)[keyof typeof IndexType];
|
|
|
421
362
|
*/
|
|
422
363
|
export interface ListIndexesInput {
|
|
423
364
|
/**
|
|
424
|
-
* <p>If specified, limits the output to only indexes of the specified Type, either
|
|
425
|
-
* <code>LOCAL</code> or <code>AGGREGATOR</code>.</p>
|
|
426
|
-
* <p>Use this option to discover the aggregator index for your account.</p>
|
|
365
|
+
* <p>If specified, limits the output to only indexes of the specified Type, either <code>LOCAL</code> or <code>AGGREGATOR</code>.</p> <p>Use this option to discover the aggregator index for your account.</p>
|
|
427
366
|
* @public
|
|
428
367
|
*/
|
|
429
368
|
Type?: IndexType | undefined;
|
|
430
369
|
/**
|
|
431
|
-
* <p>If specified, limits the response to only information about the index in the specified
|
|
432
|
-
* list of Amazon Web Services Regions.</p>
|
|
370
|
+
* <p>If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.</p>
|
|
433
371
|
* @public
|
|
434
372
|
*/
|
|
435
373
|
Regions?: string[] | undefined;
|
|
436
374
|
/**
|
|
437
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
438
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
439
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
440
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
441
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
442
|
-
* the next part of the results.</p>
|
|
443
|
-
* <note>
|
|
444
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
445
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
446
|
-
* that you receive all of the results.</p>
|
|
447
|
-
* </note>
|
|
375
|
+
* <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>
|
|
448
376
|
* @public
|
|
449
377
|
*/
|
|
450
378
|
MaxResults?: number | undefined;
|
|
451
379
|
/**
|
|
452
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
453
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
454
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
455
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
456
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
380
|
+
* <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>
|
|
457
381
|
* @public
|
|
458
382
|
*/
|
|
459
383
|
NextToken?: string | undefined;
|
|
460
384
|
}
|
|
461
385
|
/**
|
|
462
|
-
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
|
|
463
|
-
* resources that the service discovers. Creating an index in an Amazon Web Services Region turns on
|
|
464
|
-
* Resource Explorer and lets it discover your resources.</p>
|
|
465
|
-
* <p>By default, an index is <i>local</i>, meaning that it contains
|
|
466
|
-
* information about resources in only the same Region as the index. However, you can
|
|
467
|
-
* promote the index of one Region in the account by calling <a>UpdateIndexType</a> to convert it into an aggregator index. The aggregator index
|
|
468
|
-
* receives a replicated copy of the index information from all other Regions where Resource Explorer
|
|
469
|
-
* is turned on. This allows search operations in that Region to return results from all
|
|
470
|
-
* Regions in the account.</p>
|
|
386
|
+
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.</p> <p>By default, an index is <i>local</i>, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling <a>UpdateIndexType</a> to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.</p>
|
|
471
387
|
* @public
|
|
472
388
|
*/
|
|
473
389
|
export interface Index {
|
|
@@ -482,21 +398,7 @@ export interface Index {
|
|
|
482
398
|
*/
|
|
483
399
|
Arn?: string | undefined;
|
|
484
400
|
/**
|
|
485
|
-
* <p>The type of index. It can be one of the following values:</p>
|
|
486
|
-
* <ul>
|
|
487
|
-
* <li>
|
|
488
|
-
* <p>
|
|
489
|
-
* <code>LOCAL</code> – The index contains information about resources
|
|
490
|
-
* from only the same Amazon Web Services Region.</p>
|
|
491
|
-
* </li>
|
|
492
|
-
* <li>
|
|
493
|
-
* <p>
|
|
494
|
-
* <code>AGGREGATOR</code> – Resource Explorer replicates copies of the indexed
|
|
495
|
-
* information about resources in all other Amazon Web Services Regions to the aggregator index. This
|
|
496
|
-
* lets search results in the Region with the aggregator index to include resources
|
|
497
|
-
* from all Regions in the account where Resource Explorer is turned on.</p>
|
|
498
|
-
* </li>
|
|
499
|
-
* </ul>
|
|
401
|
+
* <p>The type of index. It can be one of the following values:</p> <ul> <li> <p> <code>LOCAL</code> – The index contains information about resources from only the same Amazon Web Services Region.</p> </li> <li> <p> <code>AGGREGATOR</code> – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.</p> </li> </ul>
|
|
500
402
|
* @public
|
|
501
403
|
*/
|
|
502
404
|
Type?: IndexType | undefined;
|
|
@@ -511,11 +413,7 @@ export interface ListIndexesOutput {
|
|
|
511
413
|
*/
|
|
512
414
|
Indexes?: Index[] | undefined;
|
|
513
415
|
/**
|
|
514
|
-
* <p>If present, indicates that more output is available than is
|
|
515
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
516
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
517
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
518
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
416
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
519
417
|
* @public
|
|
520
418
|
*/
|
|
521
419
|
NextToken?: string | undefined;
|
|
@@ -553,9 +451,7 @@ export interface UpdateIndexTypeInput {
|
|
|
553
451
|
*/
|
|
554
452
|
Arn: string | undefined;
|
|
555
453
|
/**
|
|
556
|
-
* <p>The type of the index. To understand the difference between <code>LOCAL</code> and
|
|
557
|
-
* <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region
|
|
558
|
-
* search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
454
|
+
* <p>The type of the index. To understand the difference between <code>LOCAL</code> and <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
559
455
|
* @public
|
|
560
456
|
*/
|
|
561
457
|
Type: IndexType | undefined;
|
|
@@ -575,8 +471,7 @@ export interface UpdateIndexTypeOutput {
|
|
|
575
471
|
*/
|
|
576
472
|
Type?: IndexType | undefined;
|
|
577
473
|
/**
|
|
578
|
-
* <p>Indicates the state of the request to update the index. This operation is
|
|
579
|
-
* asynchronous. Call the <a>GetIndex</a> operation to check for changes.</p>
|
|
474
|
+
* <p>Indicates the state of the request to update the index. This operation is asynchronous. Call the <a>GetIndex</a> operation to check for changes.</p>
|
|
580
475
|
* @public
|
|
581
476
|
*/
|
|
582
477
|
State?: IndexState | undefined;
|
|
@@ -591,47 +486,27 @@ export interface UpdateIndexTypeOutput {
|
|
|
591
486
|
*/
|
|
592
487
|
export interface CreateViewInput {
|
|
593
488
|
/**
|
|
594
|
-
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
595
|
-
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
596
|
-
* value</a> to ensure the uniqueness of your views.</p>
|
|
489
|
+
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type value</a> to ensure the uniqueness of your views.</p>
|
|
597
490
|
* @public
|
|
598
491
|
*/
|
|
599
492
|
ClientToken?: string | undefined;
|
|
600
493
|
/**
|
|
601
|
-
* <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p>
|
|
602
|
-
* <p>The name must be no more than 64 characters long, and can include letters, digits, and
|
|
603
|
-
* the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
|
|
494
|
+
* <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p> <p>The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
|
|
604
495
|
* @public
|
|
605
496
|
*/
|
|
606
497
|
ViewName: string | undefined;
|
|
607
498
|
/**
|
|
608
|
-
* <p>Specifies optional fields that you want included in search results from this
|
|
609
|
-
* view. It is a list of objects that each describe a field to include.</p>
|
|
610
|
-
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
499
|
+
* <p>Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.</p> <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
611
500
|
* @public
|
|
612
501
|
*/
|
|
613
502
|
IncludedProperties?: IncludedProperty[] | undefined;
|
|
614
503
|
/**
|
|
615
|
-
* <p>The root ARN of the account, an organizational unit (OU), or an organization ARN. If
|
|
616
|
-
* left empty, the default is account.</p>
|
|
504
|
+
* <p>The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.</p>
|
|
617
505
|
* @public
|
|
618
506
|
*/
|
|
619
507
|
Scope?: string | undefined;
|
|
620
508
|
/**
|
|
621
|
-
* <p>An array of strings that specify which resources are included in the results of
|
|
622
|
-
* queries made using this view. When you use this view in a <a>Search</a>
|
|
623
|
-
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
624
|
-
* parameter using a logical <code>AND</code> operator.</p>
|
|
625
|
-
* <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
|
|
626
|
-
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
627
|
-
* <important>
|
|
628
|
-
* <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
|
|
629
|
-
* 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
|
|
630
|
-
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
|
|
631
|
-
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
|
|
632
|
-
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
633
|
-
* <code>prod</code>.</p>
|
|
634
|
-
* </important>
|
|
509
|
+
* <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>
|
|
635
510
|
* @public
|
|
636
511
|
*/
|
|
637
512
|
Filters?: SearchFilter | undefined;
|
|
@@ -701,26 +576,12 @@ export interface GetViewOutput {
|
|
|
701
576
|
*/
|
|
702
577
|
export interface ListViewsInput {
|
|
703
578
|
/**
|
|
704
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
705
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
706
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
707
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
708
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
579
|
+
* <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>
|
|
709
580
|
* @public
|
|
710
581
|
*/
|
|
711
582
|
NextToken?: string | undefined;
|
|
712
583
|
/**
|
|
713
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
714
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
715
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
716
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
717
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
718
|
-
* the next part of the results.</p>
|
|
719
|
-
* <note>
|
|
720
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
721
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
722
|
-
* that you receive all of the results.</p>
|
|
723
|
-
* </note>
|
|
584
|
+
* <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>
|
|
724
585
|
* @public
|
|
725
586
|
*/
|
|
726
587
|
MaxResults?: number | undefined;
|
|
@@ -730,17 +591,12 @@ export interface ListViewsInput {
|
|
|
730
591
|
*/
|
|
731
592
|
export interface ListViewsOutput {
|
|
732
593
|
/**
|
|
733
|
-
* <p>The list of views available in the Amazon Web Services Region in which you called this
|
|
734
|
-
* operation.</p>
|
|
594
|
+
* <p>The list of views available in the Amazon Web Services Region in which you called this operation.</p>
|
|
735
595
|
* @public
|
|
736
596
|
*/
|
|
737
597
|
Views?: string[] | undefined;
|
|
738
598
|
/**
|
|
739
|
-
* <p>If present, indicates that more output is available than is
|
|
740
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
741
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
742
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
743
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
599
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
744
600
|
* @public
|
|
745
601
|
*/
|
|
746
602
|
NextToken?: string | undefined;
|
|
@@ -755,27 +611,12 @@ export interface UpdateViewInput {
|
|
|
755
611
|
*/
|
|
756
612
|
ViewArn: string | undefined;
|
|
757
613
|
/**
|
|
758
|
-
* <p>Specifies optional fields that you want included in search results from this
|
|
759
|
-
* view. It is a list of objects that each describe a field to include.</p>
|
|
760
|
-
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
614
|
+
* <p>Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.</p> <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
761
615
|
* @public
|
|
762
616
|
*/
|
|
763
617
|
IncludedProperties?: IncludedProperty[] | undefined;
|
|
764
618
|
/**
|
|
765
|
-
* <p>An array of strings that specify which resources are included in the results of
|
|
766
|
-
* queries made using this view. When you use this view in a <a>Search</a>
|
|
767
|
-
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
768
|
-
* parameter using a logical <code>AND</code> operator.</p>
|
|
769
|
-
* <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
|
|
770
|
-
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
771
|
-
* <important>
|
|
772
|
-
* <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
|
|
773
|
-
* 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
|
|
774
|
-
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
|
|
775
|
-
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
|
|
776
|
-
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
777
|
-
* <code>prod</code>.</p>
|
|
778
|
-
* </important>
|
|
619
|
+
* <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>
|
|
779
620
|
* @public
|
|
780
621
|
*/
|
|
781
622
|
Filters?: SearchFilter | undefined;
|
|
@@ -791,8 +632,78 @@ export interface UpdateViewOutput {
|
|
|
791
632
|
View?: View | undefined;
|
|
792
633
|
}
|
|
793
634
|
/**
|
|
794
|
-
*
|
|
795
|
-
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
export interface CreateResourceExplorerSetupInput {
|
|
638
|
+
/**
|
|
639
|
+
* <p>A list of Amazon Web Services Regions where Resource Explorer should be configured. Each Region in the list will have a user-owned index created.</p>
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
RegionList: string[] | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* <p>A list of Amazon Web Services Regions that should be configured as aggregator Regions. Aggregator Regions receive replicated index information from all other Regions where there is a user-owned index.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
AggregatorRegions?: string[] | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* <p>The name for the view to be created as part of the Resource Explorer setup. The view name must be unique within the Amazon Web Services account and Region.</p>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
ViewName: string | undefined;
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
export interface CreateResourceExplorerSetupOutput {
|
|
658
|
+
/**
|
|
659
|
+
* <p>The unique identifier for the setup task. Use this ID with <code>GetResourceExplorerSetup</code> to monitor the progress of the configuration operation.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
TaskId: string | undefined;
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
export interface DeleteResourceExplorerSetupInput {
|
|
668
|
+
/**
|
|
669
|
+
* <p>A list of Amazon Web Services Regions from which to delete the Resource Explorer configuration. If not specified, the operation uses the <code>DeleteInAllRegions</code> parameter to determine scope.</p>
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
RegionList?: string[] | undefined;
|
|
673
|
+
/**
|
|
674
|
+
* <p>Specifies whether to delete Resource Explorer configuration from all Regions where it is currently enabled. If this parameter is set to <code>true</code>, a value for <code>RegionList</code> must not be provided. Otherwise, the operation fails with a <code>ValidationException</code> error.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
DeleteInAllRegions?: boolean | undefined;
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
export interface DeleteResourceExplorerSetupOutput {
|
|
683
|
+
/**
|
|
684
|
+
* <p>The unique identifier for the deletion task. Use this ID with <code>GetResourceExplorerSetup</code> to monitor the progress of the deletion operation.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
TaskId: string | undefined;
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* <p>Contains information about an error that occurred during a Resource Explorer setup operation.</p>
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
export interface ErrorDetails {
|
|
694
|
+
/**
|
|
695
|
+
* <p>The error code that identifies the type of error that occurred.</p>
|
|
696
|
+
* @public
|
|
697
|
+
*/
|
|
698
|
+
Code?: string | undefined;
|
|
699
|
+
/**
|
|
700
|
+
* <p>A human-readable description of the error that occurred.</p>
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
Message?: string | undefined;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* <p>This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization.</p>
|
|
796
707
|
* @public
|
|
797
708
|
*/
|
|
798
709
|
export interface OrgConfiguration {
|
|
@@ -812,8 +723,7 @@ export interface OrgConfiguration {
|
|
|
812
723
|
*/
|
|
813
724
|
export interface GetAccountLevelServiceConfigurationOutput {
|
|
814
725
|
/**
|
|
815
|
-
* <p>Details about the organization, and whether configuration is <code>ENABLED</code> or
|
|
816
|
-
* <code>DISABLED</code>.</p>
|
|
726
|
+
* <p>Details about the organization, and whether configuration is <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
817
727
|
* @public
|
|
818
728
|
*/
|
|
819
729
|
OrgConfiguration?: OrgConfiguration | undefined;
|
|
@@ -823,8 +733,7 @@ export interface GetAccountLevelServiceConfigurationOutput {
|
|
|
823
733
|
*/
|
|
824
734
|
export interface GetDefaultViewOutput {
|
|
825
735
|
/**
|
|
826
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that is the current default for the Amazon Web Services Region in
|
|
827
|
-
* which you called this operation.</p>
|
|
736
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that is the current default for the Amazon Web Services Region in which you called this operation.</p>
|
|
828
737
|
* @public
|
|
829
738
|
*/
|
|
830
739
|
ViewArn?: string | undefined;
|
|
@@ -839,9 +748,7 @@ export interface GetIndexOutput {
|
|
|
839
748
|
*/
|
|
840
749
|
Arn?: string | undefined;
|
|
841
750
|
/**
|
|
842
|
-
* <p>The type of the index in this Region. For information about the aggregator index and
|
|
843
|
-
* how it differs from a local index, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search
|
|
844
|
-
* by creating an aggregator index</a>.</p>
|
|
751
|
+
* <p>The type of the index in this Region. For information about the aggregator index and how it differs from a local index, 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>.</p>
|
|
845
752
|
* @public
|
|
846
753
|
*/
|
|
847
754
|
Type?: IndexType | undefined;
|
|
@@ -851,18 +758,12 @@ export interface GetIndexOutput {
|
|
|
851
758
|
*/
|
|
852
759
|
State?: IndexState | undefined;
|
|
853
760
|
/**
|
|
854
|
-
* <p>This response value is present only if this index is
|
|
855
|
-
* <code>Type=AGGREGATOR</code>.</p>
|
|
856
|
-
* <p>A list of the Amazon Web Services Regions that replicate their content to the index in this
|
|
857
|
-
* Region.</p>
|
|
761
|
+
* <p>This response value is present only if this index is <code>Type=AGGREGATOR</code>.</p> <p>A list of the Amazon Web Services Regions that replicate their content to the index in this Region.</p>
|
|
858
762
|
* @public
|
|
859
763
|
*/
|
|
860
764
|
ReplicatingFrom?: string[] | undefined;
|
|
861
765
|
/**
|
|
862
|
-
* <p>This response value is present only if this index is <code>Type=LOCAL</code>.</p>
|
|
863
|
-
* <p>The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index
|
|
864
|
-
* does exist then the Region in which you called this operation replicates its index
|
|
865
|
-
* information to the Region specified in this response value. </p>
|
|
766
|
+
* <p>This response value is present only if this index is <code>Type=LOCAL</code>.</p> <p>The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value. </p>
|
|
866
767
|
* @public
|
|
867
768
|
*/
|
|
868
769
|
ReplicatingTo?: string[] | undefined;
|
|
@@ -893,9 +794,7 @@ export interface GetManagedViewInput {
|
|
|
893
794
|
ManagedViewArn: string | undefined;
|
|
894
795
|
}
|
|
895
796
|
/**
|
|
896
|
-
* <p>An Amazon Web Services-managed view is how other Amazon Web Services services can access
|
|
897
|
-
* resource information indexed by Resource Explorer for your Amazon Web Services account or organization
|
|
898
|
-
* with your consent. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html">Managed views</a>. </p>
|
|
797
|
+
* <p>An Amazon Web Services-managed view is how other Amazon Web Services services can access resource information indexed by Resource Explorer for your Amazon Web Services account or organization with your consent. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html">Managed views</a>. </p>
|
|
899
798
|
* @public
|
|
900
799
|
*/
|
|
901
800
|
export interface ManagedView {
|
|
@@ -925,8 +824,7 @@ export interface ManagedView {
|
|
|
925
824
|
*/
|
|
926
825
|
Owner?: string | undefined;
|
|
927
826
|
/**
|
|
928
|
-
* <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of an Amazon Web Services account or organization that specifies whether this managed view
|
|
929
|
-
* includes resources from only the specified Amazon Web Services account or all accounts in the specified organization. </p>
|
|
827
|
+
* <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of an Amazon Web Services account or organization that specifies whether this managed view includes resources from only the specified Amazon Web Services account or all accounts in the specified organization. </p>
|
|
930
828
|
* @public
|
|
931
829
|
*/
|
|
932
830
|
Scope?: string | undefined;
|
|
@@ -936,14 +834,12 @@ export interface ManagedView {
|
|
|
936
834
|
*/
|
|
937
835
|
IncludedProperties?: IncludedProperty[] | undefined;
|
|
938
836
|
/**
|
|
939
|
-
* <p>A search filter defines which resources can be part of a search query result
|
|
940
|
-
* set.</p>
|
|
837
|
+
* <p>A search filter defines which resources can be part of a search query result set.</p>
|
|
941
838
|
* @public
|
|
942
839
|
*/
|
|
943
840
|
Filters?: SearchFilter | undefined;
|
|
944
841
|
/**
|
|
945
|
-
* <p>The resource policy that defines access to the managed view. To learn more about this policy, review
|
|
946
|
-
* <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html">Managed views</a>.</p>
|
|
842
|
+
* <p>The resource policy that defines access to the managed view. To learn more about this policy, review <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html">Managed views</a>.</p>
|
|
947
843
|
* @public
|
|
948
844
|
*/
|
|
949
845
|
ResourcePolicy?: string | undefined;
|
|
@@ -963,44 +859,206 @@ export interface GetManagedViewOutput {
|
|
|
963
859
|
*/
|
|
964
860
|
ManagedView?: ManagedView | undefined;
|
|
965
861
|
}
|
|
862
|
+
/**
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface GetResourceExplorerSetupInput {
|
|
866
|
+
/**
|
|
867
|
+
* <p>The unique identifier of the setup task to retrieve status information for. This ID is returned by <code>CreateResourceExplorerSetup</code> or <code>DeleteResourceExplorerSetup</code> operations.</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
TaskId: string | undefined;
|
|
871
|
+
/**
|
|
872
|
+
* <p>The maximum number of Region status results to return in a single response. Valid values are between <code>1</code> and <code>100</code>.</p>
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
MaxResults?: number | undefined;
|
|
876
|
+
/**
|
|
877
|
+
* <p>The pagination token from a previous <code>GetResourceExplorerSetup</code> response. Use this token to retrieve the next set of results.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
NextToken?: string | undefined;
|
|
881
|
+
}
|
|
882
|
+
/**
|
|
883
|
+
* @public
|
|
884
|
+
* @enum
|
|
885
|
+
*/
|
|
886
|
+
export declare const OperationStatus: {
|
|
887
|
+
readonly FAILED: "FAILED";
|
|
888
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
889
|
+
readonly SKIPPED: "SKIPPED";
|
|
890
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
891
|
+
};
|
|
892
|
+
/**
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
export type OperationStatus = (typeof OperationStatus)[keyof typeof OperationStatus];
|
|
896
|
+
/**
|
|
897
|
+
* <p>Contains information about the status of a Resource Explorer index operation in a specific Region.</p>
|
|
898
|
+
* @public
|
|
899
|
+
*/
|
|
900
|
+
export interface IndexStatus {
|
|
901
|
+
/**
|
|
902
|
+
* <p>The current status of the index operation. Valid values are <code>SUCCEEDED</code>, <code>FAILED</code>, <code>IN_PROGRESS</code>, or <code>SKIPPED</code>.</p>
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
905
|
+
Status?: OperationStatus | undefined;
|
|
906
|
+
/**
|
|
907
|
+
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.</p> <p>By default, an index is <i>local</i>, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling <a>UpdateIndexType</a> to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.</p>
|
|
908
|
+
* @public
|
|
909
|
+
*/
|
|
910
|
+
Index?: Index | undefined;
|
|
911
|
+
/**
|
|
912
|
+
* <p>Details about any error that occurred during the index operation.</p>
|
|
913
|
+
* @public
|
|
914
|
+
*/
|
|
915
|
+
ErrorDetails?: ErrorDetails | undefined;
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* <p>Contains information about the status of a Resource Explorer view operation in a specific Region.</p>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
export interface ViewStatus {
|
|
922
|
+
/**
|
|
923
|
+
* <p>The current status of the view operation. Valid values are <code>SUCCEEDED</code>, <code>FAILED</code>, <code>IN_PROGRESS</code>, or <code>SKIPPED</code>.</p>
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
Status?: OperationStatus | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* <p>A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".</p>
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
View?: View | undefined;
|
|
932
|
+
/**
|
|
933
|
+
* <p>Details about any error that occurred during the view operation.</p>
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
ErrorDetails?: ErrorDetails | undefined;
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* <p>Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.</p>
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
export interface RegionStatus {
|
|
943
|
+
/**
|
|
944
|
+
* <p>The Amazon Web Services Region for which this status information applies.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
Region?: string | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The status information for the Resource Explorer index in this Region.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
Index?: IndexStatus | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The status information for the Resource Explorer view in this Region.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
View?: ViewStatus | undefined;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
export interface GetResourceExplorerSetupOutput {
|
|
963
|
+
/**
|
|
964
|
+
* <p>A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.</p>
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
Regions?: RegionStatus[] | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* <p>The pagination token to use in a subsequent <code>GetResourceExplorerSetup</code> request to retrieve the next set of results.</p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
NextToken?: string | undefined;
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
export interface GetServiceIndexOutput {
|
|
978
|
+
/**
|
|
979
|
+
* <p>The Amazon Resource Name (ARN) of the Resource Explorer index in the current Region.</p>
|
|
980
|
+
* @public
|
|
981
|
+
*/
|
|
982
|
+
Arn?: string | undefined;
|
|
983
|
+
/**
|
|
984
|
+
* <p>The type of the index. Valid values are <code>LOCAL</code> (contains resources from the current Region only) or <code>AGGREGATOR</code> (contains replicated resource information from all Regions).</p>
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
Type?: IndexType | undefined;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
export interface GetServiceViewInput {
|
|
993
|
+
/**
|
|
994
|
+
* <p>The Amazon Resource Name (ARN) of the service view to retrieve details for.</p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
ServiceViewArn: string | undefined;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* <p>Contains the configuration and properties of a Resource Explorer service view.</p>
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export interface ServiceView {
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The Amazon Resource Name (ARN) of the service view.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
ServiceViewArn: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>A search filter defines which resources can be part of a search query result set.</p>
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
Filters?: SearchFilter | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>A list of additional resource properties that are included in this view for search and filtering purposes.</p>
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
IncludedProperties?: IncludedProperty[] | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* <p>The Amazon Web Services service that has streaming access to this view's data.</p>
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
StreamingAccessForService?: string | undefined;
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>The scope type of the service view, which determines what resources are included.</p>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
ScopeType?: string | undefined;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
export interface GetServiceViewOutput {
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>A <code>ServiceView</code> object that contains the details and configuration of the requested service view.</p>
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
View: ServiceView | undefined;
|
|
1039
|
+
}
|
|
966
1040
|
/**
|
|
967
1041
|
* @public
|
|
968
1042
|
*/
|
|
969
1043
|
export interface ListIndexesForMembersInput {
|
|
970
1044
|
/**
|
|
971
|
-
* <p>The account IDs will limit the output to only indexes from these
|
|
972
|
-
* accounts.</p>
|
|
1045
|
+
* <p>The account IDs will limit the output to only indexes from these accounts.</p>
|
|
973
1046
|
* @public
|
|
974
1047
|
*/
|
|
975
1048
|
AccountIdList: string[] | undefined;
|
|
976
1049
|
/**
|
|
977
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
978
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
979
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
980
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
981
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
982
|
-
* the next part of the results.</p>
|
|
983
|
-
* <note>
|
|
984
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
985
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
986
|
-
* that you receive all of the results.</p>
|
|
987
|
-
* </note>
|
|
1050
|
+
* <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>
|
|
988
1051
|
* @public
|
|
989
1052
|
*/
|
|
990
1053
|
MaxResults?: number | undefined;
|
|
991
1054
|
/**
|
|
992
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
993
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
994
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
995
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
996
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
1055
|
+
* <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>
|
|
997
1056
|
* @public
|
|
998
1057
|
*/
|
|
999
1058
|
NextToken?: string | undefined;
|
|
1000
1059
|
}
|
|
1001
1060
|
/**
|
|
1002
|
-
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
|
|
1003
|
-
* resources that the service discovers. </p>
|
|
1061
|
+
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. </p>
|
|
1004
1062
|
* @public
|
|
1005
1063
|
*/
|
|
1006
1064
|
export interface MemberIndex {
|
|
@@ -1010,8 +1068,7 @@ export interface MemberIndex {
|
|
|
1010
1068
|
*/
|
|
1011
1069
|
AccountId?: string | undefined;
|
|
1012
1070
|
/**
|
|
1013
|
-
* <p>The Amazon Web Services Region in which the index
|
|
1014
|
-
* exists.</p>
|
|
1071
|
+
* <p>The Amazon Web Services Region in which the index exists.</p>
|
|
1015
1072
|
* @public
|
|
1016
1073
|
*/
|
|
1017
1074
|
Region?: string | undefined;
|
|
@@ -1021,21 +1078,7 @@ export interface MemberIndex {
|
|
|
1021
1078
|
*/
|
|
1022
1079
|
Arn?: string | undefined;
|
|
1023
1080
|
/**
|
|
1024
|
-
* <p>The type of index. It can be one of the following values: </p>
|
|
1025
|
-
* <ul>
|
|
1026
|
-
* <li>
|
|
1027
|
-
* <p>
|
|
1028
|
-
* <code>LOCAL</code> – The index contains information about resources
|
|
1029
|
-
* from only the same Amazon Web Services Region.</p>
|
|
1030
|
-
* </li>
|
|
1031
|
-
* <li>
|
|
1032
|
-
* <p>
|
|
1033
|
-
* <code>AGGREGATOR</code> – Resource Explorer replicates copies of the indexed
|
|
1034
|
-
* information about resources in all other Amazon Web Services Regions to the aggregator index. This
|
|
1035
|
-
* lets search results in the Region with the aggregator index to include resources
|
|
1036
|
-
* from all Regions in the account where Resource Explorer is turned on.</p>
|
|
1037
|
-
* </li>
|
|
1038
|
-
* </ul>
|
|
1081
|
+
* <p>The type of index. It can be one of the following values: </p> <ul> <li> <p> <code>LOCAL</code> – The index contains information about resources from only the same Amazon Web Services Region.</p> </li> <li> <p> <code>AGGREGATOR</code> – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.</p> </li> </ul>
|
|
1039
1082
|
* @public
|
|
1040
1083
|
*/
|
|
1041
1084
|
Type?: IndexType | undefined;
|
|
@@ -1045,17 +1088,12 @@ export interface MemberIndex {
|
|
|
1045
1088
|
*/
|
|
1046
1089
|
export interface ListIndexesForMembersOutput {
|
|
1047
1090
|
/**
|
|
1048
|
-
* <p>A structure that contains the details and status of each
|
|
1049
|
-
* index.</p>
|
|
1091
|
+
* <p>A structure that contains the details and status of each index.</p>
|
|
1050
1092
|
* @public
|
|
1051
1093
|
*/
|
|
1052
1094
|
Indexes?: MemberIndex[] | undefined;
|
|
1053
1095
|
/**
|
|
1054
|
-
* <p>If present, indicates that more output is available than is
|
|
1055
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1056
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1057
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1058
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
1096
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1059
1097
|
* @public
|
|
1060
1098
|
*/
|
|
1061
1099
|
NextToken?: string | undefined;
|
|
@@ -1065,32 +1103,17 @@ export interface ListIndexesForMembersOutput {
|
|
|
1065
1103
|
*/
|
|
1066
1104
|
export interface ListManagedViewsInput {
|
|
1067
1105
|
/**
|
|
1068
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
1069
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
1070
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
1071
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
1072
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
1073
|
-
* the next part of the results.</p>
|
|
1074
|
-
* <note>
|
|
1075
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
1076
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1077
|
-
* that you receive all of the results.</p>
|
|
1078
|
-
* </note>
|
|
1106
|
+
* <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>
|
|
1079
1107
|
* @public
|
|
1080
1108
|
*/
|
|
1081
1109
|
MaxResults?: number | undefined;
|
|
1082
1110
|
/**
|
|
1083
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
1084
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1085
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
1086
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
1087
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
1111
|
+
* <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>
|
|
1088
1112
|
* @public
|
|
1089
1113
|
*/
|
|
1090
1114
|
NextToken?: string | undefined;
|
|
1091
1115
|
/**
|
|
1092
|
-
* <p>Specifies a service principal name. If specified, then the
|
|
1093
|
-
* operation only returns the managed views that are managed by the input service. </p>
|
|
1116
|
+
* <p>Specifies a service principal name. If specified, then the operation only returns the managed views that are managed by the input service. </p>
|
|
1094
1117
|
* @public
|
|
1095
1118
|
*/
|
|
1096
1119
|
ServicePrincipal?: string | undefined;
|
|
@@ -1100,11 +1123,7 @@ export interface ListManagedViewsInput {
|
|
|
1100
1123
|
*/
|
|
1101
1124
|
export interface ListManagedViewsOutput {
|
|
1102
1125
|
/**
|
|
1103
|
-
* <p>If present, indicates that more output is available than is
|
|
1104
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1105
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1106
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1107
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
1126
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1108
1127
|
* @public
|
|
1109
1128
|
*/
|
|
1110
1129
|
NextToken?: string | undefined;
|
|
@@ -1119,57 +1138,22 @@ export interface ListManagedViewsOutput {
|
|
|
1119
1138
|
*/
|
|
1120
1139
|
export interface ListResourcesInput {
|
|
1121
1140
|
/**
|
|
1122
|
-
* <p>An array of strings that specify which resources are included in the results of
|
|
1123
|
-
* queries made using this view. When you use this view in a <a>Search</a>
|
|
1124
|
-
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
1125
|
-
* parameter using a logical <code>AND</code> operator.</p>
|
|
1126
|
-
* <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
|
|
1127
|
-
* Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
1128
|
-
* <important>
|
|
1129
|
-
* <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
|
|
1130
|
-
* 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
|
|
1131
|
-
* string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
|
|
1132
|
-
* resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
|
|
1133
|
-
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
1134
|
-
* <code>prod</code>.</p>
|
|
1135
|
-
* </important>
|
|
1141
|
+
* <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>
|
|
1136
1142
|
* @public
|
|
1137
1143
|
*/
|
|
1138
1144
|
Filters?: SearchFilter | undefined;
|
|
1139
1145
|
/**
|
|
1140
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
1141
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
1142
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
1143
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
1144
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
1145
|
-
* the next part of the results.</p>
|
|
1146
|
-
* <note>
|
|
1147
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
1148
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1149
|
-
* that you receive all of the results.</p>
|
|
1150
|
-
* </note>
|
|
1146
|
+
* <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>
|
|
1151
1147
|
* @public
|
|
1152
1148
|
*/
|
|
1153
1149
|
MaxResults?: number | undefined;
|
|
1154
1150
|
/**
|
|
1155
|
-
* <p>Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't
|
|
1156
|
-
* specify a value for this parameter, then the operation automatically uses the default view
|
|
1157
|
-
* for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have
|
|
1158
|
-
* a default view or if you don't have permission to use the default view, then the operation
|
|
1159
|
-
* fails with a 401 Unauthorized exception.</p>
|
|
1151
|
+
* <p>Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.</p>
|
|
1160
1152
|
* @public
|
|
1161
1153
|
*/
|
|
1162
1154
|
ViewArn?: string | undefined;
|
|
1163
1155
|
/**
|
|
1164
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
1165
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1166
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
1167
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
1168
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
1169
|
-
* <note>
|
|
1170
|
-
* <p>The <code>ListResources</code> operation
|
|
1171
|
-
* does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p>
|
|
1172
|
-
* </note>
|
|
1156
|
+
* <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>
|
|
1173
1157
|
* @public
|
|
1174
1158
|
*/
|
|
1175
1159
|
NextToken?: string | undefined;
|
|
@@ -1185,21 +1169,18 @@ export interface ResourceProperty {
|
|
|
1185
1169
|
*/
|
|
1186
1170
|
Name?: string | undefined;
|
|
1187
1171
|
/**
|
|
1188
|
-
* <p>The date and time that the information about this resource property was last
|
|
1189
|
-
* updated.</p>
|
|
1172
|
+
* <p>The date and time that the information about this resource property was last updated.</p>
|
|
1190
1173
|
* @public
|
|
1191
1174
|
*/
|
|
1192
1175
|
LastReportedAt?: Date | undefined;
|
|
1193
1176
|
/**
|
|
1194
|
-
* <p>Details about this property. The content of this field is a JSON object that varies
|
|
1195
|
-
* based on the resource type.</p>
|
|
1177
|
+
* <p>Details about this property. The content of this field is a JSON object that varies based on the resource type.</p>
|
|
1196
1178
|
* @public
|
|
1197
1179
|
*/
|
|
1198
1180
|
Data?: __DocumentType | undefined;
|
|
1199
1181
|
}
|
|
1200
1182
|
/**
|
|
1201
|
-
* <p>A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored
|
|
1202
|
-
* information in the index of the Amazon Web Services Region that contains the resource.</p>
|
|
1183
|
+
* <p>A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.</p>
|
|
1203
1184
|
* @public
|
|
1204
1185
|
*/
|
|
1205
1186
|
export interface Resource {
|
|
@@ -1224,20 +1205,17 @@ export interface Resource {
|
|
|
1224
1205
|
*/
|
|
1225
1206
|
ResourceType?: string | undefined;
|
|
1226
1207
|
/**
|
|
1227
|
-
* <p>The Amazon Web Services service that owns the resource and is responsible for creating and updating
|
|
1228
|
-
* it.</p>
|
|
1208
|
+
* <p>The Amazon Web Services service that owns the resource and is responsible for creating and updating it.</p>
|
|
1229
1209
|
* @public
|
|
1230
1210
|
*/
|
|
1231
1211
|
Service?: string | undefined;
|
|
1232
1212
|
/**
|
|
1233
|
-
* <p>The date and time that Resource Explorer last queried this resource and updated the index with
|
|
1234
|
-
* the latest information about the resource.</p>
|
|
1213
|
+
* <p>The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.</p>
|
|
1235
1214
|
* @public
|
|
1236
1215
|
*/
|
|
1237
1216
|
LastReportedAt?: Date | undefined;
|
|
1238
1217
|
/**
|
|
1239
|
-
* <p>A structure with additional type-specific details about the resource. These properties
|
|
1240
|
-
* can be added by turning on integration between Resource Explorer and other Amazon Web Services services.</p>
|
|
1218
|
+
* <p>A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.</p>
|
|
1241
1219
|
* @public
|
|
1242
1220
|
*/
|
|
1243
1221
|
Properties?: ResourceProperty[] | undefined;
|
|
@@ -1252,11 +1230,7 @@ export interface ListResourcesOutput {
|
|
|
1252
1230
|
*/
|
|
1253
1231
|
Resources?: Resource[] | undefined;
|
|
1254
1232
|
/**
|
|
1255
|
-
* <p>If present, indicates that more output is available than is
|
|
1256
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1257
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1258
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1259
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
1233
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1260
1234
|
* @public
|
|
1261
1235
|
*/
|
|
1262
1236
|
NextToken?: string | undefined;
|
|
@@ -1266,31 +1240,128 @@ export interface ListResourcesOutput {
|
|
|
1266
1240
|
*/
|
|
1267
1241
|
ViewArn?: string | undefined;
|
|
1268
1242
|
}
|
|
1243
|
+
/**
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
export interface ListServiceIndexesInput {
|
|
1247
|
+
/**
|
|
1248
|
+
* <p>A list of Amazon Web Services Regions to include in the search for indexes. If not specified, indexes from all Regions are returned.</p>
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
Regions?: string[] | undefined;
|
|
1252
|
+
/**
|
|
1253
|
+
* <p>The maximum number of index results to return in a single response. Valid values are between <code>1</code> and <code>100</code>.</p>
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
MaxResults?: number | undefined;
|
|
1257
|
+
/**
|
|
1258
|
+
* <p>The pagination token from a previous <code>ListServiceIndexes</code> response. Use this token to retrieve the next set of results.</p>
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
NextToken?: string | undefined;
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
export interface ListServiceIndexesOutput {
|
|
1267
|
+
/**
|
|
1268
|
+
* <p>A list of <code>Index</code> objects that describe the Resource Explorer indexes found in the specified Regions.</p>
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
Indexes?: Index[] | undefined;
|
|
1272
|
+
/**
|
|
1273
|
+
* <p>The pagination token to use in a subsequent <code>ListServiceIndexes</code> request to retrieve the next set of results.</p>
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
NextToken?: string | undefined;
|
|
1277
|
+
}
|
|
1278
|
+
/**
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
export interface ListServiceViewsInput {
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>The maximum number of service view results to return in a single response. Valid values are between <code>1</code> and <code>50</code>.</p>
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
MaxResults?: number | undefined;
|
|
1287
|
+
/**
|
|
1288
|
+
* <p>The pagination token from a previous <code>ListServiceViews</code> response. Use this token to retrieve the next set of results.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
NextToken?: string | undefined;
|
|
1292
|
+
}
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
export interface ListServiceViewsOutput {
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The pagination token to use in a subsequent <code>ListServiceViews</code> request to retrieve the next set of results.</p>
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
NextToken?: string | undefined;
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>A list of Amazon Resource Names (ARNs) for the service views available in the current Amazon Web Services account.</p>
|
|
1304
|
+
* @public
|
|
1305
|
+
*/
|
|
1306
|
+
ServiceViews?: string[] | undefined;
|
|
1307
|
+
}
|
|
1308
|
+
/**
|
|
1309
|
+
* @public
|
|
1310
|
+
*/
|
|
1311
|
+
export interface ListStreamingAccessForServicesInput {
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>The maximum number of streaming access entries to return in the response. If there are more results available, the response includes a NextToken value that you can use in a subsequent call to get the next set of results. The value must be between 1 and 50. If you don't specify a value, the default is 50.</p>
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
MaxResults?: number | undefined;
|
|
1317
|
+
/**
|
|
1318
|
+
* <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>
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
NextToken?: string | undefined;
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>Contains information about an Amazon Web Services service that has been granted streaming access to your Resource Explorer data.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
export interface StreamingAccessDetails {
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The service principal of the Amazon Web Services service that has streaming access to your Resource Explorer data. A service principal is a unique identifier for an Amazon Web Services service.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
ServicePrincipal: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The date and time when streaming access was granted to the Amazon Web Services service, in ISO 8601 format.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
CreatedAt: Date | undefined;
|
|
1338
|
+
}
|
|
1339
|
+
/**
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
export interface ListStreamingAccessForServicesOutput {
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>A list of Amazon Web Services services that have streaming access to your Resource Explorer data, including details about when the access was granted.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
StreamingAccessForServices: StreamingAccessDetails[] | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
NextToken?: string | undefined;
|
|
1353
|
+
}
|
|
1269
1354
|
/**
|
|
1270
1355
|
* @public
|
|
1271
1356
|
*/
|
|
1272
1357
|
export interface ListSupportedResourceTypesInput {
|
|
1273
1358
|
/**
|
|
1274
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
1275
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1276
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
1277
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
1278
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
1359
|
+
* <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>
|
|
1279
1360
|
* @public
|
|
1280
1361
|
*/
|
|
1281
1362
|
NextToken?: string | undefined;
|
|
1282
1363
|
/**
|
|
1283
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
1284
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
1285
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
1286
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
1287
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
1288
|
-
* the next part of the results.</p>
|
|
1289
|
-
* <note>
|
|
1290
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
1291
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1292
|
-
* that you receive all of the results.</p>
|
|
1293
|
-
* </note>
|
|
1364
|
+
* <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>
|
|
1294
1365
|
* @public
|
|
1295
1366
|
*/
|
|
1296
1367
|
MaxResults?: number | undefined;
|
|
@@ -1301,8 +1372,7 @@ export interface ListSupportedResourceTypesInput {
|
|
|
1301
1372
|
*/
|
|
1302
1373
|
export interface SupportedResourceType {
|
|
1303
1374
|
/**
|
|
1304
|
-
* <p>The Amazon Web Services service that is associated with the resource type. This is the primary
|
|
1305
|
-
* service that lets you create and interact with resources of this type.</p>
|
|
1375
|
+
* <p>The Amazon Web Services service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.</p>
|
|
1306
1376
|
* @public
|
|
1307
1377
|
*/
|
|
1308
1378
|
Service?: string | undefined;
|
|
@@ -1322,11 +1392,7 @@ export interface ListSupportedResourceTypesOutput {
|
|
|
1322
1392
|
*/
|
|
1323
1393
|
ResourceTypes?: SupportedResourceType[] | undefined;
|
|
1324
1394
|
/**
|
|
1325
|
-
* <p>If present, indicates that more output is available than is
|
|
1326
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1327
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1328
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1329
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
1395
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1330
1396
|
* @public
|
|
1331
1397
|
*/
|
|
1332
1398
|
NextToken?: string | undefined;
|
|
@@ -1346,42 +1412,23 @@ export interface ListTagsForResourceInput {
|
|
|
1346
1412
|
*/
|
|
1347
1413
|
export interface ListTagsForResourceOutput {
|
|
1348
1414
|
/**
|
|
1349
|
-
* <p>The tag key and value pairs that you want to attach to the specified view or
|
|
1350
|
-
* index.</p>
|
|
1415
|
+
* <p>The tag key and value pairs that you want to attach to the specified view or index.</p>
|
|
1351
1416
|
* @public
|
|
1352
1417
|
*/
|
|
1353
1418
|
Tags?: Record<string, string> | undefined;
|
|
1354
1419
|
}
|
|
1355
1420
|
/**
|
|
1356
|
-
* <p>Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer
|
|
1357
|
-
* doesn't count more than 1,000 matches for any query. This structure
|
|
1358
|
-
* provides information about whether the query exceeded this limit.</p>
|
|
1359
|
-
* <p>This field is included in every page when you paginate the results.</p>
|
|
1421
|
+
* <p>Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.</p> <p>This field is included in every page when you paginate the results.</p>
|
|
1360
1422
|
* @public
|
|
1361
1423
|
*/
|
|
1362
1424
|
export interface ResourceCount {
|
|
1363
1425
|
/**
|
|
1364
|
-
* <p>The number of resources that match the search query. This value can't exceed
|
|
1365
|
-
* 1,000. If there are more than 1,000 resources that match
|
|
1366
|
-
* the query, then only 1,000 are counted and the <code>Complete</code>
|
|
1367
|
-
* field is set to false. We recommend that you refine your query to return a smaller
|
|
1368
|
-
* number of results.</p>
|
|
1426
|
+
* <p>The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the <code>Complete</code> field is set to false. We recommend that you refine your query to return a smaller number of results.</p>
|
|
1369
1427
|
* @public
|
|
1370
1428
|
*/
|
|
1371
1429
|
TotalResources?: number | undefined;
|
|
1372
1430
|
/**
|
|
1373
|
-
* <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count
|
|
1374
|
-
* of search results.</p>
|
|
1375
|
-
* <ul>
|
|
1376
|
-
* <li>
|
|
1377
|
-
* <p>If <code>True</code>, it indicates that the search was exhaustive. Every
|
|
1378
|
-
* resource that matches the query was counted.</p>
|
|
1379
|
-
* </li>
|
|
1380
|
-
* <li>
|
|
1381
|
-
* <p>If <code>False</code>, then the search reached the limit of
|
|
1382
|
-
* 1,000 matching results, and stopped counting.</p>
|
|
1383
|
-
* </li>
|
|
1384
|
-
* </ul>
|
|
1431
|
+
* <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count of search results.</p> <ul> <li> <p>If <code>True</code>, it indicates that the search was exhaustive. Every resource that matches the query was counted.</p> </li> <li> <p>If <code>False</code>, then the search reached the limit of 1,000 matching results, and stopped counting.</p> </li> </ul>
|
|
1385
1432
|
* @public
|
|
1386
1433
|
*/
|
|
1387
1434
|
Complete?: boolean | undefined;
|
|
@@ -1391,50 +1438,22 @@ export interface ResourceCount {
|
|
|
1391
1438
|
*/
|
|
1392
1439
|
export interface SearchInput {
|
|
1393
1440
|
/**
|
|
1394
|
-
* <p>A string that includes keywords and filters that specify the resources that you want
|
|
1395
|
-
* to include in the results.</p>
|
|
1396
|
-
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
1397
|
-
* <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>
|
|
1398
|
-
* <p>The search is completely case insensitive. You can specify an empty string to return
|
|
1399
|
-
* all results up to the limit of 1,000 total results.</p>
|
|
1400
|
-
* <note>
|
|
1401
|
-
* <p>The operation can return only the first 1,000 results. If the
|
|
1402
|
-
* resource you want is not included, then use a different value for
|
|
1403
|
-
* <code>QueryString</code> to refine the results.</p>
|
|
1404
|
-
* </note>
|
|
1441
|
+
* <p>A string that includes keywords and filters that specify the resources that you want to include in the results.</p> <p>For the complete syntax supported by the <code>QueryString</code> parameter, see <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> <p>The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.</p> <note> <p>The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for <code>QueryString</code> to refine the results.</p> </note>
|
|
1405
1442
|
* @public
|
|
1406
1443
|
*/
|
|
1407
1444
|
QueryString: string | undefined;
|
|
1408
1445
|
/**
|
|
1409
|
-
* <p>The maximum number of results that you want included on each page of the
|
|
1410
|
-
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
1411
|
-
* operation. If additional items exist beyond those included in the current response, the
|
|
1412
|
-
* <code>NextToken</code> response element is present and has a value (is not null). Include that
|
|
1413
|
-
* value as the <code>NextToken</code> request parameter in the next call to the operation to get
|
|
1414
|
-
* the next part of the results.</p>
|
|
1415
|
-
* <note>
|
|
1416
|
-
* <p>An API operation can return fewer results than the maximum even when there are
|
|
1417
|
-
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1418
|
-
* that you receive all of the results.</p>
|
|
1419
|
-
* </note>
|
|
1446
|
+
* <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>
|
|
1420
1447
|
* @public
|
|
1421
1448
|
*/
|
|
1422
1449
|
MaxResults?: number | undefined;
|
|
1423
1450
|
/**
|
|
1424
|
-
* <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to use for the query. If you don't specify a
|
|
1425
|
-
* value for this parameter, then the operation automatically uses the default view for the
|
|
1426
|
-
* Amazon Web Services Region in which you called this operation. If the Region either doesn't have a
|
|
1427
|
-
* default view or if you don't have permission to use the default view, then the operation
|
|
1428
|
-
* fails with a <code>401 Unauthorized</code> exception.</p>
|
|
1451
|
+
* <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a <code>401 Unauthorized</code> exception.</p>
|
|
1429
1452
|
* @public
|
|
1430
1453
|
*/
|
|
1431
1454
|
ViewArn?: string | undefined;
|
|
1432
1455
|
/**
|
|
1433
|
-
* <p>The parameter for receiving additional results if you receive a
|
|
1434
|
-
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1435
|
-
* indicates that more output is available. Set this parameter to the value of the previous
|
|
1436
|
-
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
1437
|
-
* from. The pagination tokens expire after 24 hours.</p>
|
|
1456
|
+
* <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>
|
|
1438
1457
|
* @public
|
|
1439
1458
|
*/
|
|
1440
1459
|
NextToken?: string | undefined;
|
|
@@ -1449,11 +1468,7 @@ export interface SearchOutput {
|
|
|
1449
1468
|
*/
|
|
1450
1469
|
Resources?: Resource[] | undefined;
|
|
1451
1470
|
/**
|
|
1452
|
-
* <p>If present, indicates that more output is available than is
|
|
1453
|
-
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1454
|
-
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1455
|
-
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1456
|
-
* The pagination tokens expire after 24 hours.</p>
|
|
1471
|
+
* <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
|
|
1457
1472
|
* @public
|
|
1458
1473
|
*/
|
|
1459
1474
|
NextToken?: string | undefined;
|
|
@@ -1473,14 +1488,12 @@ export interface SearchOutput {
|
|
|
1473
1488
|
*/
|
|
1474
1489
|
export interface TagResourceInput {
|
|
1475
1490
|
/**
|
|
1476
|
-
* <p>The Amazon Resource Name (ARN) of the view or index that you want to attach tags
|
|
1477
|
-
* to.</p>
|
|
1491
|
+
* <p>The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.</p>
|
|
1478
1492
|
* @public
|
|
1479
1493
|
*/
|
|
1480
1494
|
resourceArn: string | undefined;
|
|
1481
1495
|
/**
|
|
1482
|
-
* <p>A list of tag key and value pairs that you want to attach to the specified view or
|
|
1483
|
-
* index.</p>
|
|
1496
|
+
* <p>A list of tag key and value pairs that you want to attach to the specified view or index.</p>
|
|
1484
1497
|
* @public
|
|
1485
1498
|
*/
|
|
1486
1499
|
Tags?: Record<string, string> | undefined;
|
|
@@ -1495,14 +1508,12 @@ export interface TagResourceOutput {
|
|
|
1495
1508
|
*/
|
|
1496
1509
|
export interface UntagResourceInput {
|
|
1497
1510
|
/**
|
|
1498
|
-
* <p>The Amazon Resource Name (ARN) of the view or index that you want to remove tags
|
|
1499
|
-
* from.</p>
|
|
1511
|
+
* <p>The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.</p>
|
|
1500
1512
|
* @public
|
|
1501
1513
|
*/
|
|
1502
1514
|
resourceArn: string | undefined;
|
|
1503
1515
|
/**
|
|
1504
|
-
* <p>A list of the keys for the tags that you want to remove from the specified view or
|
|
1505
|
-
* index.</p>
|
|
1516
|
+
* <p>A list of the keys for the tags that you want to remove from the specified view or index.</p>
|
|
1506
1517
|
* @public
|
|
1507
1518
|
*/
|
|
1508
1519
|
tagKeys: string[] | undefined;
|
|
@@ -1560,6 +1571,26 @@ export declare const ManagedViewFilterSensitiveLog: (obj: ManagedView) => any;
|
|
|
1560
1571
|
* @internal
|
|
1561
1572
|
*/
|
|
1562
1573
|
export declare const GetManagedViewOutputFilterSensitiveLog: (obj: GetManagedViewOutput) => any;
|
|
1574
|
+
/**
|
|
1575
|
+
* @internal
|
|
1576
|
+
*/
|
|
1577
|
+
export declare const ViewStatusFilterSensitiveLog: (obj: ViewStatus) => any;
|
|
1578
|
+
/**
|
|
1579
|
+
* @internal
|
|
1580
|
+
*/
|
|
1581
|
+
export declare const RegionStatusFilterSensitiveLog: (obj: RegionStatus) => any;
|
|
1582
|
+
/**
|
|
1583
|
+
* @internal
|
|
1584
|
+
*/
|
|
1585
|
+
export declare const GetResourceExplorerSetupOutputFilterSensitiveLog: (obj: GetResourceExplorerSetupOutput) => any;
|
|
1586
|
+
/**
|
|
1587
|
+
* @internal
|
|
1588
|
+
*/
|
|
1589
|
+
export declare const ServiceViewFilterSensitiveLog: (obj: ServiceView) => any;
|
|
1590
|
+
/**
|
|
1591
|
+
* @internal
|
|
1592
|
+
*/
|
|
1593
|
+
export declare const GetServiceViewOutputFilterSensitiveLog: (obj: GetServiceViewOutput) => any;
|
|
1563
1594
|
/**
|
|
1564
1595
|
* @internal
|
|
1565
1596
|
*/
|