@aws-sdk/client-opensearchserverless 3.879.0 → 3.882.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/dist-types/OpenSearchServerless.d.ts +1 -10
- package/dist-types/OpenSearchServerlessClient.d.ts +1 -10
- package/dist-types/commands/BatchGetCollectionCommand.d.ts +6 -5
- package/dist-types/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +2 -4
- package/dist-types/commands/BatchGetLifecyclePolicyCommand.d.ts +2 -4
- package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +2 -5
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +4 -11
- package/dist-types/commands/CreateCollectionCommand.d.ts +5 -11
- package/dist-types/commands/CreateIndexCommand.d.ts +3 -9
- package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +4 -10
- package/dist-types/commands/CreateSecurityConfigCommand.d.ts +4 -9
- package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +4 -13
- package/dist-types/commands/CreateVpcEndpointCommand.d.ts +4 -9
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +3 -7
- package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -7
- package/dist-types/commands/DeleteIndexCommand.d.ts +2 -5
- package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +2 -5
- package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +3 -7
- package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +2 -5
- package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +3 -7
- package/dist-types/commands/GetAccessPolicyCommand.d.ts +2 -4
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +1 -2
- package/dist-types/commands/GetIndexCommand.d.ts +2 -5
- package/dist-types/commands/GetPoliciesStatsCommand.d.ts +1 -2
- package/dist-types/commands/GetSecurityConfigCommand.d.ts +2 -5
- package/dist-types/commands/GetSecurityPolicyCommand.d.ts +2 -6
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -2
- package/dist-types/commands/ListCollectionsCommand.d.ts +2 -8
- package/dist-types/commands/ListLifecyclePoliciesCommand.d.ts +1 -2
- package/dist-types/commands/ListSecurityConfigsCommand.d.ts +2 -5
- package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +1 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -5
- package/dist-types/commands/TagResourceCommand.d.ts +4 -9
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -7
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +3 -7
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -5
- package/dist-types/commands/UpdateCollectionCommand.d.ts +2 -5
- package/dist-types/commands/UpdateIndexCommand.d.ts +2 -6
- package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +3 -7
- package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +3 -7
- package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +4 -10
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +3 -7
- package/dist-types/index.d.ts +1 -10
- package/dist-types/models/models_0.d.ts +111 -222
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +11 -11
|
@@ -16,9 +16,7 @@ export declare const AccessPolicyType: {
|
|
|
16
16
|
*/
|
|
17
17
|
export type AccessPolicyType = (typeof AccessPolicyType)[keyof typeof AccessPolicyType];
|
|
18
18
|
/**
|
|
19
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
20
|
-
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
21
|
-
* ACTIVE or FAILED state.</p>
|
|
19
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
|
|
22
20
|
* @public
|
|
23
21
|
*/
|
|
24
22
|
export declare class ConflictException extends __BaseException {
|
|
@@ -44,8 +42,7 @@ export interface CreateAccessPolicyRequest {
|
|
|
44
42
|
*/
|
|
45
43
|
name: string | undefined;
|
|
46
44
|
/**
|
|
47
|
-
* <p>A description of the policy. Typically used to store information about the permissions
|
|
48
|
-
* defined in the policy.</p>
|
|
45
|
+
* <p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>
|
|
49
46
|
* @public
|
|
50
47
|
*/
|
|
51
48
|
description?: string | undefined;
|
|
@@ -124,8 +121,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
124
121
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
125
122
|
}
|
|
126
123
|
/**
|
|
127
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
128
|
-
* service quotas.</p>
|
|
124
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
|
|
129
125
|
* @public
|
|
130
126
|
*/
|
|
131
127
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -157,8 +153,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
157
153
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
158
154
|
}
|
|
159
155
|
/**
|
|
160
|
-
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
161
|
-
* input.</p>
|
|
156
|
+
* <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
|
|
162
157
|
* @public
|
|
163
158
|
*/
|
|
164
159
|
export declare class ValidationException extends __BaseException {
|
|
@@ -246,16 +241,12 @@ export interface ListAccessPoliciesRequest {
|
|
|
246
241
|
*/
|
|
247
242
|
resource?: string[] | undefined;
|
|
248
243
|
/**
|
|
249
|
-
* <p>If your initial <code>ListAccessPolicies</code> operation returns a
|
|
250
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
251
|
-
* subsequent <code>ListAccessPolicies</code> operations, which returns results in the next
|
|
252
|
-
* page.</p>
|
|
244
|
+
* <p>If your initial <code>ListAccessPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListAccessPolicies</code> operations, which returns results in the next page.</p>
|
|
253
245
|
* @public
|
|
254
246
|
*/
|
|
255
247
|
nextToken?: string | undefined;
|
|
256
248
|
/**
|
|
257
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
258
|
-
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
249
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
259
250
|
* @public
|
|
260
251
|
*/
|
|
261
252
|
maxResults?: number | undefined;
|
|
@@ -266,8 +257,7 @@ export interface ListAccessPoliciesRequest {
|
|
|
266
257
|
*/
|
|
267
258
|
export interface AccessPolicySummary {
|
|
268
259
|
/**
|
|
269
|
-
* <p>The type of access policy. Currently, the only available type is
|
|
270
|
-
* <code>data</code>.</p>
|
|
260
|
+
* <p>The type of access policy. Currently, the only available type is <code>data</code>.</p>
|
|
271
261
|
* @public
|
|
272
262
|
*/
|
|
273
263
|
type?: AccessPolicyType | undefined;
|
|
@@ -307,9 +297,7 @@ export interface ListAccessPoliciesResponse {
|
|
|
307
297
|
*/
|
|
308
298
|
accessPolicySummaries?: AccessPolicySummary[] | undefined;
|
|
309
299
|
/**
|
|
310
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
311
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
312
|
-
* again using the returned token to retrieve the next page.</p>
|
|
300
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
313
301
|
* @public
|
|
314
302
|
*/
|
|
315
303
|
nextToken?: string | undefined;
|
|
@@ -334,8 +322,7 @@ export interface UpdateAccessPolicyRequest {
|
|
|
334
322
|
*/
|
|
335
323
|
policyVersion: string | undefined;
|
|
336
324
|
/**
|
|
337
|
-
* <p>A description of the policy. Typically used to store information about the permissions
|
|
338
|
-
* defined in the policy.</p>
|
|
325
|
+
* <p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>
|
|
339
326
|
* @public
|
|
340
327
|
*/
|
|
341
328
|
description?: string | undefined;
|
|
@@ -372,10 +359,7 @@ export interface AccessPolicyStats {
|
|
|
372
359
|
DataPolicyCount?: number | undefined;
|
|
373
360
|
}
|
|
374
361
|
/**
|
|
375
|
-
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
376
|
-
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
377
|
-
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
378
|
-
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
362
|
+
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
379
363
|
* @public
|
|
380
364
|
*/
|
|
381
365
|
export interface CapacityLimits {
|
|
@@ -396,10 +380,7 @@ export interface CapacityLimits {
|
|
|
396
380
|
*/
|
|
397
381
|
export interface AccountSettingsDetail {
|
|
398
382
|
/**
|
|
399
|
-
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
400
|
-
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
401
|
-
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
402
|
-
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
383
|
+
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
403
384
|
* @public
|
|
404
385
|
*/
|
|
405
386
|
capacityLimits?: CapacityLimits | undefined;
|
|
@@ -409,18 +390,32 @@ export interface AccountSettingsDetail {
|
|
|
409
390
|
*/
|
|
410
391
|
export interface BatchGetCollectionRequest {
|
|
411
392
|
/**
|
|
412
|
-
* <p>A list of collection IDs. You can't provide names and IDs in the same request. The ID
|
|
413
|
-
* is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
|
|
393
|
+
* <p>A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
|
|
414
394
|
* @public
|
|
415
395
|
*/
|
|
416
396
|
ids?: string[] | undefined;
|
|
417
397
|
/**
|
|
418
|
-
* <p>A list of collection names. You can't provide names and IDs in the same
|
|
419
|
-
* request.</p>
|
|
398
|
+
* <p>A list of collection names. You can't provide names and IDs in the same request.</p>
|
|
420
399
|
* @public
|
|
421
400
|
*/
|
|
422
401
|
names?: string[] | undefined;
|
|
423
402
|
}
|
|
403
|
+
/**
|
|
404
|
+
* <p>FIPS-compliant endpoint URLs for an OpenSearch Serverless collection. These endpoints ensure all data transmission uses FIPS 140-3 validated cryptographic implementations, meeting federal security requirements for government workloads.</p>
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
export interface FipsEndpoints {
|
|
408
|
+
/**
|
|
409
|
+
* <p>FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads.</p>
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
collectionEndpoint?: string | undefined;
|
|
413
|
+
/**
|
|
414
|
+
* <p>FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads that need dashboard visualization capabilities.</p>
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
dashboardEndpoint?: string | undefined;
|
|
418
|
+
}
|
|
424
419
|
/**
|
|
425
420
|
* @public
|
|
426
421
|
* @enum
|
|
@@ -488,8 +483,7 @@ export declare const CollectionType: {
|
|
|
488
483
|
*/
|
|
489
484
|
export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType];
|
|
490
485
|
/**
|
|
491
|
-
* <p>Details about each OpenSearch Serverless collection, including the collection endpoint and
|
|
492
|
-
* OpenSearch Dashboards endpoint.</p>
|
|
486
|
+
* <p>Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.</p>
|
|
493
487
|
* @public
|
|
494
488
|
*/
|
|
495
489
|
export interface CollectionDetail {
|
|
@@ -544,8 +538,7 @@ export interface CollectionDetail {
|
|
|
544
538
|
*/
|
|
545
539
|
lastModifiedDate?: number | undefined;
|
|
546
540
|
/**
|
|
547
|
-
* <p>Collection-specific endpoint used to submit index, search, and data upload requests to
|
|
548
|
-
* an OpenSearch Serverless collection.</p>
|
|
541
|
+
* <p>Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.</p>
|
|
549
542
|
* @public
|
|
550
543
|
*/
|
|
551
544
|
collectionEndpoint?: string | undefined;
|
|
@@ -554,6 +547,11 @@ export interface CollectionDetail {
|
|
|
554
547
|
* @public
|
|
555
548
|
*/
|
|
556
549
|
dashboardEndpoint?: string | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p>FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
fipsEndpoints?: FipsEndpoints | undefined;
|
|
557
555
|
/**
|
|
558
556
|
* <p>A failure code associated with the request.</p>
|
|
559
557
|
* @public
|
|
@@ -571,21 +569,17 @@ export interface CollectionDetail {
|
|
|
571
569
|
*/
|
|
572
570
|
export interface CollectionErrorDetail {
|
|
573
571
|
/**
|
|
574
|
-
* <p>If the request contains collection IDs, the response includes the IDs provided in the
|
|
575
|
-
* request.</p>
|
|
572
|
+
* <p>If the request contains collection IDs, the response includes the IDs provided in the request.</p>
|
|
576
573
|
* @public
|
|
577
574
|
*/
|
|
578
575
|
id?: string | undefined;
|
|
579
576
|
/**
|
|
580
|
-
* <p>If the request contains collection names, the response includes the names provided in
|
|
581
|
-
* the request.</p>
|
|
577
|
+
* <p>If the request contains collection names, the response includes the names provided in the request.</p>
|
|
582
578
|
* @public
|
|
583
579
|
*/
|
|
584
580
|
name?: string | undefined;
|
|
585
581
|
/**
|
|
586
|
-
* <p>A description of the error. For example, <code>The specified Collection is not
|
|
587
|
-
* found.</code>
|
|
588
|
-
* </p>
|
|
582
|
+
* <p>A description of the error. For example, <code>The specified Collection is not found.</code> </p>
|
|
589
583
|
* @public
|
|
590
584
|
*/
|
|
591
585
|
errorMessage?: string | undefined;
|
|
@@ -685,21 +679,17 @@ export interface EffectiveLifecyclePolicyDetail {
|
|
|
685
679
|
*/
|
|
686
680
|
policyName?: string | undefined;
|
|
687
681
|
/**
|
|
688
|
-
* <p>The type of OpenSearch Serverless resource. Currently, the only supported resource is
|
|
689
|
-
* <code>index</code>.</p>
|
|
682
|
+
* <p>The type of OpenSearch Serverless resource. Currently, the only supported resource is <code>index</code>.</p>
|
|
690
683
|
* @public
|
|
691
684
|
*/
|
|
692
685
|
resourceType?: ResourceType | undefined;
|
|
693
686
|
/**
|
|
694
|
-
* <p>The minimum number of index retention in days or hours. This is an optional parameter
|
|
695
|
-
* that will return only if it’s set.</p>
|
|
687
|
+
* <p>The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.</p>
|
|
696
688
|
* @public
|
|
697
689
|
*/
|
|
698
690
|
retentionPeriod?: string | undefined;
|
|
699
691
|
/**
|
|
700
|
-
* <p>The minimum number of index retention days set. That is an optional param that will
|
|
701
|
-
* return as <code>true</code> if the minimum number of days or hours is not set to a index
|
|
702
|
-
* resource.</p>
|
|
692
|
+
* <p>The minimum number of index retention days set. That is an optional param that will return as <code>true</code> if the minimum number of days or hours is not set to a index resource.</p>
|
|
703
693
|
* @public
|
|
704
694
|
*/
|
|
705
695
|
noMinRetentionPeriod?: boolean | undefined;
|
|
@@ -720,8 +710,7 @@ export interface EffectiveLifecyclePolicyErrorDetail {
|
|
|
720
710
|
*/
|
|
721
711
|
resource?: string | undefined;
|
|
722
712
|
/**
|
|
723
|
-
* <p>A description of the error. For example, <code>The specified Index resource is not
|
|
724
|
-
* found</code>.</p>
|
|
713
|
+
* <p>A description of the error. For example, <code>The specified Index resource is not found</code>.</p>
|
|
725
714
|
* @public
|
|
726
715
|
*/
|
|
727
716
|
errorMessage?: string | undefined;
|
|
@@ -829,8 +818,7 @@ export interface LifecyclePolicyErrorDetail {
|
|
|
829
818
|
*/
|
|
830
819
|
name?: string | undefined;
|
|
831
820
|
/**
|
|
832
|
-
* <p>A description of the error. For example, <code>The specified Lifecycle Policy is not
|
|
833
|
-
* found</code>.</p>
|
|
821
|
+
* <p>A description of the error. For example, <code>The specified Lifecycle Policy is not found</code>.</p>
|
|
834
822
|
* @public
|
|
835
823
|
*/
|
|
836
824
|
errorMessage?: string | undefined;
|
|
@@ -917,8 +905,7 @@ export interface VpcEndpointDetail {
|
|
|
917
905
|
*/
|
|
918
906
|
subnetIds?: string[] | undefined;
|
|
919
907
|
/**
|
|
920
|
-
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
921
|
-
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
908
|
+
* <p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
922
909
|
* @public
|
|
923
910
|
*/
|
|
924
911
|
securityGroupIds?: string[] | undefined;
|
|
@@ -1015,8 +1002,7 @@ export interface CreateCollectionRequest {
|
|
|
1015
1002
|
*/
|
|
1016
1003
|
description?: string | undefined;
|
|
1017
1004
|
/**
|
|
1018
|
-
* <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless
|
|
1019
|
-
* collection.</p>
|
|
1005
|
+
* <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
|
|
1020
1006
|
* @public
|
|
1021
1007
|
*/
|
|
1022
1008
|
tags?: Tag[] | undefined;
|
|
@@ -1067,8 +1053,7 @@ export interface CreateCollectionDetail {
|
|
|
1067
1053
|
*/
|
|
1068
1054
|
arn?: string | undefined;
|
|
1069
1055
|
/**
|
|
1070
|
-
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the
|
|
1071
|
-
* collection.</p>
|
|
1056
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.</p>
|
|
1072
1057
|
* @public
|
|
1073
1058
|
*/
|
|
1074
1059
|
kmsKeyArn?: string | undefined;
|
|
@@ -1099,8 +1084,7 @@ export interface CreateCollectionResponse {
|
|
|
1099
1084
|
createCollectionDetail?: CreateCollectionDetail | undefined;
|
|
1100
1085
|
}
|
|
1101
1086
|
/**
|
|
1102
|
-
* <p>Thrown when the collection you're attempting to create results in a number of search
|
|
1103
|
-
* or indexing OCUs that exceeds the account limit. </p>
|
|
1087
|
+
* <p>Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit. </p>
|
|
1104
1088
|
* @public
|
|
1105
1089
|
*/
|
|
1106
1090
|
export declare class OcuLimitExceededException extends __BaseException {
|
|
@@ -1116,8 +1100,7 @@ export declare class OcuLimitExceededException extends __BaseException {
|
|
|
1116
1100
|
*/
|
|
1117
1101
|
export interface DeleteCollectionRequest {
|
|
1118
1102
|
/**
|
|
1119
|
-
* <p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The
|
|
1120
|
-
* ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
|
|
1103
|
+
* <p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
|
|
1121
1104
|
* @public
|
|
1122
1105
|
*/
|
|
1123
1106
|
id: string | undefined;
|
|
@@ -1159,8 +1142,7 @@ export interface DeleteCollectionResponse {
|
|
|
1159
1142
|
deleteCollectionDetail?: DeleteCollectionDetail | undefined;
|
|
1160
1143
|
}
|
|
1161
1144
|
/**
|
|
1162
|
-
* <p>A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless
|
|
1163
|
-
* collections.</p>
|
|
1145
|
+
* <p>A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.</p>
|
|
1164
1146
|
* @public
|
|
1165
1147
|
*/
|
|
1166
1148
|
export interface CollectionFilters {
|
|
@@ -1185,16 +1167,12 @@ export interface ListCollectionsRequest {
|
|
|
1185
1167
|
*/
|
|
1186
1168
|
collectionFilters?: CollectionFilters | undefined;
|
|
1187
1169
|
/**
|
|
1188
|
-
* <p>If your initial <code>ListCollections</code> operation returns a
|
|
1189
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
1190
|
-
* subsequent <code>ListCollections</code> operations, which returns results in the next
|
|
1191
|
-
* page.</p>
|
|
1170
|
+
* <p>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations, which returns results in the next page.</p>
|
|
1192
1171
|
* @public
|
|
1193
1172
|
*/
|
|
1194
1173
|
nextToken?: string | undefined;
|
|
1195
1174
|
/**
|
|
1196
|
-
* <p>The maximum number of results to return. Default is 20. You can use
|
|
1197
|
-
* <code>nextToken</code> to get the next page of results.</p>
|
|
1175
|
+
* <p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>
|
|
1198
1176
|
* @public
|
|
1199
1177
|
*/
|
|
1200
1178
|
maxResults?: number | undefined;
|
|
@@ -1235,9 +1213,7 @@ export interface ListCollectionsResponse {
|
|
|
1235
1213
|
*/
|
|
1236
1214
|
collectionSummaries?: CollectionSummary[] | undefined;
|
|
1237
1215
|
/**
|
|
1238
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
1239
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
1240
|
-
* again using the returned token to retrieve the next page.</p>
|
|
1216
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
1241
1217
|
* @public
|
|
1242
1218
|
*/
|
|
1243
1219
|
nextToken?: string | undefined;
|
|
@@ -1359,26 +1335,22 @@ export declare const IamIdentityCenterUserAttribute: {
|
|
|
1359
1335
|
*/
|
|
1360
1336
|
export type IamIdentityCenterUserAttribute = (typeof IamIdentityCenterUserAttribute)[keyof typeof IamIdentityCenterUserAttribute];
|
|
1361
1337
|
/**
|
|
1362
|
-
* <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security
|
|
1363
|
-
* configuration in the form of a key-value map.</p>
|
|
1338
|
+
* <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.</p>
|
|
1364
1339
|
* @public
|
|
1365
1340
|
*/
|
|
1366
1341
|
export interface CreateIamIdentityCenterConfigOptions {
|
|
1367
1342
|
/**
|
|
1368
|
-
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1369
|
-
* Serverless.</p>
|
|
1343
|
+
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>
|
|
1370
1344
|
* @public
|
|
1371
1345
|
*/
|
|
1372
1346
|
instanceArn: string | undefined;
|
|
1373
1347
|
/**
|
|
1374
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1375
|
-
* <code>UserId</code>.</p>
|
|
1348
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>
|
|
1376
1349
|
* @public
|
|
1377
1350
|
*/
|
|
1378
1351
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
1379
1352
|
/**
|
|
1380
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1381
|
-
* <code>GroupId</code>.</p>
|
|
1353
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
|
|
1382
1354
|
* @public
|
|
1383
1355
|
*/
|
|
1384
1356
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
@@ -1393,14 +1365,12 @@ export interface CreateIndexRequest {
|
|
|
1393
1365
|
*/
|
|
1394
1366
|
id: string | undefined;
|
|
1395
1367
|
/**
|
|
1396
|
-
* <p>The name of the index to create. Index names must be lowercase and can't begin with
|
|
1397
|
-
* underscores (_) or hyphens (-).</p>
|
|
1368
|
+
* <p>The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).</p>
|
|
1398
1369
|
* @public
|
|
1399
1370
|
*/
|
|
1400
1371
|
indexName: string | undefined;
|
|
1401
1372
|
/**
|
|
1402
|
-
* <p>The JSON schema definition for the index, including field mappings and
|
|
1403
|
-
* settings.</p>
|
|
1373
|
+
* <p>The JSON schema definition for the index, including field mappings and settings.</p>
|
|
1404
1374
|
* @public
|
|
1405
1375
|
*/
|
|
1406
1376
|
indexSchema?: __DocumentType | undefined;
|
|
@@ -1451,28 +1421,23 @@ export interface CreateLifecyclePolicyResponse {
|
|
|
1451
1421
|
lifecyclePolicyDetail?: LifecyclePolicyDetail | undefined;
|
|
1452
1422
|
}
|
|
1453
1423
|
/**
|
|
1454
|
-
* <p>Describes IAM federation options for an OpenSearch Serverless security configuration
|
|
1455
|
-
* in the form of a key-value map. These options define how OpenSearch Serverless
|
|
1456
|
-
* integrates with external identity providers using federation.</p>
|
|
1424
|
+
* <p>Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map. These options define how OpenSearch Serverless integrates with external identity providers using federation.</p>
|
|
1457
1425
|
* @public
|
|
1458
1426
|
*/
|
|
1459
1427
|
export interface IamFederationConfigOptions {
|
|
1460
1428
|
/**
|
|
1461
|
-
* <p>The group attribute for this IAM federation integration. This attribute is used to map
|
|
1462
|
-
* identity provider groups to OpenSearch Serverless permissions.</p>
|
|
1429
|
+
* <p>The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.</p>
|
|
1463
1430
|
* @public
|
|
1464
1431
|
*/
|
|
1465
1432
|
groupAttribute?: string | undefined;
|
|
1466
1433
|
/**
|
|
1467
|
-
* <p>The user attribute for this IAM federation integration. This attribute is used to
|
|
1468
|
-
* identify users in the federated authentication process.</p>
|
|
1434
|
+
* <p>The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.</p>
|
|
1469
1435
|
* @public
|
|
1470
1436
|
*/
|
|
1471
1437
|
userAttribute?: string | undefined;
|
|
1472
1438
|
}
|
|
1473
1439
|
/**
|
|
1474
|
-
* <p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value
|
|
1475
|
-
* map.</p>
|
|
1440
|
+
* <p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.</p>
|
|
1476
1441
|
* @public
|
|
1477
1442
|
*/
|
|
1478
1443
|
export interface SamlConfigOptions {
|
|
@@ -1492,8 +1457,7 @@ export interface SamlConfigOptions {
|
|
|
1492
1457
|
*/
|
|
1493
1458
|
groupAttribute?: string | undefined;
|
|
1494
1459
|
/**
|
|
1495
|
-
* <p>Custom entity ID attribute to override the default entity ID for this SAML
|
|
1496
|
-
* integration.</p>
|
|
1460
|
+
* <p>Custom entity ID attribute to override the default entity ID for this SAML integration.</p>
|
|
1497
1461
|
* @public
|
|
1498
1462
|
*/
|
|
1499
1463
|
openSearchServerlessEntityId?: string | undefined;
|
|
@@ -1545,21 +1509,17 @@ export interface CreateSecurityConfigRequest {
|
|
|
1545
1509
|
*/
|
|
1546
1510
|
description?: string | undefined;
|
|
1547
1511
|
/**
|
|
1548
|
-
* <p>Describes SAML options in in the form of a key-value map. This field is required if
|
|
1549
|
-
* you specify <code>SAML</code> for the <code>type</code> parameter.</p>
|
|
1512
|
+
* <p>Describes SAML options in in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
|
|
1550
1513
|
* @public
|
|
1551
1514
|
*/
|
|
1552
1515
|
samlOptions?: SamlConfigOptions | undefined;
|
|
1553
1516
|
/**
|
|
1554
|
-
* <p>Describes IAM Identity Center options in the form of a key-value map. This field is
|
|
1555
|
-
* required if you specify iamidentitycenter for the type parameter.</p>
|
|
1517
|
+
* <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.</p>
|
|
1556
1518
|
* @public
|
|
1557
1519
|
*/
|
|
1558
1520
|
iamIdentityCenterOptions?: CreateIamIdentityCenterConfigOptions | undefined;
|
|
1559
1521
|
/**
|
|
1560
|
-
* <p>Describes IAM federation options in the form of a key-value map. This field is
|
|
1561
|
-
* required if you specify <code>iamFederation</code> for the <code>type</code>
|
|
1562
|
-
* parameter.</p>
|
|
1522
|
+
* <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
|
|
1563
1523
|
* @public
|
|
1564
1524
|
*/
|
|
1565
1525
|
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
@@ -1570,45 +1530,37 @@ export interface CreateSecurityConfigRequest {
|
|
|
1570
1530
|
clientToken?: string | undefined;
|
|
1571
1531
|
}
|
|
1572
1532
|
/**
|
|
1573
|
-
* <p>Describes IAM Identity Center options for an OpenSearch Serverless security
|
|
1574
|
-
* configuration in the form of a key-value map.</p>
|
|
1533
|
+
* <p>Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.</p>
|
|
1575
1534
|
* @public
|
|
1576
1535
|
*/
|
|
1577
1536
|
export interface IamIdentityCenterConfigOptions {
|
|
1578
1537
|
/**
|
|
1579
|
-
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1580
|
-
* Serverless.</p>
|
|
1538
|
+
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>
|
|
1581
1539
|
* @public
|
|
1582
1540
|
*/
|
|
1583
1541
|
instanceArn?: string | undefined;
|
|
1584
1542
|
/**
|
|
1585
|
-
* <p>The ARN of the IAM Identity Center application used to integrate with OpenSearch
|
|
1586
|
-
* Serverless.</p>
|
|
1543
|
+
* <p>The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
|
|
1587
1544
|
* @public
|
|
1588
1545
|
*/
|
|
1589
1546
|
applicationArn?: string | undefined;
|
|
1590
1547
|
/**
|
|
1591
|
-
* <p>The name of the IAM Identity Center application used to integrate with OpenSearch
|
|
1592
|
-
* Serverless.</p>
|
|
1548
|
+
* <p>The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
|
|
1593
1549
|
* @public
|
|
1594
1550
|
*/
|
|
1595
1551
|
applicationName?: string | undefined;
|
|
1596
1552
|
/**
|
|
1597
|
-
* <p>The description of the IAM Identity Center application used to integrate with
|
|
1598
|
-
* OpenSearch Serverless.</p>
|
|
1553
|
+
* <p>The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
|
|
1599
1554
|
* @public
|
|
1600
1555
|
*/
|
|
1601
1556
|
applicationDescription?: string | undefined;
|
|
1602
1557
|
/**
|
|
1603
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1604
|
-
* <code>UserId</code>
|
|
1605
|
-
* </p>
|
|
1558
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code> </p>
|
|
1606
1559
|
* @public
|
|
1607
1560
|
*/
|
|
1608
1561
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
1609
1562
|
/**
|
|
1610
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1611
|
-
* <code>GroupId</code>.</p>
|
|
1563
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
|
|
1612
1564
|
* @public
|
|
1613
1565
|
*/
|
|
1614
1566
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
@@ -1649,9 +1601,7 @@ export interface SecurityConfigDetail {
|
|
|
1649
1601
|
*/
|
|
1650
1602
|
iamIdentityCenterOptions?: IamIdentityCenterConfigOptions | undefined;
|
|
1651
1603
|
/**
|
|
1652
|
-
* <p>Describes IAM federation options in the form of a key-value map. Contains
|
|
1653
|
-
* configuration details about how OpenSearch Serverless integrates with external identity
|
|
1654
|
-
* providers through federation.</p>
|
|
1604
|
+
* <p>Describes IAM federation options in the form of a key-value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.</p>
|
|
1655
1605
|
* @public
|
|
1656
1606
|
*/
|
|
1657
1607
|
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
@@ -1709,8 +1659,7 @@ export interface CreateSecurityPolicyRequest {
|
|
|
1709
1659
|
*/
|
|
1710
1660
|
name: string | undefined;
|
|
1711
1661
|
/**
|
|
1712
|
-
* <p>A description of the policy. Typically used to store information about the permissions
|
|
1713
|
-
* defined in the policy.</p>
|
|
1662
|
+
* <p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>
|
|
1714
1663
|
* @public
|
|
1715
1664
|
*/
|
|
1716
1665
|
description?: string | undefined;
|
|
@@ -1796,8 +1745,7 @@ export interface CreateVpcEndpointRequest {
|
|
|
1796
1745
|
*/
|
|
1797
1746
|
subnetIds: string[] | undefined;
|
|
1798
1747
|
/**
|
|
1799
|
-
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
1800
|
-
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
1748
|
+
* <p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
1801
1749
|
* @public
|
|
1802
1750
|
*/
|
|
1803
1751
|
securityGroupIds?: string[] | undefined;
|
|
@@ -1808,9 +1756,7 @@ export interface CreateVpcEndpointRequest {
|
|
|
1808
1756
|
clientToken?: string | undefined;
|
|
1809
1757
|
}
|
|
1810
1758
|
/**
|
|
1811
|
-
* <p>Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see
|
|
1812
|
-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
|
|
1813
|
-
* Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
1759
|
+
* <p>Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
1814
1760
|
* @public
|
|
1815
1761
|
*/
|
|
1816
1762
|
export interface CreateVpcEndpointDetail {
|
|
@@ -1890,9 +1836,7 @@ export interface DeleteLifecyclePolicyResponse {
|
|
|
1890
1836
|
*/
|
|
1891
1837
|
export interface DeleteSecurityConfigRequest {
|
|
1892
1838
|
/**
|
|
1893
|
-
* <p>The security configuration identifier. For SAML the ID will be
|
|
1894
|
-
* <code>saml/<accountId>/<idpProviderName></code>. For example,
|
|
1895
|
-
* <code>saml/123456789123/OKTADev</code>.</p>
|
|
1839
|
+
* <p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
|
|
1896
1840
|
* @public
|
|
1897
1841
|
*/
|
|
1898
1842
|
id: string | undefined;
|
|
@@ -2013,8 +1957,7 @@ export interface GetIndexRequest {
|
|
|
2013
1957
|
*/
|
|
2014
1958
|
export interface GetIndexResponse {
|
|
2015
1959
|
/**
|
|
2016
|
-
* <p>The JSON schema definition for the index, including field mappings and
|
|
2017
|
-
* settings.</p>
|
|
1960
|
+
* <p>The JSON schema definition for the index, including field mappings and settings.</p>
|
|
2018
1961
|
* @public
|
|
2019
1962
|
*/
|
|
2020
1963
|
indexSchema?: __DocumentType | undefined;
|
|
@@ -2087,8 +2030,7 @@ export interface GetPoliciesStatsResponse {
|
|
|
2087
2030
|
*/
|
|
2088
2031
|
LifecyclePolicyStats?: LifecyclePolicyStats | undefined;
|
|
2089
2032
|
/**
|
|
2090
|
-
* <p>The total number of OpenSearch Serverless security policies and configurations in your
|
|
2091
|
-
* account.</p>
|
|
2033
|
+
* <p>The total number of OpenSearch Serverless security policies and configurations in your account.</p>
|
|
2092
2034
|
* @public
|
|
2093
2035
|
*/
|
|
2094
2036
|
TotalPolicyCount?: number | undefined;
|
|
@@ -2153,8 +2095,7 @@ export interface UpdateIndexRequest {
|
|
|
2153
2095
|
*/
|
|
2154
2096
|
indexName: string | undefined;
|
|
2155
2097
|
/**
|
|
2156
|
-
* <p>The updated JSON schema definition for the index, including field mappings and
|
|
2157
|
-
* settings. </p>
|
|
2098
|
+
* <p>The updated JSON schema definition for the index, including field mappings and settings. </p>
|
|
2158
2099
|
* @public
|
|
2159
2100
|
*/
|
|
2160
2101
|
indexSchema?: __DocumentType | undefined;
|
|
@@ -2174,23 +2115,17 @@ export interface ListLifecyclePoliciesRequest {
|
|
|
2174
2115
|
*/
|
|
2175
2116
|
type: LifecyclePolicyType | undefined;
|
|
2176
2117
|
/**
|
|
2177
|
-
* <p>Resource filters that policies can apply to. Currently, the only supported resource
|
|
2178
|
-
* type is <code>index</code>.</p>
|
|
2118
|
+
* <p>Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.</p>
|
|
2179
2119
|
* @public
|
|
2180
2120
|
*/
|
|
2181
2121
|
resources?: string[] | undefined;
|
|
2182
2122
|
/**
|
|
2183
|
-
* <p>If your initial <code>ListLifecyclePolicies</code> operation returns a
|
|
2184
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2185
|
-
* subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the
|
|
2186
|
-
* next page.</p>
|
|
2123
|
+
* <p>If your initial <code>ListLifecyclePolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the next page.</p>
|
|
2187
2124
|
* @public
|
|
2188
2125
|
*/
|
|
2189
2126
|
nextToken?: string | undefined;
|
|
2190
2127
|
/**
|
|
2191
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2192
|
-
* use use <code>nextToken</code> to get the next page of results. The default is
|
|
2193
|
-
* 10.</p>
|
|
2128
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use use <code>nextToken</code> to get the next page of results. The default is 10.</p>
|
|
2194
2129
|
* @public
|
|
2195
2130
|
*/
|
|
2196
2131
|
maxResults?: number | undefined;
|
|
@@ -2241,9 +2176,7 @@ export interface ListLifecyclePoliciesResponse {
|
|
|
2241
2176
|
*/
|
|
2242
2177
|
lifecyclePolicySummaries?: LifecyclePolicySummary[] | undefined;
|
|
2243
2178
|
/**
|
|
2244
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2245
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2246
|
-
* again using the returned token to retrieve the next page.</p>
|
|
2179
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
2247
2180
|
* @public
|
|
2248
2181
|
*/
|
|
2249
2182
|
nextToken?: string | undefined;
|
|
@@ -2303,16 +2236,12 @@ export interface ListSecurityConfigsRequest {
|
|
|
2303
2236
|
*/
|
|
2304
2237
|
type: SecurityConfigType | undefined;
|
|
2305
2238
|
/**
|
|
2306
|
-
* <p>If your initial <code>ListSecurityConfigs</code> operation returns a
|
|
2307
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2308
|
-
* subsequent <code>ListSecurityConfigs</code> operations, which returns results in the
|
|
2309
|
-
* next page.</p>
|
|
2239
|
+
* <p>If your initial <code>ListSecurityConfigs</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityConfigs</code> operations, which returns results in the next page.</p>
|
|
2310
2240
|
* @public
|
|
2311
2241
|
*/
|
|
2312
2242
|
nextToken?: string | undefined;
|
|
2313
2243
|
/**
|
|
2314
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2315
|
-
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2244
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2316
2245
|
* @public
|
|
2317
2246
|
*/
|
|
2318
2247
|
maxResults?: number | undefined;
|
|
@@ -2363,9 +2292,7 @@ export interface ListSecurityConfigsResponse {
|
|
|
2363
2292
|
*/
|
|
2364
2293
|
securityConfigSummaries?: SecurityConfigSummary[] | undefined;
|
|
2365
2294
|
/**
|
|
2366
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2367
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2368
|
-
* again using the returned token to retrieve the next page.</p>
|
|
2295
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
2369
2296
|
* @public
|
|
2370
2297
|
*/
|
|
2371
2298
|
nextToken?: string | undefined;
|
|
@@ -2385,16 +2312,12 @@ export interface ListSecurityPoliciesRequest {
|
|
|
2385
2312
|
*/
|
|
2386
2313
|
resource?: string[] | undefined;
|
|
2387
2314
|
/**
|
|
2388
|
-
* <p>If your initial <code>ListSecurityPolicies</code> operation returns a
|
|
2389
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2390
|
-
* subsequent <code>ListSecurityPolicies</code> operations, which returns results in the
|
|
2391
|
-
* next page.</p>
|
|
2315
|
+
* <p>If your initial <code>ListSecurityPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityPolicies</code> operations, which returns results in the next page.</p>
|
|
2392
2316
|
* @public
|
|
2393
2317
|
*/
|
|
2394
2318
|
nextToken?: string | undefined;
|
|
2395
2319
|
/**
|
|
2396
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2397
|
-
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2320
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2398
2321
|
* @public
|
|
2399
2322
|
*/
|
|
2400
2323
|
maxResults?: number | undefined;
|
|
@@ -2445,9 +2368,7 @@ export interface ListSecurityPoliciesResponse {
|
|
|
2445
2368
|
*/
|
|
2446
2369
|
securityPolicySummaries?: SecurityPolicySummary[] | undefined;
|
|
2447
2370
|
/**
|
|
2448
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2449
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2450
|
-
* again using the returned token to retrieve the next page.</p>
|
|
2371
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
2451
2372
|
* @public
|
|
2452
2373
|
*/
|
|
2453
2374
|
nextToken?: string | undefined;
|
|
@@ -2457,9 +2378,7 @@ export interface ListSecurityPoliciesResponse {
|
|
|
2457
2378
|
*/
|
|
2458
2379
|
export interface ListTagsForResourceRequest {
|
|
2459
2380
|
/**
|
|
2460
|
-
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
2461
|
-
* the <code>DELETING</code> state), and must be owned by the account ID included in the
|
|
2462
|
-
* request.</p>
|
|
2381
|
+
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</p>
|
|
2463
2382
|
* @public
|
|
2464
2383
|
*/
|
|
2465
2384
|
resourceArn: string | undefined;
|
|
@@ -2490,23 +2409,17 @@ export interface VpcEndpointFilters {
|
|
|
2490
2409
|
*/
|
|
2491
2410
|
export interface ListVpcEndpointsRequest {
|
|
2492
2411
|
/**
|
|
2493
|
-
* <p>Filter the results according to the current status of the VPC endpoint. Possible
|
|
2494
|
-
* statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>,
|
|
2495
|
-
* <code>ACTIVE</code>, and <code>FAILED</code>.</p>
|
|
2412
|
+
* <p>Filter the results according to the current status of the VPC endpoint. Possible statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p>
|
|
2496
2413
|
* @public
|
|
2497
2414
|
*/
|
|
2498
2415
|
vpcEndpointFilters?: VpcEndpointFilters | undefined;
|
|
2499
2416
|
/**
|
|
2500
|
-
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a
|
|
2501
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2502
|
-
* subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next
|
|
2503
|
-
* page. </p>
|
|
2417
|
+
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page. </p>
|
|
2504
2418
|
* @public
|
|
2505
2419
|
*/
|
|
2506
2420
|
nextToken?: string | undefined;
|
|
2507
2421
|
/**
|
|
2508
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2509
|
-
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2422
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2510
2423
|
* @public
|
|
2511
2424
|
*/
|
|
2512
2425
|
maxResults?: number | undefined;
|
|
@@ -2542,28 +2455,23 @@ export interface ListVpcEndpointsResponse {
|
|
|
2542
2455
|
*/
|
|
2543
2456
|
vpcEndpointSummaries?: VpcEndpointSummary[] | undefined;
|
|
2544
2457
|
/**
|
|
2545
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2546
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2547
|
-
* again using the returned token to retrieve the next page.</p>
|
|
2458
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
2548
2459
|
* @public
|
|
2549
2460
|
*/
|
|
2550
2461
|
nextToken?: string | undefined;
|
|
2551
2462
|
}
|
|
2552
2463
|
/**
|
|
2553
|
-
* <p>Describes IAM Identity Center options for updating an OpenSearch Serverless security
|
|
2554
|
-
* configuration in the form of a key-value map.</p>
|
|
2464
|
+
* <p>Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.</p>
|
|
2555
2465
|
* @public
|
|
2556
2466
|
*/
|
|
2557
2467
|
export interface UpdateIamIdentityCenterConfigOptions {
|
|
2558
2468
|
/**
|
|
2559
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
2560
|
-
* <code>UserId</code>.</p>
|
|
2469
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>
|
|
2561
2470
|
* @public
|
|
2562
2471
|
*/
|
|
2563
2472
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
2564
2473
|
/**
|
|
2565
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
2566
|
-
* <code>GroupId</code>.</p>
|
|
2474
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
|
|
2567
2475
|
* @public
|
|
2568
2476
|
*/
|
|
2569
2477
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
@@ -2573,16 +2481,12 @@ export interface UpdateIamIdentityCenterConfigOptions {
|
|
|
2573
2481
|
*/
|
|
2574
2482
|
export interface UpdateSecurityConfigRequest {
|
|
2575
2483
|
/**
|
|
2576
|
-
* <p>The security configuration identifier. For SAML the ID will be
|
|
2577
|
-
* <code>saml/<accountId>/<idpProviderName></code>. For example,
|
|
2578
|
-
* <code>saml/123456789123/OKTADev</code>.</p>
|
|
2484
|
+
* <p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
|
|
2579
2485
|
* @public
|
|
2580
2486
|
*/
|
|
2581
2487
|
id: string | undefined;
|
|
2582
2488
|
/**
|
|
2583
|
-
* <p>The version of the security configuration to be updated. You can find the most recent
|
|
2584
|
-
* version of a security configuration using the <code>GetSecurityPolicy</code>
|
|
2585
|
-
* command.</p>
|
|
2489
|
+
* <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
|
|
2586
2490
|
* @public
|
|
2587
2491
|
*/
|
|
2588
2492
|
configVersion: string | undefined;
|
|
@@ -2602,9 +2506,7 @@ export interface UpdateSecurityConfigRequest {
|
|
|
2602
2506
|
*/
|
|
2603
2507
|
iamIdentityCenterOptionsUpdates?: UpdateIamIdentityCenterConfigOptions | undefined;
|
|
2604
2508
|
/**
|
|
2605
|
-
* <p>Describes IAM federation options in the form of a key-value map for updating an
|
|
2606
|
-
* existing security configuration. Use this field to modify IAM federation settings for
|
|
2607
|
-
* the security configuration.</p>
|
|
2509
|
+
* <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
|
|
2608
2510
|
* @public
|
|
2609
2511
|
*/
|
|
2610
2512
|
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
@@ -2644,8 +2546,7 @@ export interface UpdateSecurityPolicyRequest {
|
|
|
2644
2546
|
*/
|
|
2645
2547
|
policyVersion: string | undefined;
|
|
2646
2548
|
/**
|
|
2647
|
-
* <p>A description of the policy. Typically used to store information about the permissions
|
|
2648
|
-
* defined in the policy.</p>
|
|
2549
|
+
* <p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>
|
|
2649
2550
|
* @public
|
|
2650
2551
|
*/
|
|
2651
2552
|
description?: string | undefined;
|
|
@@ -2675,15 +2576,12 @@ export interface UpdateSecurityPolicyResponse {
|
|
|
2675
2576
|
*/
|
|
2676
2577
|
export interface TagResourceRequest {
|
|
2677
2578
|
/**
|
|
2678
|
-
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
2679
|
-
* the <code>DELETING</code> state), and must be owned by the account ID included in the
|
|
2680
|
-
* request.</p>
|
|
2579
|
+
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</p>
|
|
2681
2580
|
* @public
|
|
2682
2581
|
*/
|
|
2683
2582
|
resourceArn: string | undefined;
|
|
2684
2583
|
/**
|
|
2685
|
-
* <p>A list of tags (key-value pairs) to add to the resource. All tag keys in the request
|
|
2686
|
-
* must be unique.</p>
|
|
2584
|
+
* <p>A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.</p>
|
|
2687
2585
|
* @public
|
|
2688
2586
|
*/
|
|
2689
2587
|
tags: Tag[] | undefined;
|
|
@@ -2698,15 +2596,12 @@ export interface TagResourceResponse {
|
|
|
2698
2596
|
*/
|
|
2699
2597
|
export interface UntagResourceRequest {
|
|
2700
2598
|
/**
|
|
2701
|
-
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must
|
|
2702
|
-
* be active (not in the <code>DELETING</code> state), and must be owned by the account ID
|
|
2703
|
-
* included in the request.</p>
|
|
2599
|
+
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</p>
|
|
2704
2600
|
* @public
|
|
2705
2601
|
*/
|
|
2706
2602
|
resourceArn: string | undefined;
|
|
2707
2603
|
/**
|
|
2708
|
-
* <p>The tag or set of tags to remove from the resource. All tag keys in the request must
|
|
2709
|
-
* be unique.</p>
|
|
2604
|
+
* <p>The tag or set of tags to remove from the resource. All tag keys in the request must be unique.</p>
|
|
2710
2605
|
* @public
|
|
2711
2606
|
*/
|
|
2712
2607
|
tagKeys: string[] | undefined;
|
|
@@ -2721,10 +2616,7 @@ export interface UntagResourceResponse {
|
|
|
2721
2616
|
*/
|
|
2722
2617
|
export interface UpdateAccountSettingsRequest {
|
|
2723
2618
|
/**
|
|
2724
|
-
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
2725
|
-
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
2726
|
-
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
2727
|
-
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
2619
|
+
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
2728
2620
|
* @public
|
|
2729
2621
|
*/
|
|
2730
2622
|
capacityLimits?: CapacityLimits | undefined;
|
|
@@ -2759,9 +2651,7 @@ export interface UpdateVpcEndpointRequest {
|
|
|
2759
2651
|
*/
|
|
2760
2652
|
removeSubnetIds?: string[] | undefined;
|
|
2761
2653
|
/**
|
|
2762
|
-
* <p>The unique identifiers of the security groups to add to the endpoint. Security groups
|
|
2763
|
-
* define the ports, protocols, and sources for inbound traffic that you are authorizing
|
|
2764
|
-
* into your endpoint.</p>
|
|
2654
|
+
* <p>The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
2765
2655
|
* @public
|
|
2766
2656
|
*/
|
|
2767
2657
|
addSecurityGroupIds?: string[] | undefined;
|
|
@@ -2802,8 +2692,7 @@ export interface UpdateVpcEndpointDetail {
|
|
|
2802
2692
|
*/
|
|
2803
2693
|
subnetIds?: string[] | undefined;
|
|
2804
2694
|
/**
|
|
2805
|
-
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
2806
|
-
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
2695
|
+
* <p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
2807
2696
|
* @public
|
|
2808
2697
|
*/
|
|
2809
2698
|
securityGroupIds?: string[] | undefined;
|