@aws-sdk/client-opensearchserverless 3.855.0 → 3.856.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 -1
- package/dist-cjs/index.js +6 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +2 -0
- package/dist-types/OpenSearchServerless.d.ts +1 -1
- package/dist-types/OpenSearchServerlessClient.d.ts +1 -1
- package/dist-types/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +7 -6
- package/dist-types/commands/CreateCollectionCommand.d.ts +7 -5
- package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +7 -5
- package/dist-types/commands/CreateSecurityConfigCommand.d.ts +15 -7
- package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +8 -7
- package/dist-types/commands/CreateVpcEndpointCommand.d.ts +5 -4
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +4 -5
- package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +5 -5
- package/dist-types/commands/GetAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetSecurityConfigCommand.d.ts +4 -0
- package/dist-types/commands/GetSecurityPolicyCommand.d.ts +4 -3
- package/dist-types/commands/ListSecurityConfigsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +7 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -4
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCollectionCommand.d.ts +3 -3
- package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +5 -4
- package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +12 -5
- package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +8 -7
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +5 -5
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +136 -54
- package/dist-types/ts3.4/models/models_0.d.ts +8 -0
- package/package.json +5 -5
|
@@ -65,9 +65,9 @@ declare const UpdateLifecyclePolicyCommand_base: {
|
|
|
65
65
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ConflictException} (client fault)
|
|
68
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
69
|
-
*
|
|
70
|
-
*
|
|
68
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
69
|
+
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
70
|
+
* ACTIVE or FAILED state.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InternalServerException} (server fault)
|
|
73
73
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -76,7 +76,8 @@ declare const UpdateLifecyclePolicyCommand_base: {
|
|
|
76
76
|
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
79
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
79
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
80
|
+
* service quotas.</p>
|
|
80
81
|
*
|
|
81
82
|
* @throws {@link ValidationException} (client fault)
|
|
82
83
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -27,8 +27,7 @@ declare const UpdateSecurityConfigCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates a security configuration for OpenSearch Serverless. For more information, see
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
|
|
30
|
+
* <p>Updates a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
|
|
32
31
|
* authentication for Amazon OpenSearch Serverless</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -51,6 +50,10 @@ declare const UpdateSecurityConfigCommand_base: {
|
|
|
51
50
|
* userAttribute: "STRING_VALUE",
|
|
52
51
|
* groupAttribute: "STRING_VALUE",
|
|
53
52
|
* },
|
|
53
|
+
* iamFederationOptions: { // IamFederationConfigOptions
|
|
54
|
+
* groupAttribute: "STRING_VALUE",
|
|
55
|
+
* userAttribute: "STRING_VALUE",
|
|
56
|
+
* },
|
|
54
57
|
* clientToken: "STRING_VALUE",
|
|
55
58
|
* };
|
|
56
59
|
* const command = new UpdateSecurityConfigCommand(input);
|
|
@@ -76,6 +79,10 @@ declare const UpdateSecurityConfigCommand_base: {
|
|
|
76
79
|
* // userAttribute: "STRING_VALUE",
|
|
77
80
|
* // groupAttribute: "STRING_VALUE",
|
|
78
81
|
* // },
|
|
82
|
+
* // iamFederationOptions: { // IamFederationConfigOptions
|
|
83
|
+
* // groupAttribute: "STRING_VALUE",
|
|
84
|
+
* // userAttribute: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
79
86
|
* // createdDate: Number("long"),
|
|
80
87
|
* // lastModifiedDate: Number("long"),
|
|
81
88
|
* // },
|
|
@@ -90,9 +97,9 @@ declare const UpdateSecurityConfigCommand_base: {
|
|
|
90
97
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
91
98
|
*
|
|
92
99
|
* @throws {@link ConflictException} (client fault)
|
|
93
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
94
|
-
*
|
|
95
|
-
*
|
|
100
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
101
|
+
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
102
|
+
* ACTIVE or FAILED state.</p>
|
|
96
103
|
*
|
|
97
104
|
* @throws {@link InternalServerException} (server fault)
|
|
98
105
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -27,9 +27,9 @@ declare const UpdateSecurityPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network
|
|
31
|
-
*
|
|
32
|
-
* rest for Amazon OpenSearch Serverless</a>.</p>
|
|
30
|
+
* <p>Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network
|
|
31
|
+
* access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption
|
|
32
|
+
* at rest for Amazon OpenSearch Serverless</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -67,9 +67,9 @@ declare const UpdateSecurityPolicyCommand_base: {
|
|
|
67
67
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ConflictException} (client fault)
|
|
70
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
71
|
-
*
|
|
72
|
-
*
|
|
70
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
71
|
+
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
72
|
+
* ACTIVE or FAILED state.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link InternalServerException} (server fault)
|
|
75
75
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -78,7 +78,8 @@ declare const UpdateSecurityPolicyCommand_base: {
|
|
|
78
78
|
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
81
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
81
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
82
|
+
* service quotas.</p>
|
|
82
83
|
*
|
|
83
84
|
* @throws {@link ValidationException} (client fault)
|
|
84
85
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -27,8 +27,8 @@ declare const UpdateVpcEndpointCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an OpenSearch Serverless-managed interface endpoint. For more information, see
|
|
31
|
-
*
|
|
30
|
+
* <p>Updates 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
|
|
31
|
+
* Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -77,9 +77,9 @@ declare const UpdateVpcEndpointCommand_base: {
|
|
|
77
77
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link ConflictException} (client fault)
|
|
80
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
81
|
-
*
|
|
82
|
-
*
|
|
80
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
81
|
+
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
82
|
+
* ACTIVE or FAILED state.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link InternalServerException} (server fault)
|
|
85
85
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* configuring, and tuning your OpenSearch clusters. It enables you to easily search and
|
|
7
7
|
* analyze petabytes of data without having to worry about the underlying infrastructure
|
|
8
8
|
* and data management.</p>
|
|
9
|
-
* <p>
|
|
9
|
+
* <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
|
|
10
10
|
* Amazon OpenSearch Serverless?</a>
|
|
11
11
|
* </p>
|
|
12
12
|
*
|
|
@@ -16,9 +16,9 @@ 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
|
|
20
|
-
*
|
|
21
|
-
*
|
|
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>
|
|
22
22
|
* @public
|
|
23
23
|
*/
|
|
24
24
|
export declare class ConflictException extends __BaseException {
|
|
@@ -124,7 +124,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
124
124
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
127
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
128
|
+
* service quotas.</p>
|
|
128
129
|
* @public
|
|
129
130
|
*/
|
|
130
131
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -248,7 +249,7 @@ export interface ListAccessPoliciesRequest {
|
|
|
248
249
|
* <p>If your initial <code>ListAccessPolicies</code> operation returns a
|
|
249
250
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
250
251
|
* subsequent <code>ListAccessPolicies</code> operations, which returns results in the next
|
|
251
|
-
* page
|
|
252
|
+
* page.</p>
|
|
252
253
|
* @public
|
|
253
254
|
*/
|
|
254
255
|
nextToken?: string | undefined;
|
|
@@ -265,7 +266,8 @@ export interface ListAccessPoliciesRequest {
|
|
|
265
266
|
*/
|
|
266
267
|
export interface AccessPolicySummary {
|
|
267
268
|
/**
|
|
268
|
-
* <p>The type of access policy. Currently, the only available type is
|
|
269
|
+
* <p>The type of access policy. Currently, the only available type is
|
|
270
|
+
* <code>data</code>.</p>
|
|
269
271
|
* @public
|
|
270
272
|
*/
|
|
271
273
|
type?: AccessPolicyType | undefined;
|
|
@@ -413,7 +415,8 @@ export interface BatchGetCollectionRequest {
|
|
|
413
415
|
*/
|
|
414
416
|
ids?: string[] | undefined;
|
|
415
417
|
/**
|
|
416
|
-
* <p>A list of collection names. You can't provide names and IDs in the same
|
|
418
|
+
* <p>A list of collection names. You can't provide names and IDs in the same
|
|
419
|
+
* request.</p>
|
|
417
420
|
* @public
|
|
418
421
|
*/
|
|
419
422
|
names?: string[] | undefined;
|
|
@@ -682,18 +685,21 @@ export interface EffectiveLifecyclePolicyDetail {
|
|
|
682
685
|
*/
|
|
683
686
|
policyName?: string | undefined;
|
|
684
687
|
/**
|
|
685
|
-
* <p>The type of OpenSearch Serverless resource. Currently, the only supported resource is
|
|
688
|
+
* <p>The type of OpenSearch Serverless resource. Currently, the only supported resource is
|
|
689
|
+
* <code>index</code>.</p>
|
|
686
690
|
* @public
|
|
687
691
|
*/
|
|
688
692
|
resourceType?: ResourceType | undefined;
|
|
689
693
|
/**
|
|
690
|
-
* <p>The minimum number of index retention in days or hours. This is an optional parameter
|
|
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>
|
|
691
696
|
* @public
|
|
692
697
|
*/
|
|
693
698
|
retentionPeriod?: string | undefined;
|
|
694
699
|
/**
|
|
695
|
-
* <p>The minimum number of index retention days set. That is an optional param that will
|
|
696
|
-
* hours is not set to a index
|
|
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>
|
|
697
703
|
* @public
|
|
698
704
|
*/
|
|
699
705
|
noMinRetentionPeriod?: boolean | undefined;
|
|
@@ -714,7 +720,8 @@ export interface EffectiveLifecyclePolicyErrorDetail {
|
|
|
714
720
|
*/
|
|
715
721
|
resource?: string | undefined;
|
|
716
722
|
/**
|
|
717
|
-
* <p>A description of the error. For example, <code>The specified Index resource is not
|
|
723
|
+
* <p>A description of the error. For example, <code>The specified Index resource is not
|
|
724
|
+
* found</code>.</p>
|
|
718
725
|
* @public
|
|
719
726
|
*/
|
|
720
727
|
errorMessage?: string | undefined;
|
|
@@ -822,7 +829,8 @@ export interface LifecyclePolicyErrorDetail {
|
|
|
822
829
|
*/
|
|
823
830
|
name?: string | undefined;
|
|
824
831
|
/**
|
|
825
|
-
* <p>A description of the error. For example, <code>The specified Lifecycle Policy is not
|
|
832
|
+
* <p>A description of the error. For example, <code>The specified Lifecycle Policy is not
|
|
833
|
+
* found</code>.</p>
|
|
826
834
|
* @public
|
|
827
835
|
*/
|
|
828
836
|
errorMessage?: string | undefined;
|
|
@@ -1007,7 +1015,8 @@ export interface CreateCollectionRequest {
|
|
|
1007
1015
|
*/
|
|
1008
1016
|
description?: string | undefined;
|
|
1009
1017
|
/**
|
|
1010
|
-
* <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless
|
|
1018
|
+
* <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless
|
|
1019
|
+
* collection.</p>
|
|
1011
1020
|
* @public
|
|
1012
1021
|
*/
|
|
1013
1022
|
tags?: Tag[] | undefined;
|
|
@@ -1058,7 +1067,8 @@ export interface CreateCollectionDetail {
|
|
|
1058
1067
|
*/
|
|
1059
1068
|
arn?: string | undefined;
|
|
1060
1069
|
/**
|
|
1061
|
-
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the
|
|
1070
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the
|
|
1071
|
+
* collection.</p>
|
|
1062
1072
|
* @public
|
|
1063
1073
|
*/
|
|
1064
1074
|
kmsKeyArn?: string | undefined;
|
|
@@ -1089,7 +1099,8 @@ export interface CreateCollectionResponse {
|
|
|
1089
1099
|
createCollectionDetail?: CreateCollectionDetail | undefined;
|
|
1090
1100
|
}
|
|
1091
1101
|
/**
|
|
1092
|
-
* <p>Thrown when the collection you're attempting to create results in a number of search
|
|
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>
|
|
1093
1104
|
* @public
|
|
1094
1105
|
*/
|
|
1095
1106
|
export declare class OcuLimitExceededException extends __BaseException {
|
|
@@ -1169,14 +1180,15 @@ export interface CollectionFilters {
|
|
|
1169
1180
|
*/
|
|
1170
1181
|
export interface ListCollectionsRequest {
|
|
1171
1182
|
/**
|
|
1172
|
-
* <p>
|
|
1183
|
+
* <p>A list of filter names and values that you can use for requests.</p>
|
|
1173
1184
|
* @public
|
|
1174
1185
|
*/
|
|
1175
1186
|
collectionFilters?: CollectionFilters | undefined;
|
|
1176
1187
|
/**
|
|
1177
|
-
* <p>If your initial <code>ListCollections</code> operation returns a
|
|
1178
|
-
*
|
|
1179
|
-
* which returns results in the next
|
|
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>
|
|
1180
1192
|
* @public
|
|
1181
1193
|
*/
|
|
1182
1194
|
nextToken?: string | undefined;
|
|
@@ -1223,9 +1235,9 @@ export interface ListCollectionsResponse {
|
|
|
1223
1235
|
*/
|
|
1224
1236
|
collectionSummaries?: CollectionSummary[] | undefined;
|
|
1225
1237
|
/**
|
|
1226
|
-
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
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>
|
|
1229
1241
|
* @public
|
|
1230
1242
|
*/
|
|
1231
1243
|
nextToken?: string | undefined;
|
|
@@ -1347,22 +1359,26 @@ export declare const IamIdentityCenterUserAttribute: {
|
|
|
1347
1359
|
*/
|
|
1348
1360
|
export type IamIdentityCenterUserAttribute = (typeof IamIdentityCenterUserAttribute)[keyof typeof IamIdentityCenterUserAttribute];
|
|
1349
1361
|
/**
|
|
1350
|
-
* <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security
|
|
1362
|
+
* <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security
|
|
1363
|
+
* configuration in the form of a key-value map.</p>
|
|
1351
1364
|
* @public
|
|
1352
1365
|
*/
|
|
1353
1366
|
export interface CreateIamIdentityCenterConfigOptions {
|
|
1354
1367
|
/**
|
|
1355
|
-
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1368
|
+
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1369
|
+
* Serverless.</p>
|
|
1356
1370
|
* @public
|
|
1357
1371
|
*/
|
|
1358
1372
|
instanceArn: string | undefined;
|
|
1359
1373
|
/**
|
|
1360
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1374
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1375
|
+
* <code>UserId</code>.</p>
|
|
1361
1376
|
* @public
|
|
1362
1377
|
*/
|
|
1363
1378
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
1364
1379
|
/**
|
|
1365
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1380
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1381
|
+
* <code>GroupId</code>.</p>
|
|
1366
1382
|
* @public
|
|
1367
1383
|
*/
|
|
1368
1384
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
@@ -1407,6 +1423,26 @@ export interface CreateLifecyclePolicyResponse {
|
|
|
1407
1423
|
*/
|
|
1408
1424
|
lifecyclePolicyDetail?: LifecyclePolicyDetail | undefined;
|
|
1409
1425
|
}
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>Describes IAM federation options for an OpenSearch Serverless security configuration
|
|
1428
|
+
* in the form of a key-value map. These options define how OpenSearch Serverless
|
|
1429
|
+
* integrates with external identity providers using federation.</p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
export interface IamFederationConfigOptions {
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>The group attribute for this IAM federation integration. This attribute is used to map
|
|
1435
|
+
* identity provider groups to OpenSearch Serverless permissions.</p>
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
groupAttribute?: string | undefined;
|
|
1439
|
+
/**
|
|
1440
|
+
* <p>The user attribute for this IAM federation integration. This attribute is used to
|
|
1441
|
+
* identify users in the federated authentication process.</p>
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
userAttribute?: string | undefined;
|
|
1445
|
+
}
|
|
1410
1446
|
/**
|
|
1411
1447
|
* <p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value
|
|
1412
1448
|
* map.</p>
|
|
@@ -1429,7 +1465,8 @@ export interface SamlConfigOptions {
|
|
|
1429
1465
|
*/
|
|
1430
1466
|
groupAttribute?: string | undefined;
|
|
1431
1467
|
/**
|
|
1432
|
-
* <p>Custom entity
|
|
1468
|
+
* <p>Custom entity ID attribute to override the default entity ID for this SAML
|
|
1469
|
+
* integration.</p>
|
|
1433
1470
|
* @public
|
|
1434
1471
|
*/
|
|
1435
1472
|
openSearchServerlessEntityId?: string | undefined;
|
|
@@ -1444,6 +1481,10 @@ export interface SamlConfigOptions {
|
|
|
1444
1481
|
* @enum
|
|
1445
1482
|
*/
|
|
1446
1483
|
export declare const SecurityConfigType: {
|
|
1484
|
+
/**
|
|
1485
|
+
* iam federation
|
|
1486
|
+
*/
|
|
1487
|
+
readonly iamfederation: "iamfederation";
|
|
1447
1488
|
/**
|
|
1448
1489
|
* iam identity center
|
|
1449
1490
|
*/
|
|
@@ -1478,15 +1519,23 @@ export interface CreateSecurityConfigRequest {
|
|
|
1478
1519
|
description?: string | undefined;
|
|
1479
1520
|
/**
|
|
1480
1521
|
* <p>Describes SAML options in in the form of a key-value map. This field is required if
|
|
1481
|
-
* you specify <code>
|
|
1522
|
+
* you specify <code>SAML</code> for the <code>type</code> parameter.</p>
|
|
1482
1523
|
* @public
|
|
1483
1524
|
*/
|
|
1484
1525
|
samlOptions?: SamlConfigOptions | undefined;
|
|
1485
1526
|
/**
|
|
1486
|
-
* <p>Describes IAM Identity Center options in the form of a key-value map. This field is
|
|
1527
|
+
* <p>Describes IAM Identity Center options in the form of a key-value map. This field is
|
|
1528
|
+
* required if you specify iamidentitycenter for the type parameter.</p>
|
|
1487
1529
|
* @public
|
|
1488
1530
|
*/
|
|
1489
1531
|
iamIdentityCenterOptions?: CreateIamIdentityCenterConfigOptions | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>Describes IAM federation options in the form of a key-value map. This field is
|
|
1534
|
+
* required if you specify <code>iamFederation</code> for the <code>type</code>
|
|
1535
|
+
* parameter.</p>
|
|
1536
|
+
* @public
|
|
1537
|
+
*/
|
|
1538
|
+
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
1490
1539
|
/**
|
|
1491
1540
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1492
1541
|
* @public
|
|
@@ -1494,44 +1543,51 @@ export interface CreateSecurityConfigRequest {
|
|
|
1494
1543
|
clientToken?: string | undefined;
|
|
1495
1544
|
}
|
|
1496
1545
|
/**
|
|
1497
|
-
* <p>Describes IAM Identity Center options for an OpenSearch Serverless security
|
|
1546
|
+
* <p>Describes IAM Identity Center options for an OpenSearch Serverless security
|
|
1547
|
+
* configuration in the form of a key-value map.</p>
|
|
1498
1548
|
* @public
|
|
1499
1549
|
*/
|
|
1500
1550
|
export interface IamIdentityCenterConfigOptions {
|
|
1501
1551
|
/**
|
|
1502
|
-
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1552
|
+
* <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch
|
|
1553
|
+
* Serverless.</p>
|
|
1503
1554
|
* @public
|
|
1504
1555
|
*/
|
|
1505
1556
|
instanceArn?: string | undefined;
|
|
1506
1557
|
/**
|
|
1507
|
-
* <p>The ARN of the IAM Identity Center application used to integrate with OpenSearch
|
|
1558
|
+
* <p>The ARN of the IAM Identity Center application used to integrate with OpenSearch
|
|
1559
|
+
* Serverless.</p>
|
|
1508
1560
|
* @public
|
|
1509
1561
|
*/
|
|
1510
1562
|
applicationArn?: string | undefined;
|
|
1511
1563
|
/**
|
|
1512
|
-
* <p>The name of the IAM Identity Center application used to integrate with OpenSearch
|
|
1564
|
+
* <p>The name of the IAM Identity Center application used to integrate with OpenSearch
|
|
1565
|
+
* Serverless.</p>
|
|
1513
1566
|
* @public
|
|
1514
1567
|
*/
|
|
1515
1568
|
applicationName?: string | undefined;
|
|
1516
1569
|
/**
|
|
1517
|
-
* <p>The description of the IAM Identity Center application used to integrate with
|
|
1570
|
+
* <p>The description of the IAM Identity Center application used to integrate with
|
|
1571
|
+
* OpenSearch Serverless.</p>
|
|
1518
1572
|
* @public
|
|
1519
1573
|
*/
|
|
1520
1574
|
applicationDescription?: string | undefined;
|
|
1521
1575
|
/**
|
|
1522
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1576
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
1577
|
+
* <code>UserId</code>
|
|
1523
1578
|
* </p>
|
|
1524
1579
|
* @public
|
|
1525
1580
|
*/
|
|
1526
1581
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
1527
1582
|
/**
|
|
1528
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1583
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
1584
|
+
* <code>GroupId</code>.</p>
|
|
1529
1585
|
* @public
|
|
1530
1586
|
*/
|
|
1531
1587
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
1532
1588
|
}
|
|
1533
1589
|
/**
|
|
1534
|
-
* <p>Details about a security configuration for OpenSearch Serverless
|
|
1590
|
+
* <p>Details about a security configuration for OpenSearch Serverless.</p>
|
|
1535
1591
|
* @public
|
|
1536
1592
|
*/
|
|
1537
1593
|
export interface SecurityConfigDetail {
|
|
@@ -1565,6 +1621,13 @@ export interface SecurityConfigDetail {
|
|
|
1565
1621
|
* @public
|
|
1566
1622
|
*/
|
|
1567
1623
|
iamIdentityCenterOptions?: IamIdentityCenterConfigOptions | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>Describes IAM federation options in the form of a key-value map. Contains
|
|
1626
|
+
* configuration details about how OpenSearch Serverless integrates with external identity
|
|
1627
|
+
* providers through federation.</p>
|
|
1628
|
+
* @public
|
|
1629
|
+
*/
|
|
1630
|
+
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
1568
1631
|
/**
|
|
1569
1632
|
* <p>The date the configuration was created.</p>
|
|
1570
1633
|
* @public
|
|
@@ -1581,7 +1644,7 @@ export interface SecurityConfigDetail {
|
|
|
1581
1644
|
*/
|
|
1582
1645
|
export interface CreateSecurityConfigResponse {
|
|
1583
1646
|
/**
|
|
1584
|
-
* <p>Details about the created security configuration
|
|
1647
|
+
* <p>Details about the created security configuration.</p>
|
|
1585
1648
|
* @public
|
|
1586
1649
|
*/
|
|
1587
1650
|
securityConfigDetail?: SecurityConfigDetail | undefined;
|
|
@@ -1719,7 +1782,8 @@ export interface CreateVpcEndpointRequest {
|
|
|
1719
1782
|
}
|
|
1720
1783
|
/**
|
|
1721
1784
|
* <p>Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see
|
|
1722
|
-
*
|
|
1785
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
|
|
1786
|
+
* Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
1723
1787
|
* @public
|
|
1724
1788
|
*/
|
|
1725
1789
|
export interface CreateVpcEndpointDetail {
|
|
@@ -2011,17 +2075,23 @@ export interface ListLifecyclePoliciesRequest {
|
|
|
2011
2075
|
*/
|
|
2012
2076
|
type: LifecyclePolicyType | undefined;
|
|
2013
2077
|
/**
|
|
2014
|
-
* <p>Resource filters that policies can apply to. Currently, the only supported resource
|
|
2078
|
+
* <p>Resource filters that policies can apply to. Currently, the only supported resource
|
|
2079
|
+
* type is <code>index</code>.</p>
|
|
2015
2080
|
* @public
|
|
2016
2081
|
*/
|
|
2017
2082
|
resources?: string[] | undefined;
|
|
2018
2083
|
/**
|
|
2019
|
-
* <p>If your initial <code>ListLifecyclePolicies</code> operation returns a
|
|
2084
|
+
* <p>If your initial <code>ListLifecyclePolicies</code> operation returns a
|
|
2085
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2086
|
+
* subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the
|
|
2087
|
+
* next page.</p>
|
|
2020
2088
|
* @public
|
|
2021
2089
|
*/
|
|
2022
2090
|
nextToken?: string | undefined;
|
|
2023
2091
|
/**
|
|
2024
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2092
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2093
|
+
* use use <code>nextToken</code> to get the next page of results. The default is
|
|
2094
|
+
* 10.</p>
|
|
2025
2095
|
* @public
|
|
2026
2096
|
*/
|
|
2027
2097
|
maxResults?: number | undefined;
|
|
@@ -2072,7 +2142,9 @@ export interface ListLifecyclePoliciesResponse {
|
|
|
2072
2142
|
*/
|
|
2073
2143
|
lifecyclePolicySummaries?: LifecyclePolicySummary[] | undefined;
|
|
2074
2144
|
/**
|
|
2075
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2145
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2146
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2147
|
+
* again using the returned token to retrieve the next page.</p>
|
|
2076
2148
|
* @public
|
|
2077
2149
|
*/
|
|
2078
2150
|
nextToken?: string | undefined;
|
|
@@ -2082,7 +2154,7 @@ export interface ListLifecyclePoliciesResponse {
|
|
|
2082
2154
|
*/
|
|
2083
2155
|
export interface UpdateLifecyclePolicyRequest {
|
|
2084
2156
|
/**
|
|
2085
|
-
* <p>
|
|
2157
|
+
* <p>The type of lifecycle policy.</p>
|
|
2086
2158
|
* @public
|
|
2087
2159
|
*/
|
|
2088
2160
|
type: LifecyclePolicyType | undefined;
|
|
@@ -2135,7 +2207,7 @@ export interface ListSecurityConfigsRequest {
|
|
|
2135
2207
|
* <p>If your initial <code>ListSecurityConfigs</code> operation returns a
|
|
2136
2208
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2137
2209
|
* subsequent <code>ListSecurityConfigs</code> operations, which returns results in the
|
|
2138
|
-
* next page
|
|
2210
|
+
* next page.</p>
|
|
2139
2211
|
* @public
|
|
2140
2212
|
*/
|
|
2141
2213
|
nextToken?: string | undefined;
|
|
@@ -2209,7 +2281,7 @@ export interface ListSecurityPoliciesRequest {
|
|
|
2209
2281
|
*/
|
|
2210
2282
|
type: SecurityPolicyType | undefined;
|
|
2211
2283
|
/**
|
|
2212
|
-
* <p>Resource filters (can be collection or indexes) that policies can apply to
|
|
2284
|
+
* <p>Resource filters (can be collection or indexes) that policies can apply to.</p>
|
|
2213
2285
|
* @public
|
|
2214
2286
|
*/
|
|
2215
2287
|
resource?: string[] | undefined;
|
|
@@ -2217,7 +2289,7 @@ export interface ListSecurityPoliciesRequest {
|
|
|
2217
2289
|
* <p>If your initial <code>ListSecurityPolicies</code> operation returns a
|
|
2218
2290
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2219
2291
|
* subsequent <code>ListSecurityPolicies</code> operations, which returns results in the
|
|
2220
|
-
* next page
|
|
2292
|
+
* next page.</p>
|
|
2221
2293
|
* @public
|
|
2222
2294
|
*/
|
|
2223
2295
|
nextToken?: string | undefined;
|
|
@@ -2329,7 +2401,7 @@ export interface ListVpcEndpointsRequest {
|
|
|
2329
2401
|
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a
|
|
2330
2402
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2331
2403
|
* subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next
|
|
2332
|
-
* page
|
|
2404
|
+
* page.</p>
|
|
2333
2405
|
* @public
|
|
2334
2406
|
*/
|
|
2335
2407
|
nextToken?: string | undefined;
|
|
@@ -2379,17 +2451,20 @@ export interface ListVpcEndpointsResponse {
|
|
|
2379
2451
|
nextToken?: string | undefined;
|
|
2380
2452
|
}
|
|
2381
2453
|
/**
|
|
2382
|
-
* <p>Describes IAM Identity Center options for updating an OpenSearch Serverless security
|
|
2454
|
+
* <p>Describes IAM Identity Center options for updating an OpenSearch Serverless security
|
|
2455
|
+
* configuration in the form of a key-value map.</p>
|
|
2383
2456
|
* @public
|
|
2384
2457
|
*/
|
|
2385
2458
|
export interface UpdateIamIdentityCenterConfigOptions {
|
|
2386
2459
|
/**
|
|
2387
|
-
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
2460
|
+
* <p>The user attribute for this IAM Identity Center integration. Defaults to
|
|
2461
|
+
* <code>UserId</code>.</p>
|
|
2388
2462
|
* @public
|
|
2389
2463
|
*/
|
|
2390
2464
|
userAttribute?: IamIdentityCenterUserAttribute | undefined;
|
|
2391
2465
|
/**
|
|
2392
|
-
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
2466
|
+
* <p>The group attribute for this IAM Identity Center integration. Defaults to
|
|
2467
|
+
* <code>GroupId</code>.</p>
|
|
2393
2468
|
* @public
|
|
2394
2469
|
*/
|
|
2395
2470
|
groupAttribute?: IamIdentityCenterGroupAttribute | undefined;
|
|
@@ -2427,6 +2502,13 @@ export interface UpdateSecurityConfigRequest {
|
|
|
2427
2502
|
* @public
|
|
2428
2503
|
*/
|
|
2429
2504
|
iamIdentityCenterOptionsUpdates?: UpdateIamIdentityCenterConfigOptions | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* <p>Describes IAM federation options in the form of a key-value map for updating an
|
|
2507
|
+
* existing security configuration. Use this field to modify IAM federation settings for
|
|
2508
|
+
* the security configuration.</p>
|
|
2509
|
+
* @public
|
|
2510
|
+
*/
|
|
2511
|
+
iamFederationOptions?: IamFederationConfigOptions | undefined;
|
|
2430
2512
|
/**
|
|
2431
2513
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
2432
2514
|
* @public
|
|
@@ -2438,7 +2520,7 @@ export interface UpdateSecurityConfigRequest {
|
|
|
2438
2520
|
*/
|
|
2439
2521
|
export interface UpdateSecurityConfigResponse {
|
|
2440
2522
|
/**
|
|
2441
|
-
* <p>Details about the updated security configuration
|
|
2523
|
+
* <p>Details about the updated security configuration.</p>
|
|
2442
2524
|
* @public
|
|
2443
2525
|
*/
|
|
2444
2526
|
securityConfigDetail?: SecurityConfigDetail | undefined;
|
|
@@ -2553,7 +2635,7 @@ export interface UpdateAccountSettingsRequest {
|
|
|
2553
2635
|
*/
|
|
2554
2636
|
export interface UpdateAccountSettingsResponse {
|
|
2555
2637
|
/**
|
|
2556
|
-
* <p>OpenSearch Serverless-related settings for the current Amazon Web Services account
|
|
2638
|
+
* <p>OpenSearch Serverless-related settings for the current Amazon Web Services account.</p>
|
|
2557
2639
|
* @public
|
|
2558
2640
|
*/
|
|
2559
2641
|
accountSettingsDetail?: AccountSettingsDetail | undefined;
|