github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/rds-data/2018-08-01/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p><fullname>Amazon RDS Data Service</fullname> <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.</p> <p>For more information about the Data Service API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p></p>", 4 "operations": { 5 "BatchExecuteStatement": "<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>", 6 "BeginTransaction": "<p>Starts a SQL transaction.</p> <pre><code> <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 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 <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important> </code></pre>", 7 "CommitTransaction": "<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and commits the changes.</p>", 8 "ExecuteSql": "<p>Runs one or more SQL statements.</p> <important> <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p> </important>", 9 "ExecuteStatement": "<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>The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.</p>", 10 "RollbackTransaction": "<p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>" 11 }, 12 "shapes": { 13 "Arn": { 14 "base": null, 15 "refs": { 16 "BatchExecuteStatementRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>", 17 "BatchExecuteStatementRequest$secretArn": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>", 18 "BeginTransactionRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>", 19 "BeginTransactionRequest$secretArn": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>", 20 "CommitTransactionRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>", 21 "CommitTransactionRequest$secretArn": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>", 22 "ExecuteSqlRequest$awsSecretStoreArn": "<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>", 23 "ExecuteSqlRequest$dbClusterOrInstanceArn": "<p>The ARN of the Aurora Serverless DB cluster.</p>", 24 "ExecuteStatementRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>", 25 "ExecuteStatementRequest$secretArn": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>", 26 "RollbackTransactionRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>", 27 "RollbackTransactionRequest$secretArn": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>" 28 } 29 }, 30 "ArrayOfArray": { 31 "base": "<p>An array of arrays.</p> <note> <p>Some array entries can be null.</p> </note>", 32 "refs": { 33 "ArrayValue$arrayValues": "<p>An array of arrays.</p>" 34 } 35 }, 36 "ArrayValue": { 37 "base": "<p>Contains an array.</p>", 38 "refs": { 39 "ArrayOfArray$member": null, 40 "Field$arrayValue": "<p>An array of values.</p>" 41 } 42 }, 43 "ArrayValueList": { 44 "base": null, 45 "refs": { 46 "StructValue$attributes": "<p>The attributes returned in the record.</p>", 47 "Value$arrayValues": "<p>An array of column values.</p>" 48 } 49 }, 50 "BadRequestException": { 51 "base": "<p>There is an error in the call or in a SQL statement.</p>", 52 "refs": { 53 } 54 }, 55 "BatchExecuteStatementRequest": { 56 "base": "<p>The request parameters represent the input of a SQL statement over an array of data.</p>", 57 "refs": { 58 } 59 }, 60 "BatchExecuteStatementResponse": { 61 "base": "<p>The response elements represent the output of a SQL statement over an array of data.</p>", 62 "refs": { 63 } 64 }, 65 "BeginTransactionRequest": { 66 "base": "<p>The request parameters represent the input of a request to start a SQL transaction.</p>", 67 "refs": { 68 } 69 }, 70 "BeginTransactionResponse": { 71 "base": "<p>The response elements represent the output of a request to start a SQL transaction.</p>", 72 "refs": { 73 } 74 }, 75 "Blob": { 76 "base": null, 77 "refs": { 78 "Field$blobValue": "<p>A value of BLOB data type.</p>", 79 "Value$blobValue": "<p>A value for a column of BLOB data type.</p>" 80 } 81 }, 82 "Boolean": { 83 "base": null, 84 "refs": { 85 "ColumnMetadata$isAutoIncrement": "<p>A value that indicates whether the column increments automatically.</p>", 86 "ColumnMetadata$isCaseSensitive": "<p>A value that indicates whether the column is case-sensitive.</p>", 87 "ColumnMetadata$isCurrency": "<p>A value that indicates whether the column contains currency values.</p>", 88 "ColumnMetadata$isSigned": "<p>A value that indicates whether an integer column is signed.</p>", 89 "ExecuteStatementRequest$continueAfterTimeout": "<p>A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.</p> <important> <p>For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.</p> </important>", 90 "ExecuteStatementRequest$includeResultMetadata": "<p>A value that indicates whether to include metadata in the results.</p>" 91 } 92 }, 93 "BooleanArray": { 94 "base": "<p>An array of Boolean values.</p> <note> <p>Some array entries can be null.</p> </note>", 95 "refs": { 96 "ArrayValue$booleanValues": "<p>An array of Boolean values.</p>" 97 } 98 }, 99 "BoxedBoolean": { 100 "base": null, 101 "refs": { 102 "BooleanArray$member": null, 103 "Field$booleanValue": "<p>A value of Boolean data type.</p>", 104 "Field$isNull": "<p>A NULL value.</p>", 105 "Value$bitValue": "<p>A value for a column of BIT data type.</p>", 106 "Value$isNull": "<p>A NULL value.</p>" 107 } 108 }, 109 "BoxedDouble": { 110 "base": null, 111 "refs": { 112 "DoubleArray$member": null, 113 "Field$doubleValue": "<p>A value of double data type.</p>", 114 "Value$doubleValue": "<p>A value for a column of double data type.</p>" 115 } 116 }, 117 "BoxedFloat": { 118 "base": null, 119 "refs": { 120 "Value$realValue": "<p>A value for a column of real data type.</p>" 121 } 122 }, 123 "BoxedInteger": { 124 "base": null, 125 "refs": { 126 "Value$intValue": "<p>A value for a column of integer data type.</p>" 127 } 128 }, 129 "BoxedLong": { 130 "base": null, 131 "refs": { 132 "Field$longValue": "<p>A value of long data type.</p>", 133 "LongArray$member": null, 134 "Value$bigIntValue": "<p>A value for a column of big integer data type.</p>" 135 } 136 }, 137 "ColumnMetadata": { 138 "base": "<p>Contains the metadata for a column.</p>", 139 "refs": { 140 "Metadata$member": null 141 } 142 }, 143 "CommitTransactionRequest": { 144 "base": "<p>The request parameters represent the input of a commit transaction request.</p>", 145 "refs": { 146 } 147 }, 148 "CommitTransactionResponse": { 149 "base": "<p>The response elements represent the output of a commit transaction request.</p>", 150 "refs": { 151 } 152 }, 153 "DbName": { 154 "base": null, 155 "refs": { 156 "BatchExecuteStatementRequest$database": "<p>The name of the database.</p>", 157 "BatchExecuteStatementRequest$schema": "<p>The name of the database schema.</p>", 158 "BeginTransactionRequest$database": "<p>The name of the database.</p>", 159 "BeginTransactionRequest$schema": "<p>The name of the database schema.</p>", 160 "ExecuteSqlRequest$database": "<p>The name of the database.</p>", 161 "ExecuteSqlRequest$schema": "<p>The name of the database schema.</p>", 162 "ExecuteStatementRequest$database": "<p>The name of the database.</p>", 163 "ExecuteStatementRequest$schema": "<p>The name of the database schema.</p> <note> <p>Currently, the <code>schema</code> parameter isn't supported.</p> </note>" 164 } 165 }, 166 "DecimalReturnType": { 167 "base": null, 168 "refs": { 169 "ResultSetOptions$decimalReturnType": "<p>A value that indicates how a field of <code>DECIMAL</code> type is represented in the response. The value of <code>STRING</code>, the default, specifies that it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code> specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.</p> <important> <p>Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.</p> </important>" 170 } 171 }, 172 "DoubleArray": { 173 "base": "<p>An array of floating point numbers.</p> <note> <p>Some array entries can be null.</p> </note>", 174 "refs": { 175 "ArrayValue$doubleValues": "<p>An array of integers.</p>" 176 } 177 }, 178 "ErrorMessage": { 179 "base": null, 180 "refs": { 181 "BadRequestException$message": "<p>The error message returned by this <code>BadRequestException</code> error.</p>", 182 "ForbiddenException$message": "<p>The error message returned by this <code>ForbiddenException</code> error.</p>", 183 "NotFoundException$message": "<p>The error message returned by this <code>NotFoundException</code> error.</p>", 184 "StatementTimeoutException$message": "<p>The error message returned by this <code>StatementTimeoutException</code> error.</p>" 185 } 186 }, 187 "ExecuteSqlRequest": { 188 "base": "<p>The request parameters represent the input of a request to run one or more SQL statements.</p>", 189 "refs": { 190 } 191 }, 192 "ExecuteSqlResponse": { 193 "base": "<p>The response elements represent the output of a request to run one or more SQL statements.</p>", 194 "refs": { 195 } 196 }, 197 "ExecuteStatementRequest": { 198 "base": "<p>The request parameters represent the input of a request to run a SQL statement against a database.</p>", 199 "refs": { 200 } 201 }, 202 "ExecuteStatementResponse": { 203 "base": "<p>The response elements represent the output of a request to run a SQL statement against a database.</p>", 204 "refs": { 205 } 206 }, 207 "Field": { 208 "base": "<p>Contains a value.</p>", 209 "refs": { 210 "FieldList$member": null, 211 "SqlParameter$value": "<p>The value of the parameter.</p>" 212 } 213 }, 214 "FieldList": { 215 "base": null, 216 "refs": { 217 "ExecuteStatementResponse$generatedFields": "<p>Values for fields generated during the request.</p> <pre><code> <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> </code></pre>", 218 "SqlRecords$member": null, 219 "UpdateResult$generatedFields": "<p>Values for fields generated during the request.</p>" 220 } 221 }, 222 "ForbiddenException": { 223 "base": "<p>There are insufficient privileges to make the call.</p>", 224 "refs": { 225 } 226 }, 227 "Id": { 228 "base": null, 229 "refs": { 230 "BatchExecuteStatementRequest$transactionId": "<p>The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.</p> <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>", 231 "BeginTransactionResponse$transactionId": "<p>The transaction ID of the transaction started by the call.</p>", 232 "CommitTransactionRequest$transactionId": "<p>The identifier of the transaction to end and commit.</p>", 233 "ExecuteStatementRequest$transactionId": "<p>The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.</p> <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>", 234 "RollbackTransactionRequest$transactionId": "<p>The identifier of the transaction to roll back.</p>" 235 } 236 }, 237 "Integer": { 238 "base": null, 239 "refs": { 240 "ColumnMetadata$arrayBaseColumnType": "<p>The type of the column.</p>", 241 "ColumnMetadata$nullable": "<p>A value that indicates whether the column is nullable.</p>", 242 "ColumnMetadata$precision": "<p>The precision value of a decimal number column.</p>", 243 "ColumnMetadata$scale": "<p>The scale value of a decimal number column.</p>", 244 "ColumnMetadata$type": "<p>The type of the column.</p>" 245 } 246 }, 247 "InternalServerErrorException": { 248 "base": "<p>An internal error occurred.</p>", 249 "refs": { 250 } 251 }, 252 "Long": { 253 "base": null, 254 "refs": { 255 "ResultSetMetadata$columnCount": "<p>The number of columns in the result set.</p>", 256 "StatementTimeoutException$dbConnectionId": "<p>The database connection ID that executed the SQL statement.</p>" 257 } 258 }, 259 "LongArray": { 260 "base": "<p>An array of integers.</p> <note> <p>Some array entries can be null.</p> </note>", 261 "refs": { 262 "ArrayValue$longValues": "<p>An array of floating point numbers.</p>" 263 } 264 }, 265 "Metadata": { 266 "base": null, 267 "refs": { 268 "ExecuteStatementResponse$columnMetadata": "<p>Metadata for the columns included in the results.</p>", 269 "ResultSetMetadata$columnMetadata": "<p>The metadata of the columns in the result set.</p>" 270 } 271 }, 272 "NotFoundException": { 273 "base": "<p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>", 274 "refs": { 275 } 276 }, 277 "ParameterName": { 278 "base": null, 279 "refs": { 280 "SqlParameter$name": "<p>The name of the parameter.</p>" 281 } 282 }, 283 "Record": { 284 "base": "<p>A record returned by a call.</p>", 285 "refs": { 286 "Records$member": null 287 } 288 }, 289 "Records": { 290 "base": null, 291 "refs": { 292 "ResultFrame$records": "<p>The records in the result set.</p>" 293 } 294 }, 295 "RecordsUpdated": { 296 "base": null, 297 "refs": { 298 "ExecuteStatementResponse$numberOfRecordsUpdated": "<p>The number of records updated by the request.</p>", 299 "SqlStatementResult$numberOfRecordsUpdated": "<p>The number of records updated by a SQL statement.</p>" 300 } 301 }, 302 "ResultFrame": { 303 "base": "<p>The result set returned by a SQL statement.</p>", 304 "refs": { 305 "SqlStatementResult$resultFrame": "<p>The result set of the SQL statement.</p>" 306 } 307 }, 308 "ResultSetMetadata": { 309 "base": "<p>The metadata of the result set returned by a SQL statement.</p>", 310 "refs": { 311 "ResultFrame$resultSetMetadata": "<p>The result-set metadata in the result set.</p>" 312 } 313 }, 314 "ResultSetOptions": { 315 "base": "<p>Options that control how the result set is returned.</p>", 316 "refs": { 317 "ExecuteStatementRequest$resultSetOptions": "<p>Options that control how the result set is returned.</p>" 318 } 319 }, 320 "RollbackTransactionRequest": { 321 "base": "<p>The request parameters represent the input of a request to perform a rollback of a transaction.</p>", 322 "refs": { 323 } 324 }, 325 "RollbackTransactionResponse": { 326 "base": "<p>The response elements represent the output of a request to perform a rollback of a transaction.</p>", 327 "refs": { 328 } 329 }, 330 "Row": { 331 "base": null, 332 "refs": { 333 "Record$values": "<p>The values returned in the record.</p>" 334 } 335 }, 336 "ServiceUnavailableError": { 337 "base": "<p>The service specified by the <code>resourceArn</code> parameter is not available.</p>", 338 "refs": { 339 } 340 }, 341 "SqlParameter": { 342 "base": "<p>A parameter used in a SQL statement.</p>", 343 "refs": { 344 "SqlParametersList$member": null 345 } 346 }, 347 "SqlParameterSets": { 348 "base": null, 349 "refs": { 350 "BatchExecuteStatementRequest$parameterSets": "<p>The parameter set for the batch operation.</p> <p>The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:</p> <ul> <li> <p>Specify one or more empty parameter sets.</p> </li> <li> <p>Use the <code>ExecuteStatement</code> operation instead of the <code>BatchExecuteStatement</code> operation.</p> </li> </ul> <note> <p>Array parameters are not supported.</p> </note>" 351 } 352 }, 353 "SqlParametersList": { 354 "base": null, 355 "refs": { 356 "ExecuteStatementRequest$parameters": "<p>The parameters for the SQL statement.</p> <note> <p>Array parameters are not supported.</p> </note>", 357 "SqlParameterSets$member": null 358 } 359 }, 360 "SqlRecords": { 361 "base": null, 362 "refs": { 363 "ExecuteStatementResponse$records": "<p>The records returned by the SQL statement.</p>" 364 } 365 }, 366 "SqlStatement": { 367 "base": null, 368 "refs": { 369 "BatchExecuteStatementRequest$sql": "<p>The SQL statement to run.</p>", 370 "ExecuteSqlRequest$sqlStatements": "<p>One or more SQL statements to run on the DB cluster.</p> <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. </p>", 371 "ExecuteStatementRequest$sql": "<p>The SQL statement to run.</p>" 372 } 373 }, 374 "SqlStatementResult": { 375 "base": "<p>The result of a SQL statement.</p> <pre><code> <important> <p>This data type is deprecated.</p> </important> </code></pre>", 376 "refs": { 377 "SqlStatementResults$member": null 378 } 379 }, 380 "SqlStatementResults": { 381 "base": null, 382 "refs": { 383 "ExecuteSqlResponse$sqlStatementResults": "<p>The results of the SQL statement or statements.</p>" 384 } 385 }, 386 "StatementTimeoutException": { 387 "base": "<p>The execution of the SQL statement timed out.</p>", 388 "refs": { 389 } 390 }, 391 "String": { 392 "base": null, 393 "refs": { 394 "ColumnMetadata$label": "<p>The label for the column.</p>", 395 "ColumnMetadata$name": "<p>The name of the column.</p>", 396 "ColumnMetadata$schemaName": "<p>The name of the schema that owns the table that includes the column.</p>", 397 "ColumnMetadata$tableName": "<p>The name of the table that includes the column.</p>", 398 "ColumnMetadata$typeName": "<p>The database-specific data type of the column.</p>", 399 "Field$stringValue": "<p>A value of string data type.</p>", 400 "StringArray$member": null, 401 "Value$stringValue": "<p>A value for a column of string data type.</p>" 402 } 403 }, 404 "StringArray": { 405 "base": "<p>An array of strings.</p> <note> <p>Some array entries can be null.</p> </note>", 406 "refs": { 407 "ArrayValue$stringValues": "<p>An array of strings.</p>" 408 } 409 }, 410 "StructValue": { 411 "base": "<p>A structure value returned by a call.</p>", 412 "refs": { 413 "Value$structValue": "<p>A value for a column of STRUCT data type.</p>" 414 } 415 }, 416 "TransactionStatus": { 417 "base": null, 418 "refs": { 419 "CommitTransactionResponse$transactionStatus": "<p>The status of the commit operation.</p>", 420 "RollbackTransactionResponse$transactionStatus": "<p>The status of the rollback operation.</p>" 421 } 422 }, 423 "TypeHint": { 424 "base": null, 425 "refs": { 426 "SqlParameter$typeHint": "<p>A hint that specifies the correct object type for data type mapping. Possible values are as follows:</p> <ul> <li> <p> <code>DATE</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>DATE</code> type to the database. The accepted format is <code>YYYY-MM-DD</code>.</p> </li> <li> <p> <code>DECIMAL</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>DECIMAL</code> type to the database.</p> </li> <li> <p> <code>JSON</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>JSON</code> type to the database.</p> </li> <li> <p> <code>TIME</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>TIME</code> type to the database. The accepted format is <code>HH:MM:SS[.FFF]</code>.</p> </li> <li> <p> <code>TIMESTAMP</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>TIMESTAMP</code> type to the database. The accepted format is <code>YYYY-MM-DD HH:MM:SS[.FFF]</code>.</p> </li> <li> <p> <code>UUID</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>UUID</code> type to the database. </p> </li> </ul>" 427 } 428 }, 429 "UpdateResult": { 430 "base": "<p>The response elements represent the results of an update.</p>", 431 "refs": { 432 "UpdateResults$member": null 433 } 434 }, 435 "UpdateResults": { 436 "base": null, 437 "refs": { 438 "BatchExecuteStatementResponse$updateResults": "<p>The execution results of each batch entry.</p>" 439 } 440 }, 441 "Value": { 442 "base": "<p>Contains the value of a column.</p> <pre><code> <important> <p>This data type is deprecated.</p> </important> </code></pre>", 443 "refs": { 444 "ArrayValueList$member": null, 445 "Row$member": null 446 } 447 } 448 } 449 }