Skip to content

Commit c63279d

Browse files
author
awstools
committed
feat(client-opensearch): Updating documentation for Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3.
1 parent ba49477 commit c63279d

File tree

7 files changed

+47
-53
lines changed

7 files changed

+47
-53
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface AddDataSourceCommandOutput extends AddDataSourceResponse, __Met
3737

3838
/**
3939
* @public
40-
* <p>Adds the data source on the domain.</p>
40+
* <p>Creates a new direct-query data source to the specified domain. For more information, see
41+
* <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>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
3737

3838
/**
3939
* @public
40-
* <p>Deletes the data source.</p>
40+
* <p>Deletes a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html">Deleting an Amazon OpenSearch Service data source with Amazon S3</a>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met
3737

3838
/**
3939
* @public
40-
* <p>Describes the data source details.</p>
40+
* <p>Retrieves information about a direct query data source.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
3737

3838
/**
3939
* @public
40-
* <p>A list of the data source details of the domain.</p>
40+
* <p>Lists direct-query data sources for a specific domain. For more information, see
41+
* For more information, see
42+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html">Working with Amazon OpenSearch Service direct queries with Amazon S3</a>.</p>
4143
* @example
4244
* Use a bare-bones client and the command you need to make an API call.
4345
* ```javascript

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
3737

3838
/**
3939
* @public
40-
* <p>Updates the data source on the domain.</p>
40+
* <p>Updates a direct-query data source. For more information, see
41+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Working with Amazon OpenSearch Service data source integrations with Amazon S3</a>.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

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

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -396,19 +396,19 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
396396

397397
/**
398398
* @public
399-
* <p>Information about the AWS S3 Glue Data Catalog.</p>
399+
* <p>Information about the Amazon S3 Glue Data Catalog.</p>
400400
*/
401401
export interface S3GlueDataCatalog {
402402
/**
403403
* @public
404-
* <p>The role ARN for the AWS S3 Glue Data Catalog.</p>
404+
* <p>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</p>
405405
*/
406406
RoleArn?: string;
407407
}
408408

409409
/**
410410
* @public
411-
* <p>Information about the data source.</p>
411+
* <p>The type of data source.</p>
412412
*/
413413
export type DataSourceType = DataSourceType.S3GlueDataCatalogMember | DataSourceType.$UnknownMember;
414414

@@ -418,7 +418,7 @@ export type DataSourceType = DataSourceType.S3GlueDataCatalogMember | DataSource
418418
export namespace DataSourceType {
419419
/**
420420
* @public
421-
* <p>The data source for the AWS S3 Glue Data Catalog.</p>
421+
* <p>An Amazon S3 data source.</p>
422422
*/
423423
export interface S3GlueDataCatalogMember {
424424
S3GlueDataCatalog: S3GlueDataCatalog;
@@ -452,13 +452,13 @@ export namespace DataSourceType {
452452
export interface AddDataSourceRequest {
453453
/**
454454
* @public
455-
* <p>The name of the domain.</p>
455+
* <p>The name of the domain to add the data source to.</p>
456456
*/
457457
DomainName: string | undefined;
458458

459459
/**
460460
* @public
461-
* <p>The name of the data source.</p>
461+
* <p>A name for the data source.</p>
462462
*/
463463
Name: string | undefined;
464464

@@ -482,7 +482,7 @@ export interface AddDataSourceRequest {
482482
export interface AddDataSourceResponse {
483483
/**
484484
* @public
485-
* <p>A message associated with the data source.</p>
485+
* <p>A message associated with creation of the data source.</p>
486486
*/
487487
Message?: string;
488488
}
@@ -1651,24 +1651,14 @@ export interface DomainEndpointOptions {
16511651
* <ul>
16521652
* <li>
16531653
* <p>
1654-
* <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy which
1654+
* <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that
16551655
* supports TLS version 1.0 to TLS version 1.2</p>
16561656
* </li>
16571657
* <li>
16581658
* <p>
1659-
* <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy which
1659+
* <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that
16601660
* supports only TLS version 1.2</p>
16611661
* </li>
1662-
* <li>
1663-
* <p>
1664-
* <b>Policy-Min-TLS-1-0-2023-10:</b> TLS security policy which
1665-
* supports TLS version 1.0 to TLS version 1.3</p>
1666-
* </li>
1667-
* <li>
1668-
* <p>
1669-
* <b>Policy-Min-TLS-1-2-2023-10:</b> TLS security policy which
1670-
* supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p>
1671-
* </li>
16721662
* </ul>
16731663
*/
16741664
TLSSecurityPolicy?: TLSSecurityPolicy;
@@ -2983,7 +2973,7 @@ export interface DeleteDataSourceRequest {
29832973

29842974
/**
29852975
* @public
2986-
* <p>The name of the data source.</p>
2976+
* <p>The name of the data source to delete.</p>
29872977
*/
29882978
Name: string | undefined;
29892979
}
@@ -2995,7 +2985,7 @@ export interface DeleteDataSourceRequest {
29952985
export interface DeleteDataSourceResponse {
29962986
/**
29972987
* @public
2998-
* <p>A message associated with the initiated request.</p>
2988+
* <p>A message associated with deletion of the data source.</p>
29992989
*/
30002990
Message?: string;
30012991
}
@@ -5367,7 +5357,7 @@ export interface GetDataSourceRequest {
53675357

53685358
/**
53695359
* @public
5370-
* <p>The name of the data source.</p>
5360+
* <p>The name of the data source to get information about.</p>
53715361
*/
53725362
Name: string | undefined;
53735363
}
@@ -5804,7 +5794,7 @@ export interface ListDataSourcesRequest {
58045794

58055795
/**
58065796
* @public
5807-
* <p>Details about the data sources.</p>
5797+
* <p>Details about a direct-query data source.</p>
58085798
*/
58095799
export interface DataSourceDetails {
58105800
/**
@@ -5833,7 +5823,7 @@ export interface DataSourceDetails {
58335823
export interface ListDataSourcesResponse {
58345824
/**
58355825
* @public
5836-
* <p>A list of the data sources.</p>
5826+
* <p>A list of data sources associated with specified domain.</p>
58375827
*/
58385828
DataSources?: DataSourceDetails[];
58395829
}
@@ -6758,7 +6748,7 @@ export interface UpdateDataSourceRequest {
67586748

67596749
/**
67606750
* @public
6761-
* <p>The name of the data source.</p>
6751+
* <p>The name of the data source to modify.</p>
67626752
*/
67636753
Name: string | undefined;
67646754

@@ -6770,7 +6760,7 @@ export interface UpdateDataSourceRequest {
67706760

67716761
/**
67726762
* @public
6773-
* <p>A description of the data source.</p>
6763+
* <p>A new description of the data source.</p>
67746764
*/
67756765
Description?: string;
67766766
}
@@ -6782,7 +6772,7 @@ export interface UpdateDataSourceRequest {
67826772
export interface UpdateDataSourceResponse {
67836773
/**
67846774
* @public
6785-
* <p>A message associated with the data source.</p>
6775+
* <p>A message associated with the updated data source.</p>
67866776
*/
67876777
Message?: string;
67886778
}

‎codegen/sdk-codegen/aws-models/opensearch.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@
290290
}
291291
],
292292
"traits": {
293-
"smithy.api#documentation": "<p>Adds the data source on the domain.</p>",
293+
"smithy.api#documentation": "<p>Creates a new direct-query data source to the specified domain. For more information, see\n <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>",
294294
"smithy.api#http": {
295295
"method": "POST",
296296
"uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource",
@@ -304,15 +304,15 @@
304304
"DomainName": {
305305
"target": "com.amazonaws.opensearch#DomainName",
306306
"traits": {
307-
"smithy.api#documentation": "<p>The name of the domain.</p>",
307+
"smithy.api#documentation": "<p>The name of the domain to add the data source to.</p>",
308308
"smithy.api#httpLabel": {},
309309
"smithy.api#required": {}
310310
}
311311
},
312312
"Name": {
313313
"target": "com.amazonaws.opensearch#DataSourceName",
314314
"traits": {
315-
"smithy.api#documentation": "<p>The name of the data source.</p>",
315+
"smithy.api#documentation": "<p>A name for the data source.</p>",
316316
"smithy.api#required": {}
317317
}
318318
},
@@ -341,7 +341,7 @@
341341
"Message": {
342342
"target": "com.amazonaws.opensearch#String",
343343
"traits": {
344-
"smithy.api#documentation": "<p>A message associated with the data source.</p>"
344+
"smithy.api#documentation": "<p>A message associated with creation of the data source.</p>"
345345
}
346346
}
347347
},
@@ -3461,7 +3461,7 @@
34613461
}
34623462
},
34633463
"traits": {
3464-
"smithy.api#documentation": "<p>Details about the data sources.</p>"
3464+
"smithy.api#documentation": "<p>Details about a direct-query data source.</p>"
34653465
}
34663466
},
34673467
"com.amazonaws.opensearch#DataSourceList": {
@@ -3486,12 +3486,12 @@
34863486
"S3GlueDataCatalog": {
34873487
"target": "com.amazonaws.opensearch#S3GlueDataCatalog",
34883488
"traits": {
3489-
"smithy.api#documentation": "<p>The data source for the AWS S3 Glue Data Catalog.</p>"
3489+
"smithy.api#documentation": "<p>An Amazon S3 data source.</p>"
34903490
}
34913491
}
34923492
},
34933493
"traits": {
3494-
"smithy.api#documentation": "<p>Information about the data source.</p>"
3494+
"smithy.api#documentation": "<p>The type of data source.</p>"
34953495
}
34963496
},
34973497
"com.amazonaws.opensearch#DeleteDataSource": {
@@ -3523,7 +3523,7 @@
35233523
}
35243524
],
35253525
"traits": {
3526-
"smithy.api#documentation": "<p>Deletes the data source.</p>",
3526+
"smithy.api#documentation": "<p>Deletes a direct-query data source. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html\">Deleting an Amazon OpenSearch Service data source with Amazon S3</a>.</p>",
35273527
"smithy.api#http": {
35283528
"method": "DELETE",
35293529
"uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -3545,7 +3545,7 @@
35453545
"Name": {
35463546
"target": "com.amazonaws.opensearch#DataSourceName",
35473547
"traits": {
3548-
"smithy.api#documentation": "<p>The name of the data source.</p>",
3548+
"smithy.api#documentation": "<p>The name of the data source to delete.</p>",
35493549
"smithy.api#httpLabel": {},
35503550
"smithy.api#required": {}
35513551
}
@@ -3562,7 +3562,7 @@
35623562
"Message": {
35633563
"target": "com.amazonaws.opensearch#String",
35643564
"traits": {
3565-
"smithy.api#documentation": "<p>A message associated with the initiated request.</p>"
3565+
"smithy.api#documentation": "<p>A message associated with deletion of the data source.</p>"
35663566
}
35673567
}
35683568
},
@@ -5476,7 +5476,7 @@
54765476
"TLSSecurityPolicy": {
54775477
"target": "com.amazonaws.opensearch#TLSSecurityPolicy",
54785478
"traits": {
5479-
"smithy.api#documentation": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:</p>\n <ul>\n <li>\n <p>\n <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy which\n supports TLS version 1.0 to TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy which\n supports only TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-0-2023-10:</b> TLS security policy which\n supports TLS version 1.0 to TLS version 1.3</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-2023-10:</b> TLS security policy which\n supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p>\n </li>\n </ul>"
5479+
"smithy.api#documentation": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:</p>\n <ul>\n <li>\n <p>\n <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that\n supports TLS version 1.0 to TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that\n supports only TLS version 1.2</p>\n </li>\n </ul>"
54805480
}
54815481
},
54825482
"CustomEndpointEnabled": {
@@ -6512,7 +6512,7 @@
65126512
}
65136513
],
65146514
"traits": {
6515-
"smithy.api#documentation": "<p>Describes the data source details.</p>",
6515+
"smithy.api#documentation": "<p>Retrieves information about a direct query data source.</p>",
65166516
"smithy.api#http": {
65176517
"method": "GET",
65186518
"uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -6534,7 +6534,7 @@
65346534
"Name": {
65356535
"target": "com.amazonaws.opensearch#DataSourceName",
65366536
"traits": {
6537-
"smithy.api#documentation": "<p>The name of the data source.</p>",
6537+
"smithy.api#documentation": "<p>The name of the data source to get information about.</p>",
65386538
"smithy.api#httpLabel": {},
65396539
"smithy.api#required": {}
65406540
}
@@ -7409,7 +7409,7 @@
74097409
}
74107410
],
74117411
"traits": {
7412-
"smithy.api#documentation": "<p>A list of the data source details of the domain.</p>",
7412+
"smithy.api#documentation": "<p>Lists direct-query data sources for a specific domain. For more information, see \n For more information, see\n <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html\">Working with Amazon OpenSearch Service direct queries with Amazon S3</a>.</p>",
74137413
"smithy.api#http": {
74147414
"method": "GET",
74157415
"uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource",
@@ -7440,7 +7440,7 @@
74407440
"DataSources": {
74417441
"target": "com.amazonaws.opensearch#DataSourceList",
74427442
"traits": {
7443-
"smithy.api#documentation": "<p>A list of the data sources.</p>"
7443+
"smithy.api#documentation": "<p>A list of data sources associated with specified domain.</p>"
74447444
}
74457445
}
74467446
},
@@ -10546,12 +10546,12 @@
1054610546
"RoleArn": {
1054710547
"target": "com.amazonaws.opensearch#RoleArn",
1054810548
"traits": {
10549-
"smithy.api#documentation": "<p>The role ARN for the AWS S3 Glue Data Catalog.</p>"
10549+
"smithy.api#documentation": "<p>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</p>"
1055010550
}
1055110551
}
1055210552
},
1055310553
"traits": {
10554-
"smithy.api#documentation": "<p>Information about the AWS S3 Glue Data Catalog.</p>"
10554+
"smithy.api#documentation": "<p>Information about the Amazon S3 Glue Data Catalog.</p>"
1055510555
}
1055610556
},
1055710557
"com.amazonaws.opensearch#S3Key": {
@@ -11456,7 +11456,7 @@
1145611456
}
1145711457
],
1145811458
"traits": {
11459-
"smithy.api#documentation": "<p>Updates the data source on the domain.</p>",
11459+
"smithy.api#documentation": "<p>Updates a direct-query data source. For more information, see\n <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html\">Working with Amazon OpenSearch Service data source integrations with Amazon S3</a>.</p>",
1146011460
"smithy.api#http": {
1146111461
"method": "PUT",
1146211462
"uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -11478,7 +11478,7 @@
1147811478
"Name": {
1147911479
"target": "com.amazonaws.opensearch#DataSourceName",
1148011480
"traits": {
11481-
"smithy.api#documentation": "<p>The name of the data source.</p>",
11481+
"smithy.api#documentation": "<p>The name of the data source to modify.</p>",
1148211482
"smithy.api#httpLabel": {},
1148311483
"smithy.api#required": {}
1148411484
}
@@ -11493,7 +11493,7 @@
1149311493
"Description": {
1149411494
"target": "com.amazonaws.opensearch#DataSourceDescription",
1149511495
"traits": {
11496-
"smithy.api#documentation": "<p>A description of the data source.</p>"
11496+
"smithy.api#documentation": "<p>A new description of the data source.</p>"
1149711497
}
1149811498
}
1149911499
},
@@ -11508,7 +11508,7 @@
1150811508
"Message": {
1150911509
"target": "com.amazonaws.opensearch#String",
1151011510
"traits": {
11511-
"smithy.api#documentation": "<p>A message associated with the data source.</p>"
11511+
"smithy.api#documentation": "<p>A message associated with the updated data source.</p>"
1151211512
}
1151311513
}
1151411514
},

0 commit comments

Comments
 (0)