POST

/Execute

http://rds-data.{region}.amazonaws.com/Execute

Runs a SQL statement against a database. <note> 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. If the binary response data from the database is more than 1 MB, the call is terminated. </note>

Access Token Required: API Key

Body Params

sqlstringrequired

The SQL statement to run.

schemastring

The name of the database schema. <note> Currently, the <code>schema</code> parameter isn't supported. </note>

databasestring

The name of the database.

secretArnstringrequired

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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.

parametersarray

The parameters for the SQL statement. <note> Array parameters are not supported. </note>

resourceArnstringrequired

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

transactionIdstring

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. If the SQL statement is not part of a transaction, don't set this parameter.

formatRecordsAsstring

A value that indicates whether to format the result set as a single JSON string. This parameter only applies to <code>SELECT</code> statements and is ignored for other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>. The default value is <code>NONE</code>. The result is returned in the <code>formattedRecords</code> field. For usage information about the JSON format for result sets, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a> in the Amazon Aurora User Guide.

resultSetOptionsobject

Options that control how the result set is returned.

continueAfterTimeoutboolean

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. <note> 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. </note>

includeResultMetadataboolean

A value that indicates whether to include metadata in the results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://rds-data.{region}.amazonaws.com/Execute' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}