feat(client-opensearch): Updating documentation for Amazon OpenSearch…

… Service support for new zero-ETL integration with Amazon S3.
aws · Dec 14, 2023 · c63279d · c63279d
1 parent ba49477
commit c63279d
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 53 deletions.
diff --git a/clients/client-opensearch/src/commands/AddDataSourceCommand.ts b/clients/client-opensearch/src/commands/AddDataSourceCommand.ts
@@ -37,7 +37,8 @@ export interface AddDataSourceCommandOutput extends AddDataSourceResponse, __Met
 
 /**
  * @public
- * <p>Adds the data source on the domain.</p>
+ * <p>Creates a new direct-query data source to the specified domain. For more information, 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 S3</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-opensearch/src/commands/DeleteDataSourceCommand.ts b/clients/client-opensearch/src/commands/DeleteDataSourceCommand.ts
@@ -37,7 +37,7 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
 
 /**
  * @public
- * <p>Deletes the data source.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-opensearch/src/commands/GetDataSourceCommand.ts b/clients/client-opensearch/src/commands/GetDataSourceCommand.ts
@@ -37,7 +37,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met
 
 /**
  * @public
- * <p>Describes the data source details.</p>
+ * <p>Retrieves information about a direct query data source.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-opensearch/src/commands/ListDataSourcesCommand.ts b/clients/client-opensearch/src/commands/ListDataSourcesCommand.ts
@@ -37,7 +37,9 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
 
 /**
  * @public
- * <p>A list of the data source details of the domain.</p>
+ * <p>Lists direct-query data sources for a specific domain. For more information, see
+ *    For more information, see
+ *    <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-opensearch/src/commands/UpdateDataSourceCommand.ts b/clients/client-opensearch/src/commands/UpdateDataSourceCommand.ts
@@ -37,7 +37,8 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
 
 /**
  * @public
- * <p>Updates the data source on the domain.</p>
+ * <p>Updates a direct-query data source. For more information, see
+ *    <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-opensearch/src/models/models_0.ts b/clients/client-opensearch/src/models/models_0.ts
@@ -396,19 +396,19 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
 
 /**
  * @public
- * <p>Information about the AWS S3 Glue Data Catalog.</p>
+ * <p>Information about the Amazon S3 Glue Data Catalog.</p>
  */
 export interface S3GlueDataCatalog {
   /**
    * @public
-   * <p>The role ARN for the AWS S3 Glue Data Catalog.</p>
+   * <p>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</p>
    */
   RoleArn?: string;
 }
 
 /**
  * @public
- * <p>Information about the data source.</p>
+ * <p>The type of data source.</p>
  */
 export type DataSourceType = DataSourceType.S3GlueDataCatalogMember | DataSourceType.$UnknownMember;
 
@@ -418,7 +418,7 @@ export type DataSourceType = DataSourceType.S3GlueDataCatalogMember | DataSource
 export namespace DataSourceType {
   /**
    * @public
-   * <p>The data source for the AWS S3 Glue Data Catalog.</p>
+   * <p>An Amazon S3 data source.</p>
    */
   export interface S3GlueDataCatalogMember {
     S3GlueDataCatalog: S3GlueDataCatalog;
@@ -452,13 +452,13 @@ export namespace DataSourceType {
 export interface AddDataSourceRequest {
   /**
    * @public
-   * <p>The name of the domain.</p>
+   * <p>The name of the domain to add the data source to.</p>
    */
   DomainName: string | undefined;
 
   /**
    * @public
-   * <p>The name of the data source.</p>
+   * <p>A name for the data source.</p>
    */
   Name: string | undefined;
 
@@ -482,7 +482,7 @@ export interface AddDataSourceRequest {
 export interface AddDataSourceResponse {
   /**
    * @public
-   * <p>A message associated with the data source.</p>
+   * <p>A message associated with creation of the data source.</p>
    */
   Message?: string;
 }
@@ -1651,24 +1651,14 @@ export interface DomainEndpointOptions {
    *          <ul>
    *             <li>
    *                <p>
-   *                   <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy which
+   *                   <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that
    *      supports TLS version 1.0 to TLS version 1.2</p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy which
+   *                   <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that
    *      supports only TLS version 1.2</p>
    *             </li>
-   *             <li>
-   *                <p>
-   *                   <b>Policy-Min-TLS-1-0-2023-10:</b> TLS security policy which
-   *      supports TLS version 1.0 to TLS version 1.3</p>
-   *             </li>
-   *             <li>
-   *                <p>
-   *                   <b>Policy-Min-TLS-1-2-2023-10:</b> TLS security policy which
-   *      supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p>
-   *             </li>
    *          </ul>
    */
   TLSSecurityPolicy?: TLSSecurityPolicy;
@@ -2983,7 +2973,7 @@ export interface DeleteDataSourceRequest {
 
   /**
    * @public
-   * <p>The name of the data source.</p>
+   * <p>The name of the data source to delete.</p>
    */
   Name: string | undefined;
 }
@@ -2995,7 +2985,7 @@ export interface DeleteDataSourceRequest {
 export interface DeleteDataSourceResponse {
   /**
    * @public
-   * <p>A message associated with the initiated request.</p>
+   * <p>A message associated with deletion of the data source.</p>
    */
   Message?: string;
 }
@@ -5367,7 +5357,7 @@ export interface GetDataSourceRequest {
 
   /**
    * @public
-   * <p>The name of the data source.</p>
+   * <p>The name of the data source to get information about.</p>
    */
   Name: string | undefined;
 }
@@ -5804,7 +5794,7 @@ export interface ListDataSourcesRequest {
 
 /**
  * @public
- * <p>Details about the data sources.</p>
+ * <p>Details about a direct-query data source.</p>
  */
 export interface DataSourceDetails {
   /**
@@ -5833,7 +5823,7 @@ export interface DataSourceDetails {
 export interface ListDataSourcesResponse {
   /**
    * @public
-   * <p>A list of the data sources.</p>
+   * <p>A list of data sources associated with specified domain.</p>
    */
   DataSources?: DataSourceDetails[];
 }
@@ -6758,7 +6748,7 @@ export interface UpdateDataSourceRequest {
 
   /**
    * @public
-   * <p>The name of the data source.</p>
+   * <p>The name of the data source to modify.</p>
    */
   Name: string | undefined;
 
@@ -6770,7 +6760,7 @@ export interface UpdateDataSourceRequest {
 
   /**
    * @public
-   * <p>A description of the data source.</p>
+   * <p>A new description of the data source.</p>
    */
   Description?: string;
 }
@@ -6782,7 +6772,7 @@ export interface UpdateDataSourceRequest {
 export interface UpdateDataSourceResponse {
   /**
    * @public
-   * <p>A message associated with the data source.</p>
+   * <p>A message associated with the updated data source.</p>
    */
   Message?: string;
 }

diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json
@@ -290,7 +290,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Adds the data source on the domain.</p>",
+        "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>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource",
@@ -304,15 +304,15 @@
         "DomainName": {
           "target": "com.amazonaws.opensearch#DomainName",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the domain.</p>",
+            "smithy.api#documentation": "<p>The name of the domain to add the data source to.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
         },
         "Name": {
           "target": "com.amazonaws.opensearch#DataSourceName",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the data source.</p>",
+            "smithy.api#documentation": "<p>A name for the data source.</p>",
             "smithy.api#required": {}
           }
         },
@@ -341,7 +341,7 @@
         "Message": {
           "target": "com.amazonaws.opensearch#String",
           "traits": {
-            "smithy.api#documentation": "<p>A message associated with the data source.</p>"
+            "smithy.api#documentation": "<p>A message associated with creation of the data source.</p>"
           }
         }
       },
@@ -3461,7 +3461,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Details about the data sources.</p>"
+        "smithy.api#documentation": "<p>Details about a direct-query data source.</p>"
       }
     },
     "com.amazonaws.opensearch#DataSourceList": {
@@ -3486,12 +3486,12 @@
         "S3GlueDataCatalog": {
           "target": "com.amazonaws.opensearch#S3GlueDataCatalog",
           "traits": {
-            "smithy.api#documentation": "<p>The data source for the AWS S3 Glue Data Catalog.</p>"
+            "smithy.api#documentation": "<p>An Amazon S3 data source.</p>"
           }
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Information about the data source.</p>"
+        "smithy.api#documentation": "<p>The type of data source.</p>"
       }
     },
     "com.amazonaws.opensearch#DeleteDataSource": {
@@ -3523,7 +3523,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Deletes the data source.</p>",
+        "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>",
         "smithy.api#http": {
           "method": "DELETE",
           "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -3545,7 +3545,7 @@
         "Name": {
           "target": "com.amazonaws.opensearch#DataSourceName",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the data source.</p>",
+            "smithy.api#documentation": "<p>The name of the data source to delete.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -3562,7 +3562,7 @@
         "Message": {
           "target": "com.amazonaws.opensearch#String",
           "traits": {
-            "smithy.api#documentation": "<p>A message associated with the initiated request.</p>"
+            "smithy.api#documentation": "<p>A message associated with deletion of the data source.</p>"
           }
         }
       },
@@ -5476,7 +5476,7 @@
         "TLSSecurityPolicy": {
           "target": "com.amazonaws.opensearch#TLSSecurityPolicy",
           "traits": {
-            "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>"
+            "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>"
           }
         },
         "CustomEndpointEnabled": {
@@ -6512,7 +6512,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Describes the data source details.</p>",
+        "smithy.api#documentation": "<p>Retrieves information about a direct query data source.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -6534,7 +6534,7 @@
         "Name": {
           "target": "com.amazonaws.opensearch#DataSourceName",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the data source.</p>",
+            "smithy.api#documentation": "<p>The name of the data source to get information about.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -7409,7 +7409,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>A list of the data source details of the domain.</p>",
+        "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>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource",
@@ -7440,7 +7440,7 @@
         "DataSources": {
           "target": "com.amazonaws.opensearch#DataSourceList",
           "traits": {
-            "smithy.api#documentation": "<p>A list of the data sources.</p>"
+            "smithy.api#documentation": "<p>A list of data sources associated with specified domain.</p>"
           }
         }
       },
@@ -10546,12 +10546,12 @@
         "RoleArn": {
           "target": "com.amazonaws.opensearch#RoleArn",
           "traits": {
-            "smithy.api#documentation": "<p>The role ARN for the AWS S3 Glue Data Catalog.</p>"
+            "smithy.api#documentation": "<p>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</p>"
           }
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Information about the AWS S3 Glue Data Catalog.</p>"
+        "smithy.api#documentation": "<p>Information about the Amazon S3 Glue Data Catalog.</p>"
       }
     },
     "com.amazonaws.opensearch#S3Key": {
@@ -11456,7 +11456,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Updates the data source on the domain.</p>",
+        "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>",
         "smithy.api#http": {
           "method": "PUT",
           "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}",
@@ -11478,7 +11478,7 @@
         "Name": {
           "target": "com.amazonaws.opensearch#DataSourceName",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the data source.</p>",
+            "smithy.api#documentation": "<p>The name of the data source to modify.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -11493,7 +11493,7 @@
         "Description": {
           "target": "com.amazonaws.opensearch#DataSourceDescription",
           "traits": {
-            "smithy.api#documentation": "<p>A description of the data source.</p>"
+            "smithy.api#documentation": "<p>A new description of the data source.</p>"
           }
         }
       },
@@ -11508,7 +11508,7 @@
         "Message": {
           "target": "com.amazonaws.opensearch#String",
           "traits": {
-            "smithy.api#documentation": "<p>A message associated with the data source.</p>"
+            "smithy.api#documentation": "<p>A message associated with the updated data source.</p>"
           }
         }
       },