@aws-sdk/client-resource-explorer-2 3.378.0 → 3.382.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.
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useFipsEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
*/
|
|
26
26
|
export * from "./ResourceExplorer2Client";
|
|
27
27
|
export * from "./ResourceExplorer2";
|
|
28
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
28
29
|
export * from "./commands";
|
|
29
30
|
export * from "./pagination";
|
|
30
31
|
export * from "./models";
|
|
@@ -20,6 +20,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AssociateDefaultViewInput {
|
|
22
22
|
/**
|
|
23
|
+
* @public
|
|
23
24
|
* <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
25
|
* Amazon Web Services account in which you call this operation. The specified view must already exist in
|
|
25
26
|
* the called Region.</p>
|
|
@@ -31,6 +32,7 @@ export interface AssociateDefaultViewInput {
|
|
|
31
32
|
*/
|
|
32
33
|
export interface AssociateDefaultViewOutput {
|
|
33
34
|
/**
|
|
35
|
+
* @public
|
|
34
36
|
* <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
|
|
35
37
|
* in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.</p>
|
|
36
38
|
*/
|
|
@@ -85,10 +87,12 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
85
87
|
*/
|
|
86
88
|
export interface ValidationExceptionField {
|
|
87
89
|
/**
|
|
90
|
+
* @public
|
|
88
91
|
* <p>The name of the request field that had a validation error.</p>
|
|
89
92
|
*/
|
|
90
93
|
Name: string | undefined;
|
|
91
94
|
/**
|
|
95
|
+
* @public
|
|
92
96
|
* <p>The validation error caused by the request field.</p>
|
|
93
97
|
*/
|
|
94
98
|
ValidationIssue: string | undefined;
|
|
@@ -103,6 +107,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
103
107
|
readonly $fault: "client";
|
|
104
108
|
Message: string | undefined;
|
|
105
109
|
/**
|
|
110
|
+
* @public
|
|
106
111
|
* <p>An array of the request fields that had validation errors.</p>
|
|
107
112
|
*/
|
|
108
113
|
FieldList?: ValidationExceptionField[];
|
|
@@ -116,6 +121,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
116
121
|
*/
|
|
117
122
|
export interface BatchGetViewInput {
|
|
118
123
|
/**
|
|
124
|
+
* @public
|
|
119
125
|
* <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>
|
|
120
126
|
*/
|
|
121
127
|
ViewArns?: string[];
|
|
@@ -127,10 +133,12 @@ export interface BatchGetViewInput {
|
|
|
127
133
|
*/
|
|
128
134
|
export interface BatchGetViewError {
|
|
129
135
|
/**
|
|
136
|
+
* @public
|
|
130
137
|
* <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>
|
|
131
138
|
*/
|
|
132
139
|
ViewArn: string | undefined;
|
|
133
140
|
/**
|
|
141
|
+
* @public
|
|
134
142
|
* <p>The description of the error for the specified view.</p>
|
|
135
143
|
*/
|
|
136
144
|
ErrorMessage: string | undefined;
|
|
@@ -142,6 +150,7 @@ export interface BatchGetViewError {
|
|
|
142
150
|
*/
|
|
143
151
|
export interface SearchFilter {
|
|
144
152
|
/**
|
|
153
|
+
* @public
|
|
145
154
|
* <p>The string that contains the search keywords, prefixes, and operators to control the
|
|
146
155
|
* results that can be returned by a <a>Search</a> operation. For more details,
|
|
147
156
|
* see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
|
|
@@ -157,6 +166,7 @@ export interface SearchFilter {
|
|
|
157
166
|
*/
|
|
158
167
|
export interface IncludedProperty {
|
|
159
168
|
/**
|
|
169
|
+
* @public
|
|
160
170
|
* <p>The name of the property that is included in this view.</p>
|
|
161
171
|
* <p>You can specify the following property names for this field:</p>
|
|
162
172
|
* <ul>
|
|
@@ -180,18 +190,22 @@ export interface IncludedProperty {
|
|
|
180
190
|
*/
|
|
181
191
|
export interface View {
|
|
182
192
|
/**
|
|
193
|
+
* @public
|
|
183
194
|
* <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>
|
|
184
195
|
*/
|
|
185
196
|
ViewArn?: string;
|
|
186
197
|
/**
|
|
198
|
+
* @public
|
|
187
199
|
* <p>The Amazon Web Services account that owns this view.</p>
|
|
188
200
|
*/
|
|
189
201
|
Owner?: string;
|
|
190
202
|
/**
|
|
203
|
+
* @public
|
|
191
204
|
* <p>The date and time when this view was last modified.</p>
|
|
192
205
|
*/
|
|
193
206
|
LastUpdatedAt?: Date;
|
|
194
207
|
/**
|
|
208
|
+
* @public
|
|
195
209
|
* <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
|
|
196
210
|
* organizational unit (OU) that specifies whether this view includes resources from only
|
|
197
211
|
* the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in
|
|
@@ -201,10 +215,12 @@ export interface View {
|
|
|
201
215
|
*/
|
|
202
216
|
Scope?: string;
|
|
203
217
|
/**
|
|
218
|
+
* @public
|
|
204
219
|
* <p>A structure that contains additional information about the view.</p>
|
|
205
220
|
*/
|
|
206
221
|
IncludedProperties?: IncludedProperty[];
|
|
207
222
|
/**
|
|
223
|
+
* @public
|
|
208
224
|
* <p>An array of <a>SearchFilter</a> objects that specify which resources can be
|
|
209
225
|
* included in the results of queries made using this view.</p>
|
|
210
226
|
*/
|
|
@@ -215,11 +231,13 @@ export interface View {
|
|
|
215
231
|
*/
|
|
216
232
|
export interface BatchGetViewOutput {
|
|
217
233
|
/**
|
|
234
|
+
* @public
|
|
218
235
|
* <p>A structure with a list of objects with details for each of the specified
|
|
219
236
|
* views.</p>
|
|
220
237
|
*/
|
|
221
238
|
Views?: View[];
|
|
222
239
|
/**
|
|
240
|
+
* @public
|
|
223
241
|
* <p>If any of the specified ARNs result in an error, then this structure describes the
|
|
224
242
|
* error.</p>
|
|
225
243
|
*/
|
|
@@ -258,12 +276,14 @@ export declare class ConflictException extends __BaseException {
|
|
|
258
276
|
*/
|
|
259
277
|
export interface CreateIndexInput {
|
|
260
278
|
/**
|
|
279
|
+
* @public
|
|
261
280
|
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
262
281
|
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
263
282
|
* value</a> to ensure the uniqueness of your views.</p>
|
|
264
283
|
*/
|
|
265
284
|
ClientToken?: string;
|
|
266
285
|
/**
|
|
286
|
+
* @public
|
|
267
287
|
* <p>The specified tags are attached only to the index created in this Amazon Web Services Region. The
|
|
268
288
|
* tags aren't attached to any of the resources listed in the index.</p>
|
|
269
289
|
*/
|
|
@@ -304,6 +324,7 @@ export type IndexState = (typeof IndexState)[keyof typeof IndexState];
|
|
|
304
324
|
*/
|
|
305
325
|
export interface CreateIndexOutput {
|
|
306
326
|
/**
|
|
327
|
+
* @public
|
|
307
328
|
* <p>The ARN of the new local index for the Region. You can reference this ARN in IAM
|
|
308
329
|
* permission policies to authorize the following operations: <a>DeleteIndex</a>
|
|
309
330
|
* | <a>GetIndex</a> | <a>UpdateIndexType</a> | <a>CreateView</a>
|
|
@@ -311,6 +332,7 @@ export interface CreateIndexOutput {
|
|
|
311
332
|
*/
|
|
312
333
|
Arn?: string;
|
|
313
334
|
/**
|
|
335
|
+
* @public
|
|
314
336
|
* <p>Indicates the current state of the index. You can check for changes to the state for
|
|
315
337
|
* asynchronous operations by calling the <a>GetIndex</a> operation.</p>
|
|
316
338
|
* <note>
|
|
@@ -321,6 +343,7 @@ export interface CreateIndexOutput {
|
|
|
321
343
|
*/
|
|
322
344
|
State?: IndexState | string;
|
|
323
345
|
/**
|
|
346
|
+
* @public
|
|
324
347
|
* <p>The date and timestamp when the index was created.</p>
|
|
325
348
|
*/
|
|
326
349
|
CreatedAt?: Date;
|
|
@@ -330,6 +353,7 @@ export interface CreateIndexOutput {
|
|
|
330
353
|
*/
|
|
331
354
|
export interface DeleteIndexInput {
|
|
332
355
|
/**
|
|
356
|
+
* @public
|
|
333
357
|
* <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>
|
|
334
358
|
*/
|
|
335
359
|
Arn: string | undefined;
|
|
@@ -339,6 +363,7 @@ export interface DeleteIndexInput {
|
|
|
339
363
|
*/
|
|
340
364
|
export interface DeleteIndexOutput {
|
|
341
365
|
/**
|
|
366
|
+
* @public
|
|
342
367
|
* <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
|
|
343
368
|
* process.</p>
|
|
344
369
|
* <note>
|
|
@@ -347,10 +372,12 @@ export interface DeleteIndexOutput {
|
|
|
347
372
|
*/
|
|
348
373
|
Arn?: string;
|
|
349
374
|
/**
|
|
375
|
+
* @public
|
|
350
376
|
* <p>Indicates the current state of the index. </p>
|
|
351
377
|
*/
|
|
352
378
|
State?: IndexState | string;
|
|
353
379
|
/**
|
|
380
|
+
* @public
|
|
354
381
|
* <p>The date and time when you last updated this index.</p>
|
|
355
382
|
*/
|
|
356
383
|
LastUpdatedAt?: Date;
|
|
@@ -378,17 +405,20 @@ export type IndexType = (typeof IndexType)[keyof typeof IndexType];
|
|
|
378
405
|
*/
|
|
379
406
|
export interface ListIndexesInput {
|
|
380
407
|
/**
|
|
408
|
+
* @public
|
|
381
409
|
* <p>If specified, limits the output to only indexes of the specified Type, either
|
|
382
410
|
* <code>LOCAL</code> or <code>AGGREGATOR</code>.</p>
|
|
383
411
|
* <p>Use this option to discover the aggregator index for your account.</p>
|
|
384
412
|
*/
|
|
385
413
|
Type?: IndexType | string;
|
|
386
414
|
/**
|
|
415
|
+
* @public
|
|
387
416
|
* <p>If specified, limits the response to only information about the index in the specified
|
|
388
417
|
* list of Amazon Web Services Regions.</p>
|
|
389
418
|
*/
|
|
390
419
|
Regions?: string[];
|
|
391
420
|
/**
|
|
421
|
+
* @public
|
|
392
422
|
* <p>The maximum number of results that you want included on each page of the
|
|
393
423
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
394
424
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -403,6 +433,7 @@ export interface ListIndexesInput {
|
|
|
403
433
|
*/
|
|
404
434
|
MaxResults?: number;
|
|
405
435
|
/**
|
|
436
|
+
* @public
|
|
406
437
|
* <p>The parameter for receiving additional results if you receive a
|
|
407
438
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
408
439
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -425,14 +456,17 @@ export interface ListIndexesInput {
|
|
|
425
456
|
*/
|
|
426
457
|
export interface Index {
|
|
427
458
|
/**
|
|
459
|
+
* @public
|
|
428
460
|
* <p>The Amazon Web Services Region in which the index exists.</p>
|
|
429
461
|
*/
|
|
430
462
|
Region?: string;
|
|
431
463
|
/**
|
|
464
|
+
* @public
|
|
432
465
|
* <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>
|
|
433
466
|
*/
|
|
434
467
|
Arn?: string;
|
|
435
468
|
/**
|
|
469
|
+
* @public
|
|
436
470
|
* <p>The type of index. It can be one of the following
|
|
437
471
|
* values:</p>
|
|
438
472
|
* <ul>
|
|
@@ -458,10 +492,12 @@ export interface Index {
|
|
|
458
492
|
*/
|
|
459
493
|
export interface ListIndexesOutput {
|
|
460
494
|
/**
|
|
495
|
+
* @public
|
|
461
496
|
* <p>A structure that contains the details and status of each index.</p>
|
|
462
497
|
*/
|
|
463
498
|
Indexes?: Index[];
|
|
464
499
|
/**
|
|
500
|
+
* @public
|
|
465
501
|
* <p>If present, indicates that more output is available than is
|
|
466
502
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
467
503
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -478,10 +514,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
478
514
|
readonly $fault: "client";
|
|
479
515
|
Message: string | undefined;
|
|
480
516
|
/**
|
|
517
|
+
* @public
|
|
481
518
|
* <p>The name of the service quota that was exceeded by the request.</p>
|
|
482
519
|
*/
|
|
483
520
|
Name: string | undefined;
|
|
484
521
|
/**
|
|
522
|
+
* @public
|
|
485
523
|
* <p>The current value for the quota that the request tried to exceed.</p>
|
|
486
524
|
*/
|
|
487
525
|
Value: string | undefined;
|
|
@@ -495,10 +533,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
495
533
|
*/
|
|
496
534
|
export interface UpdateIndexTypeInput {
|
|
497
535
|
/**
|
|
536
|
+
* @public
|
|
498
537
|
* <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>
|
|
499
538
|
*/
|
|
500
539
|
Arn: string | undefined;
|
|
501
540
|
/**
|
|
541
|
+
* @public
|
|
502
542
|
* <p>The type of the index. To understand the difference between <code>LOCAL</code> and
|
|
503
543
|
* <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region
|
|
504
544
|
* search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
|
|
@@ -510,19 +550,23 @@ export interface UpdateIndexTypeInput {
|
|
|
510
550
|
*/
|
|
511
551
|
export interface UpdateIndexTypeOutput {
|
|
512
552
|
/**
|
|
553
|
+
* @public
|
|
513
554
|
* <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>
|
|
514
555
|
*/
|
|
515
556
|
Arn?: string;
|
|
516
557
|
/**
|
|
558
|
+
* @public
|
|
517
559
|
* <p>Specifies the type of the specified index after the operation completes.</p>
|
|
518
560
|
*/
|
|
519
561
|
Type?: IndexType | string;
|
|
520
562
|
/**
|
|
563
|
+
* @public
|
|
521
564
|
* <p>Indicates the state of the request to update the index. This operation is
|
|
522
565
|
* asynchronous. Call the <a>GetIndex</a> operation to check for changes.</p>
|
|
523
566
|
*/
|
|
524
567
|
State?: IndexState | string;
|
|
525
568
|
/**
|
|
569
|
+
* @public
|
|
526
570
|
* <p>The date and timestamp when the index was last updated.</p>
|
|
527
571
|
*/
|
|
528
572
|
LastUpdatedAt?: Date;
|
|
@@ -532,24 +576,28 @@ export interface UpdateIndexTypeOutput {
|
|
|
532
576
|
*/
|
|
533
577
|
export interface CreateViewInput {
|
|
534
578
|
/**
|
|
579
|
+
* @public
|
|
535
580
|
* <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
|
|
536
581
|
* accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
|
|
537
582
|
* value</a> to ensure the uniqueness of your views.</p>
|
|
538
583
|
*/
|
|
539
584
|
ClientToken?: string;
|
|
540
585
|
/**
|
|
586
|
+
* @public
|
|
541
587
|
* <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p>
|
|
542
588
|
* <p>The name must be no more than 64 characters long, and can include letters, digits, and
|
|
543
589
|
* the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
|
|
544
590
|
*/
|
|
545
591
|
ViewName: string | undefined;
|
|
546
592
|
/**
|
|
593
|
+
* @public
|
|
547
594
|
* <p>Specifies optional fields that you want included in search results from this
|
|
548
595
|
* view. It is a list of objects that each describe a field to include.</p>
|
|
549
596
|
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
550
597
|
*/
|
|
551
598
|
IncludedProperties?: IncludedProperty[];
|
|
552
599
|
/**
|
|
600
|
+
* @public
|
|
553
601
|
* <p>An array of strings that specify which resources are included in the results of
|
|
554
602
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
555
603
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
@@ -567,6 +615,7 @@ export interface CreateViewInput {
|
|
|
567
615
|
*/
|
|
568
616
|
Filters?: SearchFilter;
|
|
569
617
|
/**
|
|
618
|
+
* @public
|
|
570
619
|
* <p>Tag key and value pairs that are attached to the view.</p>
|
|
571
620
|
*/
|
|
572
621
|
Tags?: Record<string, string>;
|
|
@@ -576,6 +625,7 @@ export interface CreateViewInput {
|
|
|
576
625
|
*/
|
|
577
626
|
export interface CreateViewOutput {
|
|
578
627
|
/**
|
|
628
|
+
* @public
|
|
579
629
|
* <p>A structure that contains the details about the new view.</p>
|
|
580
630
|
*/
|
|
581
631
|
View?: View;
|
|
@@ -585,6 +635,7 @@ export interface CreateViewOutput {
|
|
|
585
635
|
*/
|
|
586
636
|
export interface DeleteViewInput {
|
|
587
637
|
/**
|
|
638
|
+
* @public
|
|
588
639
|
* <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>
|
|
589
640
|
*/
|
|
590
641
|
ViewArn: string | undefined;
|
|
@@ -594,6 +645,7 @@ export interface DeleteViewInput {
|
|
|
594
645
|
*/
|
|
595
646
|
export interface DeleteViewOutput {
|
|
596
647
|
/**
|
|
648
|
+
* @public
|
|
597
649
|
* <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>
|
|
598
650
|
*/
|
|
599
651
|
ViewArn?: string;
|
|
@@ -603,6 +655,7 @@ export interface DeleteViewOutput {
|
|
|
603
655
|
*/
|
|
604
656
|
export interface GetViewInput {
|
|
605
657
|
/**
|
|
658
|
+
* @public
|
|
606
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 information about.</p>
|
|
607
660
|
*/
|
|
608
661
|
ViewArn: string | undefined;
|
|
@@ -612,10 +665,12 @@ export interface GetViewInput {
|
|
|
612
665
|
*/
|
|
613
666
|
export interface GetViewOutput {
|
|
614
667
|
/**
|
|
668
|
+
* @public
|
|
615
669
|
* <p>A structure that contains the details for the requested view.</p>
|
|
616
670
|
*/
|
|
617
671
|
View?: View;
|
|
618
672
|
/**
|
|
673
|
+
* @public
|
|
619
674
|
* <p>Tag key and value pairs that are attached to the view.</p>
|
|
620
675
|
*/
|
|
621
676
|
Tags?: Record<string, string>;
|
|
@@ -625,6 +680,7 @@ export interface GetViewOutput {
|
|
|
625
680
|
*/
|
|
626
681
|
export interface ListViewsInput {
|
|
627
682
|
/**
|
|
683
|
+
* @public
|
|
628
684
|
* <p>The parameter for receiving additional results if you receive a
|
|
629
685
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
630
686
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -633,6 +689,7 @@ export interface ListViewsInput {
|
|
|
633
689
|
*/
|
|
634
690
|
NextToken?: string;
|
|
635
691
|
/**
|
|
692
|
+
* @public
|
|
636
693
|
* <p>The maximum number of results that you want included on each page of the
|
|
637
694
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
638
695
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -652,11 +709,13 @@ export interface ListViewsInput {
|
|
|
652
709
|
*/
|
|
653
710
|
export interface ListViewsOutput {
|
|
654
711
|
/**
|
|
712
|
+
* @public
|
|
655
713
|
* <p>The list of views available in the Amazon Web Services Region in which you called this
|
|
656
714
|
* operation.</p>
|
|
657
715
|
*/
|
|
658
716
|
Views?: string[];
|
|
659
717
|
/**
|
|
718
|
+
* @public
|
|
660
719
|
* <p>If present, indicates that more output is available than is
|
|
661
720
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
662
721
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -669,16 +728,19 @@ export interface ListViewsOutput {
|
|
|
669
728
|
*/
|
|
670
729
|
export interface UpdateViewInput {
|
|
671
730
|
/**
|
|
731
|
+
* @public
|
|
672
732
|
* <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>
|
|
673
733
|
*/
|
|
674
734
|
ViewArn: string | undefined;
|
|
675
735
|
/**
|
|
736
|
+
* @public
|
|
676
737
|
* <p>Specifies optional fields that you want included in search results from this
|
|
677
738
|
* view. It is a list of objects that each describe a field to include.</p>
|
|
678
739
|
* <p>The default is an empty list, with no optional fields included in the results.</p>
|
|
679
740
|
*/
|
|
680
741
|
IncludedProperties?: IncludedProperty[];
|
|
681
742
|
/**
|
|
743
|
+
* @public
|
|
682
744
|
* <p>An array of strings that specify which resources are included in the results of
|
|
683
745
|
* queries made using this view. When you use this view in a <a>Search</a>
|
|
684
746
|
* operation, the filter string is combined with the search's <code>QueryString</code>
|
|
@@ -701,6 +763,7 @@ export interface UpdateViewInput {
|
|
|
701
763
|
*/
|
|
702
764
|
export interface UpdateViewOutput {
|
|
703
765
|
/**
|
|
766
|
+
* @public
|
|
704
767
|
* <p>Details about the view that you changed with this operation.</p>
|
|
705
768
|
*/
|
|
706
769
|
View?: View;
|
|
@@ -710,6 +773,7 @@ export interface UpdateViewOutput {
|
|
|
710
773
|
*/
|
|
711
774
|
export interface GetDefaultViewOutput {
|
|
712
775
|
/**
|
|
776
|
+
* @public
|
|
713
777
|
* <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
|
|
714
778
|
* which you called this operation.</p>
|
|
715
779
|
*/
|
|
@@ -720,20 +784,24 @@ export interface GetDefaultViewOutput {
|
|
|
720
784
|
*/
|
|
721
785
|
export interface GetIndexOutput {
|
|
722
786
|
/**
|
|
787
|
+
* @public
|
|
723
788
|
* <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>
|
|
724
789
|
*/
|
|
725
790
|
Arn?: string;
|
|
726
791
|
/**
|
|
792
|
+
* @public
|
|
727
793
|
* <p>The type of the index in this Region. For information about the aggregator index and
|
|
728
794
|
* 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
|
|
729
795
|
* by creating an aggregator index</a>.</p>
|
|
730
796
|
*/
|
|
731
797
|
Type?: IndexType | string;
|
|
732
798
|
/**
|
|
799
|
+
* @public
|
|
733
800
|
* <p>The current state of the index in this Amazon Web Services Region.</p>
|
|
734
801
|
*/
|
|
735
802
|
State?: IndexState | string;
|
|
736
803
|
/**
|
|
804
|
+
* @public
|
|
737
805
|
* <p>This response value is present only if this index is
|
|
738
806
|
* <code>Type=AGGREGATOR</code>.</p>
|
|
739
807
|
* <p>A list of the Amazon Web Services Regions that replicate their content to the index in this
|
|
@@ -741,6 +809,7 @@ export interface GetIndexOutput {
|
|
|
741
809
|
*/
|
|
742
810
|
ReplicatingFrom?: string[];
|
|
743
811
|
/**
|
|
812
|
+
* @public
|
|
744
813
|
* <p>This response value is present only if this index is <code>Type=LOCAL</code>.</p>
|
|
745
814
|
* <p>The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index
|
|
746
815
|
* does exist then the Region in which you called this operation replicates its index
|
|
@@ -748,14 +817,17 @@ export interface GetIndexOutput {
|
|
|
748
817
|
*/
|
|
749
818
|
ReplicatingTo?: string[];
|
|
750
819
|
/**
|
|
820
|
+
* @public
|
|
751
821
|
* <p>The date and time when the index was originally created.</p>
|
|
752
822
|
*/
|
|
753
823
|
CreatedAt?: Date;
|
|
754
824
|
/**
|
|
825
|
+
* @public
|
|
755
826
|
* <p>The date and time when the index was last updated.</p>
|
|
756
827
|
*/
|
|
757
828
|
LastUpdatedAt?: Date;
|
|
758
829
|
/**
|
|
830
|
+
* @public
|
|
759
831
|
* <p>Tag key and value pairs that are attached to the index.</p>
|
|
760
832
|
*/
|
|
761
833
|
Tags?: Record<string, string>;
|
|
@@ -765,6 +837,7 @@ export interface GetIndexOutput {
|
|
|
765
837
|
*/
|
|
766
838
|
export interface ListSupportedResourceTypesInput {
|
|
767
839
|
/**
|
|
840
|
+
* @public
|
|
768
841
|
* <p>The parameter for receiving additional results if you receive a
|
|
769
842
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
770
843
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -773,6 +846,7 @@ export interface ListSupportedResourceTypesInput {
|
|
|
773
846
|
*/
|
|
774
847
|
NextToken?: string;
|
|
775
848
|
/**
|
|
849
|
+
* @public
|
|
776
850
|
* <p>The maximum number of results that you want included on each page of the
|
|
777
851
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
778
852
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -793,11 +867,13 @@ export interface ListSupportedResourceTypesInput {
|
|
|
793
867
|
*/
|
|
794
868
|
export interface SupportedResourceType {
|
|
795
869
|
/**
|
|
870
|
+
* @public
|
|
796
871
|
* <p>The Amazon Web Service that is associated with the resource type. This is the primary
|
|
797
872
|
* service that lets you create and interact with resources of this type.</p>
|
|
798
873
|
*/
|
|
799
874
|
Service?: string;
|
|
800
875
|
/**
|
|
876
|
+
* @public
|
|
801
877
|
* <p>The unique identifier of the resource type.</p>
|
|
802
878
|
*/
|
|
803
879
|
ResourceType?: string;
|
|
@@ -807,10 +883,12 @@ export interface SupportedResourceType {
|
|
|
807
883
|
*/
|
|
808
884
|
export interface ListSupportedResourceTypesOutput {
|
|
809
885
|
/**
|
|
886
|
+
* @public
|
|
810
887
|
* <p>The list of resource types supported by Resource Explorer.</p>
|
|
811
888
|
*/
|
|
812
889
|
ResourceTypes?: SupportedResourceType[];
|
|
813
890
|
/**
|
|
891
|
+
* @public
|
|
814
892
|
* <p>If present, indicates that more output is available than is
|
|
815
893
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
816
894
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -823,6 +901,7 @@ export interface ListSupportedResourceTypesOutput {
|
|
|
823
901
|
*/
|
|
824
902
|
export interface ListTagsForResourceInput {
|
|
825
903
|
/**
|
|
904
|
+
* @public
|
|
826
905
|
* <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>
|
|
827
906
|
*/
|
|
828
907
|
resourceArn: string | undefined;
|
|
@@ -832,6 +911,7 @@ export interface ListTagsForResourceInput {
|
|
|
832
911
|
*/
|
|
833
912
|
export interface ListTagsForResourceOutput {
|
|
834
913
|
/**
|
|
914
|
+
* @public
|
|
835
915
|
* <p>The tag key and value pairs that you want to attach to the specified view or
|
|
836
916
|
* index.</p>
|
|
837
917
|
*/
|
|
@@ -843,15 +923,18 @@ export interface ListTagsForResourceOutput {
|
|
|
843
923
|
*/
|
|
844
924
|
export interface ResourceProperty {
|
|
845
925
|
/**
|
|
926
|
+
* @public
|
|
846
927
|
* <p>The name of this property of the resource.</p>
|
|
847
928
|
*/
|
|
848
929
|
Name?: string;
|
|
849
930
|
/**
|
|
931
|
+
* @public
|
|
850
932
|
* <p>The date and time that the information about this resource property was last
|
|
851
933
|
* updated.</p>
|
|
852
934
|
*/
|
|
853
935
|
LastReportedAt?: Date;
|
|
854
936
|
/**
|
|
937
|
+
* @public
|
|
855
938
|
* <p>Details about this property. The content of this field is a JSON object that varies
|
|
856
939
|
* based on the resource type.</p>
|
|
857
940
|
*/
|
|
@@ -864,32 +947,39 @@ export interface ResourceProperty {
|
|
|
864
947
|
*/
|
|
865
948
|
export interface Resource {
|
|
866
949
|
/**
|
|
950
|
+
* @public
|
|
867
951
|
* <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>
|
|
868
952
|
*/
|
|
869
953
|
Arn?: string;
|
|
870
954
|
/**
|
|
955
|
+
* @public
|
|
871
956
|
* <p>The Amazon Web Services account that owns the resource.</p>
|
|
872
957
|
*/
|
|
873
958
|
OwningAccountId?: string;
|
|
874
959
|
/**
|
|
960
|
+
* @public
|
|
875
961
|
* <p>The Amazon Web Services Region in which the resource was created and exists.</p>
|
|
876
962
|
*/
|
|
877
963
|
Region?: string;
|
|
878
964
|
/**
|
|
965
|
+
* @public
|
|
879
966
|
* <p>The type of the resource.</p>
|
|
880
967
|
*/
|
|
881
968
|
ResourceType?: string;
|
|
882
969
|
/**
|
|
970
|
+
* @public
|
|
883
971
|
* <p>The Amazon Web Service that owns the resource and is responsible for creating and updating
|
|
884
972
|
* it.</p>
|
|
885
973
|
*/
|
|
886
974
|
Service?: string;
|
|
887
975
|
/**
|
|
976
|
+
* @public
|
|
888
977
|
* <p>The date and time that Resource Explorer last queried this resource and updated the index with
|
|
889
978
|
* the latest information about the resource.</p>
|
|
890
979
|
*/
|
|
891
980
|
LastReportedAt?: Date;
|
|
892
981
|
/**
|
|
982
|
+
* @public
|
|
893
983
|
* <p>A structure with additional type-specific details about the resource. These properties
|
|
894
984
|
* can be added by turning on integration between Resource Explorer and other Amazon Web Services services.</p>
|
|
895
985
|
*/
|
|
@@ -904,6 +994,7 @@ export interface Resource {
|
|
|
904
994
|
*/
|
|
905
995
|
export interface ResourceCount {
|
|
906
996
|
/**
|
|
997
|
+
* @public
|
|
907
998
|
* <p>The number of resources that match the search query. This value can't exceed
|
|
908
999
|
* 1,000. If there are more than 1,000 resources that match
|
|
909
1000
|
* the query, then only 1,000 are counted and the <code>Complete</code>
|
|
@@ -912,6 +1003,7 @@ export interface ResourceCount {
|
|
|
912
1003
|
*/
|
|
913
1004
|
TotalResources?: number;
|
|
914
1005
|
/**
|
|
1006
|
+
* @public
|
|
915
1007
|
* <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count
|
|
916
1008
|
* of search results.</p>
|
|
917
1009
|
* <ul>
|
|
@@ -932,6 +1024,7 @@ export interface ResourceCount {
|
|
|
932
1024
|
*/
|
|
933
1025
|
export interface SearchInput {
|
|
934
1026
|
/**
|
|
1027
|
+
* @public
|
|
935
1028
|
* <p>A string that includes keywords and filters that specify the resources that you want
|
|
936
1029
|
* to include in the results.</p>
|
|
937
1030
|
* <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
|
|
@@ -946,6 +1039,7 @@ export interface SearchInput {
|
|
|
946
1039
|
*/
|
|
947
1040
|
QueryString: string | undefined;
|
|
948
1041
|
/**
|
|
1042
|
+
* @public
|
|
949
1043
|
* <p>The maximum number of results that you want included on each page of the
|
|
950
1044
|
* response. If you do not include this parameter, it defaults to a value appropriate to the
|
|
951
1045
|
* operation. If additional items exist beyond those included in the current response, the
|
|
@@ -960,6 +1054,7 @@ export interface SearchInput {
|
|
|
960
1054
|
*/
|
|
961
1055
|
MaxResults?: number;
|
|
962
1056
|
/**
|
|
1057
|
+
* @public
|
|
963
1058
|
* <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
|
|
964
1059
|
* value for this parameter, then the operation automatically uses the default view for the
|
|
965
1060
|
* Amazon Web Services Region in which you called this operation. If the Region either doesn't have a
|
|
@@ -968,6 +1063,7 @@ export interface SearchInput {
|
|
|
968
1063
|
*/
|
|
969
1064
|
ViewArn?: string;
|
|
970
1065
|
/**
|
|
1066
|
+
* @public
|
|
971
1067
|
* <p>The parameter for receiving additional results if you receive a
|
|
972
1068
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
973
1069
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -981,10 +1077,12 @@ export interface SearchInput {
|
|
|
981
1077
|
*/
|
|
982
1078
|
export interface SearchOutput {
|
|
983
1079
|
/**
|
|
1080
|
+
* @public
|
|
984
1081
|
* <p>The list of structures that describe the resources that match the query.</p>
|
|
985
1082
|
*/
|
|
986
1083
|
Resources?: Resource[];
|
|
987
1084
|
/**
|
|
1085
|
+
* @public
|
|
988
1086
|
* <p>If present, indicates that more output is available than is
|
|
989
1087
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
990
1088
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -992,10 +1090,12 @@ export interface SearchOutput {
|
|
|
992
1090
|
*/
|
|
993
1091
|
NextToken?: string;
|
|
994
1092
|
/**
|
|
1093
|
+
* @public
|
|
995
1094
|
* <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>
|
|
996
1095
|
*/
|
|
997
1096
|
ViewArn?: string;
|
|
998
1097
|
/**
|
|
1098
|
+
* @public
|
|
999
1099
|
* <p>The number of resources that match the query.</p>
|
|
1000
1100
|
*/
|
|
1001
1101
|
Count?: ResourceCount;
|
|
@@ -1005,11 +1105,13 @@ export interface SearchOutput {
|
|
|
1005
1105
|
*/
|
|
1006
1106
|
export interface TagResourceInput {
|
|
1007
1107
|
/**
|
|
1108
|
+
* @public
|
|
1008
1109
|
* <p>The Amazon Resource Name (ARN) of the view or index that you want to attach tags
|
|
1009
1110
|
* to.</p>
|
|
1010
1111
|
*/
|
|
1011
1112
|
resourceArn: string | undefined;
|
|
1012
1113
|
/**
|
|
1114
|
+
* @public
|
|
1013
1115
|
* <p>A list of tag key and value pairs that you want to attach to the specified view or
|
|
1014
1116
|
* index.</p>
|
|
1015
1117
|
*/
|
|
@@ -1025,11 +1127,13 @@ export interface TagResourceOutput {
|
|
|
1025
1127
|
*/
|
|
1026
1128
|
export interface UntagResourceInput {
|
|
1027
1129
|
/**
|
|
1130
|
+
* @public
|
|
1028
1131
|
* <p>The Amazon Resource Name (ARN) of the view or index that you want to remove tags
|
|
1029
1132
|
* from.</p>
|
|
1030
1133
|
*/
|
|
1031
1134
|
resourceArn: string | undefined;
|
|
1032
1135
|
/**
|
|
1136
|
+
* @public
|
|
1033
1137
|
* <p>A list of the keys for the tags that you want to remove from the specified view or
|
|
1034
1138
|
* index.</p>
|
|
1035
1139
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-resource-explorer-2",
|
|
3
3
|
"description": "AWS SDK for JavaScript Resource Explorer 2 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|