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.
Request Syntax
POST /BatchExecute HTTP/1.1
Content-type: application/json
{
"database": "string
",
"parameterSets": [
[
{
"name": "string
",
"typeHint": "string
",
"value": {
"arrayValue": {
"arrayValues": [
"ArrayValue"
],
"booleanValues": [ boolean
],
"doubleValues": [ number
],
"longValues": [ number
],
"stringValues": [ "string
" ]
},
"blobValue": blob
,
"booleanValue": boolean
,
"doubleValue": number
,
"isNull": boolean
,
"longValue": number
,
"stringValue": "string
"
}
}
]
],
"resourceArn": "string
",
"schema": "string
",
"secretArn": "string
",
"sql": "string
",
"transactionId": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- database
-
The name of the database.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
- 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 theBatchExecuteStatement
operation.
Note Array parameters are not supported.
Type: Array of arrays of SqlParameter objects
Required: No
-
- resourceArn
-
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 100.
Required: Yes
- schema
-
The name of the database schema.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
- secretArn
-
The name or ARN of the secret that enables access to the DB cluster.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 100.
Required: Yes
- sql
-
The SQL statement to run.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 65536.
Required: Yes
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 192.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"updateResults": [
{
"generatedFields": [
{
"arrayValue": {
"arrayValues": [
"ArrayValue"
],
"booleanValues": [ boolean ],
"doubleValues": [ number ],
"longValues": [ number ],
"stringValues": [ "string" ]
},
"blobValue": blob,
"booleanValue": boolean,
"doubleValue": number,
"isNull": boolean,
"longValue": number,
"stringValue": "string"
}
]
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- updateResults
-
The execution results of each batch entry.
Type: Array of UpdateResult objects
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- BadRequestException
-
There is an error in the call or in a SQL statement.
HTTP Status Code: 400
- ForbiddenException
-
There are insufficient privileges to make the call.
HTTP Status Code: 403
- InternalServerErrorException
-
An internal error occurred.
HTTP Status Code: 500
- ServiceUnavailableError
-
The service specified by the
resourceArn
parameter is not available.HTTP Status Code: 503
- StatementTimeoutException
-
The execution of the SQL statement timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: