Skip to content

Commit ec14d7a

Browse files
author
awstools
committed
feat(client-opensearch): This release introduces the new OpenSearch user interface (Dashboards), a new web-based application that can be associated with multiple data sources across OpenSearch managed clusters, serverless collections, and Amazon S3, so that users can gain a comprehensive insights in an unified interface.
1 parent a680861 commit ec14d7a

33 files changed

+3654
-701
lines changed

clients/client-opensearch/README.md

+47-7
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ using your favorite package manager:
2727

2828
The AWS SDK is modulized by clients and commands.
2929
To send a request, you only need to import the `OpenSearchClient` and
30-
the commands you need, for example `ListDomainNamesCommand`:
30+
the commands you need, for example `ListApplicationsCommand`:
3131

3232
```js
3333
// ES5 example
34-
const { OpenSearchClient, ListDomainNamesCommand } = require("@aws-sdk/client-opensearch");
34+
const { OpenSearchClient, ListApplicationsCommand } = require("@aws-sdk/client-opensearch");
3535
```
3636

3737
```ts
3838
// ES6+ example
39-
import { OpenSearchClient, ListDomainNamesCommand } from "@aws-sdk/client-opensearch";
39+
import { OpenSearchClient, ListApplicationsCommand } from "@aws-sdk/client-opensearch";
4040
```
4141

4242
### Usage
@@ -55,7 +55,7 @@ const client = new OpenSearchClient({ region: "REGION" });
5555
const params = {
5656
/** input parameters */
5757
};
58-
const command = new ListDomainNamesCommand(params);
58+
const command = new ListApplicationsCommand(params);
5959
```
6060

6161
#### Async/await
@@ -134,15 +134,15 @@ const client = new AWS.OpenSearch({ region: "REGION" });
134134

135135
// async/await.
136136
try {
137-
const data = await client.listDomainNames(params);
137+
const data = await client.listApplications(params);
138138
// process data.
139139
} catch (error) {
140140
// error handling.
141141
}
142142

143143
// Promises.
144144
client
145-
.listDomainNames(params)
145+
.listApplications(params)
146146
.then((data) => {
147147
// process data.
148148
})
@@ -151,7 +151,7 @@ client
151151
});
152152

153153
// callbacks.
154-
client.listDomainNames(params, (err, data) => {
154+
client.listApplications(params, (err, data) => {
155155
// process err and data.
156156
});
157157
```
@@ -262,6 +262,14 @@ CancelServiceSoftwareUpdate
262262

263263
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/CancelServiceSoftwareUpdateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CancelServiceSoftwareUpdateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CancelServiceSoftwareUpdateCommandOutput/)
264264

265+
</details>
266+
<details>
267+
<summary>
268+
CreateApplication
269+
</summary>
270+
271+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/CreateApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CreateApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CreateApplicationCommandOutput/)
272+
265273
</details>
266274
<details>
267275
<summary>
@@ -294,6 +302,14 @@ CreateVpcEndpoint
294302

295303
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/CreateVpcEndpointCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CreateVpcEndpointCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CreateVpcEndpointCommandOutput/)
296304

305+
</details>
306+
<details>
307+
<summary>
308+
DeleteApplication
309+
</summary>
310+
311+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/DeleteApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/DeleteApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/DeleteApplicationCommandOutput/)
312+
297313
</details>
298314
<details>
299315
<summary>
@@ -470,6 +486,14 @@ DissociatePackage
470486

471487
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/DissociatePackageCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/DissociatePackageCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/DissociatePackageCommandOutput/)
472488

489+
</details>
490+
<details>
491+
<summary>
492+
GetApplication
493+
</summary>
494+
495+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/GetApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetApplicationCommandOutput/)
496+
473497
</details>
474498
<details>
475499
<summary>
@@ -518,6 +542,14 @@ GetUpgradeStatus
518542

519543
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/GetUpgradeStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetUpgradeStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetUpgradeStatusCommandOutput/)
520544

545+
</details>
546+
<details>
547+
<summary>
548+
ListApplications
549+
</summary>
550+
551+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/ListApplicationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/ListApplicationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/ListApplicationsCommandOutput/)
552+
521553
</details>
522554
<details>
523555
<summary>
@@ -662,6 +694,14 @@ StartServiceSoftwareUpdate
662694

663695
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/StartServiceSoftwareUpdateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/StartServiceSoftwareUpdateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/StartServiceSoftwareUpdateCommandOutput/)
664696

697+
</details>
698+
<details>
699+
<summary>
700+
UpdateApplication
701+
</summary>
702+
703+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/UpdateApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/UpdateApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/UpdateApplicationCommandOutput/)
704+
665705
</details>
666706
<details>
667707
<summary>

clients/client-opensearch/package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@
5858
"@smithy/util-middleware": "^3.0.7",
5959
"@smithy/util-retry": "^3.0.7",
6060
"@smithy/util-utf8": "^3.0.0",
61-
"tslib": "^2.6.2"
61+
"@types/uuid": "^9.0.1",
62+
"tslib": "^2.6.2",
63+
"uuid": "^9.0.1"
6264
},
6365
"devDependencies": {
6466
"@tsconfig/node16": "16.1.3",

clients/client-opensearch/src/OpenSearch.ts

+113
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ import {
3333
CancelServiceSoftwareUpdateCommandInput,
3434
CancelServiceSoftwareUpdateCommandOutput,
3535
} from "./commands/CancelServiceSoftwareUpdateCommand";
36+
import {
37+
CreateApplicationCommand,
38+
CreateApplicationCommandInput,
39+
CreateApplicationCommandOutput,
40+
} from "./commands/CreateApplicationCommand";
3641
import {
3742
CreateDomainCommand,
3843
CreateDomainCommandInput,
@@ -53,6 +58,11 @@ import {
5358
CreateVpcEndpointCommandInput,
5459
CreateVpcEndpointCommandOutput,
5560
} from "./commands/CreateVpcEndpointCommand";
61+
import {
62+
DeleteApplicationCommand,
63+
DeleteApplicationCommandInput,
64+
DeleteApplicationCommandOutput,
65+
} from "./commands/DeleteApplicationCommand";
5666
import {
5767
DeleteDataSourceCommand,
5868
DeleteDataSourceCommandInput,
@@ -163,6 +173,11 @@ import {
163173
DissociatePackageCommandInput,
164174
DissociatePackageCommandOutput,
165175
} from "./commands/DissociatePackageCommand";
176+
import {
177+
GetApplicationCommand,
178+
GetApplicationCommandInput,
179+
GetApplicationCommandOutput,
180+
} from "./commands/GetApplicationCommand";
166181
import {
167182
GetCompatibleVersionsCommand,
168183
GetCompatibleVersionsCommandInput,
@@ -193,6 +208,11 @@ import {
193208
GetUpgradeStatusCommandInput,
194209
GetUpgradeStatusCommandOutput,
195210
} from "./commands/GetUpgradeStatusCommand";
211+
import {
212+
ListApplicationsCommand,
213+
ListApplicationsCommandInput,
214+
ListApplicationsCommandOutput,
215+
} from "./commands/ListApplicationsCommand";
196216
import {
197217
ListDataSourcesCommand,
198218
ListDataSourcesCommandInput,
@@ -275,6 +295,11 @@ import {
275295
StartServiceSoftwareUpdateCommandInput,
276296
StartServiceSoftwareUpdateCommandOutput,
277297
} from "./commands/StartServiceSoftwareUpdateCommand";
298+
import {
299+
UpdateApplicationCommand,
300+
UpdateApplicationCommandInput,
301+
UpdateApplicationCommandOutput,
302+
} from "./commands/UpdateApplicationCommand";
278303
import {
279304
UpdateDataSourceCommand,
280305
UpdateDataSourceCommandInput,
@@ -315,10 +340,12 @@ const commands = {
315340
AuthorizeVpcEndpointAccessCommand,
316341
CancelDomainConfigChangeCommand,
317342
CancelServiceSoftwareUpdateCommand,
343+
CreateApplicationCommand,
318344
CreateDomainCommand,
319345
CreateOutboundConnectionCommand,
320346
CreatePackageCommand,
321347
CreateVpcEndpointCommand,
348+
DeleteApplicationCommand,
322349
DeleteDataSourceCommand,
323350
DeleteDomainCommand,
324351
DeleteInboundConnectionCommand,
@@ -341,12 +368,14 @@ const commands = {
341368
DescribeReservedInstancesCommand,
342369
DescribeVpcEndpointsCommand,
343370
DissociatePackageCommand,
371+
GetApplicationCommand,
344372
GetCompatibleVersionsCommand,
345373
GetDataSourceCommand,
346374
GetDomainMaintenanceStatusCommand,
347375
GetPackageVersionHistoryCommand,
348376
GetUpgradeHistoryCommand,
349377
GetUpgradeStatusCommand,
378+
ListApplicationsCommand,
350379
ListDataSourcesCommand,
351380
ListDomainMaintenancesCommand,
352381
ListDomainNamesCommand,
@@ -365,6 +394,7 @@ const commands = {
365394
RevokeVpcEndpointAccessCommand,
366395
StartDomainMaintenanceCommand,
367396
StartServiceSoftwareUpdateCommand,
397+
UpdateApplicationCommand,
368398
UpdateDataSourceCommand,
369399
UpdateDomainConfigCommand,
370400
UpdatePackageCommand,
@@ -481,6 +511,23 @@ export interface OpenSearch {
481511
cb: (err: any, data?: CancelServiceSoftwareUpdateCommandOutput) => void
482512
): void;
483513

514+
/**
515+
* @see {@link CreateApplicationCommand}
516+
*/
517+
createApplication(
518+
args: CreateApplicationCommandInput,
519+
options?: __HttpHandlerOptions
520+
): Promise<CreateApplicationCommandOutput>;
521+
createApplication(
522+
args: CreateApplicationCommandInput,
523+
cb: (err: any, data?: CreateApplicationCommandOutput) => void
524+
): void;
525+
createApplication(
526+
args: CreateApplicationCommandInput,
527+
options: __HttpHandlerOptions,
528+
cb: (err: any, data?: CreateApplicationCommandOutput) => void
529+
): void;
530+
484531
/**
485532
* @see {@link CreateDomainCommand}
486533
*/
@@ -537,6 +584,23 @@ export interface OpenSearch {
537584
cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void
538585
): void;
539586

587+
/**
588+
* @see {@link DeleteApplicationCommand}
589+
*/
590+
deleteApplication(
591+
args: DeleteApplicationCommandInput,
592+
options?: __HttpHandlerOptions
593+
): Promise<DeleteApplicationCommandOutput>;
594+
deleteApplication(
595+
args: DeleteApplicationCommandInput,
596+
cb: (err: any, data?: DeleteApplicationCommandOutput) => void
597+
): void;
598+
deleteApplication(
599+
args: DeleteApplicationCommandInput,
600+
options: __HttpHandlerOptions,
601+
cb: (err: any, data?: DeleteApplicationCommandOutput) => void
602+
): void;
603+
540604
/**
541605
* @see {@link DeleteDataSourceCommand}
542606
*/
@@ -898,6 +962,20 @@ export interface OpenSearch {
898962
cb: (err: any, data?: DissociatePackageCommandOutput) => void
899963
): void;
900964

965+
/**
966+
* @see {@link GetApplicationCommand}
967+
*/
968+
getApplication(
969+
args: GetApplicationCommandInput,
970+
options?: __HttpHandlerOptions
971+
): Promise<GetApplicationCommandOutput>;
972+
getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void;
973+
getApplication(
974+
args: GetApplicationCommandInput,
975+
options: __HttpHandlerOptions,
976+
cb: (err: any, data?: GetApplicationCommandOutput) => void
977+
): void;
978+
901979
/**
902980
* @see {@link GetCompatibleVersionsCommand}
903981
*/
@@ -995,6 +1073,24 @@ export interface OpenSearch {
9951073
cb: (err: any, data?: GetUpgradeStatusCommandOutput) => void
9961074
): void;
9971075

1076+
/**
1077+
* @see {@link ListApplicationsCommand}
1078+
*/
1079+
listApplications(): Promise<ListApplicationsCommandOutput>;
1080+
listApplications(
1081+
args: ListApplicationsCommandInput,
1082+
options?: __HttpHandlerOptions
1083+
): Promise<ListApplicationsCommandOutput>;
1084+
listApplications(
1085+
args: ListApplicationsCommandInput,
1086+
cb: (err: any, data?: ListApplicationsCommandOutput) => void
1087+
): void;
1088+
listApplications(
1089+
args: ListApplicationsCommandInput,
1090+
options: __HttpHandlerOptions,
1091+
cb: (err: any, data?: ListApplicationsCommandOutput) => void
1092+
): void;
1093+
9981094
/**
9991095
* @see {@link ListDataSourcesCommand}
10001096
*/
@@ -1280,6 +1376,23 @@ export interface OpenSearch {
12801376
cb: (err: any, data?: StartServiceSoftwareUpdateCommandOutput) => void
12811377
): void;
12821378

1379+
/**
1380+
* @see {@link UpdateApplicationCommand}
1381+
*/
1382+
updateApplication(
1383+
args: UpdateApplicationCommandInput,
1384+
options?: __HttpHandlerOptions
1385+
): Promise<UpdateApplicationCommandOutput>;
1386+
updateApplication(
1387+
args: UpdateApplicationCommandInput,
1388+
cb: (err: any, data?: UpdateApplicationCommandOutput) => void
1389+
): void;
1390+
updateApplication(
1391+
args: UpdateApplicationCommandInput,
1392+
options: __HttpHandlerOptions,
1393+
cb: (err: any, data?: UpdateApplicationCommandOutput) => void
1394+
): void;
1395+
12831396
/**
12841397
* @see {@link UpdateDataSourceCommand}
12851398
*/

0 commit comments

Comments
 (0)