Skip to content

Commit 63bea3b

Browse files
author
awstools
committed
feat(client-opensearch): This release adds support for enabling or disabling Natural Language Query Processing feature for Amazon OpenSearch Service domains, and provides visibility into the current state of the setup or tear-down.
1 parent 07be7ea commit 63bea3b

File tree

10 files changed

+381
-0
lines changed

10 files changed

+381
-0
lines changed

‎clients/client-opensearch/src/commands/CreateDomainCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,11 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
165165
* SoftwareUpdateOptions: { // SoftwareUpdateOptions
166166
* AutoSoftwareUpdateEnabled: true || false,
167167
* },
168+
* AIMLOptions: { // AIMLOptionsInput
169+
* NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsInput
170+
* DesiredState: "ENABLED" || "DISABLED",
171+
* },
172+
* },
168173
* };
169174
* const command = new CreateDomainCommand(input);
170175
* const response = await client.send(command);
@@ -321,6 +326,12 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
321326
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
322327
* // },
323328
* // ],
329+
* // AIMLOptions: { // AIMLOptionsOutput
330+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
331+
* // DesiredState: "ENABLED" || "DISABLED",
332+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
333+
* // },
334+
* // },
324335
* // },
325336
* // };
326337
*

‎clients/client-opensearch/src/commands/DeleteDomainCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
194194
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
195195
* // },
196196
* // ],
197+
* // AIMLOptions: { // AIMLOptionsOutput
198+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
199+
* // DesiredState: "ENABLED" || "DISABLED",
200+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
201+
* // },
202+
* // },
197203
* // },
198204
* // };
199205
*

‎clients/client-opensearch/src/commands/DescribeDomainCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
194194
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
195195
* // },
196196
* // ],
197+
* // AIMLOptions: { // AIMLOptionsOutput
198+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
199+
* // DesiredState: "ENABLED" || "DISABLED",
200+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
201+
* // },
202+
* // },
197203
* // },
198204
* // };
199205
*

‎clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,15 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
267267
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
268268
* // },
269269
* // ],
270+
* // AIMLOptions: { // AIMLOptionsStatus
271+
* // Options: { // AIMLOptionsOutput
272+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
273+
* // DesiredState: "ENABLED" || "DISABLED",
274+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
275+
* // },
276+
* // },
277+
* // Status: "<OptionStatus>",
278+
* // },
270279
* // },
271280
* // };
272281
*

‎clients/client-opensearch/src/commands/DescribeDomainsCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,12 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
197197
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
198198
* // },
199199
* // ],
200+
* // AIMLOptions: { // AIMLOptionsOutput
201+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
202+
* // DesiredState: "ENABLED" || "DISABLED",
203+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
204+
* // },
205+
* // },
200206
* // },
201207
* // ],
202208
* // };

‎clients/client-opensearch/src/commands/DescribeDryRunProgressCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,12 @@ export interface DescribeDryRunProgressCommandOutput extends DescribeDryRunProgr
208208
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
209209
* // },
210210
* // ],
211+
* // AIMLOptions: { // AIMLOptionsOutput
212+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
213+
* // DesiredState: "ENABLED" || "DISABLED",
214+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
215+
* // },
216+
* // },
211217
* // },
212218
* // DryRunResults: { // DryRunResults
213219
* // DeploymentType: "STRING_VALUE",

‎clients/client-opensearch/src/commands/UpdateDomainConfigCommand.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,11 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo
166166
* SoftwareUpdateOptions: { // SoftwareUpdateOptions
167167
* AutoSoftwareUpdateEnabled: true || false,
168168
* },
169+
* AIMLOptions: { // AIMLOptionsInput
170+
* NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsInput
171+
* DesiredState: "ENABLED" || "DISABLED",
172+
* },
173+
* },
169174
* };
170175
* const command = new UpdateDomainConfigCommand(input);
171176
* const response = await client.send(command);
@@ -396,6 +401,15 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo
396401
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
397402
* // },
398403
* // ],
404+
* // AIMLOptions: { // AIMLOptionsStatus
405+
* // Options: { // AIMLOptionsOutput
406+
* // NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
407+
* // DesiredState: "ENABLED" || "DISABLED",
408+
* // CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
409+
* // },
410+
* // },
411+
* // Status: "<OptionStatus>",
412+
* // },
399413
* // },
400414
* // DryRunResults: { // DryRunResults
401415
* // DeploymentType: "STRING_VALUE",

‎clients/client-opensearch/src/models/models_0.ts

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -989,6 +989,113 @@ export interface AdvancedSecurityOptionsStatus {
989989
Status: OptionStatus | undefined;
990990
}
991991

992+
/**
993+
* @public
994+
* @enum
995+
*/
996+
export const NaturalLanguageQueryGenerationDesiredState = {
997+
Disabled: "DISABLED",
998+
Enabled: "ENABLED",
999+
} as const;
1000+
1001+
/**
1002+
* @public
1003+
*/
1004+
export type NaturalLanguageQueryGenerationDesiredState =
1005+
(typeof NaturalLanguageQueryGenerationDesiredState)[keyof typeof NaturalLanguageQueryGenerationDesiredState];
1006+
1007+
/**
1008+
* <p>Container for parameters required to enable the natural language query generation feature.</p>
1009+
* @public
1010+
*/
1011+
export interface NaturalLanguageQueryGenerationOptionsInput {
1012+
/**
1013+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
1014+
* @public
1015+
*/
1016+
DesiredState?: NaturalLanguageQueryGenerationDesiredState;
1017+
}
1018+
1019+
/**
1020+
* <p>Container for parameters required to enable all machine learning features.</p>
1021+
* @public
1022+
*/
1023+
export interface AIMLOptionsInput {
1024+
/**
1025+
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
1026+
* @public
1027+
*/
1028+
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput;
1029+
}
1030+
1031+
/**
1032+
* @public
1033+
* @enum
1034+
*/
1035+
export const NaturalLanguageQueryGenerationCurrentState = {
1036+
DisableComplete: "DISABLE_COMPLETE",
1037+
DisableFailed: "DISABLE_FAILED",
1038+
DisableInProgress: "DISABLE_IN_PROGRESS",
1039+
EnableComplete: "ENABLE_COMPLETE",
1040+
EnableFailed: "ENABLE_FAILED",
1041+
EnableInProgress: "ENABLE_IN_PROGRESS",
1042+
NotEnabled: "NOT_ENABLED",
1043+
} as const;
1044+
1045+
/**
1046+
* @public
1047+
*/
1048+
export type NaturalLanguageQueryGenerationCurrentState =
1049+
(typeof NaturalLanguageQueryGenerationCurrentState)[keyof typeof NaturalLanguageQueryGenerationCurrentState];
1050+
1051+
/**
1052+
* <p>Container for parameters representing the state of the natural language query generation feature on the specified domain.</p>
1053+
* @public
1054+
*/
1055+
export interface NaturalLanguageQueryGenerationOptionsOutput {
1056+
/**
1057+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
1058+
* @public
1059+
*/
1060+
DesiredState?: NaturalLanguageQueryGenerationDesiredState;
1061+
1062+
/**
1063+
* <p>The current state of the natural language query generation feature, indicating completion, in progress, or failure.</p>
1064+
* @public
1065+
*/
1066+
CurrentState?: NaturalLanguageQueryGenerationCurrentState;
1067+
}
1068+
1069+
/**
1070+
* <p>Container for parameters representing the state of machine learning features on the specified domain.</p>
1071+
* @public
1072+
*/
1073+
export interface AIMLOptionsOutput {
1074+
/**
1075+
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
1076+
* @public
1077+
*/
1078+
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput;
1079+
}
1080+
1081+
/**
1082+
* <p>The status of machine learning options on the specified domain.</p>
1083+
* @public
1084+
*/
1085+
export interface AIMLOptionsStatus {
1086+
/**
1087+
* <p>Machine learning options on the specified domain.</p>
1088+
* @public
1089+
*/
1090+
Options?: AIMLOptionsOutput;
1091+
1092+
/**
1093+
* <p>Provides the current status of an entity.</p>
1094+
* @public
1095+
*/
1096+
Status?: OptionStatus;
1097+
}
1098+
9921099
/**
9931100
* <p>Container for the request parameters to the <code>AssociatePackage</code> operation.</p>
9941101
* @public
@@ -2252,6 +2359,12 @@ export interface CreateDomainRequest {
22522359
* @public
22532360
*/
22542361
SoftwareUpdateOptions?: SoftwareUpdateOptions;
2362+
2363+
/**
2364+
* <p>Options for all machine learning features for the specified domain.</p>
2365+
* @public
2366+
*/
2367+
AIMLOptions?: AIMLOptionsInput;
22552368
}
22562369

22572370
/**
@@ -2709,6 +2822,12 @@ export interface DomainStatus {
27092822
* @public
27102823
*/
27112824
ModifyingProperties?: ModifyingProperties[];
2825+
2826+
/**
2827+
* <p>Container for parameters required to enable all machine learning features.</p>
2828+
* @public
2829+
*/
2830+
AIMLOptions?: AIMLOptionsOutput;
27122831
}
27132832

27142833
/**
@@ -4314,6 +4433,12 @@ export interface DomainConfig {
43144433
* @public
43154434
*/
43164435
ModifyingProperties?: ModifyingProperties[];
4436+
4437+
/**
4438+
* <p>Container for parameters required to enable all machine learning features.</p>
4439+
* @public
4440+
*/
4441+
AIMLOptions?: AIMLOptionsStatus;
43174442
}
43184443

43194444
/**
@@ -7330,6 +7455,12 @@ export interface UpdateDomainConfigRequest {
73307455
* @public
73317456
*/
73327457
SoftwareUpdateOptions?: SoftwareUpdateOptions;
7458+
7459+
/**
7460+
* <p>Options for all machine learning features for the specified domain.</p>
7461+
* @public
7462+
*/
7463+
AIMLOptions?: AIMLOptionsInput;
73337464
}
73347465

73357466
/**

‎clients/client-opensearch/src/protocols/Aws_restJson1.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@ import {
207207
AdvancedSecurityOptions,
208208
AdvancedSecurityOptionsInput,
209209
AdvancedSecurityOptionsStatus,
210+
AIMLOptionsInput,
211+
AIMLOptionsStatus,
210212
AutoTune,
211213
AutoTuneDetails,
212214
AutoTuneMaintenanceSchedule,
@@ -254,6 +256,7 @@ import {
254256
LogPublishingOptionsStatus,
255257
LogType,
256258
MasterUserOptions,
259+
NaturalLanguageQueryGenerationOptionsInput,
257260
NodeToNodeEncryptionOptions,
258261
NodeToNodeEncryptionOptionsStatus,
259262
OffPeakWindow,
@@ -454,6 +457,7 @@ export const se_CreateDomainCommand = async (
454457
let body: any;
455458
body = JSON.stringify(
456459
take(input, {
460+
AIMLOptions: (_) => _json(_),
457461
AccessPolicies: [],
458462
AdvancedOptions: (_) => _json(_),
459463
AdvancedSecurityOptions: (_) => _json(_),
@@ -1489,6 +1493,7 @@ export const se_UpdateDomainConfigCommand = async (
14891493
let body: any;
14901494
body = JSON.stringify(
14911495
take(input, {
1496+
AIMLOptions: (_) => _json(_),
14921497
AccessPolicies: [],
14931498
AdvancedOptions: (_) => _json(_),
14941499
AdvancedSecurityOptions: (_) => _json(_),
@@ -3295,6 +3300,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont
32953300

32963301
// se_AdvancedSecurityOptionsInput omitted.
32973302

3303+
// se_AIMLOptionsInput omitted.
3304+
32983305
/**
32993306
* serializeAws_restJson1AutoTuneMaintenanceSchedule
33003307
*/
@@ -3384,6 +3391,8 @@ const se_AutoTuneOptionsInput = (input: AutoTuneOptionsInput, context: __SerdeCo
33843391

33853392
// se_MasterUserOptions omitted.
33863393

3394+
// se_NaturalLanguageQueryGenerationOptionsInput omitted.
3395+
33873396
// se_NodeToNodeEncryptionOptions omitted.
33883397

33893398
// se_OffPeakWindow omitted.
@@ -3468,6 +3477,18 @@ const de_AdvancedSecurityOptionsStatus = (output: any, context: __SerdeContext):
34683477
}) as any;
34693478
};
34703479

3480+
// de_AIMLOptionsOutput omitted.
3481+
3482+
/**
3483+
* deserializeAws_restJson1AIMLOptionsStatus
3484+
*/
3485+
const de_AIMLOptionsStatus = (output: any, context: __SerdeContext): AIMLOptionsStatus => {
3486+
return take(output, {
3487+
Options: _json,
3488+
Status: (_: any) => de_OptionStatus(_, context),
3489+
}) as any;
3490+
};
3491+
34713492
// de_AuthorizedPrincipal omitted.
34723493

34733494
// de_AuthorizedPrincipalList omitted.
@@ -3677,6 +3698,7 @@ const de_CognitoOptionsStatus = (output: any, context: __SerdeContext): CognitoO
36773698
*/
36783699
const de_DomainConfig = (output: any, context: __SerdeContext): DomainConfig => {
36793700
return take(output, {
3701+
AIMLOptions: (_: any) => de_AIMLOptionsStatus(_, context),
36803702
AccessPolicies: (_: any) => de_AccessPoliciesStatus(_, context),
36813703
AdvancedOptions: (_: any) => de_AdvancedOptionsStatus(_, context),
36823704
AdvancedSecurityOptions: (_: any) => de_AdvancedSecurityOptionsStatus(_, context),
@@ -3783,6 +3805,7 @@ const de_DomainPackageDetailsList = (output: any, context: __SerdeContext): Doma
37833805
*/
37843806
const de_DomainStatus = (output: any, context: __SerdeContext): DomainStatus => {
37853807
return take(output, {
3808+
AIMLOptions: _json,
37863809
ARN: __expectString,
37873810
AccessPolicies: __expectString,
37883811
AdvancedOptions: _json,
@@ -3924,6 +3947,8 @@ const de_LogPublishingOptionsStatus = (output: any, context: __SerdeContext): Lo
39243947

39253948
// de_ModifyingPropertiesList omitted.
39263949

3950+
// de_NaturalLanguageQueryGenerationOptionsOutput omitted.
3951+
39273952
// de_NodeToNodeEncryptionOptions omitted.
39283953

39293954
/**

0 commit comments

Comments
 (0)