"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>"
},
"BeginTransaction":{
"name":"BeginTransaction",
"http":{
"method":"POST",
"requestUri":"/BeginTransaction",
"responseCode":200
},
"input":{"shape":"BeginTransactionRequest"},
"output":{"shape":"BeginTransactionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"StatementTimeoutException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"documentation":"<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>"
"documentation":"<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and commits the changes.</p>"
},
"ExecuteSql":{
"name":"ExecuteSql",
"http":{
"method":"POST",
"requestUri":"/ExecuteSql",
"responseCode":200
},
"input":{"shape":"ExecuteSqlRequest"},
"output":{"shape":"ExecuteSqlResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"documentation":"<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>",
"deprecated":true,
"deprecatedMessage":"The ExecuteSql API is deprecated, please use the ExecuteStatement API."
"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>The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.</p>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The ARN of the Aurora Serverless DB cluster.</p>"
},
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"sqlStatements":{
"shape":"SqlStatement",
"documentation":"<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>"
}
},
"documentation":"<p>The request parameters represent the input of a request to run one or more SQL statements.</p>"
},
"ExecuteSqlResponse":{
"type":"structure",
"members":{
"sqlStatementResults":{
"shape":"SqlStatementResults",
"documentation":"<p>The results of the SQL statement or statements.</p>"
"documentation":"<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>"
},
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"sql":{
"shape":"SqlStatement",
"documentation":"<p>The SQL statement to run.</p>"
},
"transactionId":{
"shape":"Id",
"documentation":"<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>"
"documentation":"<p>Metadata for the columns included in the results.</p>"
},
"generatedFields":{
"shape":"FieldList",
"documentation":"<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>"
},
"numberOfRecordsUpdated":{
"shape":"RecordsUpdated",
"documentation":"<p>The number of records updated by the request.</p>"
},
"records":{
"shape":"SqlRecords",
"documentation":"<p>The records returned by the SQL statement.</p>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The result of a SQL statement.</p> <pre><code> <important> <p>This data type is deprecated.</p> </important> </code></pre>"
"documentation":"<p>Contains the value of a column.</p> <pre><code> <important> <p>This data type is deprecated.</p> </important> </code></pre>",
"documentation":"<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>"