Skip to content

Commit ea5f4e4

Browse files
author
awstools
committed
feat(client-opensearch): This release introduces the Default Application feature, allowing users to set, change, or unset a preferred OpenSearch UI application on a per-region basis for a streamlined and consistent user experience.
1 parent f46fcf1 commit ea5f4e4

File tree

70 files changed

+2353
-1654
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+2353
-1654
lines changed

clients/client-opensearch/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
AWS SDK for JavaScript OpenSearch Client for Node.js, Browser and React Native.
88

99
<p>Use the Amazon OpenSearch Service configuration API to create, configure, and manage
10-
OpenSearch Service domains. The endpoint for configuration service requests is Region specific:
11-
es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a
12-
current list of supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service
13-
endpoints</a>.</p>
10+
OpenSearch Service domains. The endpoint for configuration service requests is Region
11+
specific: es.<i>region</i>.amazonaws.com. For example,
12+
es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see
13+
<a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service endpoints</a>.</p>
1414

1515
## Installing
1616

@@ -542,6 +542,14 @@ GetDataSource
542542

543543
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/GetDataSourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetDataSourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetDataSourceCommandOutput/)
544544

545+
</details>
546+
<details>
547+
<summary>
548+
GetDefaultApplicationSetting
549+
</summary>
550+
551+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/GetDefaultApplicationSettingCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetDefaultApplicationSettingCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/GetDefaultApplicationSettingCommandOutput/)
552+
545553
</details>
546554
<details>
547555
<summary>
@@ -702,6 +710,14 @@ PurchaseReservedInstanceOffering
702710

703711
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/PurchaseReservedInstanceOfferingCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/PurchaseReservedInstanceOfferingCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/PurchaseReservedInstanceOfferingCommandOutput/)
704712

713+
</details>
714+
<details>
715+
<summary>
716+
PutDefaultApplicationSetting
717+
</summary>
718+
719+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/PutDefaultApplicationSettingCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/PutDefaultApplicationSettingCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/PutDefaultApplicationSettingCommandOutput/)
720+
705721
</details>
706722
<details>
707723
<summary>

clients/client-opensearch/src/OpenSearch.ts

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,11 @@ import {
208208
GetDataSourceCommandInput,
209209
GetDataSourceCommandOutput,
210210
} from "./commands/GetDataSourceCommand";
211+
import {
212+
GetDefaultApplicationSettingCommand,
213+
GetDefaultApplicationSettingCommandInput,
214+
GetDefaultApplicationSettingCommandOutput,
215+
} from "./commands/GetDefaultApplicationSettingCommand";
211216
import {
212217
GetDirectQueryDataSourceCommand,
213218
GetDirectQueryDataSourceCommandInput,
@@ -304,6 +309,11 @@ import {
304309
PurchaseReservedInstanceOfferingCommandInput,
305310
PurchaseReservedInstanceOfferingCommandOutput,
306311
} from "./commands/PurchaseReservedInstanceOfferingCommand";
312+
import {
313+
PutDefaultApplicationSettingCommand,
314+
PutDefaultApplicationSettingCommandInput,
315+
PutDefaultApplicationSettingCommandOutput,
316+
} from "./commands/PutDefaultApplicationSettingCommand";
307317
import {
308318
RejectInboundConnectionCommand,
309319
RejectInboundConnectionCommandInput,
@@ -415,6 +425,7 @@ const commands = {
415425
GetApplicationCommand,
416426
GetCompatibleVersionsCommand,
417427
GetDataSourceCommand,
428+
GetDefaultApplicationSettingCommand,
418429
GetDirectQueryDataSourceCommand,
419430
GetDomainMaintenanceStatusCommand,
420431
GetPackageVersionHistoryCommand,
@@ -435,6 +446,7 @@ const commands = {
435446
ListVpcEndpointsCommand,
436447
ListVpcEndpointsForDomainCommand,
437448
PurchaseReservedInstanceOfferingCommand,
449+
PutDefaultApplicationSettingCommand,
438450
RejectInboundConnectionCommand,
439451
RemoveTagsCommand,
440452
RevokeVpcEndpointAccessCommand,
@@ -1121,6 +1133,24 @@ export interface OpenSearch {
11211133
cb: (err: any, data?: GetDataSourceCommandOutput) => void
11221134
): void;
11231135

1136+
/**
1137+
* @see {@link GetDefaultApplicationSettingCommand}
1138+
*/
1139+
getDefaultApplicationSetting(): Promise<GetDefaultApplicationSettingCommandOutput>;
1140+
getDefaultApplicationSetting(
1141+
args: GetDefaultApplicationSettingCommandInput,
1142+
options?: __HttpHandlerOptions
1143+
): Promise<GetDefaultApplicationSettingCommandOutput>;
1144+
getDefaultApplicationSetting(
1145+
args: GetDefaultApplicationSettingCommandInput,
1146+
cb: (err: any, data?: GetDefaultApplicationSettingCommandOutput) => void
1147+
): void;
1148+
getDefaultApplicationSetting(
1149+
args: GetDefaultApplicationSettingCommandInput,
1150+
options: __HttpHandlerOptions,
1151+
cb: (err: any, data?: GetDefaultApplicationSettingCommandOutput) => void
1152+
): void;
1153+
11241154
/**
11251155
* @see {@link GetDirectQueryDataSourceCommand}
11261156
*/
@@ -1448,6 +1478,23 @@ export interface OpenSearch {
14481478
cb: (err: any, data?: PurchaseReservedInstanceOfferingCommandOutput) => void
14491479
): void;
14501480

1481+
/**
1482+
* @see {@link PutDefaultApplicationSettingCommand}
1483+
*/
1484+
putDefaultApplicationSetting(
1485+
args: PutDefaultApplicationSettingCommandInput,
1486+
options?: __HttpHandlerOptions
1487+
): Promise<PutDefaultApplicationSettingCommandOutput>;
1488+
putDefaultApplicationSetting(
1489+
args: PutDefaultApplicationSettingCommandInput,
1490+
cb: (err: any, data?: PutDefaultApplicationSettingCommandOutput) => void
1491+
): void;
1492+
putDefaultApplicationSetting(
1493+
args: PutDefaultApplicationSettingCommandInput,
1494+
options: __HttpHandlerOptions,
1495+
cb: (err: any, data?: PutDefaultApplicationSettingCommandOutput) => void
1496+
): void;
1497+
14511498
/**
14521499
* @see {@link RejectInboundConnectionCommand}
14531500
*/
@@ -1671,10 +1718,10 @@ export interface OpenSearch {
16711718

16721719
/**
16731720
* <p>Use the Amazon OpenSearch Service configuration API to create, configure, and manage
1674-
* OpenSearch Service domains. The endpoint for configuration service requests is Region specific:
1675-
* es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a
1676-
* current list of supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service
1677-
* endpoints</a>.</p>
1721+
* OpenSearch Service domains. The endpoint for configuration service requests is Region
1722+
* specific: es.<i>region</i>.amazonaws.com. For example,
1723+
* es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see
1724+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service endpoints</a>.</p>
16781725
* @public
16791726
*/
16801727
export class OpenSearch extends OpenSearchClient implements OpenSearch {}

clients/client-opensearch/src/OpenSearchClient.ts

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,10 @@ import {
161161
GetCompatibleVersionsCommandOutput,
162162
} from "./commands/GetCompatibleVersionsCommand";
163163
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
164+
import {
165+
GetDefaultApplicationSettingCommandInput,
166+
GetDefaultApplicationSettingCommandOutput,
167+
} from "./commands/GetDefaultApplicationSettingCommand";
164168
import {
165169
GetDirectQueryDataSourceCommandInput,
166170
GetDirectQueryDataSourceCommandOutput,
@@ -217,6 +221,10 @@ import {
217221
PurchaseReservedInstanceOfferingCommandInput,
218222
PurchaseReservedInstanceOfferingCommandOutput,
219223
} from "./commands/PurchaseReservedInstanceOfferingCommand";
224+
import {
225+
PutDefaultApplicationSettingCommandInput,
226+
PutDefaultApplicationSettingCommandOutput,
227+
} from "./commands/PutDefaultApplicationSettingCommand";
220228
import {
221229
RejectInboundConnectionCommandInput,
222230
RejectInboundConnectionCommandOutput,
@@ -306,6 +314,7 @@ export type ServiceInputTypes =
306314
| GetApplicationCommandInput
307315
| GetCompatibleVersionsCommandInput
308316
| GetDataSourceCommandInput
317+
| GetDefaultApplicationSettingCommandInput
309318
| GetDirectQueryDataSourceCommandInput
310319
| GetDomainMaintenanceStatusCommandInput
311320
| GetPackageVersionHistoryCommandInput
@@ -326,6 +335,7 @@ export type ServiceInputTypes =
326335
| ListVpcEndpointsCommandInput
327336
| ListVpcEndpointsForDomainCommandInput
328337
| PurchaseReservedInstanceOfferingCommandInput
338+
| PutDefaultApplicationSettingCommandInput
329339
| RejectInboundConnectionCommandInput
330340
| RemoveTagsCommandInput
331341
| RevokeVpcEndpointAccessCommandInput
@@ -387,6 +397,7 @@ export type ServiceOutputTypes =
387397
| GetApplicationCommandOutput
388398
| GetCompatibleVersionsCommandOutput
389399
| GetDataSourceCommandOutput
400+
| GetDefaultApplicationSettingCommandOutput
390401
| GetDirectQueryDataSourceCommandOutput
391402
| GetDomainMaintenanceStatusCommandOutput
392403
| GetPackageVersionHistoryCommandOutput
@@ -407,6 +418,7 @@ export type ServiceOutputTypes =
407418
| ListVpcEndpointsCommandOutput
408419
| ListVpcEndpointsForDomainCommandOutput
409420
| PurchaseReservedInstanceOfferingCommandOutput
421+
| PutDefaultApplicationSettingCommandOutput
410422
| RejectInboundConnectionCommandOutput
411423
| RemoveTagsCommandOutput
412424
| RevokeVpcEndpointAccessCommandOutput
@@ -614,10 +626,10 @@ export interface OpenSearchClientResolvedConfig extends OpenSearchClientResolved
614626

615627
/**
616628
* <p>Use the Amazon OpenSearch Service configuration API to create, configure, and manage
617-
* OpenSearch Service domains. The endpoint for configuration service requests is Region specific:
618-
* es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a
619-
* current list of supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service
620-
* endpoints</a>.</p>
629+
* OpenSearch Service domains. The endpoint for configuration service requests is Region
630+
* specific: es.<i>region</i>.amazonaws.com. For example,
631+
* es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see
632+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service endpoints</a>.</p>
621633
* @public
622634
*/
623635
export class OpenSearchClient extends __Client<

clients/client-opensearch/src/commands/AcceptInboundConnectionCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ export interface AcceptInboundConnectionCommandOutput extends AcceptInboundConne
2929

3030
/**
3131
* <p>Allows the destination Amazon OpenSearch Service domain owner to accept an inbound
32-
* cross-cluster search connection request. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search
33-
* for Amazon OpenSearch Service</a>.</p>
32+
* cross-cluster search connection request. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
3433
* @example
3534
* Use a bare-bones client and the command you need to make an API call.
3635
* ```javascript

clients/client-opensearch/src/commands/AddDataSourceCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ export interface AddDataSourceCommandInput extends AddDataSourceRequest {}
2828
export interface AddDataSourceCommandOutput extends AddDataSourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new direct-query data source to the specified domain. For more information, see
32-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Creating Amazon OpenSearch Service data source integrations with Amazon S3</a>.</p>
31+
* <p>Creates a new direct-query data source to the specified domain. For more information,
32+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Creating Amazon OpenSearch Service data source integrations with Amazon
33+
* S3</a>.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

clients/client-opensearch/src/commands/AddDirectQueryDataSourceCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@ export interface AddDirectQueryDataSourceCommandInput extends AddDirectQueryData
2828
export interface AddDirectQueryDataSourceCommandOutput extends AddDirectQueryDataSourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Adds a new data source in Amazon OpenSearch Service
33-
* so that you can perform direct queries on external data.
34-
* </p>
31+
* <p> Adds a new data source in Amazon OpenSearch Service so that you can perform direct
32+
* queries on external data. </p>
3533
* @example
3634
* Use a bare-bones client and the command you need to make an API call.
3735
* ```javascript

clients/client-opensearch/src/commands/AddTagsCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface AddTagsCommandInput extends AddTagsRequest {}
2828
export interface AddTagsCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application. </p>
32-
* <p>Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can
33-
* have up to 10 tags. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html">Tagging
34-
* Amazon OpenSearch Service resources</a>. </p>
31+
* <p>Attaches tags to an existing Amazon OpenSearch Service domain, data source, or
32+
* application. </p>
33+
* <p>Tags are a set of case-sensitive key-value pairs. A domain, data source, or
34+
* application can have up to 10 tags. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html">Tagging Amazon OpenSearch Service resources</a>. </p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

clients/client-opensearch/src/commands/AssociatePackageCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export interface AssociatePackageCommandInput extends AssociatePackageRequest {}
2828
export interface AssociatePackageCommandOutput extends AssociatePackageResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Associates a package with an Amazon OpenSearch Service domain. For more information, see
32-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
33-
* for Amazon OpenSearch Service</a>.</p>
31+
* <p>Associates a package with an Amazon OpenSearch Service domain. For more information,
32+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
33+
* for Amazon OpenSearch Service</a>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

clients/client-opensearch/src/commands/AssociatePackagesCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ export interface AssociatePackagesCommandInput extends AssociatePackagesRequest
2828
export interface AssociatePackagesCommandOutput extends AssociatePackagesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.</p>
31+
* <p>Operation in the Amazon OpenSearch Service API for associating multiple packages with
32+
* a domain simultaneously.</p>
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

clients/client-opensearch/src/commands/AuthorizeVpcEndpointAccessCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface AuthorizeVpcEndpointAccessCommandInput extends AuthorizeVpcEndp
2828
export interface AuthorizeVpcEndpointAccessCommandOutput extends AuthorizeVpcEndpointAccessResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC
32-
* endpoint.</p>
31+
* <p>Provides access to an Amazon OpenSearch Service domain through the use of an interface
32+
* VPC endpoint.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

0 commit comments

Comments
 (0)