Skip to content

Commit d2c0cef

Browse files
author
awstools
committed
docs(client-rds-data): Documentation update for RDS Data API to reflect support for Aurora MySQL Serverless v2 and Provisioned DB clusters.
1 parent 25f3950 commit d2c0cef

File tree

7 files changed

+15
-14
lines changed

7 files changed

+15
-14
lines changed

‎clients/client-rds-data/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ statements, you use the RDS Data API (Data API).</p>
1313
<p>Data API is available with the following types of Aurora databases:</p>
1414
<ul>
1515
<li>
16-
<p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
16+
<p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
1717
</li>
1818
<li>
19-
<p>Aurora MySQL - Serverless v1 only</p>
19+
<p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
2020
</li>
2121
</ul>
2222
<p>For more information about the Data API, see

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,10 @@ export interface RDSData {
144144
* <p>Data API is available with the following types of Aurora databases:</p>
145145
* <ul>
146146
* <li>
147-
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
147+
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
148148
* </li>
149149
* <li>
150-
* <p>Aurora MySQL - Serverless v1 only</p>
150+
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
151151
* </li>
152152
* </ul>
153153
* <p>For more information about the Data API, see

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,10 @@ export interface RDSDataClientResolvedConfig extends RDSDataClientResolvedConfig
276276
* <p>Data API is available with the following types of Aurora databases:</p>
277277
* <ul>
278278
* <li>
279-
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
279+
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
280280
* </li>
281281
* <li>
282-
* <p>Aurora MySQL - Serverless v1 only</p>
282+
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
283283
* </li>
284284
* </ul>
285285
* <p>For more information about the Data API, see

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
3434
* hours.</p>
3535
* <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's
3636
* committed, it's rolled back automatically.</p>
37-
* <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate
37+
* <p>For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate
3838
* <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>
3939
* </note>
4040
* @example

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
3030
/**
3131
* <p>Runs one or more SQL statements.</p>
3232
* <note>
33-
* <p>This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters,
34-
* the operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>
33+
* <p>This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters.
34+
* For Aurora Serverless v1 DB clusters, the operation is deprecated.
35+
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>
3536
* </note>
3637
*
3738
* @deprecated The ExecuteSql API is deprecated, please use the ExecuteStatement API.

‎clients/client-rds-data/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
* <p>Data API is available with the following types of Aurora databases:</p>
88
* <ul>
99
* <li>
10-
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
10+
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
1111
* </li>
1212
* <li>
13-
* <p>Aurora MySQL - Serverless v1 only</p>
13+
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
1414
* </li>
1515
* </ul>
1616
* <p>For more information about the Data API, see

‎codegen/sdk-codegen/aws-models/rds-data.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@
267267
}
268268
],
269269
"traits": {
270-
"smithy.api#documentation": "<p>Starts a SQL transaction.</p>\n <note>\n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24\n hours.</p>\n <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's\n committed, it's rolled back automatically.</p>\n <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate\n <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>\n </note>",
270+
"smithy.api#documentation": "<p>Starts a SQL transaction.</p>\n <note>\n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24\n hours.</p>\n <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's\n committed, it's rolled back automatically.</p>\n <p>For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate\n <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>\n </note>",
271271
"smithy.api#http": {
272272
"code": 200,
273273
"method": "POST",
@@ -661,7 +661,7 @@
661661
"message": "The ExecuteSql API is deprecated, please use the ExecuteStatement API.",
662662
"since": "2019-03-21"
663663
},
664-
"smithy.api#documentation": "<p>Runs one or more SQL statements.</p>\n <note>\n <p>This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, \n the operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>\n </note>",
664+
"smithy.api#documentation": "<p>Runs one or more SQL statements.</p>\n <note>\n <p>This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters.\n For Aurora Serverless v1 DB clusters, the operation is deprecated.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>\n </note>",
665665
"smithy.api#http": {
666666
"code": 200,
667667
"method": "POST",
@@ -1115,7 +1115,7 @@
11151115
},
11161116
"aws.protocols#restJson1": {},
11171117
"smithy.api#cors": {},
1118-
"smithy.api#documentation": "<fullname>RDS Data API</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these\n statements, you use the RDS Data API (Data API).</p>\n <p>Data API is available with the following types of Aurora databases:</p>\n <ul>\n <li>\n <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>\n </li>\n <li>\n <p>Aurora MySQL - Serverless v1 only</p>\n </li>\n </ul>\n <p>For more information about the Data API, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using RDS Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>",
1118+
"smithy.api#documentation": "<fullname>RDS Data API</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these\n statements, you use the RDS Data API (Data API).</p>\n <p>Data API is available with the following types of Aurora databases:</p>\n <ul>\n <li>\n <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>\n </li>\n <li>\n <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>\n </li>\n </ul>\n <p>For more information about the Data API, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using RDS Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>",
11191119
"smithy.api#title": "AWS RDS DataService",
11201120
"smithy.rules#endpointRuleSet": {
11211121
"version": "1.0",

0 commit comments

Comments
 (0)