Skip to content

Commit 095e8f0

Browse files
author
awstools
committed
docs(client-rds-data): Documentation updates for RDS Data API
1 parent 95c192f commit 095e8f0

File tree

5 files changed

+31
-13
lines changed

5 files changed

+31
-13
lines changed

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ export class RDSData extends RDSDataClient {
4848
* <p>If a call isn't part of a transaction because it doesn't include the
4949
* <code>transactionID</code> parameter, changes that result from the call are
5050
* committed automatically.</p>
51+
* <p>There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request
52+
* submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't
53+
* process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the
54+
* number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and
55+
* the size of each parameter set.</p>
56+
* <p>The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.</p>
5157
* </important>
5258
*/
5359
public batchExecuteStatement(
@@ -193,8 +199,8 @@ export class RDSData extends RDSDataClient {
193199
* <p>If a call isn't part of a transaction because it doesn't include the
194200
* <code>transactionID</code> parameter, changes that result from the call are
195201
* committed automatically.</p>
202+
* <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
196203
* </important>
197-
* <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
198204
*/
199205
public executeStatement(
200206
args: ExecuteStatementCommandInput,

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
3131
* <p>If a call isn't part of a transaction because it doesn't include the
3232
* <code>transactionID</code> parameter, changes that result from the call are
3333
* committed automatically.</p>
34+
* <p>There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request
35+
* submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't
36+
* process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the
37+
* number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and
38+
* the size of each parameter set.</p>
39+
* <p>The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.</p>
3440
* </important>
3541
* @example
3642
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
2828
* <p>If a call isn't part of a transaction because it doesn't include the
2929
* <code>transactionID</code> parameter, changes that result from the call are
3030
* committed automatically.</p>
31+
* <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
3132
* </important>
32-
* <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,9 @@ export interface ExecuteSqlRequest {
355355
dbClusterOrInstanceArn: string | undefined;
356356

357357
/**
358-
* <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>
358+
* <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password
359+
* for the credentials in the secret.</p>
360+
* <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>
359361
*/
360362
awsSecretStoreArn: string | undefined;
361363

@@ -1128,7 +1130,9 @@ export interface ExecuteStatementRequest {
11281130
resourceArn: string | undefined;
11291131

11301132
/**
1131-
* <p>The name or ARN of the secret that enables access to the DB cluster.</p>
1133+
* <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
1134+
* the secret.</p>
1135+
* <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>
11321136
*/
11331137
secretArn: string | undefined;
11341138

@@ -1245,12 +1249,14 @@ export interface BatchExecuteStatementRequest {
12451249
resourceArn: string | undefined;
12461250

12471251
/**
1248-
* <p>The name or ARN of the secret that enables access to the DB cluster.</p>
1252+
* <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
1253+
* the secret.</p>
1254+
* <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>
12491255
*/
12501256
secretArn: string | undefined;
12511257

12521258
/**
1253-
* <p>The SQL statement to run.</p>
1259+
* <p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>
12541260
*/
12551261
sql: string | undefined;
12561262

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
}
122122
],
123123
"traits": {
124-
"smithy.api#documentation": "<p>Runs a batch SQL statement over an array of data.</p>\n <p>You can run bulk update and insert operations for multiple records using a DML \n statement with different parameter sets. Bulk operations can provide a significant \n performance improvement over individual insert and update operations.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>",
124+
"smithy.api#documentation": "<p>Runs a batch SQL statement over an array of data.</p>\n <p>You can run bulk update and insert operations for multiple records using a DML \n statement with different parameter sets. Bulk operations can provide a significant \n performance improvement over individual insert and update operations.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p>\n <p>There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request\n submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't\n process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the\n number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and\n the size of each parameter set.</p>\n <p>The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.</p> \n </important>",
125125
"smithy.api#http": {
126126
"code": 200,
127127
"method": "POST",
@@ -142,14 +142,14 @@
142142
"secretArn": {
143143
"target": "com.amazonaws.rdsdata#Arn",
144144
"traits": {
145-
"smithy.api#documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>",
145+
"smithy.api#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\n the secret.</p>\n <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>",
146146
"smithy.api#required": {}
147147
}
148148
},
149149
"sql": {
150150
"target": "com.amazonaws.rdsdata#SqlStatement",
151151
"traits": {
152-
"smithy.api#documentation": "<p>The SQL statement to run.</p>",
152+
"smithy.api#documentation": "<p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>",
153153
"smithy.api#required": {}
154154
}
155155
},
@@ -225,7 +225,7 @@
225225
}
226226
],
227227
"traits": {
228-
"smithy.api#documentation": "<p>Starts a SQL transaction.</p>\n \n <important>\n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and \n rolled back automatically after 24 hours.</p>\n <p>A transaction times out if no calls use its transaction ID in three minutes. \n If a transaction times out before it's committed, it's rolled back\n automatically.</p>\n <p>DDL statements inside a transaction cause an implicit commit. We recommend \n that you run each DDL statement in a separate <code>ExecuteStatement</code> call with \n <code>continueAfterTimeout</code> enabled.</p>\n </important>",
228+
"smithy.api#documentation": "<p>Starts a SQL transaction.</p>\n \n <important> \n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and \n rolled back automatically after 24 hours.</p>\n <p>A transaction times out if no calls use its transaction ID in three minutes. \n If a transaction times out before it's committed, it's rolled back\n automatically.</p>\n <p>DDL statements inside a transaction cause an implicit commit. We recommend \n that you run each DDL statement in a separate <code>ExecuteStatement</code> call with \n <code>continueAfterTimeout</code> enabled.</p> \n </important>",
229229
"smithy.api#http": {
230230
"code": 200,
231231
"method": "POST",
@@ -587,7 +587,7 @@
587587
"awsSecretStoreArn": {
588588
"target": "com.amazonaws.rdsdata#Arn",
589589
"traits": {
590-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>",
590+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password\n for the credentials in the secret.</p>\n <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>",
591591
"smithy.api#required": {}
592592
}
593593
},
@@ -658,7 +658,7 @@
658658
}
659659
],
660660
"traits": {
661-
"smithy.api#documentation": "<p>Runs a SQL statement against a database.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>\n <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>",
661+
"smithy.api#documentation": "<p>Runs a SQL statement against a database.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p>\n <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p> \n </important>",
662662
"smithy.api#http": {
663663
"code": 200,
664664
"method": "POST",
@@ -679,7 +679,7 @@
679679
"secretArn": {
680680
"target": "com.amazonaws.rdsdata#Arn",
681681
"traits": {
682-
"smithy.api#documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>",
682+
"smithy.api#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\n the secret.</p>\n <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>",
683683
"smithy.api#required": {}
684684
}
685685
},

0 commit comments

Comments
 (0)