"documentation":"<fullname>Amazon RDS Data Service</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora\n Serverless DB cluster. To run these statements, you work with the Data Service\n API.</p>\n <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\n Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"operations":{
"BatchExecuteStatement":{
"name":"BatchExecuteStatement",
"http":{
"method":"POST",
"requestUri":"/BatchExecute",
"responseCode":200
},
"input":{
"shape":"BatchExecuteStatementRequest"
},
"output":{
"shape":"BatchExecuteStatementResponse"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"ServiceUnavailableError"
},
{
"shape":"StatementTimeoutException"
}
],
"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>"
},
"BeginTransaction":{
"name":"BeginTransaction",
"http":{
"method":"POST",
"requestUri":"/BeginTransaction",
"responseCode":200
},
"input":{
"shape":"BeginTransactionRequest"
},
"output":{
"shape":"BeginTransactionResponse"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"ServiceUnavailableError"
},
{
"shape":"StatementTimeoutException"
}
],
"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>"
},
"CommitTransaction":{
"name":"CommitTransaction",
"http":{
"method":"POST",
"requestUri":"/CommitTransaction",
"responseCode":200
},
"input":{
"shape":"CommitTransactionRequest"
},
"output":{
"shape":"CommitTransactionResponse"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"NotFoundException"
},
{
"shape":"ServiceUnavailableError"
}
],
"documentation":"<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and\n commits the changes.</p>"
},
"ExecuteSql":{
"name":"ExecuteSql",
"http":{
"method":"POST",
"requestUri":"/ExecuteSql",
"responseCode":200
},
"input":{
"shape":"ExecuteSqlRequest"
},
"output":{
"shape":"ExecuteSqlResponse"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"ServiceUnavailableError"
}
],
"deprecated":true,
"documentation":"<p>Runs one or more SQL statements.</p>\n <important>\n <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or\n <code>ExecuteStatement</code> operation.</p>\n </important>"
},
"ExecuteStatement":{
"name":"ExecuteStatement",
"http":{
"method":"POST",
"requestUri":"/Execute",
"responseCode":200
},
"input":{
"shape":"ExecuteStatementRequest"
},
"output":{
"shape":"ExecuteStatementResponse"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"ServiceUnavailableError"
},
{
"shape":"StatementTimeoutException"
}
],
"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>The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.</p>"
"documentation":"<p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>"
}
},
"shapes":{
"SqlStatementResults":{
"type":"list",
"member":{
"shape":"SqlStatementResult"
}
},
"ResultFrame":{
"type":"structure",
"members":{
"records":{
"shape":"Records",
"documentation":"<p>The records in the result set.</p>"
},
"resultSetMetadata":{
"shape":"ResultSetMetadata",
"documentation":"<p>The result-set metadata in the result set.</p>"
}
},
"documentation":"<p>The result set returned by a SQL statement.</p>"
},
"SqlParameterSets":{
"type":"list",
"member":{
"shape":"SqlParametersList"
}
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>NotFoundException</code> error.</p>"
}
},
"documentation":"<p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>",
"exception":true,
"error":{
"code":"NotFoundException",
"httpStatusCode":404,
"senderFault":true
}
},
"BatchExecuteStatementRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"sql"
],
"members":{
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"parameterSets":{
"shape":"SqlParameterSets",
"documentation":"<p>The parameter set for the batch operation.</p>"
},
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"secretArn":{
"shape":"Arn",
"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\n <code>BeginTransaction</code> operation. Specify the transaction ID of the\n transaction that you want to include the SQL statement in.</p>\n <p>If the SQL statement is not part of a transaction, don't set this\n parameter.</p>"
}
},
"documentation":"<p>The request parameters represent the input of a SQL statement over an array of\n data.</p>"
},
"ArrayValueList":{
"type":"list",
"member":{
"shape":"Value"
}
},
"UpdateResults":{
"type":"list",
"member":{
"shape":"UpdateResult"
}
},
"Row":{
"type":"list",
"member":{
"shape":"Value"
}
},
"SqlRecords":{
"type":"list",
"member":{
"shape":"FieldList"
}
},
"Long":{
"type":"long"
},
"BoxedInteger":{
"type":"integer",
"box":true
},
"CommitTransactionResponse":{
"type":"structure",
"members":{
"transactionStatus":{
"shape":"TransactionStatus",
"documentation":"<p>The status of the commit operation.</p>"
}
},
"documentation":"<p>The response elements represent the output of a commit transaction request.</p>"
},
"Integer":{
"type":"integer"
},
"BoxedLong":{
"type":"long",
"box":true
},
"SqlParameter":{
"type":"structure",
"members":{
"name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter.</p>"
},
"value":{
"shape":"Field",
"documentation":"<p>The value of the parameter.</p>"
}
},
"documentation":"<p>A parameter used in a SQL statement.</p>"
},
"Field":{
"type":"structure",
"members":{
"blobValue":{
"shape":"Blob",
"documentation":"<p>A value of BLOB data type.</p>"
},
"booleanValue":{
"shape":"BoxedBoolean",
"documentation":"<p>A value of Boolean data type.</p>"
},
"doubleValue":{
"shape":"BoxedDouble",
"documentation":"<p>A value of double data type.</p>"
},
"isNull":{
"shape":"BoxedBoolean",
"documentation":"<p>A NULL value.</p>"
},
"longValue":{
"shape":"BoxedLong",
"documentation":"<p>A value of long data type.</p>"
},
"stringValue":{
"shape":"String",
"documentation":"<p>A value of string data type.</p>"
}
},
"documentation":"<p>Contains a value.</p>"
},
"ExecuteSqlRequest":{
"type":"structure",
"required":[
"awsSecretStoreArn",
"dbClusterOrInstanceArn",
"sqlStatements"
],
"members":{
"awsSecretStoreArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>"
},
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"dbClusterOrInstanceArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the Aurora Serverless DB cluster.</p>"
"documentation":"<p>One or more SQL statements to run on the DB cluster.</p>\n <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL\n statement is permitted, including data definition, data manipulation, and commit\n statements. </p>"
"documentation":"<p>The error message returned by this <code>ForbiddenException</code> error.</p>"
}
},
"documentation":"<p>There are insufficient privileges to make the call.</p>",
"exception":true,
"error":{
"code":"ForbiddenException",
"httpStatusCode":403,
"senderFault":true
}
},
"Value":{
"type":"structure",
"members":{
"arrayValues":{
"shape":"ArrayValueList",
"documentation":"<p>An array of column values.</p>"
},
"bigIntValue":{
"shape":"BoxedLong",
"documentation":"<p>A value for a column of big integer data type.</p>"
},
"bitValue":{
"shape":"BoxedBoolean",
"documentation":"<p>A value for a column of BIT data type.</p>"
},
"blobValue":{
"shape":"Blob",
"documentation":"<p>A value for a column of BLOB data type.</p>"
},
"doubleValue":{
"shape":"BoxedDouble",
"documentation":"<p>A value for a column of double data type.</p>"
},
"intValue":{
"shape":"BoxedInteger",
"documentation":"<p>A value for a column of integer data type.</p>"
},
"isNull":{
"shape":"BoxedBoolean",
"documentation":"<p>A NULL value.</p>"
},
"realValue":{
"shape":"BoxedFloat",
"documentation":"<p>A value for a column of real data type.</p>"
},
"stringValue":{
"shape":"String",
"documentation":"<p>A value for a column of string data type.</p>"
},
"structValue":{
"shape":"StructValue",
"documentation":"<p>A value for a column of STRUCT data type.</p>"
}
},
"documentation":"<p>Contains the value of a column.</p>"
},
"FieldList":{
"type":"list",
"member":{
"shape":"Field"
}
},
"StatementTimeoutException":{
"type":"structure",
"members":{
"dbConnectionId":{
"shape":"Long",
"documentation":"<p>The database connection ID that executed the SQL statement.</p>"
},
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>StatementTimeoutException</code> error.</p>"
}
},
"documentation":"<p>The execution of the SQL statement timed out.</p>",
"exception":true,
"error":{
"code":"StatementTimeoutException",
"httpStatusCode":400,
"senderFault":true
}
},
"ExecuteStatementResponse":{
"type":"structure",
"members":{
"columnMetadata":{
"shape":"Metadata",
"documentation":"<p>Metadata for the columns included in the results.</p>"
},
"generatedFields":{
"shape":"FieldList",
"documentation":"<p>Values for fields generated during the request.</p>"
},
"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>The response elements represent the output of a request to run a SQL statement against\n a database.</p>"
},
"BoxedBoolean":{
"type":"boolean",
"box":true
},
"RecordsUpdated":{
"type":"long"
},
"UpdateResult":{
"type":"structure",
"members":{
"generatedFields":{
"shape":"FieldList",
"documentation":"<p>Values for fields generated during the request.</p>"
}
},
"documentation":"<p>The response elements represent the results of an update.</p>"
},
"SqlParametersList":{
"type":"list",
"member":{
"shape":"SqlParameter"
}
},
"ParameterName":{
"type":"string"
},
"Metadata":{
"type":"list",
"member":{
"shape":"ColumnMetadata"
}
},
"ExecuteSqlResponse":{
"type":"structure",
"members":{
"sqlStatementResults":{
"shape":"SqlStatementResults",
"documentation":"<p>The results of the SQL statement or statements.</p>"
}
},
"documentation":"<p>The response elements represent the output of a request to run one or more SQL\n statements.</p>"
},
"SqlStatementResult":{
"type":"structure",
"members":{
"numberOfRecordsUpdated":{
"shape":"RecordsUpdated",
"documentation":"<p>The number of records updated by a SQL statement.</p>"
},
"resultFrame":{
"shape":"ResultFrame",
"documentation":"<p>The result set of the SQL statement.</p>"
}
},
"documentation":"<p>The result of a SQL statement.</p>"
},
"BeginTransactionRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn"
],
"members":{
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
}
},
"documentation":"<p>The request parameters represent the input of a request to start a SQL\n transaction.</p>"
},
"RollbackTransactionResponse":{
"type":"structure",
"members":{
"transactionStatus":{
"shape":"TransactionStatus",
"documentation":"<p>The status of the rollback operation.</p>"
}
},
"documentation":"<p>The response elements represent the output of a request to perform a rollback of a\n transaction.</p>"
},
"BatchExecuteStatementResponse":{
"type":"structure",
"members":{
"updateResults":{
"shape":"UpdateResults",
"documentation":"<p>The execution results of each batch entry.</p>"
}
},
"documentation":"<p>The response elements represent the output of a SQL statement over an array of\n data.</p>"
},
"ResultSetMetadata":{
"type":"structure",
"members":{
"columnCount":{
"shape":"Long",
"documentation":"<p>The number of columns in the result set.</p>"
},
"columnMetadata":{
"shape":"Metadata",
"documentation":"<p>The metadata of the columns in the result set.</p>"
}
},
"documentation":"<p>The metadata of the result set returned by a SQL statement.</p>"
},
"Records":{
"type":"list",
"member":{
"shape":"Record"
}
},
"ExecuteStatementRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"sql"
],
"members":{
"continueAfterTimeout":{
"shape":"Boolean",
"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 <important>\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 </important>"
},
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"includeResultMetadata":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether to include metadata in the results.</p>"
},
"parameters":{
"shape":"SqlParametersList",
"documentation":"<p>The parameters for the SQL statement.</p>"
},
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"secretArn":{
"shape":"Arn",
"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\n <code>BeginTransaction</code> operation. Specify the transaction ID of the\n transaction that you want to include the SQL statement in.</p>\n <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>"
}
},
"documentation":"<p>The request parameters represent the input of a request to run a SQL statement against\n a database.</p>"
},
"Blob":{
"type":"blob"
},
"String":{
"type":"string"
},
"BeginTransactionResponse":{
"type":"structure",
"members":{
"transactionId":{
"shape":"Id",
"documentation":"<p>The transaction ID of the transaction started by the call.</p>"
}
},
"documentation":"<p>The response elements represent the output of a request to start a SQL\n transaction.</p>"
},
"Id":{
"type":"string",
"max":192
},
"CommitTransactionRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"transactionId"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"transactionId":{
"shape":"Id",
"documentation":"<p>The identifier of the transaction to end and commit.</p>"
}
},
"documentation":"<p>The request parameters represent the input of a commit transaction request.</p>"