@aws-sdk/client-resource-explorer-2 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/ResourceExplorer2.d.ts +10 -1
- package/dist-types/ResourceExplorer2Client.d.ts +1 -1
- package/dist-types/commands/AssociateDefaultViewCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetViewCommand.d.ts +2 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -1
- package/dist-types/commands/CreateViewCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +2 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateDefaultViewCommand.d.ts +2 -1
- package/dist-types/commands/GetAccountLevelServiceConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetDefaultViewCommand.d.ts +2 -1
- package/dist-types/commands/GetIndexCommand.d.ts +2 -1
- package/dist-types/commands/GetViewCommand.d.ts +2 -1
- package/dist-types/commands/ListIndexesCommand.d.ts +2 -1
- package/dist-types/commands/ListIndexesForMembersCommand.d.ts +2 -1
- package/dist-types/commands/ListSupportedResourceTypesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListViewsCommand.d.ts +2 -1
- package/dist-types/commands/SearchCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateIndexTypeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateViewCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +137 -137
- package/dist-types/ts3.4/ResourceExplorer2.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateDefaultViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateDefaultViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccountLevelServiceConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDefaultViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetViewCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/ListIndexesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIndexesForMembersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSupportedResourceTypesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListViewsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateIndexTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -2,9 +2,9 @@ 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
|
-
* @public
|
|
6
5
|
* <p>The credentials that you used to call this operation don't have the minimum required
|
|
7
6
|
* permissions.</p>
|
|
7
|
+
* @public
|
|
8
8
|
*/
|
|
9
9
|
export declare class AccessDeniedException extends __BaseException {
|
|
10
10
|
readonly name: "AccessDeniedException";
|
|
@@ -20,10 +20,10 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AssociateDefaultViewInput {
|
|
22
22
|
/**
|
|
23
|
-
* @public
|
|
24
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
|
|
25
24
|
* Amazon Web Services account in which you call this operation. The specified view must already exist in
|
|
26
25
|
* the called Region.</p>
|
|
26
|
+
* @public
|
|
27
27
|
*/
|
|
28
28
|
ViewArn: string | undefined;
|
|
29
29
|
}
|
|
@@ -32,16 +32,16 @@ export interface AssociateDefaultViewInput {
|
|
|
32
32
|
*/
|
|
33
33
|
export interface AssociateDefaultViewOutput {
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
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
|
|
37
36
|
* in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.</p>
|
|
37
|
+
* @public
|
|
38
38
|
*/
|
|
39
39
|
ViewArn?: string;
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>The request failed because of internal service error. Try your request again
|
|
44
43
|
* later.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
export declare class InternalServerException extends __BaseException {
|
|
47
47
|
readonly name: "InternalServerException";
|
|
@@ -53,9 +53,9 @@ export declare class InternalServerException extends __BaseException {
|
|
|
53
53
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>You specified a resource that doesn't exist. Check the ID or ARN that you used to
|
|
58
57
|
* identity the resource, and try again.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
61
61
|
readonly name: "ResourceNotFoundException";
|
|
@@ -67,10 +67,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
67
67
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* @public
|
|
71
70
|
* <p>The request failed because you exceeded a rate limit for this operation. For more
|
|
72
71
|
* information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html">Quotas for
|
|
73
72
|
* Resource Explorer</a>.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
export declare class ThrottlingException extends __BaseException {
|
|
76
76
|
readonly name: "ThrottlingException";
|
|
@@ -82,33 +82,33 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
82
82
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>A structure that describes a request field with a validation error.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
export interface ValidationExceptionField {
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The name of the request field that had a validation error.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
Name: string | undefined;
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>The validation error caused by the request field.</p>
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
ValidationIssue: string | undefined;
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>You provided an invalid value for one of the operation's parameters. Check the syntax
|
|
103
102
|
* for the operation, and try again.</p>
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
export declare class ValidationException extends __BaseException {
|
|
106
106
|
readonly name: "ValidationException";
|
|
107
107
|
readonly $fault: "client";
|
|
108
108
|
Message: string | undefined;
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>An array of the request fields that had validation errors.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
FieldList?: ValidationExceptionField[];
|
|
114
114
|
/**
|
|
@@ -133,52 +133,51 @@ export type AWSServiceAccessStatus = (typeof AWSServiceAccessStatus)[keyof typeo
|
|
|
133
133
|
*/
|
|
134
134
|
export interface BatchGetViewInput {
|
|
135
135
|
/**
|
|
136
|
-
* @public
|
|
137
136
|
* <p>A list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource names (ARNs)</a> that identify the views you want details for.</p>
|
|
137
|
+
* @public
|
|
138
138
|
*/
|
|
139
139
|
ViewArns?: string[];
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve
|
|
144
143
|
* details.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
export interface BatchGetViewError {
|
|
147
147
|
/**
|
|
148
|
-
* @public
|
|
149
148
|
* <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 for which Resource Explorer failed to retrieve details.</p>
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
ViewArn: string | undefined;
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>The description of the error for the specified view.</p>
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
ErrorMessage: string | undefined;
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>A search filter defines which resources can be part of a search query result
|
|
161
160
|
* set.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
export interface SearchFilter {
|
|
164
164
|
/**
|
|
165
|
-
* @public
|
|
166
165
|
* <p>The string that contains the search keywords, prefixes, and operators to control the
|
|
167
166
|
* results that can be returned by a <a>Search</a> operation. For more details,
|
|
168
167
|
* see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
|
|
169
168
|
* query syntax</a>.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
FilterString: string | undefined;
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>Information about an additional property that describes a resource, that you can
|
|
176
175
|
* optionally include in the view. This lets you view that property in search results, and
|
|
177
176
|
* filter your search results based on the value of the property.</p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
export interface IncludedProperty {
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>The name of the property that is included in this view.</p>
|
|
183
182
|
* <p>You can specify the following property names for this field:</p>
|
|
184
183
|
* <ul>
|
|
@@ -188,53 +187,54 @@ export interface IncludedProperty {
|
|
|
188
187
|
* </p>
|
|
189
188
|
* </li>
|
|
190
189
|
* </ul>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
Name: string | undefined;
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>A view is a structure that defines a set of filters that provide a view into the
|
|
197
196
|
* information in the Amazon Web Services Resource Explorer index. The filters specify which information from the
|
|
198
197
|
* index is visible to the users of the view. For example, you can specify filters that
|
|
199
198
|
* include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in
|
|
200
199
|
* the results returned by this view. You could also create a second view that includes
|
|
201
200
|
* only resources that are tagged with "ENV" and "PRODUCTION".</p>
|
|
201
|
+
* @public
|
|
202
202
|
*/
|
|
203
203
|
export interface View {
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <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.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
ViewArn?: string;
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The Amazon Web Services account that owns this view.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
Owner?: string;
|
|
214
214
|
/**
|
|
215
|
-
* @public
|
|
216
215
|
* <p>The date and time when this view was last modified.</p>
|
|
216
|
+
* @public
|
|
217
217
|
*/
|
|
218
218
|
LastUpdatedAt?: Date;
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
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
|
|
222
221
|
* organizational unit (OU) that specifies whether this view includes resources from only
|
|
223
222
|
* the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in
|
|
224
223
|
* the specified OU.</p>
|
|
225
224
|
* <p>If not specified, the value defaults to the Amazon Web Services account used to call this
|
|
226
225
|
* operation.</p>
|
|
226
|
+
* @public
|
|
227
227
|
*/
|
|
228
228
|
Scope?: string;
|
|
229
229
|
/**
|
|
230
|
-
* @public
|
|
231
230
|
* <p>A structure that contains additional information about the view.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
IncludedProperties?: IncludedProperty[];
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>An array of <a>SearchFilter</a> objects that specify which resources can be
|
|
237
236
|
* included in the results of queries made using this view.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
Filters?: SearchFilter;
|
|
240
240
|
}
|
|
@@ -243,21 +243,21 @@ export interface View {
|
|
|
243
243
|
*/
|
|
244
244
|
export interface BatchGetViewOutput {
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>A structure with a list of objects with details for each of the specified
|
|
248
247
|
* views.</p>
|
|
248
|
+
* @public
|
|
249
249
|
*/
|
|
250
250
|
Views?: View[];
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>If any of the specified ARNs result in an error, then this structure describes the
|
|
254
253
|
* error.</p>
|
|
254
|
+
* @public
|
|
255
255
|
*/
|
|
256
256
|
Errors?: BatchGetViewError[];
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>The principal making the request isn't permitted to perform the operation.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
export declare class UnauthorizedException extends __BaseException {
|
|
263
263
|
readonly name: "UnauthorizedException";
|
|
@@ -269,7 +269,6 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
269
269
|
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
270
270
|
}
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the
|
|
274
273
|
* original request, or you attempted to create a view with a name that already exists in
|
|
275
274
|
* this Amazon Web Services Region.</p>
|
|
@@ -277,6 +276,7 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
277
276
|
* the original request, or an index already exists in the current Amazon Web Services Region.</p>
|
|
278
277
|
* <p>If you attempted to update an index type to <code>AGGREGATOR</code>, then the request failed because you already
|
|
279
278
|
* have an <code>AGGREGATOR</code> index in a different Amazon Web Services Region.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
export declare class ConflictException extends __BaseException {
|
|
282
282
|
readonly name: "ConflictException";
|
|
@@ -292,16 +292,16 @@ export declare class ConflictException extends __BaseException {
|
|
|
292
292
|
*/
|
|
293
293
|
export interface CreateIndexInput {
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
297
296
|
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
298
297
|
* value</a> to ensure the uniqueness of your index.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
ClientToken?: string;
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>The specified tags are attached only to the index created in this Amazon Web Services Region. The
|
|
304
303
|
* tags aren't attached to any of the resources listed in the index.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
Tags?: Record<string, string>;
|
|
307
307
|
}
|
|
@@ -340,15 +340,14 @@ export type IndexState = (typeof IndexState)[keyof typeof IndexState];
|
|
|
340
340
|
*/
|
|
341
341
|
export interface CreateIndexOutput {
|
|
342
342
|
/**
|
|
343
|
-
* @public
|
|
344
343
|
* <p>The ARN of the new local index for the Region. You can reference this ARN in IAM
|
|
345
344
|
* permission policies to authorize the following operations: <a>DeleteIndex</a>
|
|
346
345
|
* | <a>GetIndex</a> | <a>UpdateIndexType</a> | <a>CreateView</a>
|
|
347
346
|
* </p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
Arn?: string;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>Indicates the current state of the index. You can check for changes to the state for
|
|
353
352
|
* asynchronous operations by calling the <a>GetIndex</a> operation.</p>
|
|
354
353
|
* <note>
|
|
@@ -356,11 +355,12 @@ export interface CreateIndexOutput {
|
|
|
356
355
|
* for several hours as Resource Explorer discovers the information about your resources and
|
|
357
356
|
* populates the index.</p>
|
|
358
357
|
* </note>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
State?: IndexState;
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>The date and timestamp when the index was created.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
CreatedAt?: Date;
|
|
366
366
|
}
|
|
@@ -369,8 +369,8 @@ export interface CreateIndexOutput {
|
|
|
369
369
|
*/
|
|
370
370
|
export interface DeleteIndexInput {
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <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 want to delete.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
Arn: string | undefined;
|
|
376
376
|
}
|
|
@@ -379,22 +379,22 @@ export interface DeleteIndexInput {
|
|
|
379
379
|
*/
|
|
380
380
|
export interface DeleteIndexOutput {
|
|
381
381
|
/**
|
|
382
|
-
* @public
|
|
383
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
|
|
384
383
|
* process.</p>
|
|
385
384
|
* <note>
|
|
386
385
|
* <p>This operation is asynchronous. To check its status, call the <a>GetIndex</a> operation.</p>
|
|
387
386
|
* </note>
|
|
387
|
+
* @public
|
|
388
388
|
*/
|
|
389
389
|
Arn?: string;
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p>Indicates the current state of the index. </p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
State?: IndexState;
|
|
395
395
|
/**
|
|
396
|
-
* @public
|
|
397
396
|
* <p>The date and time when you last updated this index.</p>
|
|
397
|
+
* @public
|
|
398
398
|
*/
|
|
399
399
|
LastUpdatedAt?: Date;
|
|
400
400
|
}
|
|
@@ -421,20 +421,19 @@ export type IndexType = (typeof IndexType)[keyof typeof IndexType];
|
|
|
421
421
|
*/
|
|
422
422
|
export interface ListIndexesInput {
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>If specified, limits the output to only indexes of the specified Type, either
|
|
426
425
|
* <code>LOCAL</code> or <code>AGGREGATOR</code>.</p>
|
|
427
426
|
* <p>Use this option to discover the aggregator index for your account.</p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
Type?: IndexType;
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>If specified, limits the response to only information about the index in the specified
|
|
433
432
|
* list of Amazon Web Services Regions.</p>
|
|
433
|
+
* @public
|
|
434
434
|
*/
|
|
435
435
|
Regions?: string[];
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>The maximum number of results that you want included on each page of the
|
|
439
438
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
440
439
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -446,20 +445,20 @@ export interface ListIndexesInput {
|
|
|
446
445
|
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
447
446
|
* that you receive all of the results.</p>
|
|
448
447
|
* </note>
|
|
448
|
+
* @public
|
|
449
449
|
*/
|
|
450
450
|
MaxResults?: number;
|
|
451
451
|
/**
|
|
452
|
-
* @public
|
|
453
452
|
* <p>The parameter for receiving additional results if you receive a
|
|
454
453
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
455
454
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
456
455
|
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
457
456
|
* from. The pagination tokens expire after 24 hours.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
NextToken?: string;
|
|
460
460
|
}
|
|
461
461
|
/**
|
|
462
|
-
* @public
|
|
463
462
|
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
|
|
464
463
|
* resources that the service discovers. Creating an index in an Amazon Web Services Region turns on
|
|
465
464
|
* Resource Explorer and lets it discover your resources.</p>
|
|
@@ -469,20 +468,20 @@ export interface ListIndexesInput {
|
|
|
469
468
|
* receives a replicated copy of the index information from all other Regions where Resource Explorer
|
|
470
469
|
* is turned on. This allows search operations in that Region to return results from all
|
|
471
470
|
* Regions in the account.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
export interface Index {
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>The Amazon Web Services Region in which the index exists.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
Region?: string;
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <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.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
Arn?: string;
|
|
484
484
|
/**
|
|
485
|
-
* @public
|
|
486
485
|
* <p>The type of index. It can be one of the following values:</p>
|
|
487
486
|
* <ul>
|
|
488
487
|
* <li>
|
|
@@ -498,6 +497,7 @@ export interface Index {
|
|
|
498
497
|
* from all Regions in the account where Resource Explorer is turned on.</p>
|
|
499
498
|
* </li>
|
|
500
499
|
* </ul>
|
|
500
|
+
* @public
|
|
501
501
|
*/
|
|
502
502
|
Type?: IndexType;
|
|
503
503
|
}
|
|
@@ -506,36 +506,36 @@ export interface Index {
|
|
|
506
506
|
*/
|
|
507
507
|
export interface ListIndexesOutput {
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>A structure that contains the details and status of each index.</p>
|
|
510
|
+
* @public
|
|
511
511
|
*/
|
|
512
512
|
Indexes?: Index[];
|
|
513
513
|
/**
|
|
514
|
-
* @public
|
|
515
514
|
* <p>If present, indicates that more output is available than is
|
|
516
515
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
517
516
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
518
517
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
519
518
|
* The pagination tokens expire after 24 hours.</p>
|
|
519
|
+
* @public
|
|
520
520
|
*/
|
|
521
521
|
NextToken?: string;
|
|
522
522
|
}
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>The request failed because it exceeds a service quota.</p>
|
|
525
|
+
* @public
|
|
526
526
|
*/
|
|
527
527
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
528
528
|
readonly name: "ServiceQuotaExceededException";
|
|
529
529
|
readonly $fault: "client";
|
|
530
530
|
Message: string | undefined;
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>The name of the service quota that was exceeded by the request.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
Name: string | undefined;
|
|
536
536
|
/**
|
|
537
|
-
* @public
|
|
538
537
|
* <p>The current value for the quota that the request tried to exceed.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
Value: string | undefined;
|
|
541
541
|
/**
|
|
@@ -548,15 +548,15 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
548
548
|
*/
|
|
549
549
|
export interface UpdateIndexTypeInput {
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <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 want to update.</p>
|
|
552
|
+
* @public
|
|
553
553
|
*/
|
|
554
554
|
Arn: string | undefined;
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>The type of the index. To understand the difference between <code>LOCAL</code> and
|
|
558
557
|
* <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region
|
|
559
558
|
* search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
Type: IndexType | undefined;
|
|
562
562
|
}
|
|
@@ -565,24 +565,24 @@ export interface UpdateIndexTypeInput {
|
|
|
565
565
|
*/
|
|
566
566
|
export interface UpdateIndexTypeOutput {
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <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 updated.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
Arn?: string;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>Specifies the type of the specified index after the operation completes.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
Type?: IndexType;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>Indicates the state of the request to update the index. This operation is
|
|
580
579
|
* asynchronous. Call the <a>GetIndex</a> operation to check for changes.</p>
|
|
580
|
+
* @public
|
|
581
581
|
*/
|
|
582
582
|
State?: IndexState;
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p>The date and timestamp when the index was last updated.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
LastUpdatedAt?: Date;
|
|
588
588
|
}
|
|
@@ -591,34 +591,33 @@ export interface UpdateIndexTypeOutput {
|
|
|
591
591
|
*/
|
|
592
592
|
export interface CreateViewInput {
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
596
595
|
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
597
596
|
* value</a> to ensure the uniqueness of your views.</p>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
ClientToken?: string;
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p>
|
|
603
602
|
* <p>The name must be no more than 64 characters long, and can include letters, digits, and
|
|
604
603
|
* the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
ViewName: string | undefined;
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>Specifies optional fields that you want included in search results from this
|
|
610
609
|
* view. It is a list of objects that each describe a field to include.</p>
|
|
611
610
|
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
IncludedProperties?: IncludedProperty[];
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>The root ARN of the account, an organizational unit (OU), or an organization ARN. If
|
|
617
616
|
* left empty, the default is account.</p>
|
|
617
|
+
* @public
|
|
618
618
|
*/
|
|
619
619
|
Scope?: string;
|
|
620
620
|
/**
|
|
621
|
-
* @public
|
|
622
621
|
* <p>An array of strings that specify which resources are included in the results of
|
|
623
622
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
624
623
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
@@ -633,11 +632,12 @@ export interface CreateViewInput {
|
|
|
633
632
|
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
634
633
|
* <code>prod</code>.</p>
|
|
635
634
|
* </important>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
Filters?: SearchFilter;
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>Tag key and value pairs that are attached to the view.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
Tags?: Record<string, string>;
|
|
643
643
|
}
|
|
@@ -646,8 +646,8 @@ export interface CreateViewInput {
|
|
|
646
646
|
*/
|
|
647
647
|
export interface CreateViewOutput {
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>A structure that contains the details about the new view.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
View?: View;
|
|
653
653
|
}
|
|
@@ -656,8 +656,8 @@ export interface CreateViewOutput {
|
|
|
656
656
|
*/
|
|
657
657
|
export interface DeleteViewInput {
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <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 you want to delete.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
ViewArn: string | undefined;
|
|
663
663
|
}
|
|
@@ -666,8 +666,8 @@ export interface DeleteViewInput {
|
|
|
666
666
|
*/
|
|
667
667
|
export interface DeleteViewOutput {
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <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 you successfully deleted.</p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
ViewArn?: string;
|
|
673
673
|
}
|
|
@@ -676,8 +676,8 @@ export interface DeleteViewOutput {
|
|
|
676
676
|
*/
|
|
677
677
|
export interface GetViewInput {
|
|
678
678
|
/**
|
|
679
|
-
* @public
|
|
680
679
|
* <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 you want information about.</p>
|
|
680
|
+
* @public
|
|
681
681
|
*/
|
|
682
682
|
ViewArn: string | undefined;
|
|
683
683
|
}
|
|
@@ -686,13 +686,13 @@ export interface GetViewInput {
|
|
|
686
686
|
*/
|
|
687
687
|
export interface GetViewOutput {
|
|
688
688
|
/**
|
|
689
|
-
* @public
|
|
690
689
|
* <p>A structure that contains the details for the requested view.</p>
|
|
690
|
+
* @public
|
|
691
691
|
*/
|
|
692
692
|
View?: View;
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>Tag key and value pairs that are attached to the view.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
Tags?: Record<string, string>;
|
|
698
698
|
}
|
|
@@ -701,16 +701,15 @@ export interface GetViewOutput {
|
|
|
701
701
|
*/
|
|
702
702
|
export interface ListViewsInput {
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>The parameter for receiving additional results if you receive a
|
|
706
705
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
707
706
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
708
707
|
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
709
708
|
* from. The pagination tokens expire after 24 hours.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
NextToken?: string;
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The maximum number of results that you want included on each page of the
|
|
715
714
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
716
715
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -722,6 +721,7 @@ export interface ListViewsInput {
|
|
|
722
721
|
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
723
722
|
* that you receive all of the results.</p>
|
|
724
723
|
* </note>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
MaxResults?: number;
|
|
727
727
|
}
|
|
@@ -730,18 +730,18 @@ export interface ListViewsInput {
|
|
|
730
730
|
*/
|
|
731
731
|
export interface ListViewsOutput {
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>The list of views available in the Amazon Web Services Region in which you called this
|
|
735
734
|
* operation.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
Views?: string[];
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>If present, indicates that more output is available than is
|
|
741
740
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
742
741
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
743
742
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
744
743
|
* The pagination tokens expire after 24 hours.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
NextToken?: string;
|
|
747
747
|
}
|
|
@@ -750,19 +750,18 @@ export interface ListViewsOutput {
|
|
|
750
750
|
*/
|
|
751
751
|
export interface UpdateViewInput {
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <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 you want to modify.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
ViewArn: string | undefined;
|
|
757
757
|
/**
|
|
758
|
-
* @public
|
|
759
758
|
* <p>Specifies optional fields that you want included in search results from this
|
|
760
759
|
* view. It is a list of objects that each describe a field to include.</p>
|
|
761
760
|
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
761
|
+
* @public
|
|
762
762
|
*/
|
|
763
763
|
IncludedProperties?: IncludedProperty[];
|
|
764
764
|
/**
|
|
765
|
-
* @public
|
|
766
765
|
* <p>An array of strings that specify which resources are included in the results of
|
|
767
766
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
768
767
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
@@ -777,6 +776,7 @@ export interface UpdateViewInput {
|
|
|
777
776
|
* <i>not</i> tagged with a key <code>Stage</code> that has the value
|
|
778
777
|
* <code>prod</code>.</p>
|
|
779
778
|
* </important>
|
|
779
|
+
* @public
|
|
780
780
|
*/
|
|
781
781
|
Filters?: SearchFilter;
|
|
782
782
|
}
|
|
@@ -785,25 +785,25 @@ export interface UpdateViewInput {
|
|
|
785
785
|
*/
|
|
786
786
|
export interface UpdateViewOutput {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>Details about the view that you changed with this operation.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
View?: View;
|
|
792
792
|
}
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <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
|
|
796
795
|
* multi-account search for your organization.</p>
|
|
796
|
+
* @public
|
|
797
797
|
*/
|
|
798
798
|
export interface OrgConfiguration {
|
|
799
799
|
/**
|
|
800
|
-
* @public
|
|
801
800
|
* <p>This value displays whether your Amazon Web Services service access is <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
801
|
+
* @public
|
|
802
802
|
*/
|
|
803
803
|
AWSServiceAccessStatus: AWSServiceAccessStatus | undefined;
|
|
804
804
|
/**
|
|
805
|
-
* @public
|
|
806
805
|
* <p>This value shows whether or not you have a valid a service-linked role required to start the multi-account search feature.</p>
|
|
806
|
+
* @public
|
|
807
807
|
*/
|
|
808
808
|
ServiceLinkedRole?: string;
|
|
809
809
|
}
|
|
@@ -812,9 +812,9 @@ export interface OrgConfiguration {
|
|
|
812
812
|
*/
|
|
813
813
|
export interface GetAccountLevelServiceConfigurationOutput {
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>Details about the organization, and whether configuration is <code>ENABLED</code> or
|
|
817
816
|
* <code>DISABLED</code>.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
OrgConfiguration?: OrgConfiguration;
|
|
820
820
|
}
|
|
@@ -823,9 +823,9 @@ export interface GetAccountLevelServiceConfigurationOutput {
|
|
|
823
823
|
*/
|
|
824
824
|
export interface GetDefaultViewOutput {
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
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
|
|
828
827
|
* which you called this operation.</p>
|
|
828
|
+
* @public
|
|
829
829
|
*/
|
|
830
830
|
ViewArn?: string;
|
|
831
831
|
}
|
|
@@ -834,51 +834,51 @@ export interface GetDefaultViewOutput {
|
|
|
834
834
|
*/
|
|
835
835
|
export interface GetIndexOutput {
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <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.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
Arn?: string;
|
|
841
841
|
/**
|
|
842
|
-
* @public
|
|
843
842
|
* <p>The type of the index in this Region. For information about the aggregator index and
|
|
844
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
|
|
845
844
|
* by creating an aggregator index</a>.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
Type?: IndexType;
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>The current state of the index in this Amazon Web Services Region.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
State?: IndexState;
|
|
853
853
|
/**
|
|
854
|
-
* @public
|
|
855
854
|
* <p>This response value is present only if this index is
|
|
856
855
|
* <code>Type=AGGREGATOR</code>.</p>
|
|
857
856
|
* <p>A list of the Amazon Web Services Regions that replicate their content to the index in this
|
|
858
857
|
* Region.</p>
|
|
858
|
+
* @public
|
|
859
859
|
*/
|
|
860
860
|
ReplicatingFrom?: string[];
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>This response value is present only if this index is <code>Type=LOCAL</code>.</p>
|
|
864
863
|
* <p>The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index
|
|
865
864
|
* does exist then the Region in which you called this operation replicates its index
|
|
866
865
|
* information to the Region specified in this response value. </p>
|
|
866
|
+
* @public
|
|
867
867
|
*/
|
|
868
868
|
ReplicatingTo?: string[];
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>The date and time when the index was originally created.</p>
|
|
871
|
+
* @public
|
|
872
872
|
*/
|
|
873
873
|
CreatedAt?: Date;
|
|
874
874
|
/**
|
|
875
|
-
* @public
|
|
876
875
|
* <p>The date and time when the index was last updated.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
LastUpdatedAt?: Date;
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <p>Tag key and value pairs that are attached to the index.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
Tags?: Record<string, string>;
|
|
884
884
|
}
|
|
@@ -887,13 +887,12 @@ export interface GetIndexOutput {
|
|
|
887
887
|
*/
|
|
888
888
|
export interface ListIndexesForMembersInput {
|
|
889
889
|
/**
|
|
890
|
-
* @public
|
|
891
890
|
* <p>The account IDs will limit the output to only indexes from these
|
|
892
891
|
* accounts.</p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
AccountIdList: string[] | undefined;
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>The maximum number of results that you want included on each page of the
|
|
898
897
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
899
898
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -905,42 +904,42 @@ export interface ListIndexesForMembersInput {
|
|
|
905
904
|
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
906
905
|
* that you receive all of the results.</p>
|
|
907
906
|
* </note>
|
|
907
|
+
* @public
|
|
908
908
|
*/
|
|
909
909
|
MaxResults?: number;
|
|
910
910
|
/**
|
|
911
|
-
* @public
|
|
912
911
|
* <p>The parameter for receiving additional results if you receive a
|
|
913
912
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
914
913
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
915
914
|
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
916
915
|
* from. The pagination tokens expire after 24 hours.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
NextToken?: string;
|
|
919
919
|
}
|
|
920
920
|
/**
|
|
921
|
-
* @public
|
|
922
921
|
* <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
|
|
923
922
|
* resources that the service discovers. </p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
export interface MemberIndex {
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>The account ID for the index.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
AccountId?: string;
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>The Amazon Web Services Region in which the index
|
|
934
933
|
* exists.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
Region?: string;
|
|
937
937
|
/**
|
|
938
|
-
* @public
|
|
939
938
|
* <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.</p>
|
|
939
|
+
* @public
|
|
940
940
|
*/
|
|
941
941
|
Arn?: string;
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>The type of index. It can be one of the following values: </p>
|
|
945
944
|
* <ul>
|
|
946
945
|
* <li>
|
|
@@ -956,6 +955,7 @@ export interface MemberIndex {
|
|
|
956
955
|
* from all Regions in the account where Resource Explorer is turned on.</p>
|
|
957
956
|
* </li>
|
|
958
957
|
* </ul>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
Type?: IndexType;
|
|
961
961
|
}
|
|
@@ -964,18 +964,18 @@ export interface MemberIndex {
|
|
|
964
964
|
*/
|
|
965
965
|
export interface ListIndexesForMembersOutput {
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>A structure that contains the details and status of each
|
|
969
968
|
* index.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
Indexes?: MemberIndex[];
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>If present, indicates that more output is available than is
|
|
975
974
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
976
975
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
977
976
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
978
977
|
* The pagination tokens expire after 24 hours.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
NextToken?: string;
|
|
981
981
|
}
|
|
@@ -984,16 +984,15 @@ export interface ListIndexesForMembersOutput {
|
|
|
984
984
|
*/
|
|
985
985
|
export interface ListSupportedResourceTypesInput {
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>The parameter for receiving additional results if you receive a
|
|
989
988
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
990
989
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
991
990
|
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
992
991
|
* from. The pagination tokens expire after 24 hours.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
NextToken?: string;
|
|
995
995
|
/**
|
|
996
|
-
* @public
|
|
997
996
|
* <p>The maximum number of results that you want included on each page of the
|
|
998
997
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
999
998
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -1005,23 +1004,24 @@ export interface ListSupportedResourceTypesInput {
|
|
|
1005
1004
|
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1006
1005
|
* that you receive all of the results.</p>
|
|
1007
1006
|
* </note>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
MaxResults?: number;
|
|
1010
1010
|
}
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>A structure that describes a resource type supported by Amazon Web Services Resource Explorer.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
export interface SupportedResourceType {
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>The Amazon Web Service that is associated with the resource type. This is the primary
|
|
1019
1018
|
* service that lets you create and interact with resources of this type.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
Service?: string;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>The unique identifier of the resource type.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
ResourceType?: string;
|
|
1027
1027
|
}
|
|
@@ -1030,17 +1030,17 @@ export interface SupportedResourceType {
|
|
|
1030
1030
|
*/
|
|
1031
1031
|
export interface ListSupportedResourceTypesOutput {
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>The list of resource types supported by Resource Explorer.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
ResourceTypes?: SupportedResourceType[];
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>If present, indicates that more output is available than is
|
|
1040
1039
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1041
1040
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1042
1041
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1043
1042
|
* The pagination tokens expire after 24 hours.</p>
|
|
1043
|
+
* @public
|
|
1044
1044
|
*/
|
|
1045
1045
|
NextToken?: string;
|
|
1046
1046
|
}
|
|
@@ -1049,8 +1049,8 @@ export interface ListSupportedResourceTypesOutput {
|
|
|
1049
1049
|
*/
|
|
1050
1050
|
export interface ListTagsForResourceInput {
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <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 or index that you want to attach tags to.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
resourceArn: string | undefined;
|
|
1056
1056
|
}
|
|
@@ -1059,99 +1059,98 @@ export interface ListTagsForResourceInput {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
export interface ListTagsForResourceOutput {
|
|
1061
1061
|
/**
|
|
1062
|
-
* @public
|
|
1063
1062
|
* <p>The tag key and value pairs that you want to attach to the specified view or
|
|
1064
1063
|
* index.</p>
|
|
1064
|
+
* @public
|
|
1065
1065
|
*/
|
|
1066
1066
|
Tags?: Record<string, string>;
|
|
1067
1067
|
}
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>A structure that describes a property of a resource.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
export interface ResourceProperty {
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The name of this property of the resource.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
Name?: string;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The date and time that the information about this resource property was last
|
|
1081
1080
|
* updated.</p>
|
|
1081
|
+
* @public
|
|
1082
1082
|
*/
|
|
1083
1083
|
LastReportedAt?: Date;
|
|
1084
1084
|
/**
|
|
1085
|
-
* @public
|
|
1086
1085
|
* <p>Details about this property. The content of this field is a JSON object that varies
|
|
1087
1086
|
* based on the resource type.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
Data?: __DocumentType;
|
|
1090
1090
|
}
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored
|
|
1094
1093
|
* information in the index of the Amazon Web Services Region that contains the resource.</p>
|
|
1094
|
+
* @public
|
|
1095
1095
|
*/
|
|
1096
1096
|
export interface Resource {
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the resource.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
Arn?: string;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The Amazon Web Services account that owns the resource.</p>
|
|
1104
|
+
* @public
|
|
1105
1105
|
*/
|
|
1106
1106
|
OwningAccountId?: string;
|
|
1107
1107
|
/**
|
|
1108
|
-
* @public
|
|
1109
1108
|
* <p>The Amazon Web Services Region in which the resource was created and exists.</p>
|
|
1109
|
+
* @public
|
|
1110
1110
|
*/
|
|
1111
1111
|
Region?: string;
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The type of the resource.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
ResourceType?: string;
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The Amazon Web Service that owns the resource and is responsible for creating and updating
|
|
1120
1119
|
* it.</p>
|
|
1120
|
+
* @public
|
|
1121
1121
|
*/
|
|
1122
1122
|
Service?: string;
|
|
1123
1123
|
/**
|
|
1124
|
-
* @public
|
|
1125
1124
|
* <p>The date and time that Resource Explorer last queried this resource and updated the index with
|
|
1126
1125
|
* the latest information about the resource.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
LastReportedAt?: Date;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>A structure with additional type-specific details about the resource. These properties
|
|
1132
1131
|
* can be added by turning on integration between Resource Explorer and other Amazon Web Services services.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
Properties?: ResourceProperty[];
|
|
1135
1135
|
}
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer
|
|
1139
1138
|
* doesn't count more than 1,000 matches for any query. This structure
|
|
1140
1139
|
* provides information about whether the query exceeded this limit.</p>
|
|
1141
1140
|
* <p>This field is included in every page when you paginate the results.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
export interface ResourceCount {
|
|
1144
1144
|
/**
|
|
1145
|
-
* @public
|
|
1146
1145
|
* <p>The number of resources that match the search query. This value can't exceed
|
|
1147
1146
|
* 1,000. If there are more than 1,000 resources that match
|
|
1148
1147
|
* the query, then only 1,000 are counted and the <code>Complete</code>
|
|
1149
1148
|
* field is set to false. We recommend that you refine your query to return a smaller
|
|
1150
1149
|
* number of results.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
TotalResources?: number;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count
|
|
1156
1155
|
* of search results.</p>
|
|
1157
1156
|
* <ul>
|
|
@@ -1164,6 +1163,7 @@ export interface ResourceCount {
|
|
|
1164
1163
|
* 1,000 matching results, and stopped counting.</p>
|
|
1165
1164
|
* </li>
|
|
1166
1165
|
* </ul>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
Complete?: boolean;
|
|
1169
1169
|
}
|
|
@@ -1172,7 +1172,6 @@ export interface ResourceCount {
|
|
|
1172
1172
|
*/
|
|
1173
1173
|
export interface SearchInput {
|
|
1174
1174
|
/**
|
|
1175
|
-
* @public
|
|
1176
1175
|
* <p>A string that includes keywords and filters that specify the resources that you want
|
|
1177
1176
|
* to include in the results.</p>
|
|
1178
1177
|
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
@@ -1184,10 +1183,10 @@ export interface SearchInput {
|
|
|
1184
1183
|
* resource you want is not included, then use a different value for
|
|
1185
1184
|
* <code>QueryString</code> to refine the results.</p>
|
|
1186
1185
|
* </note>
|
|
1186
|
+
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
QueryString: string | undefined;
|
|
1189
1189
|
/**
|
|
1190
|
-
* @public
|
|
1191
1190
|
* <p>The maximum number of results that you want included on each page of the
|
|
1192
1191
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
1193
1192
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -1199,24 +1198,25 @@ export interface SearchInput {
|
|
|
1199
1198
|
* more results available. You should check <code>NextToken</code> after every operation to ensure
|
|
1200
1199
|
* that you receive all of the results.</p>
|
|
1201
1200
|
* </note>
|
|
1201
|
+
* @public
|
|
1202
1202
|
*/
|
|
1203
1203
|
MaxResults?: number;
|
|
1204
1204
|
/**
|
|
1205
|
-
* @public
|
|
1206
1205
|
* <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
|
|
1207
1206
|
* value for this parameter, then the operation automatically uses the default view for the
|
|
1208
1207
|
* Amazon Web Services Region in which you called this operation. If the Region either doesn't have a
|
|
1209
1208
|
* default view or if you don't have permission to use the default view, then the operation
|
|
1210
1209
|
* fails with a <code>401 Unauthorized</code> exception.</p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
ViewArn?: string;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p>The parameter for receiving additional results if you receive a
|
|
1216
1215
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1217
1216
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
1218
1217
|
* call's <code>NextToken</code> response to indicate where the output should continue
|
|
1219
1218
|
* from. The pagination tokens expire after 24 hours.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
NextToken?: string;
|
|
1222
1222
|
}
|
|
@@ -1225,27 +1225,27 @@ export interface SearchInput {
|
|
|
1225
1225
|
*/
|
|
1226
1226
|
export interface SearchOutput {
|
|
1227
1227
|
/**
|
|
1228
|
-
* @public
|
|
1229
1228
|
* <p>The list of structures that describe the resources that match the query.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
Resources?: Resource[];
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>If present, indicates that more output is available than is
|
|
1235
1234
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1236
1235
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1237
1236
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.
|
|
1238
1237
|
* The pagination tokens expire after 24 hours.</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
NextToken?: string;
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <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 this operation used to perform the search.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
ViewArn?: string;
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>The number of resources that match the query.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
Count?: ResourceCount;
|
|
1251
1251
|
}
|
|
@@ -1254,15 +1254,15 @@ export interface SearchOutput {
|
|
|
1254
1254
|
*/
|
|
1255
1255
|
export interface TagResourceInput {
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The Amazon Resource Name (ARN) of the view or index that you want to attach tags
|
|
1259
1258
|
* to.</p>
|
|
1259
|
+
* @public
|
|
1260
1260
|
*/
|
|
1261
1261
|
resourceArn: string | undefined;
|
|
1262
1262
|
/**
|
|
1263
|
-
* @public
|
|
1264
1263
|
* <p>A list of tag key and value pairs that you want to attach to the specified view or
|
|
1265
1264
|
* index.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
Tags?: Record<string, string>;
|
|
1268
1268
|
}
|
|
@@ -1276,15 +1276,15 @@ export interface TagResourceOutput {
|
|
|
1276
1276
|
*/
|
|
1277
1277
|
export interface UntagResourceInput {
|
|
1278
1278
|
/**
|
|
1279
|
-
* @public
|
|
1280
1279
|
* <p>The Amazon Resource Name (ARN) of the view or index that you want to remove tags
|
|
1281
1280
|
* from.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
resourceArn: string | undefined;
|
|
1284
1284
|
/**
|
|
1285
|
-
* @public
|
|
1286
1285
|
* <p>A list of the keys for the tags that you want to remove from the specified view or
|
|
1287
1286
|
* index.</p>
|
|
1287
|
+
* @public
|
|
1288
1288
|
*/
|
|
1289
1289
|
tagKeys: string[] | undefined;
|
|
1290
1290
|
}
|