Jump to Content

New API Documentation - Developer Preview Available

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.

Interface ExecuteStatementCommandInputProtected

The input for ExecuteStatementCommand.



continueAfterTimeout?: boolean

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.

database?: string

The name of the database.

formatRecordsAs?: string

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.

includeResultMetadata?: boolean

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

parameters?: SqlParameter[]

The parameters for the SQL statement.

Array parameters are not supported.

resourceArn: undefined | string

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

resultSetOptions?: ResultSetOptions

Options that control how the result set is returned.

schema?: string

The name of the database schema.

Currently, the schema parameter isn't supported.

secretArn: undefined | string

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.

sql: undefined | string

The SQL statement to run.

transactionId?: string

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.