Skip to content

Commit c6b9634

Browse files
author
AWS
committed
AWS RDS DataService Update: Documentation updates for RDS Data API
1 parent ae81bc8 commit c6b9634

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS RDS DataService",
4+
"contributor": "",
5+
"description": "Documentation updates for RDS Data API"
6+
}

services/rdsdata/src/main/resources/codegen-resources/service-2.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
{"shape":"ForbiddenException"},
3030
{"shape":"ServiceUnavailableError"}
3131
],
32-
"documentation":"<p>Runs a batch SQL statement over an array of data.</p> <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> </important>"
32+
"documentation":"<p>Runs a batch SQL statement over an array of data.</p> <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> <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>"
3333
},
3434
"BeginTransaction":{
3535
"name":"BeginTransaction",
@@ -107,7 +107,7 @@
107107
{"shape":"ForbiddenException"},
108108
{"shape":"ServiceUnavailableError"}
109109
],
110-
"documentation":"<p>Runs a SQL statement against a database.</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> </important> <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>"
110+
"documentation":"<p>Runs a SQL statement against a database.</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> <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p> </important>"
111111
},
112112
"RollbackTransaction":{
113113
"name":"RollbackTransaction",
@@ -225,11 +225,11 @@
225225
},
226226
"secretArn":{
227227
"shape":"Arn",
228-
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
228+
"documentation":"<p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.</p> <p>For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.</p>"
229229
},
230230
"sql":{
231231
"shape":"SqlStatement",
232-
"documentation":"<p>The SQL statement to run.</p>"
232+
"documentation":"<p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>"
233233
},
234234
"transactionId":{
235235
"shape":"Id",
@@ -434,7 +434,7 @@
434434
"members":{
435435
"awsSecretStoreArn":{
436436
"shape":"Arn",
437-
"documentation":"<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>"
437+
"documentation":"<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.</p> <p>For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.</p>"
438438
},
439439
"database":{
440440
"shape":"DbName",
@@ -507,7 +507,7 @@
507507
},
508508
"secretArn":{
509509
"shape":"Arn",
510-
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
510+
"documentation":"<p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.</p> <p>For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.</p>"
511511
},
512512
"sql":{
513513
"shape":"SqlStatement",

0 commit comments

Comments
 (0)