Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).
Data API is available with the following types of Aurora databases:
Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned
Aurora MySQL - Serverless v1 only
For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.
", "operations": { "BatchExecuteStatement": "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.
There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.
The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.
Starts a SQL transaction.
A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.
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.
DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.
Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
Runs one or more SQL statements.
This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the 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.
If the binary response data from the database is more than 1 MB, the call is terminated.
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have sufficient access to perform this action.
", "refs": { } }, "Arn": { "base": null, "refs": { "BatchExecuteStatementRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "BatchExecuteStatementRequest$secretArn": "The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.
For information about creating the secret, see Create a database secret.
", "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$dbClusterOrInstanceArn": "The ARN of the Aurora Serverless DB cluster.
", "ExecuteSqlRequest$awsSecretStoreArn": "The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.
For information about creating the secret, see Create a database secret.
", "ExecuteStatementRequest$resourceArn": "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
", "ExecuteStatementRequest$secretArn": "The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.
For information about creating the secret, see Create a database secret.
", "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. (This error only appears in calls from Aurora Serverless v1 databases.)
", "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$isSigned": "A value that indicates whether an integer column is signed.
", "ColumnMetadata$isCurrency": "A value that indicates whether the column contains currency values.
", "ColumnMetadata$isCaseSensitive": "A value that indicates whether the column is case-sensitive.
", "ExecuteStatementRequest$includeResultMetadata": "A value that indicates whether to include metadata in the results.
", "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.
An array of Boolean values.
Some array entries can be null.
An array of Boolean values.
" } }, "BoxedBoolean": { "base": null, "refs": { "BooleanArray$member": null, "Field$isNull": "A NULL value.
", "Field$booleanValue": "A value of Boolean data type.
", "Value$isNull": "A NULL value.
", "Value$bitValue": "A value for a column of BIT data type.
" } }, "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": { } }, "DatabaseErrorException": { "base": "There was an error in processing the SQL statement.
", "refs": { } }, "DatabaseNotFoundException": { "base": "The DB cluster doesn't have a DB instance.
", "refs": { } }, "DatabaseUnavailableException": { "base": "The writer instance in the DB cluster isn't available.
", "refs": { } }, "DbName": { "base": null, "refs": { "BatchExecuteStatementRequest$database": "The name of the database.
", "BatchExecuteStatementRequest$schema": "The name of the database schema.
Currently, the schema parameter isn't supported.
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.
Currently, the schema parameter isn't supported.
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 floating-point numbers.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "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 a DML request.
The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.
Values for fields generated during the request.
" } }, "ForbiddenException": { "base": "There are insufficient privileges to make the call.
", "refs": { } }, "FormattedSqlRecords": { "base": null, "refs": { "ExecuteStatementResponse$formattedRecords": "A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.
The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.
" } }, "HttpEndpointNotEnabledException": { "base": "The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.
", "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$type": "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$arrayBaseColumnType": "The type of the column.
" } }, "InternalServerErrorException": { "base": "An internal error occurred.
", "refs": { } }, "InvalidSecretException": { "base": "The Secrets Manager secret used with the request isn't valid.
", "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 integers.
" } }, "LongReturnType": { "base": null, "refs": { "ResultSetOptions$longReturnType": "A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.
Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.
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.
This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.
The records in the result set.
" } }, "RecordsFormatType": { "base": null, "refs": { "ExecuteStatementRequest$formatRecordsAs": "A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.
For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.
" } }, "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.
This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.
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.
" } }, "SecretsErrorException": { "base": "There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:
RDS Data API timed out retrieving the secret.
The secret provided wasn't found.
The secret couldn't be decrypted.
The service specified by the resourceArn parameter isn't 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. This field is blank if the formatRecordsAs parameter is set to JSON.
The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.
", "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.
This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.
The results of the SQL statement or statements.
" } }, "StatementTimeoutException": { "base": "The execution of the SQL statement timed out.
", "refs": { } }, "String": { "base": null, "refs": { "ColumnMetadata$name": "The name of the column.
", "ColumnMetadata$typeName": "The database-specific data type of the column.
", "ColumnMetadata$label": "The label for 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.
", "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.
This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.
A value for a column of STRUCT data type.
" } }, "TransactionNotFoundException": { "base": "The transaction ID wasn't found.
", "refs": { } }, "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. Possible values are as follows:
DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
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].
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].
UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
There was a problem with the result because of one of the following conditions:
It contained an unsupported data type.
It contained a multidimensional array.
The size was too large.
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.
This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.