@aws-sdk/client-opensearchserverless 3.296.0 → 3.297.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-types/OpenSearchServerless.d.ts +33 -1
- package/dist-types/OpenSearchServerlessClient.d.ts +24 -4
- package/dist-types/commands/BatchGetCollectionCommand.d.ts +16 -0
- package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +16 -0
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +16 -0
- package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
- package/dist-types/commands/CreateSecurityConfigCommand.d.ts +16 -0
- package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +16 -0
- package/dist-types/commands/CreateVpcEndpointCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +16 -0
- package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +16 -0
- package/dist-types/commands/GetAccessPolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +16 -0
- package/dist-types/commands/GetPoliciesStatsCommand.d.ts +16 -0
- package/dist-types/commands/GetSecurityConfigCommand.d.ts +16 -0
- package/dist-types/commands/GetSecurityPolicyCommand.d.ts +16 -0
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListCollectionsCommand.d.ts +17 -1
- package/dist-types/commands/ListSecurityConfigsCommand.d.ts +16 -0
- package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCollectionCommand.d.ts +16 -0
- package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +16 -0
- package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +16 -0
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +16 -0
- package/dist-types/models/OpenSearchServerlessServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +235 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAccessPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSecurityConfigsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSecurityPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListVpcEndpointsPaginator.d.ts +3 -0
- package/package.json +3 -3
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { DocumentType as __DocumentType } from "@aws-sdk/types";
|
|
3
3
|
import { OpenSearchServerlessServiceException as __BaseException } from "./OpenSearchServerlessServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
4
7
|
export declare enum AccessPolicyType {
|
|
5
8
|
/**
|
|
6
9
|
* data policy type
|
|
@@ -8,6 +11,7 @@ export declare enum AccessPolicyType {
|
|
|
8
11
|
data = "data"
|
|
9
12
|
}
|
|
10
13
|
/**
|
|
14
|
+
* @public
|
|
11
15
|
* <p>When creating a collection, thrown when a collection with the same name already exists
|
|
12
16
|
* or is being created. When deleting a collection, thrown when the collection is not in
|
|
13
17
|
* the ACTIVE or FAILED state.</p>
|
|
@@ -20,6 +24,9 @@ export declare class ConflictException extends __BaseException {
|
|
|
20
24
|
*/
|
|
21
25
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
22
26
|
}
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
23
30
|
export interface CreateAccessPolicyRequest {
|
|
24
31
|
/**
|
|
25
32
|
* <p>The type of policy.</p>
|
|
@@ -44,6 +51,7 @@ export interface CreateAccessPolicyRequest {
|
|
|
44
51
|
clientToken?: string;
|
|
45
52
|
}
|
|
46
53
|
/**
|
|
54
|
+
* @public
|
|
47
55
|
* <p>Details about an OpenSearch Serverless access policy.</p>
|
|
48
56
|
*/
|
|
49
57
|
export interface AccessPolicyDetail {
|
|
@@ -76,6 +84,9 @@ export interface AccessPolicyDetail {
|
|
|
76
84
|
*/
|
|
77
85
|
lastModifiedDate?: number;
|
|
78
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
79
90
|
export interface CreateAccessPolicyResponse {
|
|
80
91
|
/**
|
|
81
92
|
* <p>Details about the created access policy.</p>
|
|
@@ -83,6 +94,7 @@ export interface CreateAccessPolicyResponse {
|
|
|
83
94
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
84
95
|
}
|
|
85
96
|
/**
|
|
97
|
+
* @public
|
|
86
98
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
87
99
|
*/
|
|
88
100
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -94,6 +106,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
94
106
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
95
107
|
}
|
|
96
108
|
/**
|
|
109
|
+
* @public
|
|
97
110
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
98
111
|
* input.</p>
|
|
99
112
|
*/
|
|
@@ -105,6 +118,9 @@ export declare class ValidationException extends __BaseException {
|
|
|
105
118
|
*/
|
|
106
119
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
107
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
108
124
|
export interface DeleteAccessPolicyRequest {
|
|
109
125
|
/**
|
|
110
126
|
* <p>The type of policy.</p>
|
|
@@ -119,9 +135,13 @@ export interface DeleteAccessPolicyRequest {
|
|
|
119
135
|
*/
|
|
120
136
|
clientToken?: string;
|
|
121
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
122
141
|
export interface DeleteAccessPolicyResponse {
|
|
123
142
|
}
|
|
124
143
|
/**
|
|
144
|
+
* @public
|
|
125
145
|
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
126
146
|
*/
|
|
127
147
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -132,6 +152,9 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
132
152
|
*/
|
|
133
153
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
134
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
135
158
|
export interface GetAccessPolicyRequest {
|
|
136
159
|
/**
|
|
137
160
|
* <p>Tye type of policy. Currently the only supported value is <code>data</code>.</p>
|
|
@@ -142,12 +165,18 @@ export interface GetAccessPolicyRequest {
|
|
|
142
165
|
*/
|
|
143
166
|
name: string | undefined;
|
|
144
167
|
}
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
145
171
|
export interface GetAccessPolicyResponse {
|
|
146
172
|
/**
|
|
147
173
|
* <p>Details about the requested access policy.</p>
|
|
148
174
|
*/
|
|
149
175
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
150
176
|
}
|
|
177
|
+
/**
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
151
180
|
export interface ListAccessPoliciesRequest {
|
|
152
181
|
/**
|
|
153
182
|
* <p>The type of access policy.</p>
|
|
@@ -171,6 +200,7 @@ export interface ListAccessPoliciesRequest {
|
|
|
171
200
|
maxResults?: number;
|
|
172
201
|
}
|
|
173
202
|
/**
|
|
203
|
+
* @public
|
|
174
204
|
* <p>A summary of the data access policy.</p>
|
|
175
205
|
*/
|
|
176
206
|
export interface AccessPolicySummary {
|
|
@@ -199,6 +229,9 @@ export interface AccessPolicySummary {
|
|
|
199
229
|
*/
|
|
200
230
|
lastModifiedDate?: number;
|
|
201
231
|
}
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
202
235
|
export interface ListAccessPoliciesResponse {
|
|
203
236
|
/**
|
|
204
237
|
* <p>Details about the requested access policies.</p>
|
|
@@ -211,6 +244,9 @@ export interface ListAccessPoliciesResponse {
|
|
|
211
244
|
*/
|
|
212
245
|
nextToken?: string;
|
|
213
246
|
}
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
214
250
|
export interface UpdateAccessPolicyRequest {
|
|
215
251
|
/**
|
|
216
252
|
* <p>The type of policy.</p>
|
|
@@ -238,6 +274,9 @@ export interface UpdateAccessPolicyRequest {
|
|
|
238
274
|
*/
|
|
239
275
|
clientToken?: string;
|
|
240
276
|
}
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
241
280
|
export interface UpdateAccessPolicyResponse {
|
|
242
281
|
/**
|
|
243
282
|
* <p>Details about the updated access policy.</p>
|
|
@@ -245,6 +284,7 @@ export interface UpdateAccessPolicyResponse {
|
|
|
245
284
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
246
285
|
}
|
|
247
286
|
/**
|
|
287
|
+
* @public
|
|
248
288
|
* <p>Statistics for an OpenSearch Serverless access policy.</p>
|
|
249
289
|
*/
|
|
250
290
|
export interface AccessPolicyStats {
|
|
@@ -254,6 +294,7 @@ export interface AccessPolicyStats {
|
|
|
254
294
|
DataPolicyCount?: number;
|
|
255
295
|
}
|
|
256
296
|
/**
|
|
297
|
+
* @public
|
|
257
298
|
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
258
299
|
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
259
300
|
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
|
|
@@ -269,6 +310,7 @@ export interface CapacityLimits {
|
|
|
269
310
|
maxSearchCapacityInOCU?: number;
|
|
270
311
|
}
|
|
271
312
|
/**
|
|
313
|
+
* @public
|
|
272
314
|
* <p>OpenSearch Serverless-related information for the current account.</p>
|
|
273
315
|
*/
|
|
274
316
|
export interface AccountSettingsDetail {
|
|
@@ -279,6 +321,9 @@ export interface AccountSettingsDetail {
|
|
|
279
321
|
*/
|
|
280
322
|
capacityLimits?: CapacityLimits;
|
|
281
323
|
}
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
282
327
|
export interface BatchGetCollectionRequest {
|
|
283
328
|
/**
|
|
284
329
|
* <p>A list of collection IDs. You can't provide names and IDs in the same request. The ID
|
|
@@ -290,6 +335,9 @@ export interface BatchGetCollectionRequest {
|
|
|
290
335
|
*/
|
|
291
336
|
names?: string[];
|
|
292
337
|
}
|
|
338
|
+
/**
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
293
341
|
export declare enum CollectionStatus {
|
|
294
342
|
/**
|
|
295
343
|
* Collection resource is ready to use
|
|
@@ -308,6 +356,9 @@ export declare enum CollectionStatus {
|
|
|
308
356
|
*/
|
|
309
357
|
FAILED = "FAILED"
|
|
310
358
|
}
|
|
359
|
+
/**
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
311
362
|
export declare enum CollectionType {
|
|
312
363
|
/**
|
|
313
364
|
* Search collection type
|
|
@@ -319,6 +370,7 @@ export declare enum CollectionType {
|
|
|
319
370
|
TIMESERIES = "TIMESERIES"
|
|
320
371
|
}
|
|
321
372
|
/**
|
|
373
|
+
* @public
|
|
322
374
|
* <p>Details about each OpenSearch Serverless collection, including the collection endpoint and the
|
|
323
375
|
* OpenSearch Dashboards endpoint.</p>
|
|
324
376
|
*/
|
|
@@ -370,6 +422,7 @@ export interface CollectionDetail {
|
|
|
370
422
|
dashboardEndpoint?: string;
|
|
371
423
|
}
|
|
372
424
|
/**
|
|
425
|
+
* @public
|
|
373
426
|
* <p>Error information for an OpenSearch Serverless request.</p>
|
|
374
427
|
*/
|
|
375
428
|
export interface CollectionErrorDetail {
|
|
@@ -394,6 +447,9 @@ export interface CollectionErrorDetail {
|
|
|
394
447
|
*/
|
|
395
448
|
errorCode?: string;
|
|
396
449
|
}
|
|
450
|
+
/**
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
397
453
|
export interface BatchGetCollectionResponse {
|
|
398
454
|
/**
|
|
399
455
|
* <p>Details about each collection.</p>
|
|
@@ -404,12 +460,18 @@ export interface BatchGetCollectionResponse {
|
|
|
404
460
|
*/
|
|
405
461
|
collectionErrorDetails?: CollectionErrorDetail[];
|
|
406
462
|
}
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
407
466
|
export interface BatchGetVpcEndpointRequest {
|
|
408
467
|
/**
|
|
409
468
|
* <p>A list of VPC endpoint identifiers.</p>
|
|
410
469
|
*/
|
|
411
470
|
ids: string[] | undefined;
|
|
412
471
|
}
|
|
472
|
+
/**
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
413
475
|
export declare enum VpcEndpointStatus {
|
|
414
476
|
/**
|
|
415
477
|
* VPCEndpoint resource is ready to use
|
|
@@ -429,6 +491,7 @@ export declare enum VpcEndpointStatus {
|
|
|
429
491
|
PENDING = "PENDING"
|
|
430
492
|
}
|
|
431
493
|
/**
|
|
494
|
+
* @public
|
|
432
495
|
* <p>Details about an OpenSearch Serverless-managed interface endpoint.</p>
|
|
433
496
|
*/
|
|
434
497
|
export interface VpcEndpointDetail {
|
|
@@ -463,6 +526,7 @@ export interface VpcEndpointDetail {
|
|
|
463
526
|
createdDate?: number;
|
|
464
527
|
}
|
|
465
528
|
/**
|
|
529
|
+
* @public
|
|
466
530
|
* <p>Error information for a failed <code>BatchGetVpcEndpoint</code> request.</p>
|
|
467
531
|
*/
|
|
468
532
|
export interface VpcEndpointErrorDetail {
|
|
@@ -479,6 +543,9 @@ export interface VpcEndpointErrorDetail {
|
|
|
479
543
|
*/
|
|
480
544
|
errorCode?: string;
|
|
481
545
|
}
|
|
546
|
+
/**
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
482
549
|
export interface BatchGetVpcEndpointResponse {
|
|
483
550
|
/**
|
|
484
551
|
* <p>Details about the specified VPC endpoint.</p>
|
|
@@ -490,6 +557,7 @@ export interface BatchGetVpcEndpointResponse {
|
|
|
490
557
|
vpcEndpointErrorDetails?: VpcEndpointErrorDetail[];
|
|
491
558
|
}
|
|
492
559
|
/**
|
|
560
|
+
* @public
|
|
493
561
|
* <p>A map of key-value pairs associated to an OpenSearch Serverless resource.</p>
|
|
494
562
|
*/
|
|
495
563
|
export interface Tag {
|
|
@@ -502,6 +570,9 @@ export interface Tag {
|
|
|
502
570
|
*/
|
|
503
571
|
value: string | undefined;
|
|
504
572
|
}
|
|
573
|
+
/**
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
505
576
|
export interface CreateCollectionRequest {
|
|
506
577
|
/**
|
|
507
578
|
* <p>Name of the collection.</p>
|
|
@@ -525,6 +596,7 @@ export interface CreateCollectionRequest {
|
|
|
525
596
|
clientToken?: string;
|
|
526
597
|
}
|
|
527
598
|
/**
|
|
599
|
+
* @public
|
|
528
600
|
* <p>Details about the created OpenSearch Serverless collection.</p>
|
|
529
601
|
*/
|
|
530
602
|
export interface CreateCollectionDetail {
|
|
@@ -565,12 +637,18 @@ export interface CreateCollectionDetail {
|
|
|
565
637
|
*/
|
|
566
638
|
lastModifiedDate?: number;
|
|
567
639
|
}
|
|
640
|
+
/**
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
568
643
|
export interface CreateCollectionResponse {
|
|
569
644
|
/**
|
|
570
645
|
* <p>Details about the collection.</p>
|
|
571
646
|
*/
|
|
572
647
|
createCollectionDetail?: CreateCollectionDetail;
|
|
573
648
|
}
|
|
649
|
+
/**
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
574
652
|
export interface DeleteCollectionRequest {
|
|
575
653
|
/**
|
|
576
654
|
* <p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The
|
|
@@ -583,6 +661,7 @@ export interface DeleteCollectionRequest {
|
|
|
583
661
|
clientToken?: string;
|
|
584
662
|
}
|
|
585
663
|
/**
|
|
664
|
+
* @public
|
|
586
665
|
* <p>Details about a deleted OpenSearch Serverless collection.</p>
|
|
587
666
|
*/
|
|
588
667
|
export interface DeleteCollectionDetail {
|
|
@@ -599,6 +678,9 @@ export interface DeleteCollectionDetail {
|
|
|
599
678
|
*/
|
|
600
679
|
status?: CollectionStatus | string;
|
|
601
680
|
}
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
602
684
|
export interface DeleteCollectionResponse {
|
|
603
685
|
/**
|
|
604
686
|
* <p>Details of the deleted collection.</p>
|
|
@@ -606,6 +688,7 @@ export interface DeleteCollectionResponse {
|
|
|
606
688
|
deleteCollectionDetail?: DeleteCollectionDetail;
|
|
607
689
|
}
|
|
608
690
|
/**
|
|
691
|
+
* @public
|
|
609
692
|
* <p>List of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless
|
|
610
693
|
* collections.</p>
|
|
611
694
|
*/
|
|
@@ -619,6 +702,9 @@ export interface CollectionFilters {
|
|
|
619
702
|
*/
|
|
620
703
|
status?: CollectionStatus | string;
|
|
621
704
|
}
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
*/
|
|
622
708
|
export interface ListCollectionsRequest {
|
|
623
709
|
/**
|
|
624
710
|
* <p>List of filter names and values that you can use for requests.</p>
|
|
@@ -637,6 +723,7 @@ export interface ListCollectionsRequest {
|
|
|
637
723
|
maxResults?: number;
|
|
638
724
|
}
|
|
639
725
|
/**
|
|
726
|
+
* @public
|
|
640
727
|
* <p>Details about each OpenSearch Serverless collection.</p>
|
|
641
728
|
*/
|
|
642
729
|
export interface CollectionSummary {
|
|
@@ -657,6 +744,9 @@ export interface CollectionSummary {
|
|
|
657
744
|
*/
|
|
658
745
|
arn?: string;
|
|
659
746
|
}
|
|
747
|
+
/**
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
660
750
|
export interface ListCollectionsResponse {
|
|
661
751
|
/**
|
|
662
752
|
* <p>Details about each collection.</p>
|
|
@@ -669,6 +759,9 @@ export interface ListCollectionsResponse {
|
|
|
669
759
|
*/
|
|
670
760
|
nextToken?: string;
|
|
671
761
|
}
|
|
762
|
+
/**
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
672
765
|
export interface UpdateCollectionRequest {
|
|
673
766
|
/**
|
|
674
767
|
* <p>The unique identifier of the collection.</p>
|
|
@@ -684,6 +777,7 @@ export interface UpdateCollectionRequest {
|
|
|
684
777
|
clientToken?: string;
|
|
685
778
|
}
|
|
686
779
|
/**
|
|
780
|
+
* @public
|
|
687
781
|
* <p>Details about an updated OpenSearch Serverless collection.</p>
|
|
688
782
|
*/
|
|
689
783
|
export interface UpdateCollectionDetail {
|
|
@@ -720,6 +814,9 @@ export interface UpdateCollectionDetail {
|
|
|
720
814
|
*/
|
|
721
815
|
lastModifiedDate?: number;
|
|
722
816
|
}
|
|
817
|
+
/**
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
723
820
|
export interface UpdateCollectionResponse {
|
|
724
821
|
/**
|
|
725
822
|
* <p>Details about the updated collection.</p>
|
|
@@ -727,6 +824,7 @@ export interface UpdateCollectionResponse {
|
|
|
727
824
|
updateCollectionDetail?: UpdateCollectionDetail;
|
|
728
825
|
}
|
|
729
826
|
/**
|
|
827
|
+
* @public
|
|
730
828
|
* <p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value
|
|
731
829
|
* map.</p>
|
|
732
830
|
*/
|
|
@@ -749,12 +847,18 @@ export interface SamlConfigOptions {
|
|
|
749
847
|
*/
|
|
750
848
|
sessionTimeout?: number;
|
|
751
849
|
}
|
|
850
|
+
/**
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
752
853
|
export declare enum SecurityConfigType {
|
|
753
854
|
/**
|
|
754
855
|
* saml provider
|
|
755
856
|
*/
|
|
756
857
|
saml = "saml"
|
|
757
858
|
}
|
|
859
|
+
/**
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
758
862
|
export interface CreateSecurityConfigRequest {
|
|
759
863
|
/**
|
|
760
864
|
* <p>The type of security configuration.</p>
|
|
@@ -778,6 +882,7 @@ export interface CreateSecurityConfigRequest {
|
|
|
778
882
|
clientToken?: string;
|
|
779
883
|
}
|
|
780
884
|
/**
|
|
885
|
+
* @public
|
|
781
886
|
* <p>Details about a security configuration for OpenSearch Serverless. </p>
|
|
782
887
|
*/
|
|
783
888
|
export interface SecurityConfigDetail {
|
|
@@ -810,12 +915,18 @@ export interface SecurityConfigDetail {
|
|
|
810
915
|
*/
|
|
811
916
|
lastModifiedDate?: number;
|
|
812
917
|
}
|
|
918
|
+
/**
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
813
921
|
export interface CreateSecurityConfigResponse {
|
|
814
922
|
/**
|
|
815
923
|
* <p>Details about the created security configuration. </p>
|
|
816
924
|
*/
|
|
817
925
|
securityConfigDetail?: SecurityConfigDetail;
|
|
818
926
|
}
|
|
927
|
+
/**
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
819
930
|
export declare enum SecurityPolicyType {
|
|
820
931
|
/**
|
|
821
932
|
* encryption policy type
|
|
@@ -826,6 +937,9 @@ export declare enum SecurityPolicyType {
|
|
|
826
937
|
*/
|
|
827
938
|
network = "network"
|
|
828
939
|
}
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
829
943
|
export interface CreateSecurityPolicyRequest {
|
|
830
944
|
/**
|
|
831
945
|
* <p>The type of security policy.</p>
|
|
@@ -850,6 +964,7 @@ export interface CreateSecurityPolicyRequest {
|
|
|
850
964
|
clientToken?: string;
|
|
851
965
|
}
|
|
852
966
|
/**
|
|
967
|
+
* @public
|
|
853
968
|
* <p>Details about an OpenSearch Serverless security policy.</p>
|
|
854
969
|
*/
|
|
855
970
|
export interface SecurityPolicyDetail {
|
|
@@ -882,12 +997,18 @@ export interface SecurityPolicyDetail {
|
|
|
882
997
|
*/
|
|
883
998
|
lastModifiedDate?: number;
|
|
884
999
|
}
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
885
1003
|
export interface CreateSecurityPolicyResponse {
|
|
886
1004
|
/**
|
|
887
1005
|
* <p>Details about the created security policy.</p>
|
|
888
1006
|
*/
|
|
889
1007
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
890
1008
|
}
|
|
1009
|
+
/**
|
|
1010
|
+
* @public
|
|
1011
|
+
*/
|
|
891
1012
|
export interface CreateVpcEndpointRequest {
|
|
892
1013
|
/**
|
|
893
1014
|
* <p>The name of the interface endpoint.</p>
|
|
@@ -912,6 +1033,7 @@ export interface CreateVpcEndpointRequest {
|
|
|
912
1033
|
clientToken?: string;
|
|
913
1034
|
}
|
|
914
1035
|
/**
|
|
1036
|
+
* @public
|
|
915
1037
|
* <p>Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see
|
|
916
1038
|
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
917
1039
|
*/
|
|
@@ -929,12 +1051,18 @@ export interface CreateVpcEndpointDetail {
|
|
|
929
1051
|
*/
|
|
930
1052
|
status?: VpcEndpointStatus | string;
|
|
931
1053
|
}
|
|
1054
|
+
/**
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
932
1057
|
export interface CreateVpcEndpointResponse {
|
|
933
1058
|
/**
|
|
934
1059
|
* <p>Details about the created interface VPC endpoint.</p>
|
|
935
1060
|
*/
|
|
936
1061
|
createVpcEndpointDetail?: CreateVpcEndpointDetail;
|
|
937
1062
|
}
|
|
1063
|
+
/**
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
938
1066
|
export interface DeleteSecurityConfigRequest {
|
|
939
1067
|
/**
|
|
940
1068
|
* <p>The security configuration identifier. For SAML the ID will be
|
|
@@ -947,8 +1075,14 @@ export interface DeleteSecurityConfigRequest {
|
|
|
947
1075
|
*/
|
|
948
1076
|
clientToken?: string;
|
|
949
1077
|
}
|
|
1078
|
+
/**
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
950
1081
|
export interface DeleteSecurityConfigResponse {
|
|
951
1082
|
}
|
|
1083
|
+
/**
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
952
1086
|
export interface DeleteSecurityPolicyRequest {
|
|
953
1087
|
/**
|
|
954
1088
|
* <p>The type of policy.</p>
|
|
@@ -963,8 +1097,14 @@ export interface DeleteSecurityPolicyRequest {
|
|
|
963
1097
|
*/
|
|
964
1098
|
clientToken?: string;
|
|
965
1099
|
}
|
|
1100
|
+
/**
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
966
1103
|
export interface DeleteSecurityPolicyResponse {
|
|
967
1104
|
}
|
|
1105
|
+
/**
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
968
1108
|
export interface DeleteVpcEndpointRequest {
|
|
969
1109
|
/**
|
|
970
1110
|
* <p>The VPC endpoint identifier.</p>
|
|
@@ -976,6 +1116,7 @@ export interface DeleteVpcEndpointRequest {
|
|
|
976
1116
|
clientToken?: string;
|
|
977
1117
|
}
|
|
978
1118
|
/**
|
|
1119
|
+
* @public
|
|
979
1120
|
* <p>Deletion details for an OpenSearch Serverless-managed interface endpoint.</p>
|
|
980
1121
|
*/
|
|
981
1122
|
export interface DeleteVpcEndpointDetail {
|
|
@@ -992,23 +1133,36 @@ export interface DeleteVpcEndpointDetail {
|
|
|
992
1133
|
*/
|
|
993
1134
|
status?: VpcEndpointStatus | string;
|
|
994
1135
|
}
|
|
1136
|
+
/**
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
995
1139
|
export interface DeleteVpcEndpointResponse {
|
|
996
1140
|
/**
|
|
997
1141
|
* <p>Details about the deleted endpoint.</p>
|
|
998
1142
|
*/
|
|
999
1143
|
deleteVpcEndpointDetail?: DeleteVpcEndpointDetail;
|
|
1000
1144
|
}
|
|
1145
|
+
/**
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1001
1148
|
export interface GetAccountSettingsRequest {
|
|
1002
1149
|
}
|
|
1150
|
+
/**
|
|
1151
|
+
* @public
|
|
1152
|
+
*/
|
|
1003
1153
|
export interface GetAccountSettingsResponse {
|
|
1004
1154
|
/**
|
|
1005
1155
|
* <p>OpenSearch Serverless-related details for the current account.</p>
|
|
1006
1156
|
*/
|
|
1007
1157
|
accountSettingsDetail?: AccountSettingsDetail;
|
|
1008
1158
|
}
|
|
1159
|
+
/**
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1009
1162
|
export interface GetPoliciesStatsRequest {
|
|
1010
1163
|
}
|
|
1011
1164
|
/**
|
|
1165
|
+
* @public
|
|
1012
1166
|
* <p>Statistics for an OpenSearch Serverless security configuration.</p>
|
|
1013
1167
|
*/
|
|
1014
1168
|
export interface SecurityConfigStats {
|
|
@@ -1018,6 +1172,7 @@ export interface SecurityConfigStats {
|
|
|
1018
1172
|
SamlConfigCount?: number;
|
|
1019
1173
|
}
|
|
1020
1174
|
/**
|
|
1175
|
+
* @public
|
|
1021
1176
|
* <p>Statistics for an OpenSearch Serverless security policy.</p>
|
|
1022
1177
|
*/
|
|
1023
1178
|
export interface SecurityPolicyStats {
|
|
@@ -1030,6 +1185,9 @@ export interface SecurityPolicyStats {
|
|
|
1030
1185
|
*/
|
|
1031
1186
|
NetworkPolicyCount?: number;
|
|
1032
1187
|
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1033
1191
|
export interface GetPoliciesStatsResponse {
|
|
1034
1192
|
/**
|
|
1035
1193
|
* <p>Information about the data access policies in your account.</p>
|
|
@@ -1049,18 +1207,27 @@ export interface GetPoliciesStatsResponse {
|
|
|
1049
1207
|
*/
|
|
1050
1208
|
TotalPolicyCount?: number;
|
|
1051
1209
|
}
|
|
1210
|
+
/**
|
|
1211
|
+
* @public
|
|
1212
|
+
*/
|
|
1052
1213
|
export interface GetSecurityConfigRequest {
|
|
1053
1214
|
/**
|
|
1054
1215
|
* <p>The unique identifier of the security configuration.</p>
|
|
1055
1216
|
*/
|
|
1056
1217
|
id: string | undefined;
|
|
1057
1218
|
}
|
|
1219
|
+
/**
|
|
1220
|
+
* @public
|
|
1221
|
+
*/
|
|
1058
1222
|
export interface GetSecurityConfigResponse {
|
|
1059
1223
|
/**
|
|
1060
1224
|
* <p>Details of the requested security configuration.</p>
|
|
1061
1225
|
*/
|
|
1062
1226
|
securityConfigDetail?: SecurityConfigDetail;
|
|
1063
1227
|
}
|
|
1228
|
+
/**
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1064
1231
|
export interface GetSecurityPolicyRequest {
|
|
1065
1232
|
/**
|
|
1066
1233
|
* <p>The type of security policy.</p>
|
|
@@ -1071,12 +1238,18 @@ export interface GetSecurityPolicyRequest {
|
|
|
1071
1238
|
*/
|
|
1072
1239
|
name: string | undefined;
|
|
1073
1240
|
}
|
|
1241
|
+
/**
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1074
1244
|
export interface GetSecurityPolicyResponse {
|
|
1075
1245
|
/**
|
|
1076
1246
|
* <p>Details about the requested security policy.</p>
|
|
1077
1247
|
*/
|
|
1078
1248
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
1079
1249
|
}
|
|
1250
|
+
/**
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1080
1253
|
export interface ListSecurityConfigsRequest {
|
|
1081
1254
|
/**
|
|
1082
1255
|
* <p>The type of security configuration.</p>
|
|
@@ -1096,6 +1269,7 @@ export interface ListSecurityConfigsRequest {
|
|
|
1096
1269
|
maxResults?: number;
|
|
1097
1270
|
}
|
|
1098
1271
|
/**
|
|
1272
|
+
* @public
|
|
1099
1273
|
* <p>A summary of a security configuration for OpenSearch Serverless.</p>
|
|
1100
1274
|
*/
|
|
1101
1275
|
export interface SecurityConfigSummary {
|
|
@@ -1124,6 +1298,9 @@ export interface SecurityConfigSummary {
|
|
|
1124
1298
|
*/
|
|
1125
1299
|
lastModifiedDate?: number;
|
|
1126
1300
|
}
|
|
1301
|
+
/**
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1127
1304
|
export interface ListSecurityConfigsResponse {
|
|
1128
1305
|
/**
|
|
1129
1306
|
* <p>Details about the security configurations in your account.</p>
|
|
@@ -1136,6 +1313,9 @@ export interface ListSecurityConfigsResponse {
|
|
|
1136
1313
|
*/
|
|
1137
1314
|
nextToken?: string;
|
|
1138
1315
|
}
|
|
1316
|
+
/**
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1139
1319
|
export interface ListSecurityPoliciesRequest {
|
|
1140
1320
|
/**
|
|
1141
1321
|
* <p>The type of policy.</p>
|
|
@@ -1159,6 +1339,7 @@ export interface ListSecurityPoliciesRequest {
|
|
|
1159
1339
|
maxResults?: number;
|
|
1160
1340
|
}
|
|
1161
1341
|
/**
|
|
1342
|
+
* @public
|
|
1162
1343
|
* <p>A summary of a security policy for OpenSearch Serverless.</p>
|
|
1163
1344
|
*/
|
|
1164
1345
|
export interface SecurityPolicySummary {
|
|
@@ -1187,6 +1368,9 @@ export interface SecurityPolicySummary {
|
|
|
1187
1368
|
*/
|
|
1188
1369
|
lastModifiedDate?: number;
|
|
1189
1370
|
}
|
|
1371
|
+
/**
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1190
1374
|
export interface ListSecurityPoliciesResponse {
|
|
1191
1375
|
/**
|
|
1192
1376
|
* <p>Details about the security policies in your account.</p>
|
|
@@ -1199,6 +1383,9 @@ export interface ListSecurityPoliciesResponse {
|
|
|
1199
1383
|
*/
|
|
1200
1384
|
nextToken?: string;
|
|
1201
1385
|
}
|
|
1386
|
+
/**
|
|
1387
|
+
* @public
|
|
1388
|
+
*/
|
|
1202
1389
|
export interface ListTagsForResourceRequest {
|
|
1203
1390
|
/**
|
|
1204
1391
|
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
@@ -1207,6 +1394,9 @@ export interface ListTagsForResourceRequest {
|
|
|
1207
1394
|
*/
|
|
1208
1395
|
resourceArn: string | undefined;
|
|
1209
1396
|
}
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1210
1400
|
export interface ListTagsForResourceResponse {
|
|
1211
1401
|
/**
|
|
1212
1402
|
* <p>The tags associated with the resource.</p>
|
|
@@ -1214,6 +1404,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1214
1404
|
tags?: Tag[];
|
|
1215
1405
|
}
|
|
1216
1406
|
/**
|
|
1407
|
+
* @public
|
|
1217
1408
|
* <p>Filter the results of a <code>ListVpcEndpoints</code> request.</p>
|
|
1218
1409
|
*/
|
|
1219
1410
|
export interface VpcEndpointFilters {
|
|
@@ -1222,6 +1413,9 @@ export interface VpcEndpointFilters {
|
|
|
1222
1413
|
*/
|
|
1223
1414
|
status?: VpcEndpointStatus | string;
|
|
1224
1415
|
}
|
|
1416
|
+
/**
|
|
1417
|
+
* @public
|
|
1418
|
+
*/
|
|
1225
1419
|
export interface ListVpcEndpointsRequest {
|
|
1226
1420
|
/**
|
|
1227
1421
|
* <p>Filter the results according to the current status of the VPC endpoint. Possible
|
|
@@ -1243,6 +1437,7 @@ export interface ListVpcEndpointsRequest {
|
|
|
1243
1437
|
maxResults?: number;
|
|
1244
1438
|
}
|
|
1245
1439
|
/**
|
|
1440
|
+
* @public
|
|
1246
1441
|
* <p>The VPC endpoint object.</p>
|
|
1247
1442
|
*/
|
|
1248
1443
|
export interface VpcEndpointSummary {
|
|
@@ -1259,6 +1454,9 @@ export interface VpcEndpointSummary {
|
|
|
1259
1454
|
*/
|
|
1260
1455
|
status?: VpcEndpointStatus | string;
|
|
1261
1456
|
}
|
|
1457
|
+
/**
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1262
1460
|
export interface ListVpcEndpointsResponse {
|
|
1263
1461
|
/**
|
|
1264
1462
|
* <p>Details about each VPC endpoint, including the name and current status.</p>
|
|
@@ -1271,6 +1469,9 @@ export interface ListVpcEndpointsResponse {
|
|
|
1271
1469
|
*/
|
|
1272
1470
|
nextToken?: string;
|
|
1273
1471
|
}
|
|
1472
|
+
/**
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1274
1475
|
export interface UpdateSecurityConfigRequest {
|
|
1275
1476
|
/**
|
|
1276
1477
|
* <p>The security configuration identifier. For SAML the ID will be
|
|
@@ -1297,12 +1498,18 @@ export interface UpdateSecurityConfigRequest {
|
|
|
1297
1498
|
*/
|
|
1298
1499
|
clientToken?: string;
|
|
1299
1500
|
}
|
|
1501
|
+
/**
|
|
1502
|
+
* @public
|
|
1503
|
+
*/
|
|
1300
1504
|
export interface UpdateSecurityConfigResponse {
|
|
1301
1505
|
/**
|
|
1302
1506
|
* <p>Details about the updated security configuration. </p>
|
|
1303
1507
|
*/
|
|
1304
1508
|
securityConfigDetail?: SecurityConfigDetail;
|
|
1305
1509
|
}
|
|
1510
|
+
/**
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1306
1513
|
export interface UpdateSecurityPolicyRequest {
|
|
1307
1514
|
/**
|
|
1308
1515
|
* <p>The type of access policy.</p>
|
|
@@ -1330,12 +1537,18 @@ export interface UpdateSecurityPolicyRequest {
|
|
|
1330
1537
|
*/
|
|
1331
1538
|
clientToken?: string;
|
|
1332
1539
|
}
|
|
1540
|
+
/**
|
|
1541
|
+
* @public
|
|
1542
|
+
*/
|
|
1333
1543
|
export interface UpdateSecurityPolicyResponse {
|
|
1334
1544
|
/**
|
|
1335
1545
|
* <p>Details about the updated security policy.</p>
|
|
1336
1546
|
*/
|
|
1337
1547
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
1338
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1339
1552
|
export interface TagResourceRequest {
|
|
1340
1553
|
/**
|
|
1341
1554
|
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
@@ -1349,8 +1562,14 @@ export interface TagResourceRequest {
|
|
|
1349
1562
|
*/
|
|
1350
1563
|
tags: Tag[] | undefined;
|
|
1351
1564
|
}
|
|
1565
|
+
/**
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1352
1568
|
export interface TagResourceResponse {
|
|
1353
1569
|
}
|
|
1570
|
+
/**
|
|
1571
|
+
* @public
|
|
1572
|
+
*/
|
|
1354
1573
|
export interface UntagResourceRequest {
|
|
1355
1574
|
/**
|
|
1356
1575
|
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must
|
|
@@ -1364,8 +1583,14 @@ export interface UntagResourceRequest {
|
|
|
1364
1583
|
*/
|
|
1365
1584
|
tagKeys: string[] | undefined;
|
|
1366
1585
|
}
|
|
1586
|
+
/**
|
|
1587
|
+
* @public
|
|
1588
|
+
*/
|
|
1367
1589
|
export interface UntagResourceResponse {
|
|
1368
1590
|
}
|
|
1591
|
+
/**
|
|
1592
|
+
* @public
|
|
1593
|
+
*/
|
|
1369
1594
|
export interface UpdateAccountSettingsRequest {
|
|
1370
1595
|
/**
|
|
1371
1596
|
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
@@ -1374,12 +1599,18 @@ export interface UpdateAccountSettingsRequest {
|
|
|
1374
1599
|
*/
|
|
1375
1600
|
capacityLimits?: CapacityLimits;
|
|
1376
1601
|
}
|
|
1602
|
+
/**
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1377
1605
|
export interface UpdateAccountSettingsResponse {
|
|
1378
1606
|
/**
|
|
1379
1607
|
* <p>OpenSearch Serverless-related settings for the current Amazon Web Services account. </p>
|
|
1380
1608
|
*/
|
|
1381
1609
|
accountSettingsDetail?: AccountSettingsDetail;
|
|
1382
1610
|
}
|
|
1611
|
+
/**
|
|
1612
|
+
* @public
|
|
1613
|
+
*/
|
|
1383
1614
|
export interface UpdateVpcEndpointRequest {
|
|
1384
1615
|
/**
|
|
1385
1616
|
* <p>The unique identifier of the interface endpoint to update.</p>
|
|
@@ -1409,6 +1640,7 @@ export interface UpdateVpcEndpointRequest {
|
|
|
1409
1640
|
clientToken?: string;
|
|
1410
1641
|
}
|
|
1411
1642
|
/**
|
|
1643
|
+
* @public
|
|
1412
1644
|
* <p>Update details for an OpenSearch Serverless-managed interface endpoint.</p>
|
|
1413
1645
|
*/
|
|
1414
1646
|
export interface UpdateVpcEndpointDetail {
|
|
@@ -1438,6 +1670,9 @@ export interface UpdateVpcEndpointDetail {
|
|
|
1438
1670
|
*/
|
|
1439
1671
|
lastModifiedDate?: number;
|
|
1440
1672
|
}
|
|
1673
|
+
/**
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1441
1676
|
export interface UpdateVpcEndpointResponse {
|
|
1442
1677
|
/**
|
|
1443
1678
|
* <p>Details about the updated VPC endpoint.</p>
|