docs(client-rds-data): Documentation updates for RDS Data API

Author: awstools

clients/client-rds-data/README.md

@@ -11,9 +11,11 @@ AWS SDK for JavaScript RDSData Client for Node.js, Browser and React Native.
 
 <fullname>Amazon RDS Data Service</fullname>
 
-<p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora
-Serverless DB cluster. To run these statements, you work with the Data Service
-API.</p>
+<p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
+statements, you work with the Data Service API.</p>
+<note>
+<p>The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.</p>
+</note>
 <p>For more information about the Data Service API, see
 <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a>
 in the <i>Amazon Aurora User Guide</i>.</p>

clients/client-rds-data/src/RDSData.ts

@@ -31,9 +31,11 @@ import { RDSDataClient } from "./RDSDataClient";
 
 /**
  * <fullname>Amazon RDS Data Service</fullname>
- *         <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora
- *             Serverless DB cluster. To run these statements, you work with the Data Service
- *             API.</p>
+ *         <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
+ *             statements, you work with the Data Service API.</p>
+ *         <note>
+ *             <p>The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.</p>
+ *         </note>
  *         <p>For more information about the Data Service API, see
  *           <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a>
  *           in the <i>Amazon Aurora User Guide</i>.</p>
@@ -44,17 +46,16 @@ export class RDSData extends RDSDataClient {
    *         <p>You can run bulk update and insert operations for multiple records using a DML
    *             statement with different parameter sets. Bulk operations can provide a significant
    *             performance improvement over individual insert and update operations.</p>
-   *         <important>
-   *             <p>If a call isn't part of a transaction because it doesn't include the
-   *                     <code>transactionID</code> parameter, changes that result from the call are
-   *                 committed automatically.</p>
+   *         <note>
+   *             <p>If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> parameter,
+   *                 changes that result from the call are committed automatically.</p>
    *             <p>There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request
    *                 submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't
    *                 process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the
    *                 number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and
    *                 the size of each parameter set.</p>
    *             <p>The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.</p>
-   *         </important>
+   *         </note>
    */
   public batchExecuteStatement(
     args: BatchExecuteStatementCommandInput,
@@ -87,17 +88,14 @@ export class RDSData extends RDSDataClient {
 
   /**
    * <p>Starts a SQL transaction.</p>
-   *
-   *         <important>
-   *             <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and
-   *                 rolled back automatically after 24 hours.</p>
-   *             <p>A transaction times out if no calls use its transaction ID in three minutes.
-   *                 If a transaction times out before it's committed, it's rolled back
-   *                 automatically.</p>
-   *             <p>DDL statements inside a transaction cause an implicit commit. We recommend
-   *                 that you run each DDL statement in a separate <code>ExecuteStatement</code> call with
-   *                 <code>continueAfterTimeout</code> enabled.</p>
-   *         </important>
+   *         <note>
+   *             <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24
+   *                 hours.</p>
+   *             <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's
+   *                 committed, it's rolled back automatically.</p>
+   *             <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate
+   *                     <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>
+   *         </note>
    */
   public beginTransaction(
     args: BeginTransactionCommandInput,
@@ -165,10 +163,10 @@ export class RDSData extends RDSDataClient {
    * @deprecated
    *
    * <p>Runs one or more SQL statements.</p>
-   *         <important>
+   *         <note>
    *             <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or
    *                     <code>ExecuteStatement</code> operation.</p>
-   *         </important>
+   *         </note>
    */
   public executeSql(args: ExecuteSqlCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteSqlCommandOutput>;
   public executeSql(args: ExecuteSqlCommandInput, cb: (err: any, data?: ExecuteSqlCommandOutput) => void): void;
@@ -195,12 +193,12 @@ export class RDSData extends RDSDataClient {
 
   /**
    * <p>Runs a SQL statement against a database.</p>
-   *         <important>
+   *         <note>
    *             <p>If a call isn't part of a transaction because it doesn't include the
    *                     <code>transactionID</code> parameter, changes that result from the call are
    *                 committed automatically.</p>
    *             <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
-   *         </important>
+   *         </note>
    */
   public executeStatement(
     args: ExecuteStatementCommandInput,

clients/client-rds-data/src/RDSDataClient.ts

@@ -238,9 +238,11 @@ export interface RDSDataClientResolvedConfig extends RDSDataClientResolvedConfig
 
 /**
  * <fullname>Amazon RDS Data Service</fullname>
- *         <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora
- *             Serverless DB cluster. To run these statements, you work with the Data Service
- *             API.</p>
+ *         <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
+ *             statements, you work with the Data Service API.</p>
+ *         <note>
+ *             <p>The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.</p>
+ *         </note>
  *         <p>For more information about the Data Service API, see
  *           <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a>
  *           in the <i>Amazon Aurora User Guide</i>.</p>

clients/client-rds-data/src/commands/BatchExecuteStatementCommand.ts

@@ -32,17 +32,16 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
  *         <p>You can run bulk update and insert operations for multiple records using a DML
  *             statement with different parameter sets. Bulk operations can provide a significant
  *             performance improvement over individual insert and update operations.</p>
- *         <important>
- *             <p>If a call isn't part of a transaction because it doesn't include the
- *                     <code>transactionID</code> parameter, changes that result from the call are
- *                 committed automatically.</p>
+ *         <note>
+ *             <p>If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> parameter,
+ *                 changes that result from the call are committed automatically.</p>
  *             <p>There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request
  *                 submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't
  *                 process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the
  *                 number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and
  *                 the size of each parameter set.</p>
  *             <p>The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.</p>
- *         </important>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rds-data/src/commands/BeginTransactionCommand.ts

@@ -29,17 +29,14 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
 
 /**
  * <p>Starts a SQL transaction.</p>
- *
- *         <important>
- *             <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and
- *                 rolled back automatically after 24 hours.</p>
- *             <p>A transaction times out if no calls use its transaction ID in three minutes.
- *                 If a transaction times out before it's committed, it's rolled back
- *                 automatically.</p>
- *             <p>DDL statements inside a transaction cause an implicit commit. We recommend
- *                 that you run each DDL statement in a separate <code>ExecuteStatement</code> call with
- *                 <code>continueAfterTimeout</code> enabled.</p>
- *         </important>
+ *         <note>
+ *             <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24
+ *                 hours.</p>
+ *             <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's
+ *                 committed, it's rolled back automatically.</p>
+ *             <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate
+ *                     <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rds-data/src/commands/ExecuteSqlCommand.ts

@@ -31,10 +31,10 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
  * @deprecated
  *
  * <p>Runs one or more SQL statements.</p>
- *         <important>
+ *         <note>
  *             <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or
  *                     <code>ExecuteStatement</code> operation.</p>
- *         </important>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rds-data/src/commands/ExecuteStatementCommand.ts

@@ -29,12 +29,12 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
 
 /**
  * <p>Runs a SQL statement against a database.</p>
- *         <important>
+ *         <note>
  *             <p>If a call isn't part of a transaction because it doesn't include the
  *                     <code>transactionID</code> parameter, changes that result from the call are
  *                 committed automatically.</p>
  *             <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
- *         </important>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rds-data/src/models/models_0.ts

@@ -370,10 +370,10 @@ export interface ResultSetOptions {
    *             it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code>
    *             specifies that it is converted to a Long value if its scale is 0, or to a Double
    *             value otherwise.</p>
-   *         <important>
+   *         <note>
    *             <p>Conversion to Double or Long can result in roundoff errors due to precision loss.
    *                 We recommend converting to String, especially when working with currency values.</p>
-   *         </important>
+   *         </note>
    */
   decimalReturnType?: DecimalReturnType | string;
 
@@ -732,10 +732,10 @@ export interface UpdateResult {
 /**
  * <p>Contains the value of a column.</p>
  *
- *         <important>
+ *         <note>
  *             <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
  *               Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
- *         </important>
+ *         </note>
  */
 export type Value =
   | Value.ArrayValuesMember
@@ -1024,11 +1024,11 @@ export interface ExecuteStatementRequest {
    * <p>A value that indicates whether to continue running the statement after
    *             the call times out. By default, the statement stops running when the call
    *             times out.</p>
-   *         <important>
+   *         <note>
    *             <p>For DDL statements, we recommend continuing to run the statement after
    *                the call times out. When a DDL statement terminates before it is finished
    *                running, it can result in errors and possibly corrupted data structures.</p>
-   *         </important>
+   *         </note>
    */
   continueAfterTimeout?: boolean;
 
@@ -1051,10 +1051,10 @@ export interface ExecuteStatementRequest {
 
 /**
  * <p>A structure value returned by a call.</p>
- *         <important>
+ *         <note>
  *             <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
  *               Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
- *         </important>
+ *         </note>
  */
 export interface StructValue {
   /**
@@ -1136,10 +1136,10 @@ export interface BatchExecuteStatementResponse {
 
 /**
  * <p>A record returned by a call.</p>
- *         <important>
+ *         <note>
  *             <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
  *               Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
- *         </important>
+ *         </note>
  */
 export interface _Record {
   /**
@@ -1194,10 +1194,10 @@ export interface ExecuteStatementResponse {
 
 /**
  * <p>The result set returned by a SQL statement.</p>
- *         <important>
+ *         <note>
  *             <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
  *               Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
- *         </important>
+ *         </note>
  */
 export interface ResultFrame {
   /**
@@ -1214,10 +1214,10 @@ export interface ResultFrame {
 /**
  * <p>The result of a SQL statement.</p>
  *
- *         <important>
+ *         <note>
  *             <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
  *               Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
- *         </important>
+ *         </note>
  */
 export interface SqlStatementResult {
   /**