@aws-sdk/client-opensearchserverless 3.858.0 → 3.862.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/index.js +173 -0
- package/dist-es/OpenSearchServerless.js +8 -0
- package/dist-es/commands/CreateIndexCommand.js +22 -0
- package/dist-es/commands/DeleteIndexCommand.js +22 -0
- package/dist-es/commands/GetIndexCommand.js +22 -0
- package/dist-es/commands/UpdateIndexCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/protocols/Aws_json1_0.js +101 -0
- package/dist-types/OpenSearchServerless.d.ts +28 -0
- package/dist-types/OpenSearchServerlessClient.d.ts +6 -2
- package/dist-types/commands/CreateCollectionCommand.d.ts +1 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +90 -0
- package/dist-types/commands/DeleteIndexCommand.d.ts +83 -0
- package/dist-types/commands/GetIndexCommand.d.ts +85 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +85 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +105 -6
- package/dist-types/protocols/Aws_json1_0.d.ts +36 -0
- package/dist-types/ts3.4/OpenSearchServerless.d.ts +68 -0
- package/dist-types/ts3.4/OpenSearchServerlessClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +24 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +48 -0
- package/package.json +33 -33
|
@@ -40,6 +40,12 @@ export const se_CreateCollectionCommand = async (input, context) => {
|
|
|
40
40
|
body = JSON.stringify(se_CreateCollectionRequest(input, context));
|
|
41
41
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
42
42
|
};
|
|
43
|
+
export const se_CreateIndexCommand = async (input, context) => {
|
|
44
|
+
const headers = sharedHeaders("CreateIndex");
|
|
45
|
+
let body;
|
|
46
|
+
body = JSON.stringify(se_CreateIndexRequest(input, context));
|
|
47
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
48
|
+
};
|
|
43
49
|
export const se_CreateLifecyclePolicyCommand = async (input, context) => {
|
|
44
50
|
const headers = sharedHeaders("CreateLifecyclePolicy");
|
|
45
51
|
let body;
|
|
@@ -76,6 +82,12 @@ export const se_DeleteCollectionCommand = async (input, context) => {
|
|
|
76
82
|
body = JSON.stringify(se_DeleteCollectionRequest(input, context));
|
|
77
83
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
78
84
|
};
|
|
85
|
+
export const se_DeleteIndexCommand = async (input, context) => {
|
|
86
|
+
const headers = sharedHeaders("DeleteIndex");
|
|
87
|
+
let body;
|
|
88
|
+
body = JSON.stringify(_json(input));
|
|
89
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
90
|
+
};
|
|
79
91
|
export const se_DeleteLifecyclePolicyCommand = async (input, context) => {
|
|
80
92
|
const headers = sharedHeaders("DeleteLifecyclePolicy");
|
|
81
93
|
let body;
|
|
@@ -112,6 +124,12 @@ export const se_GetAccountSettingsCommand = async (input, context) => {
|
|
|
112
124
|
body = JSON.stringify(_json(input));
|
|
113
125
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
114
126
|
};
|
|
127
|
+
export const se_GetIndexCommand = async (input, context) => {
|
|
128
|
+
const headers = sharedHeaders("GetIndex");
|
|
129
|
+
let body;
|
|
130
|
+
body = JSON.stringify(_json(input));
|
|
131
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
132
|
+
};
|
|
115
133
|
export const se_GetPoliciesStatsCommand = async (input, context) => {
|
|
116
134
|
const headers = sharedHeaders("GetPoliciesStats");
|
|
117
135
|
let body;
|
|
@@ -202,6 +220,12 @@ export const se_UpdateCollectionCommand = async (input, context) => {
|
|
|
202
220
|
body = JSON.stringify(se_UpdateCollectionRequest(input, context));
|
|
203
221
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
204
222
|
};
|
|
223
|
+
export const se_UpdateIndexCommand = async (input, context) => {
|
|
224
|
+
const headers = sharedHeaders("UpdateIndex");
|
|
225
|
+
let body;
|
|
226
|
+
body = JSON.stringify(se_UpdateIndexRequest(input, context));
|
|
227
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
228
|
+
};
|
|
205
229
|
export const se_UpdateLifecyclePolicyCommand = async (input, context) => {
|
|
206
230
|
const headers = sharedHeaders("UpdateLifecyclePolicy");
|
|
207
231
|
let body;
|
|
@@ -304,6 +328,19 @@ export const de_CreateCollectionCommand = async (output, context) => {
|
|
|
304
328
|
};
|
|
305
329
|
return response;
|
|
306
330
|
};
|
|
331
|
+
export const de_CreateIndexCommand = async (output, context) => {
|
|
332
|
+
if (output.statusCode >= 300) {
|
|
333
|
+
return de_CommandError(output, context);
|
|
334
|
+
}
|
|
335
|
+
const data = await parseBody(output.body, context);
|
|
336
|
+
let contents = {};
|
|
337
|
+
contents = _json(data);
|
|
338
|
+
const response = {
|
|
339
|
+
$metadata: deserializeMetadata(output),
|
|
340
|
+
...contents,
|
|
341
|
+
};
|
|
342
|
+
return response;
|
|
343
|
+
};
|
|
307
344
|
export const de_CreateLifecyclePolicyCommand = async (output, context) => {
|
|
308
345
|
if (output.statusCode >= 300) {
|
|
309
346
|
return de_CommandError(output, context);
|
|
@@ -382,6 +419,19 @@ export const de_DeleteCollectionCommand = async (output, context) => {
|
|
|
382
419
|
};
|
|
383
420
|
return response;
|
|
384
421
|
};
|
|
422
|
+
export const de_DeleteIndexCommand = async (output, context) => {
|
|
423
|
+
if (output.statusCode >= 300) {
|
|
424
|
+
return de_CommandError(output, context);
|
|
425
|
+
}
|
|
426
|
+
const data = await parseBody(output.body, context);
|
|
427
|
+
let contents = {};
|
|
428
|
+
contents = _json(data);
|
|
429
|
+
const response = {
|
|
430
|
+
$metadata: deserializeMetadata(output),
|
|
431
|
+
...contents,
|
|
432
|
+
};
|
|
433
|
+
return response;
|
|
434
|
+
};
|
|
385
435
|
export const de_DeleteLifecyclePolicyCommand = async (output, context) => {
|
|
386
436
|
if (output.statusCode >= 300) {
|
|
387
437
|
return de_CommandError(output, context);
|
|
@@ -460,6 +510,19 @@ export const de_GetAccountSettingsCommand = async (output, context) => {
|
|
|
460
510
|
};
|
|
461
511
|
return response;
|
|
462
512
|
};
|
|
513
|
+
export const de_GetIndexCommand = async (output, context) => {
|
|
514
|
+
if (output.statusCode >= 300) {
|
|
515
|
+
return de_CommandError(output, context);
|
|
516
|
+
}
|
|
517
|
+
const data = await parseBody(output.body, context);
|
|
518
|
+
let contents = {};
|
|
519
|
+
contents = de_GetIndexResponse(data, context);
|
|
520
|
+
const response = {
|
|
521
|
+
$metadata: deserializeMetadata(output),
|
|
522
|
+
...contents,
|
|
523
|
+
};
|
|
524
|
+
return response;
|
|
525
|
+
};
|
|
463
526
|
export const de_GetPoliciesStatsCommand = async (output, context) => {
|
|
464
527
|
if (output.statusCode >= 300) {
|
|
465
528
|
return de_CommandError(output, context);
|
|
@@ -655,6 +718,19 @@ export const de_UpdateCollectionCommand = async (output, context) => {
|
|
|
655
718
|
};
|
|
656
719
|
return response;
|
|
657
720
|
};
|
|
721
|
+
export const de_UpdateIndexCommand = async (output, context) => {
|
|
722
|
+
if (output.statusCode >= 300) {
|
|
723
|
+
return de_CommandError(output, context);
|
|
724
|
+
}
|
|
725
|
+
const data = await parseBody(output.body, context);
|
|
726
|
+
let contents = {};
|
|
727
|
+
contents = _json(data);
|
|
728
|
+
const response = {
|
|
729
|
+
$metadata: deserializeMetadata(output),
|
|
730
|
+
...contents,
|
|
731
|
+
};
|
|
732
|
+
return response;
|
|
733
|
+
};
|
|
658
734
|
export const de_UpdateLifecyclePolicyCommand = async (output, context) => {
|
|
659
735
|
if (output.statusCode >= 300) {
|
|
660
736
|
return de_CommandError(output, context);
|
|
@@ -814,6 +890,13 @@ const se_CreateCollectionRequest = (input, context) => {
|
|
|
814
890
|
type: [],
|
|
815
891
|
});
|
|
816
892
|
};
|
|
893
|
+
const se_CreateIndexRequest = (input, context) => {
|
|
894
|
+
return take(input, {
|
|
895
|
+
id: [],
|
|
896
|
+
indexName: [],
|
|
897
|
+
indexSchema: (_) => se_IndexSchema(_, context),
|
|
898
|
+
});
|
|
899
|
+
};
|
|
817
900
|
const se_CreateLifecyclePolicyRequest = (input, context) => {
|
|
818
901
|
return take(input, {
|
|
819
902
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
@@ -891,6 +974,9 @@ const se_DeleteVpcEndpointRequest = (input, context) => {
|
|
|
891
974
|
id: [],
|
|
892
975
|
});
|
|
893
976
|
};
|
|
977
|
+
const se_IndexSchema = (input, context) => {
|
|
978
|
+
return input;
|
|
979
|
+
};
|
|
894
980
|
const se_UpdateAccessPolicyRequest = (input, context) => {
|
|
895
981
|
return take(input, {
|
|
896
982
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
@@ -908,6 +994,13 @@ const se_UpdateCollectionRequest = (input, context) => {
|
|
|
908
994
|
id: [],
|
|
909
995
|
});
|
|
910
996
|
};
|
|
997
|
+
const se_UpdateIndexRequest = (input, context) => {
|
|
998
|
+
return take(input, {
|
|
999
|
+
id: [],
|
|
1000
|
+
indexName: [],
|
|
1001
|
+
indexSchema: (_) => se_IndexSchema(_, context),
|
|
1002
|
+
});
|
|
1003
|
+
};
|
|
911
1004
|
const se_UpdateLifecyclePolicyRequest = (input, context) => {
|
|
912
1005
|
return take(input, {
|
|
913
1006
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
@@ -986,11 +1079,19 @@ const de_GetAccessPolicyResponse = (output, context) => {
|
|
|
986
1079
|
accessPolicyDetail: (_) => de_AccessPolicyDetail(_, context),
|
|
987
1080
|
});
|
|
988
1081
|
};
|
|
1082
|
+
const de_GetIndexResponse = (output, context) => {
|
|
1083
|
+
return take(output, {
|
|
1084
|
+
indexSchema: (_) => de_IndexSchema(_, context),
|
|
1085
|
+
});
|
|
1086
|
+
};
|
|
989
1087
|
const de_GetSecurityPolicyResponse = (output, context) => {
|
|
990
1088
|
return take(output, {
|
|
991
1089
|
securityPolicyDetail: (_) => de_SecurityPolicyDetail(_, context),
|
|
992
1090
|
});
|
|
993
1091
|
};
|
|
1092
|
+
const de_IndexSchema = (output, context) => {
|
|
1093
|
+
return output;
|
|
1094
|
+
};
|
|
994
1095
|
const de_LifecyclePolicyDetail = (output, context) => {
|
|
995
1096
|
return take(output, {
|
|
996
1097
|
createdDate: __expectLong,
|
|
@@ -5,18 +5,21 @@ import { BatchGetLifecyclePolicyCommandInput, BatchGetLifecyclePolicyCommandOutp
|
|
|
5
5
|
import { BatchGetVpcEndpointCommandInput, BatchGetVpcEndpointCommandOutput } from "./commands/BatchGetVpcEndpointCommand";
|
|
6
6
|
import { CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput } from "./commands/CreateAccessPolicyCommand";
|
|
7
7
|
import { CreateCollectionCommandInput, CreateCollectionCommandOutput } from "./commands/CreateCollectionCommand";
|
|
8
|
+
import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
|
|
8
9
|
import { CreateLifecyclePolicyCommandInput, CreateLifecyclePolicyCommandOutput } from "./commands/CreateLifecyclePolicyCommand";
|
|
9
10
|
import { CreateSecurityConfigCommandInput, CreateSecurityConfigCommandOutput } from "./commands/CreateSecurityConfigCommand";
|
|
10
11
|
import { CreateSecurityPolicyCommandInput, CreateSecurityPolicyCommandOutput } from "./commands/CreateSecurityPolicyCommand";
|
|
11
12
|
import { CreateVpcEndpointCommandInput, CreateVpcEndpointCommandOutput } from "./commands/CreateVpcEndpointCommand";
|
|
12
13
|
import { DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput } from "./commands/DeleteAccessPolicyCommand";
|
|
13
14
|
import { DeleteCollectionCommandInput, DeleteCollectionCommandOutput } from "./commands/DeleteCollectionCommand";
|
|
15
|
+
import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
|
|
14
16
|
import { DeleteLifecyclePolicyCommandInput, DeleteLifecyclePolicyCommandOutput } from "./commands/DeleteLifecyclePolicyCommand";
|
|
15
17
|
import { DeleteSecurityConfigCommandInput, DeleteSecurityConfigCommandOutput } from "./commands/DeleteSecurityConfigCommand";
|
|
16
18
|
import { DeleteSecurityPolicyCommandInput, DeleteSecurityPolicyCommandOutput } from "./commands/DeleteSecurityPolicyCommand";
|
|
17
19
|
import { DeleteVpcEndpointCommandInput, DeleteVpcEndpointCommandOutput } from "./commands/DeleteVpcEndpointCommand";
|
|
18
20
|
import { GetAccessPolicyCommandInput, GetAccessPolicyCommandOutput } from "./commands/GetAccessPolicyCommand";
|
|
19
21
|
import { GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput } from "./commands/GetAccountSettingsCommand";
|
|
22
|
+
import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
|
|
20
23
|
import { GetPoliciesStatsCommandInput, GetPoliciesStatsCommandOutput } from "./commands/GetPoliciesStatsCommand";
|
|
21
24
|
import { GetSecurityConfigCommandInput, GetSecurityConfigCommandOutput } from "./commands/GetSecurityConfigCommand";
|
|
22
25
|
import { GetSecurityPolicyCommandInput, GetSecurityPolicyCommandOutput } from "./commands/GetSecurityPolicyCommand";
|
|
@@ -32,6 +35,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
32
35
|
import { UpdateAccessPolicyCommandInput, UpdateAccessPolicyCommandOutput } from "./commands/UpdateAccessPolicyCommand";
|
|
33
36
|
import { UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput } from "./commands/UpdateAccountSettingsCommand";
|
|
34
37
|
import { UpdateCollectionCommandInput, UpdateCollectionCommandOutput } from "./commands/UpdateCollectionCommand";
|
|
38
|
+
import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
|
|
35
39
|
import { UpdateLifecyclePolicyCommandInput, UpdateLifecyclePolicyCommandOutput } from "./commands/UpdateLifecyclePolicyCommand";
|
|
36
40
|
import { UpdateSecurityConfigCommandInput, UpdateSecurityConfigCommandOutput } from "./commands/UpdateSecurityConfigCommand";
|
|
37
41
|
import { UpdateSecurityPolicyCommandInput, UpdateSecurityPolicyCommandOutput } from "./commands/UpdateSecurityPolicyCommand";
|
|
@@ -75,6 +79,12 @@ export interface OpenSearchServerless {
|
|
|
75
79
|
createCollection(args: CreateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateCollectionCommandOutput>;
|
|
76
80
|
createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
77
81
|
createCollection(args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
82
|
+
/**
|
|
83
|
+
* @see {@link CreateIndexCommand}
|
|
84
|
+
*/
|
|
85
|
+
createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
|
|
86
|
+
createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
87
|
+
createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
78
88
|
/**
|
|
79
89
|
* @see {@link CreateLifecyclePolicyCommand}
|
|
80
90
|
*/
|
|
@@ -111,6 +121,12 @@ export interface OpenSearchServerless {
|
|
|
111
121
|
deleteCollection(args: DeleteCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCollectionCommandOutput>;
|
|
112
122
|
deleteCollection(args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
113
123
|
deleteCollection(args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
124
|
+
/**
|
|
125
|
+
* @see {@link DeleteIndexCommand}
|
|
126
|
+
*/
|
|
127
|
+
deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexCommandOutput>;
|
|
128
|
+
deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
129
|
+
deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
114
130
|
/**
|
|
115
131
|
* @see {@link DeleteLifecyclePolicyCommand}
|
|
116
132
|
*/
|
|
@@ -148,6 +164,12 @@ export interface OpenSearchServerless {
|
|
|
148
164
|
getAccountSettings(args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>;
|
|
149
165
|
getAccountSettings(args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
150
166
|
getAccountSettings(args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
167
|
+
/**
|
|
168
|
+
* @see {@link GetIndexCommand}
|
|
169
|
+
*/
|
|
170
|
+
getIndex(args: GetIndexCommandInput, options?: __HttpHandlerOptions): Promise<GetIndexCommandOutput>;
|
|
171
|
+
getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
|
|
172
|
+
getIndex(args: GetIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
|
|
151
173
|
/**
|
|
152
174
|
* @see {@link GetPoliciesStatsCommand}
|
|
153
175
|
*/
|
|
@@ -242,6 +264,12 @@ export interface OpenSearchServerless {
|
|
|
242
264
|
updateCollection(args: UpdateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCollectionCommandOutput>;
|
|
243
265
|
updateCollection(args: UpdateCollectionCommandInput, cb: (err: any, data?: UpdateCollectionCommandOutput) => void): void;
|
|
244
266
|
updateCollection(args: UpdateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCollectionCommandOutput) => void): void;
|
|
267
|
+
/**
|
|
268
|
+
* @see {@link UpdateIndexCommand}
|
|
269
|
+
*/
|
|
270
|
+
updateIndex(args: UpdateIndexCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIndexCommandOutput>;
|
|
271
|
+
updateIndex(args: UpdateIndexCommandInput, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void;
|
|
272
|
+
updateIndex(args: UpdateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void;
|
|
245
273
|
/**
|
|
246
274
|
* @see {@link UpdateLifecyclePolicyCommand}
|
|
247
275
|
*/
|
|
@@ -13,18 +13,21 @@ import { BatchGetLifecyclePolicyCommandInput, BatchGetLifecyclePolicyCommandOutp
|
|
|
13
13
|
import { BatchGetVpcEndpointCommandInput, BatchGetVpcEndpointCommandOutput } from "./commands/BatchGetVpcEndpointCommand";
|
|
14
14
|
import { CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput } from "./commands/CreateAccessPolicyCommand";
|
|
15
15
|
import { CreateCollectionCommandInput, CreateCollectionCommandOutput } from "./commands/CreateCollectionCommand";
|
|
16
|
+
import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
|
|
16
17
|
import { CreateLifecyclePolicyCommandInput, CreateLifecyclePolicyCommandOutput } from "./commands/CreateLifecyclePolicyCommand";
|
|
17
18
|
import { CreateSecurityConfigCommandInput, CreateSecurityConfigCommandOutput } from "./commands/CreateSecurityConfigCommand";
|
|
18
19
|
import { CreateSecurityPolicyCommandInput, CreateSecurityPolicyCommandOutput } from "./commands/CreateSecurityPolicyCommand";
|
|
19
20
|
import { CreateVpcEndpointCommandInput, CreateVpcEndpointCommandOutput } from "./commands/CreateVpcEndpointCommand";
|
|
20
21
|
import { DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput } from "./commands/DeleteAccessPolicyCommand";
|
|
21
22
|
import { DeleteCollectionCommandInput, DeleteCollectionCommandOutput } from "./commands/DeleteCollectionCommand";
|
|
23
|
+
import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
|
|
22
24
|
import { DeleteLifecyclePolicyCommandInput, DeleteLifecyclePolicyCommandOutput } from "./commands/DeleteLifecyclePolicyCommand";
|
|
23
25
|
import { DeleteSecurityConfigCommandInput, DeleteSecurityConfigCommandOutput } from "./commands/DeleteSecurityConfigCommand";
|
|
24
26
|
import { DeleteSecurityPolicyCommandInput, DeleteSecurityPolicyCommandOutput } from "./commands/DeleteSecurityPolicyCommand";
|
|
25
27
|
import { DeleteVpcEndpointCommandInput, DeleteVpcEndpointCommandOutput } from "./commands/DeleteVpcEndpointCommand";
|
|
26
28
|
import { GetAccessPolicyCommandInput, GetAccessPolicyCommandOutput } from "./commands/GetAccessPolicyCommand";
|
|
27
29
|
import { GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput } from "./commands/GetAccountSettingsCommand";
|
|
30
|
+
import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
|
|
28
31
|
import { GetPoliciesStatsCommandInput, GetPoliciesStatsCommandOutput } from "./commands/GetPoliciesStatsCommand";
|
|
29
32
|
import { GetSecurityConfigCommandInput, GetSecurityConfigCommandOutput } from "./commands/GetSecurityConfigCommand";
|
|
30
33
|
import { GetSecurityPolicyCommandInput, GetSecurityPolicyCommandOutput } from "./commands/GetSecurityPolicyCommand";
|
|
@@ -40,6 +43,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
40
43
|
import { UpdateAccessPolicyCommandInput, UpdateAccessPolicyCommandOutput } from "./commands/UpdateAccessPolicyCommand";
|
|
41
44
|
import { UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput } from "./commands/UpdateAccountSettingsCommand";
|
|
42
45
|
import { UpdateCollectionCommandInput, UpdateCollectionCommandOutput } from "./commands/UpdateCollectionCommand";
|
|
46
|
+
import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
|
|
43
47
|
import { UpdateLifecyclePolicyCommandInput, UpdateLifecyclePolicyCommandOutput } from "./commands/UpdateLifecyclePolicyCommand";
|
|
44
48
|
import { UpdateSecurityConfigCommandInput, UpdateSecurityConfigCommandOutput } from "./commands/UpdateSecurityConfigCommand";
|
|
45
49
|
import { UpdateSecurityPolicyCommandInput, UpdateSecurityPolicyCommandOutput } from "./commands/UpdateSecurityPolicyCommand";
|
|
@@ -50,11 +54,11 @@ export { __Client };
|
|
|
50
54
|
/**
|
|
51
55
|
* @public
|
|
52
56
|
*/
|
|
53
|
-
export type ServiceInputTypes = BatchGetCollectionCommandInput | BatchGetEffectiveLifecyclePolicyCommandInput | BatchGetLifecyclePolicyCommandInput | BatchGetVpcEndpointCommandInput | CreateAccessPolicyCommandInput | CreateCollectionCommandInput | CreateLifecyclePolicyCommandInput | CreateSecurityConfigCommandInput | CreateSecurityPolicyCommandInput | CreateVpcEndpointCommandInput | DeleteAccessPolicyCommandInput | DeleteCollectionCommandInput | DeleteLifecyclePolicyCommandInput | DeleteSecurityConfigCommandInput | DeleteSecurityPolicyCommandInput | DeleteVpcEndpointCommandInput | GetAccessPolicyCommandInput | GetAccountSettingsCommandInput | GetPoliciesStatsCommandInput | GetSecurityConfigCommandInput | GetSecurityPolicyCommandInput | ListAccessPoliciesCommandInput | ListCollectionsCommandInput | ListLifecyclePoliciesCommandInput | ListSecurityConfigsCommandInput | ListSecurityPoliciesCommandInput | ListTagsForResourceCommandInput | ListVpcEndpointsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAccountSettingsCommandInput | UpdateCollectionCommandInput | UpdateLifecyclePolicyCommandInput | UpdateSecurityConfigCommandInput | UpdateSecurityPolicyCommandInput | UpdateVpcEndpointCommandInput;
|
|
57
|
+
export type ServiceInputTypes = BatchGetCollectionCommandInput | BatchGetEffectiveLifecyclePolicyCommandInput | BatchGetLifecyclePolicyCommandInput | BatchGetVpcEndpointCommandInput | CreateAccessPolicyCommandInput | CreateCollectionCommandInput | CreateIndexCommandInput | CreateLifecyclePolicyCommandInput | CreateSecurityConfigCommandInput | CreateSecurityPolicyCommandInput | CreateVpcEndpointCommandInput | DeleteAccessPolicyCommandInput | DeleteCollectionCommandInput | DeleteIndexCommandInput | DeleteLifecyclePolicyCommandInput | DeleteSecurityConfigCommandInput | DeleteSecurityPolicyCommandInput | DeleteVpcEndpointCommandInput | GetAccessPolicyCommandInput | GetAccountSettingsCommandInput | GetIndexCommandInput | GetPoliciesStatsCommandInput | GetSecurityConfigCommandInput | GetSecurityPolicyCommandInput | ListAccessPoliciesCommandInput | ListCollectionsCommandInput | ListLifecyclePoliciesCommandInput | ListSecurityConfigsCommandInput | ListSecurityPoliciesCommandInput | ListTagsForResourceCommandInput | ListVpcEndpointsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAccountSettingsCommandInput | UpdateCollectionCommandInput | UpdateIndexCommandInput | UpdateLifecyclePolicyCommandInput | UpdateSecurityConfigCommandInput | UpdateSecurityPolicyCommandInput | UpdateVpcEndpointCommandInput;
|
|
54
58
|
/**
|
|
55
59
|
* @public
|
|
56
60
|
*/
|
|
57
|
-
export type ServiceOutputTypes = BatchGetCollectionCommandOutput | BatchGetEffectiveLifecyclePolicyCommandOutput | BatchGetLifecyclePolicyCommandOutput | BatchGetVpcEndpointCommandOutput | CreateAccessPolicyCommandOutput | CreateCollectionCommandOutput | CreateLifecyclePolicyCommandOutput | CreateSecurityConfigCommandOutput | CreateSecurityPolicyCommandOutput | CreateVpcEndpointCommandOutput | DeleteAccessPolicyCommandOutput | DeleteCollectionCommandOutput | DeleteLifecyclePolicyCommandOutput | DeleteSecurityConfigCommandOutput | DeleteSecurityPolicyCommandOutput | DeleteVpcEndpointCommandOutput | GetAccessPolicyCommandOutput | GetAccountSettingsCommandOutput | GetPoliciesStatsCommandOutput | GetSecurityConfigCommandOutput | GetSecurityPolicyCommandOutput | ListAccessPoliciesCommandOutput | ListCollectionsCommandOutput | ListLifecyclePoliciesCommandOutput | ListSecurityConfigsCommandOutput | ListSecurityPoliciesCommandOutput | ListTagsForResourceCommandOutput | ListVpcEndpointsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAccountSettingsCommandOutput | UpdateCollectionCommandOutput | UpdateLifecyclePolicyCommandOutput | UpdateSecurityConfigCommandOutput | UpdateSecurityPolicyCommandOutput | UpdateVpcEndpointCommandOutput;
|
|
61
|
+
export type ServiceOutputTypes = BatchGetCollectionCommandOutput | BatchGetEffectiveLifecyclePolicyCommandOutput | BatchGetLifecyclePolicyCommandOutput | BatchGetVpcEndpointCommandOutput | CreateAccessPolicyCommandOutput | CreateCollectionCommandOutput | CreateIndexCommandOutput | CreateLifecyclePolicyCommandOutput | CreateSecurityConfigCommandOutput | CreateSecurityPolicyCommandOutput | CreateVpcEndpointCommandOutput | DeleteAccessPolicyCommandOutput | DeleteCollectionCommandOutput | DeleteIndexCommandOutput | DeleteLifecyclePolicyCommandOutput | DeleteSecurityConfigCommandOutput | DeleteSecurityPolicyCommandOutput | DeleteVpcEndpointCommandOutput | GetAccessPolicyCommandOutput | GetAccountSettingsCommandOutput | GetIndexCommandOutput | GetPoliciesStatsCommandOutput | GetSecurityConfigCommandOutput | GetSecurityPolicyCommandOutput | ListAccessPoliciesCommandOutput | ListCollectionsCommandOutput | ListLifecyclePoliciesCommandOutput | ListSecurityConfigsCommandOutput | ListSecurityPoliciesCommandOutput | ListTagsForResourceCommandOutput | ListVpcEndpointsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAccountSettingsCommandOutput | UpdateCollectionCommandOutput | UpdateIndexCommandOutput | UpdateLifecyclePolicyCommandOutput | UpdateSecurityConfigCommandOutput | UpdateSecurityPolicyCommandOutput | UpdateVpcEndpointCommandOutput;
|
|
58
62
|
/**
|
|
59
63
|
* @public
|
|
60
64
|
*/
|
|
@@ -83,7 +83,7 @@ declare const CreateCollectionCommand_base: {
|
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link OcuLimitExceededException} (client fault)
|
|
85
85
|
* <p>Thrown when the collection you're attempting to create results in a number of search
|
|
86
|
-
* or indexing OCUs that exceeds the account limit
|
|
86
|
+
* or indexing OCUs that exceeds the account limit. </p>
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
89
89
|
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateIndexRequest, CreateIndexResponse } from "../models/models_0";
|
|
4
|
+
import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateIndexCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateIndexCommandInput extends CreateIndexRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateIndexCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateIndexCommand_base: {
|
|
25
|
+
new (input: CreateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIndexCommandInput, CreateIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIndexCommandInput, CreateIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes
|
|
31
|
+
* created by this API are automatically configured to conduct automatic semantic
|
|
32
|
+
* enrichment ingestion and search. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment">About automatic semantic enrichment</a> in the <i>OpenSearch User
|
|
33
|
+
* Guide</i>.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { OpenSearchServerlessClient, CreateIndexCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
|
|
38
|
+
* // const { OpenSearchServerlessClient, CreateIndexCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
|
|
39
|
+
* const client = new OpenSearchServerlessClient(config);
|
|
40
|
+
* const input = { // CreateIndexRequest
|
|
41
|
+
* id: "STRING_VALUE", // required
|
|
42
|
+
* indexName: "STRING_VALUE", // required
|
|
43
|
+
* indexSchema: "DOCUMENT_VALUE",
|
|
44
|
+
* };
|
|
45
|
+
* const command = new CreateIndexCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param CreateIndexCommandInput - {@link CreateIndexCommandInput}
|
|
52
|
+
* @returns {@link CreateIndexCommandOutput}
|
|
53
|
+
* @see {@link CreateIndexCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link CreateIndexCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ConflictException} (client fault)
|
|
58
|
+
* <p>When creating a resource, thrown when a resource with the same name already exists or
|
|
59
|
+
* is being created. When deleting a resource, thrown when the resource is not in the
|
|
60
|
+
* ACTIVE or FAILED state.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
70
|
+
* input.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link OpenSearchServerlessServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
|
|
74
|
+
*
|
|
75
|
+
*
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export declare class CreateIndexCommand extends CreateIndexCommand_base {
|
|
79
|
+
/** @internal type navigation helper, not in runtime. */
|
|
80
|
+
protected static __types: {
|
|
81
|
+
api: {
|
|
82
|
+
input: CreateIndexRequest;
|
|
83
|
+
output: {};
|
|
84
|
+
};
|
|
85
|
+
sdk: {
|
|
86
|
+
input: CreateIndexCommandInput;
|
|
87
|
+
output: CreateIndexCommandOutput;
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteIndexRequest, DeleteIndexResponse } from "../models/models_0";
|
|
4
|
+
import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteIndexCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteIndexCommandInput extends DeleteIndexRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteIndexCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteIndexCommandOutput extends DeleteIndexResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteIndexCommand_base: {
|
|
25
|
+
new (input: DeleteIndexCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIndexCommandInput, DeleteIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteIndexCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIndexCommandInput, DeleteIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be
|
|
31
|
+
* configured to conduct automatic semantic enrichment ingestion and search. For more
|
|
32
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment">About automatic semantic enrichment</a>.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OpenSearchServerlessClient, DeleteIndexCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
|
|
37
|
+
* // const { OpenSearchServerlessClient, DeleteIndexCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
|
|
38
|
+
* const client = new OpenSearchServerlessClient(config);
|
|
39
|
+
* const input = { // DeleteIndexRequest
|
|
40
|
+
* id: "STRING_VALUE", // required
|
|
41
|
+
* indexName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteIndexCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput}
|
|
50
|
+
* @returns {@link DeleteIndexCommandOutput}
|
|
51
|
+
* @see {@link DeleteIndexCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeleteIndexCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InternalServerException} (server fault)
|
|
56
|
+
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
|
+
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ValidationException} (client fault)
|
|
62
|
+
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
63
|
+
* input.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link OpenSearchServerlessServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export declare class DeleteIndexCommand extends DeleteIndexCommand_base {
|
|
72
|
+
/** @internal type navigation helper, not in runtime. */
|
|
73
|
+
protected static __types: {
|
|
74
|
+
api: {
|
|
75
|
+
input: DeleteIndexRequest;
|
|
76
|
+
output: {};
|
|
77
|
+
};
|
|
78
|
+
sdk: {
|
|
79
|
+
input: DeleteIndexCommandInput;
|
|
80
|
+
output: DeleteIndexCommandOutput;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetIndexRequest, GetIndexResponse } from "../models/models_0";
|
|
4
|
+
import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetIndexCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetIndexCommandInput extends GetIndexRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetIndexCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetIndexCommandOutput extends GetIndexResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetIndexCommand_base: {
|
|
25
|
+
new (input: GetIndexCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetIndexCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about an index in an OpenSearch Serverless collection, including its schema
|
|
31
|
+
* definition. The index might be configured to conduct automatic semantic enrichment
|
|
32
|
+
* ingestion and search. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment">About automatic semantic enrichment</a>.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OpenSearchServerlessClient, GetIndexCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
|
|
37
|
+
* // const { OpenSearchServerlessClient, GetIndexCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
|
|
38
|
+
* const client = new OpenSearchServerlessClient(config);
|
|
39
|
+
* const input = { // GetIndexRequest
|
|
40
|
+
* id: "STRING_VALUE", // required
|
|
41
|
+
* indexName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetIndexCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetIndexResponse
|
|
46
|
+
* // indexSchema: "DOCUMENT_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetIndexCommandInput - {@link GetIndexCommandInput}
|
|
52
|
+
* @returns {@link GetIndexCommandOutput}
|
|
53
|
+
* @see {@link GetIndexCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetIndexCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
65
|
+
* input.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link OpenSearchServerlessServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export declare class GetIndexCommand extends GetIndexCommand_base {
|
|
74
|
+
/** @internal type navigation helper, not in runtime. */
|
|
75
|
+
protected static __types: {
|
|
76
|
+
api: {
|
|
77
|
+
input: GetIndexRequest;
|
|
78
|
+
output: GetIndexResponse;
|
|
79
|
+
};
|
|
80
|
+
sdk: {
|
|
81
|
+
input: GetIndexCommandInput;
|
|
82
|
+
output: GetIndexCommandOutput;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
}
|