Skip to content

Commit 6aabe74

Browse files
author
awstools
committed
docs(client-rds-data): Doc update to reflect no support for schema parameter on BatchExecuteStatement API
1 parent f53ca0e commit 6aabe74

File tree

2 files changed

+55
-40
lines changed

2 files changed

+55
-40
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,6 +1092,9 @@ export interface BatchExecuteStatementRequest {
10921092

10931093
/**
10941094
* <p>The name of the database schema.</p>
1095+
* <note>
1096+
* <p>Currently, the <code>schema</code> parameter isn't supported.</p>
1097+
* </note>
10951098
*/
10961099
schema?: string;
10971100

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

Lines changed: 52 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"smithy": "1.0",
2+
"smithy": "2.0",
33
"shapes": {
44
"com.amazonaws.rdsdata#AccessDeniedException": {
55
"type": "structure",
@@ -162,7 +162,7 @@
162162
"schema": {
163163
"target": "com.amazonaws.rdsdata#DbName",
164164
"traits": {
165-
"smithy.api#documentation": "<p>The name of the database schema.</p>"
165+
"smithy.api#documentation": "<p>The name of the database schema.</p>\n <note>\n <p>Currently, the <code>schema</code> parameter isn't supported.</p>\n </note>"
166166
}
167167
},
168168
"parameterSets": {
@@ -285,7 +285,10 @@
285285
"type": "blob"
286286
},
287287
"com.amazonaws.rdsdata#Boolean": {
288-
"type": "boolean"
288+
"type": "boolean",
289+
"traits": {
290+
"smithy.api#default": false
291+
}
289292
},
290293
"com.amazonaws.rdsdata#BooleanArray": {
291294
"type": "list",
@@ -297,34 +300,19 @@
297300
}
298301
},
299302
"com.amazonaws.rdsdata#BoxedBoolean": {
300-
"type": "boolean",
301-
"traits": {
302-
"smithy.api#box": {}
303-
}
303+
"type": "boolean"
304304
},
305305
"com.amazonaws.rdsdata#BoxedDouble": {
306-
"type": "double",
307-
"traits": {
308-
"smithy.api#box": {}
309-
}
306+
"type": "double"
310307
},
311308
"com.amazonaws.rdsdata#BoxedFloat": {
312-
"type": "float",
313-
"traits": {
314-
"smithy.api#box": {}
315-
}
309+
"type": "float"
316310
},
317311
"com.amazonaws.rdsdata#BoxedInteger": {
318-
"type": "integer",
319-
"traits": {
320-
"smithy.api#box": {}
321-
}
312+
"type": "integer"
322313
},
323314
"com.amazonaws.rdsdata#BoxedLong": {
324-
"type": "long",
325-
"traits": {
326-
"smithy.api#box": {}
327-
}
315+
"type": "long"
328316
},
329317
"com.amazonaws.rdsdata#ColumnMetadata": {
330318
"type": "structure",
@@ -338,6 +326,7 @@
338326
"type": {
339327
"target": "com.amazonaws.rdsdata#Integer",
340328
"traits": {
329+
"smithy.api#default": 0,
341330
"smithy.api#documentation": "<p>The type of the column.</p>"
342331
}
343332
},
@@ -368,48 +357,56 @@
368357
"isAutoIncrement": {
369358
"target": "com.amazonaws.rdsdata#Boolean",
370359
"traits": {
360+
"smithy.api#default": false,
371361
"smithy.api#documentation": "<p>A value that indicates whether the column increments automatically.</p>"
372362
}
373363
},
374364
"isSigned": {
375365
"target": "com.amazonaws.rdsdata#Boolean",
376366
"traits": {
367+
"smithy.api#default": false,
377368
"smithy.api#documentation": "<p>A value that indicates whether an integer column is signed.</p>"
378369
}
379370
},
380371
"isCurrency": {
381372
"target": "com.amazonaws.rdsdata#Boolean",
382373
"traits": {
374+
"smithy.api#default": false,
383375
"smithy.api#documentation": "<p>A value that indicates whether the column contains currency values.</p>"
384376
}
385377
},
386378
"isCaseSensitive": {
387379
"target": "com.amazonaws.rdsdata#Boolean",
388380
"traits": {
381+
"smithy.api#default": false,
389382
"smithy.api#documentation": "<p>A value that indicates whether the column is case-sensitive.</p>"
390383
}
391384
},
392385
"nullable": {
393386
"target": "com.amazonaws.rdsdata#Integer",
394387
"traits": {
388+
"smithy.api#default": 0,
395389
"smithy.api#documentation": "<p>A value that indicates whether the column is nullable.</p>"
396390
}
397391
},
398392
"precision": {
399393
"target": "com.amazonaws.rdsdata#Integer",
400394
"traits": {
395+
"smithy.api#default": 0,
401396
"smithy.api#documentation": "<p>The precision value of a decimal number column.</p>"
402397
}
403398
},
404399
"scale": {
405400
"target": "com.amazonaws.rdsdata#Integer",
406401
"traits": {
402+
"smithy.api#default": 0,
407403
"smithy.api#documentation": "<p>The scale value of a decimal number column.</p>"
408404
}
409405
},
410406
"arrayBaseColumnType": {
411407
"target": "com.amazonaws.rdsdata#Integer",
412408
"traits": {
409+
"smithy.api#default": 0,
413410
"smithy.api#documentation": "<p>The type of the column.</p>"
414411
}
415412
}
@@ -717,12 +714,14 @@
717714
"includeResultMetadata": {
718715
"target": "com.amazonaws.rdsdata#Boolean",
719716
"traits": {
717+
"smithy.api#default": false,
720718
"smithy.api#documentation": "<p>A value that indicates whether to include metadata in the results.</p>"
721719
}
722720
},
723721
"continueAfterTimeout": {
724722
"target": "com.amazonaws.rdsdata#Boolean",
725723
"traits": {
724+
"smithy.api#default": false,
726725
"smithy.api#documentation": "<p>A value that indicates whether to continue running the statement after \n the call times out. By default, the statement stops running when the call \n times out.</p>\n <note>\n <p>For DDL statements, we recommend continuing to run the statement after \n the call times out. When a DDL statement terminates before it is finished \n running, it can result in errors and possibly corrupted data structures.</p>\n </note>"
727726
}
728727
},
@@ -761,6 +760,7 @@
761760
"numberOfRecordsUpdated": {
762761
"target": "com.amazonaws.rdsdata#RecordsUpdated",
763762
"traits": {
763+
"smithy.api#default": 0,
764764
"smithy.api#documentation": "<p>The number of records updated by the request.</p>"
765765
}
766766
},
@@ -865,7 +865,10 @@
865865
}
866866
},
867867
"com.amazonaws.rdsdata#Integer": {
868-
"type": "integer"
868+
"type": "integer",
869+
"traits": {
870+
"smithy.api#default": 0
871+
}
869872
},
870873
"com.amazonaws.rdsdata#InternalServerErrorException": {
871874
"type": "structure",
@@ -877,7 +880,10 @@
877880
}
878881
},
879882
"com.amazonaws.rdsdata#Long": {
880-
"type": "long"
883+
"type": "long",
884+
"traits": {
885+
"smithy.api#default": 0
886+
}
881887
},
882888
"com.amazonaws.rdsdata#LongArray": {
883889
"type": "list",
@@ -930,19 +936,6 @@
930936
},
931937
"com.amazonaws.rdsdata#RdsDataService": {
932938
"type": "service",
933-
"traits": {
934-
"aws.api#service": {
935-
"sdkId": "RDS Data",
936-
"arnNamespace": "rds-data"
937-
},
938-
"aws.auth#sigv4": {
939-
"name": "rds-data"
940-
},
941-
"aws.protocols#restJson1": {},
942-
"smithy.api#cors": {},
943-
"smithy.api#documentation": "<fullname>Amazon RDS Data Service</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these\n statements, you work with the Data Service API.</p>\n <note>\n <p>The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.</p>\n </note>\n <p>For more information about the Data Service API, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>",
944-
"smithy.api#title": "AWS RDS DataService"
945-
},
946939
"version": "2018-08-01",
947940
"operations": [
948941
{
@@ -963,7 +956,20 @@
963956
{
964957
"target": "com.amazonaws.rdsdata#RollbackTransaction"
965958
}
966-
]
959+
],
960+
"traits": {
961+
"aws.api#service": {
962+
"sdkId": "RDS Data",
963+
"arnNamespace": "rds-data"
964+
},
965+
"aws.auth#sigv4": {
966+
"name": "rds-data"
967+
},
968+
"aws.protocols#restJson1": {},
969+
"smithy.api#cors": {},
970+
"smithy.api#documentation": "<fullname>Amazon RDS Data Service</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these\n statements, you work with the Data Service API.</p>\n <note>\n <p>The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.</p>\n </note>\n <p>For more information about the Data Service API, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>",
971+
"smithy.api#title": "AWS RDS DataService"
972+
}
967973
},
968974
"com.amazonaws.rdsdata#Record": {
969975
"type": "structure",
@@ -1001,7 +1007,10 @@
10011007
}
10021008
},
10031009
"com.amazonaws.rdsdata#RecordsUpdated": {
1004-
"type": "long"
1010+
"type": "long",
1011+
"traits": {
1012+
"smithy.api#default": 0
1013+
}
10051014
},
10061015
"com.amazonaws.rdsdata#ResultFrame": {
10071016
"type": "structure",
@@ -1029,6 +1038,7 @@
10291038
"columnCount": {
10301039
"target": "com.amazonaws.rdsdata#Long",
10311040
"traits": {
1041+
"smithy.api#default": 0,
10321042
"smithy.api#documentation": "<p>The number of columns in the result set.</p>"
10331043
}
10341044
},
@@ -1225,6 +1235,7 @@
12251235
"numberOfRecordsUpdated": {
12261236
"target": "com.amazonaws.rdsdata#RecordsUpdated",
12271237
"traits": {
1238+
"smithy.api#default": 0,
12281239
"smithy.api#documentation": "<p>The number of records updated by a SQL statement.</p>"
12291240
}
12301241
}
@@ -1251,6 +1262,7 @@
12511262
"dbConnectionId": {
12521263
"target": "com.amazonaws.rdsdata#Long",
12531264
"traits": {
1265+
"smithy.api#default": 0,
12541266
"smithy.api#documentation": "<p>The database connection ID that executed the SQL statement.</p>"
12551267
}
12561268
}

0 commit comments

Comments
 (0)