We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Optional
continueA 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.
Optional
databaseThe name of the database.
Optional
formatA 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.
Optional
includeA value that indicates whether to include metadata in the results.
Optional
parametersThe parameters for the SQL statement.
Array parameters are not supported.
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
Optional
resultOptions that control how the result set is returned.
Optional
schemaThe name of the database schema.
Currently, the schema
parameter isn't supported.
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.
The SQL statement to run.
Optional
transactionThe 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.
The input for ExecuteStatementCommand.