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.
For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.
Runs a batch SQL statement over an array of data.
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.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.
Starts a SQL transaction.
<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> Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.
Runs a SQL statement against a database.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.
The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.
", "RollbackTransaction": "Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
" }, "shapes": { "Arn": { "base": null, "refs": { "BatchExecuteStatementRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "BatchExecuteStatementRequest$secretArn": "The name or ARN of the secret that enables access to the DB cluster.
", "BeginTransactionRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "BeginTransactionRequest$secretArn": "The name or ARN of the secret that enables access to the DB cluster.
", "CommitTransactionRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "CommitTransactionRequest$secretArn": "The name or ARN of the secret that enables access to the DB cluster.
", "ExecuteSqlRequest$awsSecretStoreArn": "The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.
", "ExecuteSqlRequest$dbClusterOrInstanceArn": "The ARN of the Aurora Serverless DB cluster.
", "ExecuteStatementRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "ExecuteStatementRequest$secretArn": "The name or ARN of the secret that enables access to the DB cluster.
", "RollbackTransactionRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "RollbackTransactionRequest$secretArn": "The name or ARN of the secret that enables access to the DB cluster.
" } }, "ArrayOfArray": { "base": "An array of arrays.
Some array entries can be null.
An array of arrays.
" } }, "ArrayValue": { "base": "Contains an array.
", "refs": { "ArrayOfArray$member": null, "Field$arrayValue": "An array of values.
" } }, "ArrayValueList": { "base": null, "refs": { "StructValue$attributes": "The attributes returned in the record.
", "Value$arrayValues": "An array of column values.
" } }, "BadRequestException": { "base": "There is an error in the call or in a SQL statement.
", "refs": { } }, "BatchExecuteStatementRequest": { "base": "The request parameters represent the input of a SQL statement over an array of data.
", "refs": { } }, "BatchExecuteStatementResponse": { "base": "The response elements represent the output of a SQL statement over an array of data.
", "refs": { } }, "BeginTransactionRequest": { "base": "The request parameters represent the input of a request to start a SQL transaction.
", "refs": { } }, "BeginTransactionResponse": { "base": "The response elements represent the output of a request to start a SQL transaction.
", "refs": { } }, "Blob": { "base": null, "refs": { "Field$blobValue": "A value of BLOB data type.
", "Value$blobValue": "A value for a column of BLOB data type.
" } }, "Boolean": { "base": null, "refs": { "ColumnMetadata$isAutoIncrement": "A value that indicates whether the column increments automatically.
", "ColumnMetadata$isCaseSensitive": "A value that indicates whether the column is case-sensitive.
", "ColumnMetadata$isCurrency": "A value that indicates whether the column contains currency values.
", "ColumnMetadata$isSigned": "A value that indicates whether an integer column is signed.
", "ExecuteStatementRequest$continueAfterTimeout": "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.
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.
A value that indicates whether to include metadata in the results.
" } }, "BooleanArray": { "base": "An array of Boolean values.
Some array entries can be null.
An array of Boolean values.
" } }, "BoxedBoolean": { "base": null, "refs": { "BooleanArray$member": null, "Field$booleanValue": "A value of Boolean data type.
", "Field$isNull": "A NULL value.
", "Value$bitValue": "A value for a column of BIT data type.
", "Value$isNull": "A NULL value.
" } }, "BoxedDouble": { "base": null, "refs": { "DoubleArray$member": null, "Field$doubleValue": "A value of double data type.
", "Value$doubleValue": "A value for a column of double data type.
" } }, "BoxedFloat": { "base": null, "refs": { "Value$realValue": "A value for a column of real data type.
" } }, "BoxedInteger": { "base": null, "refs": { "Value$intValue": "A value for a column of integer data type.
" } }, "BoxedLong": { "base": null, "refs": { "Field$longValue": "A value of long data type.
", "LongArray$member": null, "Value$bigIntValue": "A value for a column of big integer data type.
" } }, "ColumnMetadata": { "base": "Contains the metadata for a column.
", "refs": { "Metadata$member": null } }, "CommitTransactionRequest": { "base": "The request parameters represent the input of a commit transaction request.
", "refs": { } }, "CommitTransactionResponse": { "base": "The response elements represent the output of a commit transaction request.
", "refs": { } }, "DbName": { "base": null, "refs": { "BatchExecuteStatementRequest$database": "The name of the database.
", "BatchExecuteStatementRequest$schema": "The name of the database schema.
", "BeginTransactionRequest$database": "The name of the database.
", "BeginTransactionRequest$schema": "The name of the database schema.
", "ExecuteSqlRequest$database": "The name of the database.
", "ExecuteSqlRequest$schema": "The name of the database schema.
", "ExecuteStatementRequest$database": "The name of the database.
", "ExecuteStatementRequest$schema": "The name of the database schema.
" } }, "DecimalReturnType": { "base": null, "refs": { "ResultSetOptions$decimalReturnType": "A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.
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.
An array of floating point numbers.
Some array entries can be null.
An array of integers.
" } }, "ErrorMessage": { "base": null, "refs": { "BadRequestException$message": "The error message returned by this BadRequestException error.
The error message returned by this ForbiddenException error.
The error message returned by this NotFoundException error.
The error message returned by this StatementTimeoutException error.
The request parameters represent the input of a request to run one or more SQL statements.
", "refs": { } }, "ExecuteSqlResponse": { "base": "The response elements represent the output of a request to run one or more SQL statements.
", "refs": { } }, "ExecuteStatementRequest": { "base": "The request parameters represent the input of a request to run a SQL statement against a database.
", "refs": { } }, "ExecuteStatementResponse": { "base": "The response elements represent the output of a request to run a SQL statement against a database.
", "refs": { } }, "Field": { "base": "Contains a value.
", "refs": { "FieldList$member": null, "SqlParameter$value": "The value of the parameter.
" } }, "FieldList": { "base": null, "refs": { "ExecuteStatementResponse$generatedFields": "Values for fields generated during the request.
<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> Values for fields generated during the request.
" } }, "ForbiddenException": { "base": "There are insufficient privileges to make the call.
", "refs": { } }, "Id": { "base": null, "refs": { "BatchExecuteStatementRequest$transactionId": "The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.
If the SQL statement is not part of a transaction, don't set this parameter.
", "BeginTransactionResponse$transactionId": "The transaction ID of the transaction started by the call.
", "CommitTransactionRequest$transactionId": "The identifier of the transaction to end and commit.
", "ExecuteStatementRequest$transactionId": "The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.
If the SQL statement is not part of a transaction, don't set this parameter.
", "RollbackTransactionRequest$transactionId": "The identifier of the transaction to roll back.
" } }, "Integer": { "base": null, "refs": { "ColumnMetadata$arrayBaseColumnType": "The type of the column.
", "ColumnMetadata$nullable": "A value that indicates whether the column is nullable.
", "ColumnMetadata$precision": "The precision value of a decimal number column.
", "ColumnMetadata$scale": "The scale value of a decimal number column.
", "ColumnMetadata$type": "The type of the column.
" } }, "InternalServerErrorException": { "base": "An internal error occurred.
", "refs": { } }, "Long": { "base": null, "refs": { "ResultSetMetadata$columnCount": "The number of columns in the result set.
", "StatementTimeoutException$dbConnectionId": "The database connection ID that executed the SQL statement.
" } }, "LongArray": { "base": "An array of integers.
Some array entries can be null.
An array of floating point numbers.
" } }, "Metadata": { "base": null, "refs": { "ExecuteStatementResponse$columnMetadata": "Metadata for the columns included in the results.
", "ResultSetMetadata$columnMetadata": "The metadata of the columns in the result set.
" } }, "NotFoundException": { "base": "The resourceArn, secretArn, or transactionId value can't be found.
The name of the parameter.
" } }, "Record": { "base": "A record returned by a call.
", "refs": { "Records$member": null } }, "Records": { "base": null, "refs": { "ResultFrame$records": "The records in the result set.
" } }, "RecordsUpdated": { "base": null, "refs": { "ExecuteStatementResponse$numberOfRecordsUpdated": "The number of records updated by the request.
", "SqlStatementResult$numberOfRecordsUpdated": "The number of records updated by a SQL statement.
" } }, "ResultFrame": { "base": "The result set returned by a SQL statement.
", "refs": { "SqlStatementResult$resultFrame": "The result set of the SQL statement.
" } }, "ResultSetMetadata": { "base": "The metadata of the result set returned by a SQL statement.
", "refs": { "ResultFrame$resultSetMetadata": "The result-set metadata in the result set.
" } }, "ResultSetOptions": { "base": "Options that control how the result set is returned.
", "refs": { "ExecuteStatementRequest$resultSetOptions": "Options that control how the result set is returned.
" } }, "RollbackTransactionRequest": { "base": "The request parameters represent the input of a request to perform a rollback of a transaction.
", "refs": { } }, "RollbackTransactionResponse": { "base": "The response elements represent the output of a request to perform a rollback of a transaction.
", "refs": { } }, "Row": { "base": null, "refs": { "Record$values": "The values returned in the record.
" } }, "ServiceUnavailableError": { "base": "The service specified by the resourceArn parameter is not available.
A parameter used in a SQL statement.
", "refs": { "SqlParametersList$member": null } }, "SqlParameterSets": { "base": null, "refs": { "BatchExecuteStatementRequest$parameterSets": "The parameter set for the batch operation.
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:
Specify one or more empty parameter sets.
Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.
Array parameters are not supported.
The parameters for the SQL statement.
Array parameters are not supported.
The records returned by the SQL statement.
" } }, "SqlStatement": { "base": null, "refs": { "BatchExecuteStatementRequest$sql": "The SQL statement to run.
", "ExecuteSqlRequest$sqlStatements": "One or more SQL statements to run on the DB cluster.
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.
", "ExecuteStatementRequest$sql": "The SQL statement to run.
" } }, "SqlStatementResult": { "base": "The result of a SQL statement.
<important> <p>This data type is deprecated.</p> </important> The results of the SQL statement or statements.
" } }, "StatementTimeoutException": { "base": "The execution of the SQL statement timed out.
", "refs": { } }, "String": { "base": null, "refs": { "ColumnMetadata$label": "The label for the column.
", "ColumnMetadata$name": "The name of the column.
", "ColumnMetadata$schemaName": "The name of the schema that owns the table that includes the column.
", "ColumnMetadata$tableName": "The name of the table that includes the column.
", "ColumnMetadata$typeName": "The database-specific data type of the column.
", "Field$stringValue": "A value of string data type.
", "StringArray$member": null, "Value$stringValue": "A value for a column of string data type.
" } }, "StringArray": { "base": "An array of strings.
Some array entries can be null.
An array of strings.
" } }, "StructValue": { "base": "A structure value returned by a call.
", "refs": { "Value$structValue": "A value for a column of STRUCT data type.
" } }, "TransactionStatus": { "base": null, "refs": { "CommitTransactionResponse$transactionStatus": "The status of the commit operation.
", "RollbackTransactionResponse$transactionStatus": "The status of the rollback operation.
" } }, "TypeHint": { "base": null, "refs": { "SqlParameter$typeHint": "A hint that specifies the correct object type for data type mapping.
Values:
DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
The response elements represent the results of an update.
", "refs": { "UpdateResults$member": null } }, "UpdateResults": { "base": null, "refs": { "BatchExecuteStatementResponse$updateResults": "The execution results of each batch entry.
" } }, "Value": { "base": "Contains the value of a column.
<important> <p>This data type is deprecated.</p> </important>