@aws-sdk/client-opensearchserverless 3.529.1 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/OpenSearchServerless.d.ts +7 -1
- package/dist-types/OpenSearchServerlessClient.d.ts +1 -1
- package/dist-types/commands/BatchGetCollectionCommand.d.ts +2 -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 -1
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +2 -1
- package/dist-types/commands/CreateCollectionCommand.d.ts +2 -1
- package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/CreateSecurityConfigCommand.d.ts +2 -1
- package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/CreateVpcEndpointCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCollectionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +2 -1
- package/dist-types/commands/GetAccessPolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/GetPoliciesStatsCommand.d.ts +2 -1
- package/dist-types/commands/GetSecurityConfigCommand.d.ts +2 -1
- package/dist-types/commands/GetSecurityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/ListCollectionsCommand.d.ts +2 -1
- package/dist-types/commands/ListLifecyclePoliciesCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityConfigsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCollectionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +358 -358
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/OpenSearchServerless.d.ts +6 -0
- package/dist-types/ts3.4/commands/BatchGetCollectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetLifecyclePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetVpcEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAccessPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCollectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateLifecyclePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSecurityConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSecurityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateVpcEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAccessPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCollectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteLifecyclePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSecurityConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSecurityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteVpcEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccessPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccountSettingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPoliciesStatsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSecurityConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSecurityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCollectionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListLifecyclePoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityConfigsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVpcEndpointsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAccessPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCollectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateLifecyclePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecurityConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecurityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateVpcEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -16,10 +16,10 @@ export declare const AccessPolicyType: {
|
|
|
16
16
|
*/
|
|
17
17
|
export type AccessPolicyType = (typeof AccessPolicyType)[keyof typeof AccessPolicyType];
|
|
18
18
|
/**
|
|
19
|
-
* @public
|
|
20
19
|
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
21
20
|
* or is being created. When deleting a resource, thrown when the resource is not in
|
|
22
21
|
* the ACTIVE or FAILED state.</p>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
export declare class ConflictException extends __BaseException {
|
|
25
25
|
readonly name: "ConflictException";
|
|
@@ -34,70 +34,70 @@ export declare class ConflictException extends __BaseException {
|
|
|
34
34
|
*/
|
|
35
35
|
export interface CreateAccessPolicyRequest {
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The type of policy.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
type: AccessPolicyType | undefined;
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>The name of the policy.</p>
|
|
43
|
+
* @public
|
|
44
44
|
*/
|
|
45
45
|
name: string | undefined;
|
|
46
46
|
/**
|
|
47
|
-
* @public
|
|
48
47
|
* <p>A description of the policy. Typically used to store information about the permissions
|
|
49
48
|
* defined in the policy.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
description?: string;
|
|
52
52
|
/**
|
|
53
|
-
* @public
|
|
54
53
|
* <p>The JSON policy document to use as the content for the policy.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
policy: string | undefined;
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
clientToken?: string;
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>Details about an OpenSearch Serverless access policy.</p>
|
|
65
|
+
* @public
|
|
66
66
|
*/
|
|
67
67
|
export interface AccessPolicyDetail {
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>The type of access policy.</p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
type?: AccessPolicyType;
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>The name of the policy.</p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
name?: string;
|
|
78
78
|
/**
|
|
79
|
-
* @public
|
|
80
79
|
* <p>The version of the policy.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
policyVersion?: string;
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>The description of the policy.</p>
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
description?: string;
|
|
88
88
|
/**
|
|
89
|
-
* @public
|
|
90
89
|
* <p>The JSON policy document without any whitespaces.</p>
|
|
90
|
+
* @public
|
|
91
91
|
*/
|
|
92
92
|
policy?: __DocumentType;
|
|
93
93
|
/**
|
|
94
|
-
* @public
|
|
95
94
|
* <p>The date the policy was created.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
createdDate?: number;
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The timestamp of when the policy was last modified.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
lastModifiedDate?: number;
|
|
103
103
|
}
|
|
@@ -106,14 +106,14 @@ export interface AccessPolicyDetail {
|
|
|
106
106
|
*/
|
|
107
107
|
export interface CreateAccessPolicyResponse {
|
|
108
108
|
/**
|
|
109
|
-
* @public
|
|
110
109
|
* <p>Details about the created access policy.</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export declare class InternalServerException extends __BaseException {
|
|
119
119
|
readonly name: "InternalServerException";
|
|
@@ -124,30 +124,30 @@ export declare class InternalServerException extends __BaseException {
|
|
|
124
124
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
131
131
|
readonly name: "ServiceQuotaExceededException";
|
|
132
132
|
readonly $fault: "client";
|
|
133
133
|
/**
|
|
134
|
-
* @public
|
|
135
134
|
* Identifier of the resource affected.
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
resourceId?: string;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* Type of the resource affected.
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
resourceType?: string;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* Service Quotas requirement to identify originating service.
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
serviceCode: string | undefined;
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* Service Quotas requirement to identify originating quota.
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
quotaCode?: string;
|
|
153
153
|
/**
|
|
@@ -156,9 +156,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
156
156
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
161
160
|
* input.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
export declare class ValidationException extends __BaseException {
|
|
164
164
|
readonly name: "ValidationException";
|
|
@@ -173,18 +173,18 @@ export declare class ValidationException extends __BaseException {
|
|
|
173
173
|
*/
|
|
174
174
|
export interface DeleteAccessPolicyRequest {
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>The type of policy.</p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
type: AccessPolicyType | undefined;
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>The name of the policy to delete.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
name: string | undefined;
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
clientToken?: string;
|
|
190
190
|
}
|
|
@@ -194,8 +194,8 @@ export interface DeleteAccessPolicyRequest {
|
|
|
194
194
|
export interface DeleteAccessPolicyResponse {
|
|
195
195
|
}
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
201
201
|
readonly name: "ResourceNotFoundException";
|
|
@@ -210,13 +210,13 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
210
210
|
*/
|
|
211
211
|
export interface GetAccessPolicyRequest {
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>Tye type of policy. Currently, the only supported value is <code>data</code>.</p>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
type: AccessPolicyType | undefined;
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>The name of the access policy.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
name: string | undefined;
|
|
222
222
|
}
|
|
@@ -225,8 +225,8 @@ export interface GetAccessPolicyRequest {
|
|
|
225
225
|
*/
|
|
226
226
|
export interface GetAccessPolicyResponse {
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>Details about the requested access policy.</p>
|
|
229
|
+
* @public
|
|
230
230
|
*/
|
|
231
231
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
232
232
|
}
|
|
@@ -235,63 +235,63 @@ export interface GetAccessPolicyResponse {
|
|
|
235
235
|
*/
|
|
236
236
|
export interface ListAccessPoliciesRequest {
|
|
237
237
|
/**
|
|
238
|
-
* @public
|
|
239
238
|
* <p>The type of access policy.</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
type: AccessPolicyType | undefined;
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>Resource filters (can be collections or indexes) that policies can apply to.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
resource?: string[];
|
|
247
247
|
/**
|
|
248
|
-
* @public
|
|
249
248
|
* <p>If your initial <code>ListAccessPolicies</code> operation returns a
|
|
250
249
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
251
250
|
* subsequent <code>ListAccessPolicies</code> operations, which returns results in the next
|
|
252
251
|
* page. </p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
nextToken?: string;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
258
257
|
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
maxResults?: number;
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
|
-
* @public
|
|
264
263
|
* <p>A summary of the data access policy.</p>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
export interface AccessPolicySummary {
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>The type of access policy. Currently, the only available type is <code>data</code>.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
type?: AccessPolicyType;
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The name of the access policy.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
name?: string;
|
|
277
277
|
/**
|
|
278
|
-
* @public
|
|
279
278
|
* <p>The version of the policy.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
policyVersion?: string;
|
|
282
282
|
/**
|
|
283
|
-
* @public
|
|
284
283
|
* <p>The description of the access policy.</p>
|
|
284
|
+
* @public
|
|
285
285
|
*/
|
|
286
286
|
description?: string;
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>The Epoch time when the access policy was created.</p>
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
createdDate?: number;
|
|
292
292
|
/**
|
|
293
|
-
* @public
|
|
294
293
|
* <p>The date and time when the collection was last modified.</p>
|
|
294
|
+
* @public
|
|
295
295
|
*/
|
|
296
296
|
lastModifiedDate?: number;
|
|
297
297
|
}
|
|
@@ -300,15 +300,15 @@ export interface AccessPolicySummary {
|
|
|
300
300
|
*/
|
|
301
301
|
export interface ListAccessPoliciesResponse {
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>Details about the requested access policies.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
accessPolicySummaries?: AccessPolicySummary[];
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
310
309
|
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
311
310
|
* again using the returned token to retrieve the next page.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
nextToken?: string;
|
|
314
314
|
}
|
|
@@ -317,34 +317,34 @@ export interface ListAccessPoliciesResponse {
|
|
|
317
317
|
*/
|
|
318
318
|
export interface UpdateAccessPolicyRequest {
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The type of policy.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
type: AccessPolicyType | undefined;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The name of the policy.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
name: string | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>The version of the policy being updated.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
policyVersion: string | undefined;
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>A description of the policy. Typically used to store information about the permissions
|
|
337
336
|
* defined in the policy.</p>
|
|
337
|
+
* @public
|
|
338
338
|
*/
|
|
339
339
|
description?: string;
|
|
340
340
|
/**
|
|
341
|
-
* @public
|
|
342
341
|
* <p>The JSON policy document to use as the content for the policy.</p>
|
|
342
|
+
* @public
|
|
343
343
|
*/
|
|
344
344
|
policy?: string;
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
clientToken?: string;
|
|
350
350
|
}
|
|
@@ -353,52 +353,52 @@ export interface UpdateAccessPolicyRequest {
|
|
|
353
353
|
*/
|
|
354
354
|
export interface UpdateAccessPolicyResponse {
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>Details about the updated access policy.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
accessPolicyDetail?: AccessPolicyDetail;
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>Statistics for an OpenSearch Serverless access policy.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
export interface AccessPolicyStats {
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <p>The number of data access policies in the current account.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
DataPolicyCount?: number;
|
|
371
371
|
}
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
375
374
|
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
376
375
|
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
377
376
|
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
export interface CapacityLimits {
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>The maximum indexing capacity for collections.</p>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
maxIndexingCapacityInOCU?: number;
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>The maximum search capacity for collections.</p>
|
|
387
|
+
* @public
|
|
388
388
|
*/
|
|
389
389
|
maxSearchCapacityInOCU?: number;
|
|
390
390
|
}
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>OpenSearch Serverless-related information for the current account.</p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
export interface AccountSettingsDetail {
|
|
396
396
|
/**
|
|
397
|
-
* @public
|
|
398
397
|
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
399
398
|
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
400
399
|
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
401
400
|
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
401
|
+
* @public
|
|
402
402
|
*/
|
|
403
403
|
capacityLimits?: CapacityLimits;
|
|
404
404
|
}
|
|
@@ -407,14 +407,14 @@ export interface AccountSettingsDetail {
|
|
|
407
407
|
*/
|
|
408
408
|
export interface BatchGetCollectionRequest {
|
|
409
409
|
/**
|
|
410
|
-
* @public
|
|
411
410
|
* <p>A list of collection IDs. You can't provide names and IDs in the same request. The ID
|
|
412
411
|
* 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>
|
|
412
|
+
* @public
|
|
413
413
|
*/
|
|
414
414
|
ids?: string[];
|
|
415
415
|
/**
|
|
416
|
-
* @public
|
|
417
416
|
* <p>A list of collection names. You can't provide names and IDs in the same request.</p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
names?: string[];
|
|
420
420
|
}
|
|
@@ -485,100 +485,100 @@ export declare const CollectionType: {
|
|
|
485
485
|
*/
|
|
486
486
|
export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType];
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>Details about each OpenSearch Serverless collection, including the collection endpoint and the
|
|
490
489
|
* OpenSearch Dashboards endpoint.</p>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
export interface CollectionDetail {
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>A unique identifier for the collection.</p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
id?: string;
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>The name of the collection.</p>
|
|
500
|
+
* @public
|
|
501
501
|
*/
|
|
502
502
|
name?: string;
|
|
503
503
|
/**
|
|
504
|
-
* @public
|
|
505
504
|
* <p>The current status of the collection.</p>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
status?: CollectionStatus;
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>The type of collection.</p>
|
|
510
|
+
* @public
|
|
511
511
|
*/
|
|
512
512
|
type?: CollectionType;
|
|
513
513
|
/**
|
|
514
|
-
* @public
|
|
515
514
|
* <p>A description of the collection.</p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
description?: string;
|
|
518
518
|
/**
|
|
519
|
-
* @public
|
|
520
519
|
* <p>The Amazon Resource Name (ARN) of the collection.</p>
|
|
520
|
+
* @public
|
|
521
521
|
*/
|
|
522
522
|
arn?: string;
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>The ARN of the Amazon Web Services KMS key used to encrypt the collection.</p>
|
|
525
|
+
* @public
|
|
526
526
|
*/
|
|
527
527
|
kmsKeyArn?: string;
|
|
528
528
|
/**
|
|
529
|
-
* @public
|
|
530
529
|
* <p>Details about an OpenSearch Serverless collection.</p>
|
|
530
|
+
* @public
|
|
531
531
|
*/
|
|
532
532
|
standbyReplicas?: StandbyReplicas;
|
|
533
533
|
/**
|
|
534
|
-
* @public
|
|
535
534
|
* <p>The Epoch time when the collection was created.</p>
|
|
535
|
+
* @public
|
|
536
536
|
*/
|
|
537
537
|
createdDate?: number;
|
|
538
538
|
/**
|
|
539
|
-
* @public
|
|
540
539
|
* <p>The date and time when the collection was last modified.</p>
|
|
540
|
+
* @public
|
|
541
541
|
*/
|
|
542
542
|
lastModifiedDate?: number;
|
|
543
543
|
/**
|
|
544
|
-
* @public
|
|
545
544
|
* <p>Collection-specific endpoint used to submit index, search, and data upload requests to
|
|
546
545
|
* an OpenSearch Serverless collection.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
collectionEndpoint?: string;
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>Collection-specific endpoint used to access OpenSearch Dashboards.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
dashboardEndpoint?: string;
|
|
554
554
|
}
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>Error information for an OpenSearch Serverless request.</p>
|
|
557
|
+
* @public
|
|
558
558
|
*/
|
|
559
559
|
export interface CollectionErrorDetail {
|
|
560
560
|
/**
|
|
561
|
-
* @public
|
|
562
561
|
* <p>If the request contains collection IDs, the response includes the IDs provided in the
|
|
563
562
|
* request.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
id?: string;
|
|
566
566
|
/**
|
|
567
|
-
* @public
|
|
568
567
|
* <p>If the request contains collection names, the response includes the names provided in
|
|
569
568
|
* the request.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
name?: string;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>A description of the error. For example, <code>The specified Collection is not
|
|
575
574
|
* found.</code>
|
|
576
575
|
* </p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
errorMessage?: string;
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>
|
|
581
|
+
* @public
|
|
582
582
|
*/
|
|
583
583
|
errorCode?: string;
|
|
584
584
|
}
|
|
@@ -587,13 +587,13 @@ export interface CollectionErrorDetail {
|
|
|
587
587
|
*/
|
|
588
588
|
export interface BatchGetCollectionResponse {
|
|
589
589
|
/**
|
|
590
|
-
* @public
|
|
591
590
|
* <p>Details about each collection.</p>
|
|
591
|
+
* @public
|
|
592
592
|
*/
|
|
593
593
|
collectionDetails?: CollectionDetail[];
|
|
594
594
|
/**
|
|
595
|
-
* @public
|
|
596
595
|
* <p>Error information for the request.</p>
|
|
596
|
+
* @public
|
|
597
597
|
*/
|
|
598
598
|
collectionErrorDetails?: CollectionErrorDetail[];
|
|
599
599
|
}
|
|
@@ -612,18 +612,18 @@ export declare const LifecyclePolicyType: {
|
|
|
612
612
|
*/
|
|
613
613
|
export type LifecyclePolicyType = (typeof LifecyclePolicyType)[keyof typeof LifecyclePolicyType];
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>The unique identifiers of policy types and resource names.</p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
export interface LifecyclePolicyResourceIdentifier {
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>The type of lifecycle policy.</p>
|
|
621
|
+
* @public
|
|
622
622
|
*/
|
|
623
623
|
type: LifecyclePolicyType | undefined;
|
|
624
624
|
/**
|
|
625
|
-
* @public
|
|
626
625
|
* <p>The name of the OpenSearch Serverless ilndex resource.</p>
|
|
626
|
+
* @public
|
|
627
627
|
*/
|
|
628
628
|
resource: string | undefined;
|
|
629
629
|
}
|
|
@@ -632,8 +632,8 @@ export interface LifecyclePolicyResourceIdentifier {
|
|
|
632
632
|
*/
|
|
633
633
|
export interface BatchGetEffectiveLifecyclePolicyRequest {
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>The unique identifiers of policy types and resource names.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
resourceIdentifiers: LifecyclePolicyResourceIdentifier[] | undefined;
|
|
639
639
|
}
|
|
@@ -652,65 +652,65 @@ export declare const ResourceType: {
|
|
|
652
652
|
*/
|
|
653
653
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>Error information for an OpenSearch Serverless request.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
export interface EffectiveLifecyclePolicyDetail {
|
|
659
659
|
/**
|
|
660
|
-
* @public
|
|
661
660
|
* <p>The type of lifecycle policy.</p>
|
|
661
|
+
* @public
|
|
662
662
|
*/
|
|
663
663
|
type?: LifecyclePolicyType;
|
|
664
664
|
/**
|
|
665
|
-
* @public
|
|
666
665
|
* <p>The name of the OpenSearch Serverless index resource.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
resource?: string;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The name of the lifecycle policy.</p>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
policyName?: string;
|
|
674
674
|
/**
|
|
675
|
-
* @public
|
|
676
675
|
* <p>The type of OpenSearch Serverless resource. Currently, the only supported resource is <code>index</code>.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
resourceType?: ResourceType;
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <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>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
retentionPeriod?: string;
|
|
684
684
|
/**
|
|
685
|
-
* @public
|
|
686
685
|
* <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
|
|
687
686
|
* hours is not set to a index resource.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
noMinRetentionPeriod?: boolean;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>Error information for an OpenSearch Serverless request.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
export interface EffectiveLifecyclePolicyErrorDetail {
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>The type of lifecycle policy.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
type?: LifecyclePolicyType;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The name of OpenSearch Serverless index resource.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
resource?: string;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>A description of the error. For example, <code>The specified Index resource is not found</code>.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
errorMessage?: string;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>The error code for the request.</p>
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
errorCode?: string;
|
|
716
716
|
}
|
|
@@ -719,29 +719,29 @@ export interface EffectiveLifecyclePolicyErrorDetail {
|
|
|
719
719
|
*/
|
|
720
720
|
export interface BatchGetEffectiveLifecyclePolicyResponse {
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>A list of lifecycle policies applied to the OpenSearch Serverless indexes.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
effectiveLifecyclePolicyDetails?: EffectiveLifecyclePolicyDetail[];
|
|
726
726
|
/**
|
|
727
|
-
* @public
|
|
728
727
|
* <p>A list of resources for which retrieval failed.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
effectiveLifecyclePolicyErrorDetails?: EffectiveLifecyclePolicyErrorDetail[];
|
|
731
731
|
}
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>The unique identifiers of policy types and policy names.</p>
|
|
734
|
+
* @public
|
|
735
735
|
*/
|
|
736
736
|
export interface LifecyclePolicyIdentifier {
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>The type of lifecycle policy.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
type: LifecyclePolicyType | undefined;
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>The name of the lifecycle policy.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
name: string | undefined;
|
|
747
747
|
}
|
|
@@ -750,75 +750,75 @@ export interface LifecyclePolicyIdentifier {
|
|
|
750
750
|
*/
|
|
751
751
|
export interface BatchGetLifecyclePolicyRequest {
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>The unique identifiers of policy types and policy names.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
identifiers: LifecyclePolicyIdentifier[] | undefined;
|
|
757
757
|
}
|
|
758
758
|
/**
|
|
759
|
-
* @public
|
|
760
759
|
* <p>Details about an OpenSearch Serverless lifecycle policy.</p>
|
|
760
|
+
* @public
|
|
761
761
|
*/
|
|
762
762
|
export interface LifecyclePolicyDetail {
|
|
763
763
|
/**
|
|
764
|
-
* @public
|
|
765
764
|
* <p>The type of lifecycle policy.</p>
|
|
765
|
+
* @public
|
|
766
766
|
*/
|
|
767
767
|
type?: LifecyclePolicyType;
|
|
768
768
|
/**
|
|
769
|
-
* @public
|
|
770
769
|
* <p>The name of the lifecycle policy.</p>
|
|
770
|
+
* @public
|
|
771
771
|
*/
|
|
772
772
|
name?: string;
|
|
773
773
|
/**
|
|
774
|
-
* @public
|
|
775
774
|
* <p>The version of the lifecycle policy.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
policyVersion?: string;
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>The description of the lifecycle policy.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
description?: string;
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>The JSON policy document without any whitespaces.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
policy?: __DocumentType;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>The date the lifecycle policy was created.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
createdDate?: number;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The timestamp of when the lifecycle policy was last modified.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
lastModifiedDate?: number;
|
|
798
798
|
}
|
|
799
799
|
/**
|
|
800
|
-
* @public
|
|
801
800
|
* <p>Error information for an OpenSearch Serverless request.</p>
|
|
801
|
+
* @public
|
|
802
802
|
*/
|
|
803
803
|
export interface LifecyclePolicyErrorDetail {
|
|
804
804
|
/**
|
|
805
|
-
* @public
|
|
806
805
|
* <p>The type of lifecycle policy.</p>
|
|
806
|
+
* @public
|
|
807
807
|
*/
|
|
808
808
|
type?: LifecyclePolicyType;
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>The name of the lifecycle policy.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
name?: string;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>A description of the error. For example, <code>The specified Lifecycle Policy is not found</code>.</p>
|
|
816
|
+
* @public
|
|
817
817
|
*/
|
|
818
818
|
errorMessage?: string;
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
errorCode?: string;
|
|
824
824
|
}
|
|
@@ -827,13 +827,13 @@ export interface LifecyclePolicyErrorDetail {
|
|
|
827
827
|
*/
|
|
828
828
|
export interface BatchGetLifecyclePolicyResponse {
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>A list of lifecycle policies matched to the input policy name and policy type.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
lifecyclePolicyDetails?: LifecyclePolicyDetail[];
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>A list of lifecycle policy names and policy types for which retrieval failed.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
lifecyclePolicyErrorDetails?: LifecyclePolicyErrorDetail[];
|
|
839
839
|
}
|
|
@@ -842,8 +842,8 @@ export interface BatchGetLifecyclePolicyResponse {
|
|
|
842
842
|
*/
|
|
843
843
|
export interface BatchGetVpcEndpointRequest {
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>A list of VPC endpoint identifiers.</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
ids: string[] | undefined;
|
|
849
849
|
}
|
|
@@ -874,65 +874,65 @@ export declare const VpcEndpointStatus: {
|
|
|
874
874
|
*/
|
|
875
875
|
export type VpcEndpointStatus = (typeof VpcEndpointStatus)[keyof typeof VpcEndpointStatus];
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>Details about an OpenSearch Serverless-managed interface endpoint.</p>
|
|
878
|
+
* @public
|
|
879
879
|
*/
|
|
880
880
|
export interface VpcEndpointDetail {
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>The unique identifier of the endpoint.</p>
|
|
883
|
+
* @public
|
|
884
884
|
*/
|
|
885
885
|
id?: string;
|
|
886
886
|
/**
|
|
887
|
-
* @public
|
|
888
887
|
* <p>The name of the endpoint.</p>
|
|
888
|
+
* @public
|
|
889
889
|
*/
|
|
890
890
|
name?: string;
|
|
891
891
|
/**
|
|
892
|
-
* @public
|
|
893
892
|
* <p>The ID of the VPC from which you access OpenSearch Serverless.</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
vpcId?: string;
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>The ID of the subnets from which you access OpenSearch Serverless.</p>
|
|
898
|
+
* @public
|
|
899
899
|
*/
|
|
900
900
|
subnetIds?: string[];
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
904
903
|
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
904
|
+
* @public
|
|
905
905
|
*/
|
|
906
906
|
securityGroupIds?: string[];
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>The current status of the endpoint.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
status?: VpcEndpointStatus;
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>The date the endpoint was created.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
createdDate?: number;
|
|
917
917
|
}
|
|
918
918
|
/**
|
|
919
|
-
* @public
|
|
920
919
|
* <p>Error information for a failed <code>BatchGetVpcEndpoint</code> request.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
export interface VpcEndpointErrorDetail {
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>The unique identifier of the VPC endpoint.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
id?: string;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>An error message describing the reason for the failure.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
errorMessage?: string;
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>The error code for the failed request.</p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
errorCode?: string;
|
|
938
938
|
}
|
|
@@ -941,29 +941,29 @@ export interface VpcEndpointErrorDetail {
|
|
|
941
941
|
*/
|
|
942
942
|
export interface BatchGetVpcEndpointResponse {
|
|
943
943
|
/**
|
|
944
|
-
* @public
|
|
945
944
|
* <p>Details about the specified VPC endpoint.</p>
|
|
945
|
+
* @public
|
|
946
946
|
*/
|
|
947
947
|
vpcEndpointDetails?: VpcEndpointDetail[];
|
|
948
948
|
/**
|
|
949
|
-
* @public
|
|
950
949
|
* <p>Error information for a failed request.</p>
|
|
950
|
+
* @public
|
|
951
951
|
*/
|
|
952
952
|
vpcEndpointErrorDetails?: VpcEndpointErrorDetail[];
|
|
953
953
|
}
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>A map of key-value pairs associated to an OpenSearch Serverless resource.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
export interface Tag {
|
|
959
959
|
/**
|
|
960
|
-
* @public
|
|
961
960
|
* <p>The key to use in the tag.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
key: string | undefined;
|
|
964
964
|
/**
|
|
965
|
-
* @public
|
|
966
965
|
* <p>The value of the tag.</p>
|
|
966
|
+
* @public
|
|
967
967
|
*/
|
|
968
968
|
value: string | undefined;
|
|
969
969
|
}
|
|
@@ -972,89 +972,89 @@ export interface Tag {
|
|
|
972
972
|
*/
|
|
973
973
|
export interface CreateCollectionRequest {
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>Name of the collection.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
name: string | undefined;
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p>The type of collection.</p>
|
|
981
|
+
* @public
|
|
982
982
|
*/
|
|
983
983
|
type?: CollectionType;
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>Description of the collection.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
description?: string;
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
tags?: Tag[];
|
|
994
994
|
/**
|
|
995
|
-
* @public
|
|
996
995
|
* <p>Indicates whether standby replicas should be used for a collection.</p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
standbyReplicas?: StandbyReplicas;
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
clientToken?: string;
|
|
1004
1004
|
}
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>Details about the created OpenSearch Serverless collection.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
export interface CreateCollectionDetail {
|
|
1010
1010
|
/**
|
|
1011
|
-
* @public
|
|
1012
1011
|
* <p>The unique identifier of the collection.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
id?: string;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The name of the collection.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
name?: string;
|
|
1020
1020
|
/**
|
|
1021
|
-
* @public
|
|
1022
1021
|
* <p>The current status of the collection.</p>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
status?: CollectionStatus;
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>The type of collection.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
type?: CollectionType;
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>A description of the collection.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
description?: string;
|
|
1035
1035
|
/**
|
|
1036
|
-
* @public
|
|
1037
1036
|
* <p>The Amazon Resource Name (ARN) of the collection.</p>
|
|
1037
|
+
* @public
|
|
1038
1038
|
*/
|
|
1039
1039
|
arn?: string;
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.</p>
|
|
1042
|
+
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
kmsKeyArn?: string;
|
|
1045
1045
|
/**
|
|
1046
|
-
* @public
|
|
1047
1046
|
* <p>Creates details about an OpenSearch Serverless collection.</p>
|
|
1047
|
+
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
standbyReplicas?: StandbyReplicas;
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <p>The Epoch time when the collection was created.</p>
|
|
1052
|
+
* @public
|
|
1053
1053
|
*/
|
|
1054
1054
|
createdDate?: number;
|
|
1055
1055
|
/**
|
|
1056
|
-
* @public
|
|
1057
1056
|
* <p>The date and time when the collection was last modified.</p>
|
|
1057
|
+
* @public
|
|
1058
1058
|
*/
|
|
1059
1059
|
lastModifiedDate?: number;
|
|
1060
1060
|
}
|
|
@@ -1063,14 +1063,14 @@ export interface CreateCollectionDetail {
|
|
|
1063
1063
|
*/
|
|
1064
1064
|
export interface CreateCollectionResponse {
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>Details about the collection.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
createCollectionDetail?: CreateCollectionDetail;
|
|
1070
1070
|
}
|
|
1071
1071
|
/**
|
|
1072
|
-
* @public
|
|
1073
1072
|
* <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>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
export declare class OcuLimitExceededException extends __BaseException {
|
|
1076
1076
|
readonly name: "OcuLimitExceededException";
|
|
@@ -1085,35 +1085,35 @@ export declare class OcuLimitExceededException extends __BaseException {
|
|
|
1085
1085
|
*/
|
|
1086
1086
|
export interface DeleteCollectionRequest {
|
|
1087
1087
|
/**
|
|
1088
|
-
* @public
|
|
1089
1088
|
* <p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The
|
|
1090
1089
|
* 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>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
id: string | undefined;
|
|
1093
1093
|
/**
|
|
1094
|
-
* @public
|
|
1095
1094
|
* <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1095
|
+
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
clientToken?: string;
|
|
1098
1098
|
}
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>Details about a deleted OpenSearch Serverless collection.</p>
|
|
1101
|
+
* @public
|
|
1102
1102
|
*/
|
|
1103
1103
|
export interface DeleteCollectionDetail {
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>The unique identifier of the collection.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
id?: string;
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The name of the collection.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
name?: string;
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The current status of the collection.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
status?: CollectionStatus;
|
|
1119
1119
|
}
|
|
@@ -1122,25 +1122,25 @@ export interface DeleteCollectionDetail {
|
|
|
1122
1122
|
*/
|
|
1123
1123
|
export interface DeleteCollectionResponse {
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>Details of the deleted collection.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
deleteCollectionDetail?: DeleteCollectionDetail;
|
|
1129
1129
|
}
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless
|
|
1133
1132
|
* collections.</p>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface CollectionFilters {
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>The name of the collection.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
name?: string;
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>The current status of the collection.</p>
|
|
1143
|
+
* @public
|
|
1144
1144
|
*/
|
|
1145
1145
|
status?: CollectionStatus;
|
|
1146
1146
|
}
|
|
@@ -1149,47 +1149,47 @@ export interface CollectionFilters {
|
|
|
1149
1149
|
*/
|
|
1150
1150
|
export interface ListCollectionsRequest {
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p> A list of filter names and values that you can use for requests.</p>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
collectionFilters?: CollectionFilters;
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>,
|
|
1159
1158
|
* you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations,
|
|
1160
1159
|
* which returns results in the next page.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
nextToken?: string;
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>The maximum number of results to return. Default is 20. You can use
|
|
1166
1165
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
maxResults?: number;
|
|
1169
1169
|
}
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>Details about each OpenSearch Serverless collection.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
export interface CollectionSummary {
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The unique identifier of the collection.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
id?: string;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The name of the collection.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
name?: string;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The current status of the collection.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
status?: CollectionStatus;
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>The Amazon Resource Name (ARN) of the collection.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
arn?: string;
|
|
1195
1195
|
}
|
|
@@ -1198,15 +1198,15 @@ export interface CollectionSummary {
|
|
|
1198
1198
|
*/
|
|
1199
1199
|
export interface ListCollectionsResponse {
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>Details about each collection.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
collectionSummaries?: CollectionSummary[];
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
1208
1207
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1209
1208
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
nextToken?: string;
|
|
1212
1212
|
}
|
|
@@ -1215,64 +1215,64 @@ export interface ListCollectionsResponse {
|
|
|
1215
1215
|
*/
|
|
1216
1216
|
export interface UpdateCollectionRequest {
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>The unique identifier of the collection.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
id: string | undefined;
|
|
1222
1222
|
/**
|
|
1223
|
-
* @public
|
|
1224
1223
|
* <p>A description of the collection.</p>
|
|
1224
|
+
* @public
|
|
1225
1225
|
*/
|
|
1226
1226
|
description?: string;
|
|
1227
1227
|
/**
|
|
1228
|
-
* @public
|
|
1229
1228
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
clientToken?: string;
|
|
1232
1232
|
}
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>Details about an updated OpenSearch Serverless collection.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export interface UpdateCollectionDetail {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>The unique identifier of the collection.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
id?: string;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The name of the collection.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
name?: string;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The current status of the collection.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
status?: CollectionStatus;
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>The collection type.</p>
|
|
1255
|
+
* @public
|
|
1256
1256
|
*/
|
|
1257
1257
|
type?: CollectionType;
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>The description of the collection.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
description?: string;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>The Amazon Resource Name (ARN) of the collection.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
arn?: string;
|
|
1268
1268
|
/**
|
|
1269
|
-
* @public
|
|
1270
1269
|
* <p>The date and time when the collection was created.</p>
|
|
1270
|
+
* @public
|
|
1271
1271
|
*/
|
|
1272
1272
|
createdDate?: number;
|
|
1273
1273
|
/**
|
|
1274
|
-
* @public
|
|
1275
1274
|
* <p>The date and time when the collection was last modified.</p>
|
|
1275
|
+
* @public
|
|
1276
1276
|
*/
|
|
1277
1277
|
lastModifiedDate?: number;
|
|
1278
1278
|
}
|
|
@@ -1281,8 +1281,8 @@ export interface UpdateCollectionDetail {
|
|
|
1281
1281
|
*/
|
|
1282
1282
|
export interface UpdateCollectionResponse {
|
|
1283
1283
|
/**
|
|
1284
|
-
* @public
|
|
1285
1284
|
* <p>Details about the updated collection.</p>
|
|
1285
|
+
* @public
|
|
1286
1286
|
*/
|
|
1287
1287
|
updateCollectionDetail?: UpdateCollectionDetail;
|
|
1288
1288
|
}
|
|
@@ -1291,28 +1291,28 @@ export interface UpdateCollectionResponse {
|
|
|
1291
1291
|
*/
|
|
1292
1292
|
export interface CreateLifecyclePolicyRequest {
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>The type of lifecycle policy.</p>
|
|
1295
|
+
* @public
|
|
1296
1296
|
*/
|
|
1297
1297
|
type: LifecyclePolicyType | undefined;
|
|
1298
1298
|
/**
|
|
1299
|
-
* @public
|
|
1300
1299
|
* <p>The name of the lifecycle policy.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
name: string | undefined;
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>A description of the lifecycle policy.</p>
|
|
1305
|
+
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
description?: string;
|
|
1308
1308
|
/**
|
|
1309
|
-
* @public
|
|
1310
1309
|
* <p>The JSON policy document to use as the content for the lifecycle policy.</p>
|
|
1310
|
+
* @public
|
|
1311
1311
|
*/
|
|
1312
1312
|
policy: string | undefined;
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
clientToken?: string;
|
|
1318
1318
|
}
|
|
@@ -1321,35 +1321,35 @@ export interface CreateLifecyclePolicyRequest {
|
|
|
1321
1321
|
*/
|
|
1322
1322
|
export interface CreateLifecyclePolicyResponse {
|
|
1323
1323
|
/**
|
|
1324
|
-
* @public
|
|
1325
1324
|
* <p>Details about the created lifecycle policy.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
lifecyclePolicyDetail?: LifecyclePolicyDetail;
|
|
1328
1328
|
}
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value
|
|
1332
1331
|
* map.</p>
|
|
1332
|
+
* @public
|
|
1333
1333
|
*/
|
|
1334
1334
|
export interface SamlConfigOptions {
|
|
1335
1335
|
/**
|
|
1336
|
-
* @public
|
|
1337
1336
|
* <p>The XML IdP metadata file generated from your identity provider.</p>
|
|
1337
|
+
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
metadata: string | undefined;
|
|
1340
1340
|
/**
|
|
1341
|
-
* @public
|
|
1342
1341
|
* <p>A user attribute for this SAML integration.</p>
|
|
1342
|
+
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
userAttribute?: string;
|
|
1345
1345
|
/**
|
|
1346
|
-
* @public
|
|
1347
1346
|
* <p>The group attribute for this SAML integration.</p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
groupAttribute?: string;
|
|
1350
1350
|
/**
|
|
1351
|
-
* @public
|
|
1352
1351
|
* <p>The session timeout, in minutes. Default is 60 minutes (12 hours).</p>
|
|
1352
|
+
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
sessionTimeout?: number;
|
|
1355
1355
|
}
|
|
@@ -1372,70 +1372,70 @@ export type SecurityConfigType = (typeof SecurityConfigType)[keyof typeof Securi
|
|
|
1372
1372
|
*/
|
|
1373
1373
|
export interface CreateSecurityConfigRequest {
|
|
1374
1374
|
/**
|
|
1375
|
-
* @public
|
|
1376
1375
|
* <p>The type of security configuration.</p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
type: SecurityConfigType | undefined;
|
|
1379
1379
|
/**
|
|
1380
|
-
* @public
|
|
1381
1380
|
* <p>The name of the security configuration.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
name: string | undefined;
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>A description of the security configuration.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
description?: string;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>Describes SAML options in in the form of a key-value map. This field is required if
|
|
1392
1391
|
* you specify <code>saml</code> for the <code>type</code> parameter.</p>
|
|
1392
|
+
* @public
|
|
1393
1393
|
*/
|
|
1394
1394
|
samlOptions?: SamlConfigOptions;
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
clientToken?: string;
|
|
1400
1400
|
}
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>Details about a security configuration for OpenSearch Serverless. </p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
export interface SecurityConfigDetail {
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The unique identifier of the security configuration.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
id?: string;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The type of security configuration.</p>
|
|
1413
|
+
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
type?: SecurityConfigType;
|
|
1416
1416
|
/**
|
|
1417
|
-
* @public
|
|
1418
1417
|
* <p>The version of the security configuration.</p>
|
|
1418
|
+
* @public
|
|
1419
1419
|
*/
|
|
1420
1420
|
configVersion?: string;
|
|
1421
1421
|
/**
|
|
1422
|
-
* @public
|
|
1423
1422
|
* <p>The description of the security configuration.</p>
|
|
1423
|
+
* @public
|
|
1424
1424
|
*/
|
|
1425
1425
|
description?: string;
|
|
1426
1426
|
/**
|
|
1427
|
-
* @public
|
|
1428
1427
|
* <p>SAML options for the security configuration in the form of a key-value map.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
samlOptions?: SamlConfigOptions;
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>The date the configuration was created.</p>
|
|
1433
|
+
* @public
|
|
1434
1434
|
*/
|
|
1435
1435
|
createdDate?: number;
|
|
1436
1436
|
/**
|
|
1437
|
-
* @public
|
|
1438
1437
|
* <p>The timestamp of when the configuration was last modified.</p>
|
|
1438
|
+
* @public
|
|
1439
1439
|
*/
|
|
1440
1440
|
lastModifiedDate?: number;
|
|
1441
1441
|
}
|
|
@@ -1444,8 +1444,8 @@ export interface SecurityConfigDetail {
|
|
|
1444
1444
|
*/
|
|
1445
1445
|
export interface CreateSecurityConfigResponse {
|
|
1446
1446
|
/**
|
|
1447
|
-
* @public
|
|
1448
1447
|
* <p>Details about the created security configuration. </p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
securityConfigDetail?: SecurityConfigDetail;
|
|
1451
1451
|
}
|
|
@@ -1472,70 +1472,70 @@ export type SecurityPolicyType = (typeof SecurityPolicyType)[keyof typeof Securi
|
|
|
1472
1472
|
*/
|
|
1473
1473
|
export interface CreateSecurityPolicyRequest {
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>The type of security policy.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
type: SecurityPolicyType | undefined;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>The name of the policy.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
name: string | undefined;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>A description of the policy. Typically used to store information about the permissions
|
|
1487
1486
|
* defined in the policy.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
description?: string;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>The JSON policy document to use as the content for the new policy.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
policy: string | undefined;
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
clientToken?: string;
|
|
1500
1500
|
}
|
|
1501
1501
|
/**
|
|
1502
|
-
* @public
|
|
1503
1502
|
* <p>Details about an OpenSearch Serverless security policy.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
export interface SecurityPolicyDetail {
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The type of security policy.</p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
type?: SecurityPolicyType;
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <p>The name of the policy.</p>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
name?: string;
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>The version of the policy.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
policyVersion?: string;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>The description of the security policy.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
description?: string;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>The JSON policy document without any whitespaces.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
policy?: __DocumentType;
|
|
1531
1531
|
/**
|
|
1532
|
-
* @public
|
|
1533
1532
|
* <p>The date the policy was created.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
createdDate?: number;
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The timestamp of when the policy was last modified.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
lastModifiedDate?: number;
|
|
1541
1541
|
}
|
|
@@ -1544,8 +1544,8 @@ export interface SecurityPolicyDetail {
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
export interface CreateSecurityPolicyResponse {
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>Details about the created security policy.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
1551
1551
|
}
|
|
@@ -1554,51 +1554,51 @@ export interface CreateSecurityPolicyResponse {
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
export interface CreateVpcEndpointRequest {
|
|
1556
1556
|
/**
|
|
1557
|
-
* @public
|
|
1558
1557
|
* <p>The name of the interface endpoint.</p>
|
|
1558
|
+
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
name: string | undefined;
|
|
1561
1561
|
/**
|
|
1562
|
-
* @public
|
|
1563
1562
|
* <p>The ID of the VPC from which you'll access OpenSearch Serverless.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
vpcId: string | undefined;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>The ID of one or more subnets from which you'll access OpenSearch Serverless.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
subnetIds: string[] | undefined;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
1574
1573
|
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
1574
|
+
* @public
|
|
1575
1575
|
*/
|
|
1576
1576
|
securityGroupIds?: string[];
|
|
1577
1577
|
/**
|
|
1578
|
-
* @public
|
|
1579
1578
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
clientToken?: string;
|
|
1582
1582
|
}
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see
|
|
1586
1585
|
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
export interface CreateVpcEndpointDetail {
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>The unique identifier of the endpoint.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
id?: string;
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>The name of the endpoint.</p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
name?: string;
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>The current status in the endpoint creation process.</p>
|
|
1601
|
+
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
status?: VpcEndpointStatus;
|
|
1604
1604
|
}
|
|
@@ -1607,8 +1607,8 @@ export interface CreateVpcEndpointDetail {
|
|
|
1607
1607
|
*/
|
|
1608
1608
|
export interface CreateVpcEndpointResponse {
|
|
1609
1609
|
/**
|
|
1610
|
-
* @public
|
|
1611
1610
|
* <p>Details about the created interface VPC endpoint.</p>
|
|
1611
|
+
* @public
|
|
1612
1612
|
*/
|
|
1613
1613
|
createVpcEndpointDetail?: CreateVpcEndpointDetail;
|
|
1614
1614
|
}
|
|
@@ -1617,18 +1617,18 @@ export interface CreateVpcEndpointResponse {
|
|
|
1617
1617
|
*/
|
|
1618
1618
|
export interface DeleteLifecyclePolicyRequest {
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p>The type of lifecycle policy.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
type: LifecyclePolicyType | undefined;
|
|
1624
1624
|
/**
|
|
1625
|
-
* @public
|
|
1626
1625
|
* <p>The name of the policy to delete.</p>
|
|
1626
|
+
* @public
|
|
1627
1627
|
*/
|
|
1628
1628
|
name: string | undefined;
|
|
1629
1629
|
/**
|
|
1630
|
-
* @public
|
|
1631
1630
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1631
|
+
* @public
|
|
1632
1632
|
*/
|
|
1633
1633
|
clientToken?: string;
|
|
1634
1634
|
}
|
|
@@ -1642,15 +1642,15 @@ export interface DeleteLifecyclePolicyResponse {
|
|
|
1642
1642
|
*/
|
|
1643
1643
|
export interface DeleteSecurityConfigRequest {
|
|
1644
1644
|
/**
|
|
1645
|
-
* @public
|
|
1646
1645
|
* <p>The security configuration identifier. For SAML the ID will be
|
|
1647
1646
|
* <code>saml/<accountId>/<idpProviderName></code>. For example,
|
|
1648
1647
|
* <code>saml/123456789123/OKTADev</code>.</p>
|
|
1648
|
+
* @public
|
|
1649
1649
|
*/
|
|
1650
1650
|
id: string | undefined;
|
|
1651
1651
|
/**
|
|
1652
|
-
* @public
|
|
1653
1652
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
clientToken?: string;
|
|
1656
1656
|
}
|
|
@@ -1664,18 +1664,18 @@ export interface DeleteSecurityConfigResponse {
|
|
|
1664
1664
|
*/
|
|
1665
1665
|
export interface DeleteSecurityPolicyRequest {
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>The type of policy.</p>
|
|
1668
|
+
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
type: SecurityPolicyType | undefined;
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>The name of the policy to delete.</p>
|
|
1673
|
+
* @public
|
|
1674
1674
|
*/
|
|
1675
1675
|
name: string | undefined;
|
|
1676
1676
|
/**
|
|
1677
|
-
* @public
|
|
1678
1677
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1678
|
+
* @public
|
|
1679
1679
|
*/
|
|
1680
1680
|
clientToken?: string;
|
|
1681
1681
|
}
|
|
@@ -1689,34 +1689,34 @@ export interface DeleteSecurityPolicyResponse {
|
|
|
1689
1689
|
*/
|
|
1690
1690
|
export interface DeleteVpcEndpointRequest {
|
|
1691
1691
|
/**
|
|
1692
|
-
* @public
|
|
1693
1692
|
* <p>The VPC endpoint identifier.</p>
|
|
1693
|
+
* @public
|
|
1694
1694
|
*/
|
|
1695
1695
|
id: string | undefined;
|
|
1696
1696
|
/**
|
|
1697
|
-
* @public
|
|
1698
1697
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1698
|
+
* @public
|
|
1699
1699
|
*/
|
|
1700
1700
|
clientToken?: string;
|
|
1701
1701
|
}
|
|
1702
1702
|
/**
|
|
1703
|
-
* @public
|
|
1704
1703
|
* <p>Deletion details for an OpenSearch Serverless-managed interface endpoint.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
export interface DeleteVpcEndpointDetail {
|
|
1707
1707
|
/**
|
|
1708
|
-
* @public
|
|
1709
1708
|
* <p>The unique identifier of the endpoint.</p>
|
|
1709
|
+
* @public
|
|
1710
1710
|
*/
|
|
1711
1711
|
id?: string;
|
|
1712
1712
|
/**
|
|
1713
|
-
* @public
|
|
1714
1713
|
* <p>The name of the endpoint.</p>
|
|
1714
|
+
* @public
|
|
1715
1715
|
*/
|
|
1716
1716
|
name?: string;
|
|
1717
1717
|
/**
|
|
1718
|
-
* @public
|
|
1719
1718
|
* <p>The current status of the endpoint deletion process.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
status?: VpcEndpointStatus;
|
|
1722
1722
|
}
|
|
@@ -1725,8 +1725,8 @@ export interface DeleteVpcEndpointDetail {
|
|
|
1725
1725
|
*/
|
|
1726
1726
|
export interface DeleteVpcEndpointResponse {
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>Details about the deleted endpoint.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
deleteVpcEndpointDetail?: DeleteVpcEndpointDetail;
|
|
1732
1732
|
}
|
|
@@ -1740,8 +1740,8 @@ export interface GetAccountSettingsRequest {
|
|
|
1740
1740
|
*/
|
|
1741
1741
|
export interface GetAccountSettingsResponse {
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>OpenSearch Serverless-related details for the current account.</p>
|
|
1744
|
+
* @public
|
|
1745
1745
|
*/
|
|
1746
1746
|
accountSettingsDetail?: AccountSettingsDetail;
|
|
1747
1747
|
}
|
|
@@ -1751,40 +1751,40 @@ export interface GetAccountSettingsResponse {
|
|
|
1751
1751
|
export interface GetPoliciesStatsRequest {
|
|
1752
1752
|
}
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>Statistics for an OpenSearch Serverless lifecycle policy.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
export interface LifecyclePolicyStats {
|
|
1758
1758
|
/**
|
|
1759
|
-
* @public
|
|
1760
1759
|
* <p>The number of retention lifecycle policies in the current account.</p>
|
|
1760
|
+
* @public
|
|
1761
1761
|
*/
|
|
1762
1762
|
RetentionPolicyCount?: number;
|
|
1763
1763
|
}
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>Statistics for an OpenSearch Serverless security configuration.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
export interface SecurityConfigStats {
|
|
1769
1769
|
/**
|
|
1770
|
-
* @public
|
|
1771
1770
|
* <p>The number of security configurations in the current account.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
SamlConfigCount?: number;
|
|
1774
1774
|
}
|
|
1775
1775
|
/**
|
|
1776
|
-
* @public
|
|
1777
1776
|
* <p>Statistics for an OpenSearch Serverless security policy.</p>
|
|
1777
|
+
* @public
|
|
1778
1778
|
*/
|
|
1779
1779
|
export interface SecurityPolicyStats {
|
|
1780
1780
|
/**
|
|
1781
|
-
* @public
|
|
1782
1781
|
* <p>The number of encryption policies in the current account.</p>
|
|
1782
|
+
* @public
|
|
1783
1783
|
*/
|
|
1784
1784
|
EncryptionPolicyCount?: number;
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>The number of network policies in the current account.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
NetworkPolicyCount?: number;
|
|
1790
1790
|
}
|
|
@@ -1793,29 +1793,29 @@ export interface SecurityPolicyStats {
|
|
|
1793
1793
|
*/
|
|
1794
1794
|
export interface GetPoliciesStatsResponse {
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>Information about the data access policies in your account.</p>
|
|
1797
|
+
* @public
|
|
1798
1798
|
*/
|
|
1799
1799
|
AccessPolicyStats?: AccessPolicyStats;
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>Information about the security policies in your account.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
SecurityPolicyStats?: SecurityPolicyStats;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>Information about the security configurations in your account.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
SecurityConfigStats?: SecurityConfigStats;
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>Information about the lifecycle policies in your account.</p>
|
|
1812
|
+
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
LifecyclePolicyStats?: LifecyclePolicyStats;
|
|
1815
1815
|
/**
|
|
1816
|
-
* @public
|
|
1817
1816
|
* <p>The total number of OpenSearch Serverless security policies and configurations in your
|
|
1818
1817
|
* account.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
TotalPolicyCount?: number;
|
|
1821
1821
|
}
|
|
@@ -1824,8 +1824,8 @@ export interface GetPoliciesStatsResponse {
|
|
|
1824
1824
|
*/
|
|
1825
1825
|
export interface GetSecurityConfigRequest {
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The unique identifier of the security configuration.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
id: string | undefined;
|
|
1831
1831
|
}
|
|
@@ -1834,8 +1834,8 @@ export interface GetSecurityConfigRequest {
|
|
|
1834
1834
|
*/
|
|
1835
1835
|
export interface GetSecurityConfigResponse {
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>Details of the requested security configuration.</p>
|
|
1838
|
+
* @public
|
|
1839
1839
|
*/
|
|
1840
1840
|
securityConfigDetail?: SecurityConfigDetail;
|
|
1841
1841
|
}
|
|
@@ -1844,13 +1844,13 @@ export interface GetSecurityConfigResponse {
|
|
|
1844
1844
|
*/
|
|
1845
1845
|
export interface GetSecurityPolicyRequest {
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The type of security policy.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
type: SecurityPolicyType | undefined;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>The name of the security policy.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
name: string | undefined;
|
|
1856
1856
|
}
|
|
@@ -1859,8 +1859,8 @@ export interface GetSecurityPolicyRequest {
|
|
|
1859
1859
|
*/
|
|
1860
1860
|
export interface GetSecurityPolicyResponse {
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p>Details about the requested security policy.</p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
1866
1866
|
}
|
|
@@ -1869,59 +1869,59 @@ export interface GetSecurityPolicyResponse {
|
|
|
1869
1869
|
*/
|
|
1870
1870
|
export interface ListLifecyclePoliciesRequest {
|
|
1871
1871
|
/**
|
|
1872
|
-
* @public
|
|
1873
1872
|
* <p>The type of lifecycle policy.</p>
|
|
1873
|
+
* @public
|
|
1874
1874
|
*/
|
|
1875
1875
|
type: LifecyclePolicyType | undefined;
|
|
1876
1876
|
/**
|
|
1877
|
-
* @public
|
|
1878
1877
|
* <p>Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.</p>
|
|
1878
|
+
* @public
|
|
1879
1879
|
*/
|
|
1880
1880
|
resources?: string[];
|
|
1881
1881
|
/**
|
|
1882
|
-
* @public
|
|
1883
1882
|
* <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>
|
|
1883
|
+
* @public
|
|
1884
1884
|
*/
|
|
1885
1885
|
nextToken?: string;
|
|
1886
1886
|
/**
|
|
1887
|
-
* @public
|
|
1888
1887
|
* <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>
|
|
1888
|
+
* @public
|
|
1889
1889
|
*/
|
|
1890
1890
|
maxResults?: number;
|
|
1891
1891
|
}
|
|
1892
1892
|
/**
|
|
1893
|
-
* @public
|
|
1894
1893
|
* <p>A summary of the lifecycle policy.</p>
|
|
1894
|
+
* @public
|
|
1895
1895
|
*/
|
|
1896
1896
|
export interface LifecyclePolicySummary {
|
|
1897
1897
|
/**
|
|
1898
|
-
* @public
|
|
1899
1898
|
* <p>The type of lifecycle policy.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
type?: LifecyclePolicyType;
|
|
1902
1902
|
/**
|
|
1903
|
-
* @public
|
|
1904
1903
|
* <p>The name of the lifecycle policy.</p>
|
|
1904
|
+
* @public
|
|
1905
1905
|
*/
|
|
1906
1906
|
name?: string;
|
|
1907
1907
|
/**
|
|
1908
|
-
* @public
|
|
1909
1908
|
* <p>The version of the lifecycle policy.</p>
|
|
1909
|
+
* @public
|
|
1910
1910
|
*/
|
|
1911
1911
|
policyVersion?: string;
|
|
1912
1912
|
/**
|
|
1913
|
-
* @public
|
|
1914
1913
|
* <p>The description of the lifecycle policy.</p>
|
|
1914
|
+
* @public
|
|
1915
1915
|
*/
|
|
1916
1916
|
description?: string;
|
|
1917
1917
|
/**
|
|
1918
|
-
* @public
|
|
1919
1918
|
* <p>The Epoch time when the lifecycle policy was created.</p>
|
|
1919
|
+
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
createdDate?: number;
|
|
1922
1922
|
/**
|
|
1923
|
-
* @public
|
|
1924
1923
|
* <p>The date and time when the lifecycle policy was last modified.</p>
|
|
1924
|
+
* @public
|
|
1925
1925
|
*/
|
|
1926
1926
|
lastModifiedDate?: number;
|
|
1927
1927
|
}
|
|
@@ -1930,13 +1930,13 @@ export interface LifecyclePolicySummary {
|
|
|
1930
1930
|
*/
|
|
1931
1931
|
export interface ListLifecyclePoliciesResponse {
|
|
1932
1932
|
/**
|
|
1933
|
-
* @public
|
|
1934
1933
|
* <p>Details about the requested lifecycle policies.</p>
|
|
1934
|
+
* @public
|
|
1935
1935
|
*/
|
|
1936
1936
|
lifecyclePolicySummaries?: LifecyclePolicySummary[];
|
|
1937
1937
|
/**
|
|
1938
|
-
* @public
|
|
1939
1938
|
* <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>
|
|
1939
|
+
* @public
|
|
1940
1940
|
*/
|
|
1941
1941
|
nextToken?: string;
|
|
1942
1942
|
}
|
|
@@ -1945,33 +1945,33 @@ export interface ListLifecyclePoliciesResponse {
|
|
|
1945
1945
|
*/
|
|
1946
1946
|
export interface UpdateLifecyclePolicyRequest {
|
|
1947
1947
|
/**
|
|
1948
|
-
* @public
|
|
1949
1948
|
* <p> The type of lifecycle policy.</p>
|
|
1949
|
+
* @public
|
|
1950
1950
|
*/
|
|
1951
1951
|
type: LifecyclePolicyType | undefined;
|
|
1952
1952
|
/**
|
|
1953
|
-
* @public
|
|
1954
1953
|
* <p>The name of the policy.</p>
|
|
1954
|
+
* @public
|
|
1955
1955
|
*/
|
|
1956
1956
|
name: string | undefined;
|
|
1957
1957
|
/**
|
|
1958
|
-
* @public
|
|
1959
1958
|
* <p>The version of the policy being updated.</p>
|
|
1959
|
+
* @public
|
|
1960
1960
|
*/
|
|
1961
1961
|
policyVersion: string | undefined;
|
|
1962
1962
|
/**
|
|
1963
|
-
* @public
|
|
1964
1963
|
* <p>A description of the lifecycle policy.</p>
|
|
1964
|
+
* @public
|
|
1965
1965
|
*/
|
|
1966
1966
|
description?: string;
|
|
1967
1967
|
/**
|
|
1968
|
-
* @public
|
|
1969
1968
|
* <p>The JSON policy document to use as the content for the lifecycle policy.</p>
|
|
1969
|
+
* @public
|
|
1970
1970
|
*/
|
|
1971
1971
|
policy?: string;
|
|
1972
1972
|
/**
|
|
1973
|
-
* @public
|
|
1974
1973
|
* <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1974
|
+
* @public
|
|
1975
1975
|
*/
|
|
1976
1976
|
clientToken?: string;
|
|
1977
1977
|
}
|
|
@@ -1980,8 +1980,8 @@ export interface UpdateLifecyclePolicyRequest {
|
|
|
1980
1980
|
*/
|
|
1981
1981
|
export interface UpdateLifecyclePolicyResponse {
|
|
1982
1982
|
/**
|
|
1983
|
-
* @public
|
|
1984
1983
|
* <p>Details about the updated lifecycle policy.</p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
lifecyclePolicyDetail?: LifecyclePolicyDetail;
|
|
1987
1987
|
}
|
|
@@ -1990,58 +1990,58 @@ export interface UpdateLifecyclePolicyResponse {
|
|
|
1990
1990
|
*/
|
|
1991
1991
|
export interface ListSecurityConfigsRequest {
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>The type of security configuration.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
type: SecurityConfigType | undefined;
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>If your initial <code>ListSecurityConfigs</code> operation returns a
|
|
2000
1999
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2001
2000
|
* subsequent <code>ListSecurityConfigs</code> operations, which returns results in the
|
|
2002
2001
|
* next page. </p>
|
|
2002
|
+
* @public
|
|
2003
2003
|
*/
|
|
2004
2004
|
nextToken?: string;
|
|
2005
2005
|
/**
|
|
2006
|
-
* @public
|
|
2007
2006
|
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2008
2007
|
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2008
|
+
* @public
|
|
2009
2009
|
*/
|
|
2010
2010
|
maxResults?: number;
|
|
2011
2011
|
}
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>A summary of a security configuration for OpenSearch Serverless.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
export interface SecurityConfigSummary {
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p>The unique identifier of the security configuration.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
id?: string;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>The type of security configuration.</p>
|
|
2024
|
+
* @public
|
|
2025
2025
|
*/
|
|
2026
2026
|
type?: SecurityConfigType;
|
|
2027
2027
|
/**
|
|
2028
|
-
* @public
|
|
2029
2028
|
* <p>The version of the security configuration.</p>
|
|
2029
|
+
* @public
|
|
2030
2030
|
*/
|
|
2031
2031
|
configVersion?: string;
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>The description of the security configuration.</p>
|
|
2034
|
+
* @public
|
|
2035
2035
|
*/
|
|
2036
2036
|
description?: string;
|
|
2037
2037
|
/**
|
|
2038
|
-
* @public
|
|
2039
2038
|
* <p>The Epoch time when the security configuration was created.</p>
|
|
2039
|
+
* @public
|
|
2040
2040
|
*/
|
|
2041
2041
|
createdDate?: number;
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>The timestamp of when the configuration was last modified.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
lastModifiedDate?: number;
|
|
2047
2047
|
}
|
|
@@ -2050,15 +2050,15 @@ export interface SecurityConfigSummary {
|
|
|
2050
2050
|
*/
|
|
2051
2051
|
export interface ListSecurityConfigsResponse {
|
|
2052
2052
|
/**
|
|
2053
|
-
* @public
|
|
2054
2053
|
* <p>Details about the security configurations in your account.</p>
|
|
2054
|
+
* @public
|
|
2055
2055
|
*/
|
|
2056
2056
|
securityConfigSummaries?: SecurityConfigSummary[];
|
|
2057
2057
|
/**
|
|
2058
|
-
* @public
|
|
2059
2058
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2060
2059
|
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2061
2060
|
* again using the returned token to retrieve the next page.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
nextToken?: string;
|
|
2064
2064
|
}
|
|
@@ -2067,63 +2067,63 @@ export interface ListSecurityConfigsResponse {
|
|
|
2067
2067
|
*/
|
|
2068
2068
|
export interface ListSecurityPoliciesRequest {
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>The type of policy.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
type: SecurityPolicyType | undefined;
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>Resource filters (can be collection or indexes) that policies can apply to. </p>
|
|
2076
|
+
* @public
|
|
2077
2077
|
*/
|
|
2078
2078
|
resource?: string[];
|
|
2079
2079
|
/**
|
|
2080
|
-
* @public
|
|
2081
2080
|
* <p>If your initial <code>ListSecurityPolicies</code> operation returns a
|
|
2082
2081
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2083
2082
|
* subsequent <code>ListSecurityPolicies</code> operations, which returns results in the
|
|
2084
2083
|
* next page. </p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
nextToken?: string;
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2090
2089
|
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2090
|
+
* @public
|
|
2091
2091
|
*/
|
|
2092
2092
|
maxResults?: number;
|
|
2093
2093
|
}
|
|
2094
2094
|
/**
|
|
2095
|
-
* @public
|
|
2096
2095
|
* <p>A summary of a security policy for OpenSearch Serverless.</p>
|
|
2096
|
+
* @public
|
|
2097
2097
|
*/
|
|
2098
2098
|
export interface SecurityPolicySummary {
|
|
2099
2099
|
/**
|
|
2100
|
-
* @public
|
|
2101
2100
|
* <p>The type of security policy.</p>
|
|
2101
|
+
* @public
|
|
2102
2102
|
*/
|
|
2103
2103
|
type?: SecurityPolicyType;
|
|
2104
2104
|
/**
|
|
2105
|
-
* @public
|
|
2106
2105
|
* <p>The name of the policy.</p>
|
|
2106
|
+
* @public
|
|
2107
2107
|
*/
|
|
2108
2108
|
name?: string;
|
|
2109
2109
|
/**
|
|
2110
|
-
* @public
|
|
2111
2110
|
* <p>The version of the policy.</p>
|
|
2111
|
+
* @public
|
|
2112
2112
|
*/
|
|
2113
2113
|
policyVersion?: string;
|
|
2114
2114
|
/**
|
|
2115
|
-
* @public
|
|
2116
2115
|
* <p>The description of the security policy.</p>
|
|
2116
|
+
* @public
|
|
2117
2117
|
*/
|
|
2118
2118
|
description?: string;
|
|
2119
2119
|
/**
|
|
2120
|
-
* @public
|
|
2121
2120
|
* <p>The date the policy was created.</p>
|
|
2121
|
+
* @public
|
|
2122
2122
|
*/
|
|
2123
2123
|
createdDate?: number;
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>The timestamp of when the policy was last modified.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
lastModifiedDate?: number;
|
|
2129
2129
|
}
|
|
@@ -2132,15 +2132,15 @@ export interface SecurityPolicySummary {
|
|
|
2132
2132
|
*/
|
|
2133
2133
|
export interface ListSecurityPoliciesResponse {
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>Details about the security policies in your account.</p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
securityPolicySummaries?: SecurityPolicySummary[];
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2142
2141
|
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2143
2142
|
* again using the returned token to retrieve the next page.</p>
|
|
2143
|
+
* @public
|
|
2144
2144
|
*/
|
|
2145
2145
|
nextToken?: string;
|
|
2146
2146
|
}
|
|
@@ -2149,10 +2149,10 @@ export interface ListSecurityPoliciesResponse {
|
|
|
2149
2149
|
*/
|
|
2150
2150
|
export interface ListTagsForResourceRequest {
|
|
2151
2151
|
/**
|
|
2152
|
-
* @public
|
|
2153
2152
|
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
2154
2153
|
* the <code>DELETING</code> state), and must be owned by the account ID included in the
|
|
2155
2154
|
* request.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
resourceArn: string | undefined;
|
|
2158
2158
|
}
|
|
@@ -2161,19 +2161,19 @@ export interface ListTagsForResourceRequest {
|
|
|
2161
2161
|
*/
|
|
2162
2162
|
export interface ListTagsForResourceResponse {
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>The tags associated with the resource.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
tags?: Tag[];
|
|
2168
2168
|
}
|
|
2169
2169
|
/**
|
|
2170
|
-
* @public
|
|
2171
2170
|
* <p>Filter the results of a <code>ListVpcEndpoints</code> request.</p>
|
|
2171
|
+
* @public
|
|
2172
2172
|
*/
|
|
2173
2173
|
export interface VpcEndpointFilters {
|
|
2174
2174
|
/**
|
|
2175
|
-
* @public
|
|
2176
2175
|
* <p>The current status of the endpoint.</p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
status?: VpcEndpointStatus;
|
|
2179
2179
|
}
|
|
@@ -2182,45 +2182,45 @@ export interface VpcEndpointFilters {
|
|
|
2182
2182
|
*/
|
|
2183
2183
|
export interface ListVpcEndpointsRequest {
|
|
2184
2184
|
/**
|
|
2185
|
-
* @public
|
|
2186
2185
|
* <p>Filter the results according to the current status of the VPC endpoint. Possible
|
|
2187
2186
|
* statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>,
|
|
2188
2187
|
* <code>ACTIVE</code>, and <code>FAILED</code>.</p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
vpcEndpointFilters?: VpcEndpointFilters;
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a
|
|
2194
2193
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
2195
2194
|
* subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next
|
|
2196
2195
|
* page. </p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
nextToken?: string;
|
|
2199
2199
|
/**
|
|
2200
|
-
* @public
|
|
2201
2200
|
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
2202
2201
|
* use <code>nextToken</code> to get the next page of results. The default is 20.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
maxResults?: number;
|
|
2205
2205
|
}
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>The VPC endpoint object.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
export interface VpcEndpointSummary {
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>The unique identifier of the endpoint.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
id?: string;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>The name of the endpoint.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
name?: string;
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>The current status of the endpoint.</p>
|
|
2223
|
+
* @public
|
|
2224
2224
|
*/
|
|
2225
2225
|
status?: VpcEndpointStatus;
|
|
2226
2226
|
}
|
|
@@ -2229,15 +2229,15 @@ export interface VpcEndpointSummary {
|
|
|
2229
2229
|
*/
|
|
2230
2230
|
export interface ListVpcEndpointsResponse {
|
|
2231
2231
|
/**
|
|
2232
|
-
* @public
|
|
2233
2232
|
* <p>Details about each VPC endpoint, including the name and current status.</p>
|
|
2233
|
+
* @public
|
|
2234
2234
|
*/
|
|
2235
2235
|
vpcEndpointSummaries?: VpcEndpointSummary[];
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
2239
2238
|
* of <code>nextToken</code> is a unique pagination token for each page. Make the call
|
|
2240
2239
|
* again using the returned token to retrieve the next page.</p>
|
|
2240
|
+
* @public
|
|
2241
2241
|
*/
|
|
2242
2242
|
nextToken?: string;
|
|
2243
2243
|
}
|
|
@@ -2246,32 +2246,32 @@ export interface ListVpcEndpointsResponse {
|
|
|
2246
2246
|
*/
|
|
2247
2247
|
export interface UpdateSecurityConfigRequest {
|
|
2248
2248
|
/**
|
|
2249
|
-
* @public
|
|
2250
2249
|
* <p>The security configuration identifier. For SAML the ID will be
|
|
2251
2250
|
* <code>saml/<accountId>/<idpProviderName></code>. For example,
|
|
2252
2251
|
* <code>saml/123456789123/OKTADev</code>.</p>
|
|
2252
|
+
* @public
|
|
2253
2253
|
*/
|
|
2254
2254
|
id: string | undefined;
|
|
2255
2255
|
/**
|
|
2256
|
-
* @public
|
|
2257
2256
|
* <p>The version of the security configuration to be updated. You can find the most recent
|
|
2258
2257
|
* version of a security configuration using the <code>GetSecurityPolicy</code>
|
|
2259
2258
|
* command.</p>
|
|
2259
|
+
* @public
|
|
2260
2260
|
*/
|
|
2261
2261
|
configVersion: string | undefined;
|
|
2262
2262
|
/**
|
|
2263
|
-
* @public
|
|
2264
2263
|
* <p>A description of the security configuration.</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
description?: string;
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>SAML options in in the form of a key-value map.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
samlOptions?: SamlConfigOptions;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
2274
|
+
* @public
|
|
2275
2275
|
*/
|
|
2276
2276
|
clientToken?: string;
|
|
2277
2277
|
}
|
|
@@ -2280,8 +2280,8 @@ export interface UpdateSecurityConfigRequest {
|
|
|
2280
2280
|
*/
|
|
2281
2281
|
export interface UpdateSecurityConfigResponse {
|
|
2282
2282
|
/**
|
|
2283
|
-
* @public
|
|
2284
2283
|
* <p>Details about the updated security configuration. </p>
|
|
2284
|
+
* @public
|
|
2285
2285
|
*/
|
|
2286
2286
|
securityConfigDetail?: SecurityConfigDetail;
|
|
2287
2287
|
}
|
|
@@ -2290,34 +2290,34 @@ export interface UpdateSecurityConfigResponse {
|
|
|
2290
2290
|
*/
|
|
2291
2291
|
export interface UpdateSecurityPolicyRequest {
|
|
2292
2292
|
/**
|
|
2293
|
-
* @public
|
|
2294
2293
|
* <p>The type of access policy.</p>
|
|
2294
|
+
* @public
|
|
2295
2295
|
*/
|
|
2296
2296
|
type: SecurityPolicyType | undefined;
|
|
2297
2297
|
/**
|
|
2298
|
-
* @public
|
|
2299
2298
|
* <p>The name of the policy.</p>
|
|
2299
|
+
* @public
|
|
2300
2300
|
*/
|
|
2301
2301
|
name: string | undefined;
|
|
2302
2302
|
/**
|
|
2303
|
-
* @public
|
|
2304
2303
|
* <p>The version of the policy being updated.</p>
|
|
2304
|
+
* @public
|
|
2305
2305
|
*/
|
|
2306
2306
|
policyVersion: string | undefined;
|
|
2307
2307
|
/**
|
|
2308
|
-
* @public
|
|
2309
2308
|
* <p>A description of the policy. Typically used to store information about the permissions
|
|
2310
2309
|
* defined in the policy.</p>
|
|
2310
|
+
* @public
|
|
2311
2311
|
*/
|
|
2312
2312
|
description?: string;
|
|
2313
2313
|
/**
|
|
2314
|
-
* @public
|
|
2315
2314
|
* <p>The JSON policy document to use as the content for the new policy.</p>
|
|
2315
|
+
* @public
|
|
2316
2316
|
*/
|
|
2317
2317
|
policy?: string;
|
|
2318
2318
|
/**
|
|
2319
|
-
* @public
|
|
2320
2319
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
2320
|
+
* @public
|
|
2321
2321
|
*/
|
|
2322
2322
|
clientToken?: string;
|
|
2323
2323
|
}
|
|
@@ -2326,8 +2326,8 @@ export interface UpdateSecurityPolicyRequest {
|
|
|
2326
2326
|
*/
|
|
2327
2327
|
export interface UpdateSecurityPolicyResponse {
|
|
2328
2328
|
/**
|
|
2329
|
-
* @public
|
|
2330
2329
|
* <p>Details about the updated security policy.</p>
|
|
2330
|
+
* @public
|
|
2331
2331
|
*/
|
|
2332
2332
|
securityPolicyDetail?: SecurityPolicyDetail;
|
|
2333
2333
|
}
|
|
@@ -2336,16 +2336,16 @@ export interface UpdateSecurityPolicyResponse {
|
|
|
2336
2336
|
*/
|
|
2337
2337
|
export interface TagResourceRequest {
|
|
2338
2338
|
/**
|
|
2339
|
-
* @public
|
|
2340
2339
|
* <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
|
|
2341
2340
|
* the <code>DELETING</code> state), and must be owned by the account ID included in the
|
|
2342
2341
|
* request.</p>
|
|
2342
|
+
* @public
|
|
2343
2343
|
*/
|
|
2344
2344
|
resourceArn: string | undefined;
|
|
2345
2345
|
/**
|
|
2346
|
-
* @public
|
|
2347
2346
|
* <p>A list of tags (key-value pairs) to add to the resource. All tag keys in the request
|
|
2348
2347
|
* must be unique.</p>
|
|
2348
|
+
* @public
|
|
2349
2349
|
*/
|
|
2350
2350
|
tags: Tag[] | undefined;
|
|
2351
2351
|
}
|
|
@@ -2359,16 +2359,16 @@ export interface TagResourceResponse {
|
|
|
2359
2359
|
*/
|
|
2360
2360
|
export interface UntagResourceRequest {
|
|
2361
2361
|
/**
|
|
2362
|
-
* @public
|
|
2363
2362
|
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must
|
|
2364
2363
|
* be active (not in the <code>DELETING</code> state), and must be owned by the account ID
|
|
2365
2364
|
* included in the request.</p>
|
|
2365
|
+
* @public
|
|
2366
2366
|
*/
|
|
2367
2367
|
resourceArn: string | undefined;
|
|
2368
2368
|
/**
|
|
2369
|
-
* @public
|
|
2370
2369
|
* <p>The tag or set of tags to remove from the resource. All tag keys in the request must
|
|
2371
2370
|
* be unique.</p>
|
|
2371
|
+
* @public
|
|
2372
2372
|
*/
|
|
2373
2373
|
tagKeys: string[] | undefined;
|
|
2374
2374
|
}
|
|
@@ -2382,11 +2382,11 @@ export interface UntagResourceResponse {
|
|
|
2382
2382
|
*/
|
|
2383
2383
|
export interface UpdateAccountSettingsRequest {
|
|
2384
2384
|
/**
|
|
2385
|
-
* @public
|
|
2386
2385
|
* <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
|
|
2387
2386
|
* (OCUs). These limits are used to scale your collections based on the current workload.
|
|
2388
2387
|
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
|
|
2389
2388
|
* capacity limits for Amazon OpenSearch Serverless</a>.</p>
|
|
2389
|
+
* @public
|
|
2390
2390
|
*/
|
|
2391
2391
|
capacityLimits?: CapacityLimits;
|
|
2392
2392
|
}
|
|
@@ -2395,8 +2395,8 @@ export interface UpdateAccountSettingsRequest {
|
|
|
2395
2395
|
*/
|
|
2396
2396
|
export interface UpdateAccountSettingsResponse {
|
|
2397
2397
|
/**
|
|
2398
|
-
* @public
|
|
2399
2398
|
* <p>OpenSearch Serverless-related settings for the current Amazon Web Services account. </p>
|
|
2399
|
+
* @public
|
|
2400
2400
|
*/
|
|
2401
2401
|
accountSettingsDetail?: AccountSettingsDetail;
|
|
2402
2402
|
}
|
|
@@ -2405,72 +2405,72 @@ export interface UpdateAccountSettingsResponse {
|
|
|
2405
2405
|
*/
|
|
2406
2406
|
export interface UpdateVpcEndpointRequest {
|
|
2407
2407
|
/**
|
|
2408
|
-
* @public
|
|
2409
2408
|
* <p>The unique identifier of the interface endpoint to update.</p>
|
|
2409
|
+
* @public
|
|
2410
2410
|
*/
|
|
2411
2411
|
id: string | undefined;
|
|
2412
2412
|
/**
|
|
2413
|
-
* @public
|
|
2414
2413
|
* <p>The ID of one or more subnets to add to the endpoint.</p>
|
|
2414
|
+
* @public
|
|
2415
2415
|
*/
|
|
2416
2416
|
addSubnetIds?: string[];
|
|
2417
2417
|
/**
|
|
2418
|
-
* @public
|
|
2419
2418
|
* <p>The unique identifiers of the subnets to remove from the endpoint.</p>
|
|
2419
|
+
* @public
|
|
2420
2420
|
*/
|
|
2421
2421
|
removeSubnetIds?: string[];
|
|
2422
2422
|
/**
|
|
2423
|
-
* @public
|
|
2424
2423
|
* <p>The unique identifiers of the security groups to add to the endpoint. Security groups
|
|
2425
2424
|
* define the ports, protocols, and sources for inbound traffic that you are authorizing
|
|
2426
2425
|
* into your endpoint.</p>
|
|
2426
|
+
* @public
|
|
2427
2427
|
*/
|
|
2428
2428
|
addSecurityGroupIds?: string[];
|
|
2429
2429
|
/**
|
|
2430
|
-
* @public
|
|
2431
2430
|
* <p>The unique identifiers of the security groups to remove from the endpoint.</p>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
removeSecurityGroupIds?: string[];
|
|
2434
2434
|
/**
|
|
2435
|
-
* @public
|
|
2436
2435
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
2436
|
+
* @public
|
|
2437
2437
|
*/
|
|
2438
2438
|
clientToken?: string;
|
|
2439
2439
|
}
|
|
2440
2440
|
/**
|
|
2441
|
-
* @public
|
|
2442
2441
|
* <p>Update details for an OpenSearch Serverless-managed interface endpoint.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
export interface UpdateVpcEndpointDetail {
|
|
2445
2445
|
/**
|
|
2446
|
-
* @public
|
|
2447
2446
|
* <p>The unique identifier of the endpoint.</p>
|
|
2447
|
+
* @public
|
|
2448
2448
|
*/
|
|
2449
2449
|
id?: string;
|
|
2450
2450
|
/**
|
|
2451
|
-
* @public
|
|
2452
2451
|
* <p>The name of the endpoint.</p>
|
|
2452
|
+
* @public
|
|
2453
2453
|
*/
|
|
2454
2454
|
name?: string;
|
|
2455
2455
|
/**
|
|
2456
|
-
* @public
|
|
2457
2456
|
* <p>The current status of the endpoint update process.</p>
|
|
2457
|
+
* @public
|
|
2458
2458
|
*/
|
|
2459
2459
|
status?: VpcEndpointStatus;
|
|
2460
2460
|
/**
|
|
2461
|
-
* @public
|
|
2462
2461
|
* <p>The ID of the subnets from which you access OpenSearch Serverless.</p>
|
|
2462
|
+
* @public
|
|
2463
2463
|
*/
|
|
2464
2464
|
subnetIds?: string[];
|
|
2465
2465
|
/**
|
|
2466
|
-
* @public
|
|
2467
2466
|
* <p>The unique identifiers of the security groups that define the ports, protocols, and
|
|
2468
2467
|
* sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
2468
|
+
* @public
|
|
2469
2469
|
*/
|
|
2470
2470
|
securityGroupIds?: string[];
|
|
2471
2471
|
/**
|
|
2472
|
-
* @public
|
|
2473
2472
|
* <p>The timestamp of when the endpoint was last modified.</p>
|
|
2473
|
+
* @public
|
|
2474
2474
|
*/
|
|
2475
2475
|
lastModifiedDate?: number;
|
|
2476
2476
|
}
|
|
@@ -2479,8 +2479,8 @@ export interface UpdateVpcEndpointDetail {
|
|
|
2479
2479
|
*/
|
|
2480
2480
|
export interface UpdateVpcEndpointResponse {
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>Details about the updated VPC endpoint.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
UpdateVpcEndpointDetail?: UpdateVpcEndpointDetail;
|
|
2486
2486
|
}
|