Amazon Redshift · Schema
ExecuteStatementRequest
AnalyticsBig DataCloudData LakeData WarehouseETLMachine LearningServerlessSQL
Properties
| Name | Type | Description |
|---|---|---|
| ClusterIdentifier | string | The cluster identifier. Required when connecting to a provisioned cluster. Mutually exclusive with WorkgroupName. |
| Database | string | The name of the database to run the SQL statement against |
| DbUser | string | The database user name. Required when authenticating with temporary credentials from GetClusterCredentials. |
| SecretArn | string | The ARN of the secret stored in AWS Secrets Manager that contains the database credentials. Mutually exclusive with DbUser and temporary credentials. |
| Sql | string | The SQL statement to run. Maximum length is 100,000 characters. |
| StatementName | string | A name for the SQL statement. This name can be used to identify the query in the ListStatements output. |
| WithEvent | boolean | Whether to send an event to Amazon EventBridge when the SQL statement completes. Default is false. |
| WorkgroupName | string | The serverless workgroup name. Required when connecting to Redshift Serverless. Mutually exclusive with ClusterIdentifier. |
| Parameters | array | Named parameters for the SQL statement. Use :name syntax in the SQL string to reference parameters. |
| ClientToken | string | A unique, case-sensitive identifier to ensure idempotency of the request. |