Skip to content

Commit

Permalink
docs(client-rds-data): Documentation update for RDS Data API to refle…
Browse files Browse the repository at this point in the history
…ct support for Aurora MySQL Serverless v2 and Provisioned DB clusters.
  • Loading branch information
awstools committed Sep 26, 2024
1 parent 25f3950 commit d2c0cef
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions clients/client-rds-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ statements, you use the RDS Data API (Data API).</p>
<p>Data API is available with the following types of Aurora databases:</p>
<ul>
<li>
<p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
<p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
</li>
<li>
<p>Aurora MySQL - Serverless v1 only</p>
<p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
</li>
</ul>
<p>For more information about the Data API, see
Expand Down
4 changes: 2 additions & 2 deletions clients/client-rds-data/src/RDSData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ export interface RDSData {
* <p>Data API is available with the following types of Aurora databases:</p>
* <ul>
* <li>
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* <li>
* <p>Aurora MySQL - Serverless v1 only</p>
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* </ul>
* <p>For more information about the Data API, see
Expand Down
4 changes: 2 additions & 2 deletions clients/client-rds-data/src/RDSDataClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,10 @@ export interface RDSDataClientResolvedConfig extends RDSDataClientResolvedConfig
* <p>Data API is available with the following types of Aurora databases:</p>
* <ul>
* <li>
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* <li>
* <p>Aurora MySQL - Serverless v1 only</p>
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* </ul>
* <p>For more information about the Data API, see
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
* 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
* <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
* <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p>
* </note>
* @example
Expand Down
5 changes: 3 additions & 2 deletions clients/client-rds-data/src/commands/ExecuteSqlCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
/**
* <p>Runs one or more SQL statements.</p>
* <note>
* <p>This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters,
* the operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>
* <p>This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters.
* For Aurora Serverless v1 DB clusters, the operation is deprecated.
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>
* </note>
*
* @deprecated The ExecuteSql API is deprecated, please use the ExecuteStatement API.
Expand Down
4 changes: 2 additions & 2 deletions clients/client-rds-data/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
* <p>Data API is available with the following types of Aurora databases:</p>
* <ul>
* <li>
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
* <p>Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* <li>
* <p>Aurora MySQL - Serverless v1 only</p>
* <p>Aurora MySQL - Serverless v2, provisioned, and Serverless v1</p>
* </li>
* </ul>
* <p>For more information about the Data API, see
Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/rds-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@
}
],
"traits": {
"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>",
"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>",
"smithy.api#http": {
"code": 200,
"method": "POST",
Expand Down Expand Up @@ -661,7 +661,7 @@
"message": "The ExecuteSql API is deprecated, please use the ExecuteStatement API.",
"since": "2019-03-21"
},
"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>",
"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>",
"smithy.api#http": {
"code": 200,
"method": "POST",
Expand Down Expand Up @@ -1115,7 +1115,7 @@
},
"aws.protocols#restJson1": {},
"smithy.api#cors": {},
"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>",
"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>",
"smithy.api#title": "AWS RDS DataService",
"smithy.rules#endpointRuleSet": {
"version": "1.0",
Expand Down

0 comments on commit d2c0cef

Please sign in to comment.