ExecuteStatement - Amazon Redshift Data API
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ExecuteStatement

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

  • AWS Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in AWS Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and AWS CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Request Syntax

{
   "ClientToken": "string",
   "ClusterIdentifier": "string",
   "Database": "string",
   "DbUser": "string",
   "Parameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "ResultFormat": "string",
   "SecretArn": "string",
   "SessionId": "string",
   "SessionKeepAliveSeconds": number,
   "Sql": "string",
   "StatementName": "string",
   "WithEvent": boolean,
   "WorkgroupName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Sql

The SQL statement text to run.

Type: String

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

ClusterIdentifier

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either AWS Secrets Manager or temporary credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

Database

The name of the database. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Type: String

Required: No

DbUser

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Type: String

Required: No

Parameters

The parameters for the SQL statement.

Type: Array of SqlParameter objects

Array Members: Minimum number of 1 item.

Required: No

ResultFormat

The data format of the result of the SQL statement. If no format is specified, the default is JSON.

Type: String

Valid Values: JSON | CSV

Required: No

SecretArn

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Type: String

Required: No

SessionId

The session identifier of the query.

Type: String

Pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$

Required: No

SessionKeepAliveSeconds

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 86400.

Required: No

StatementName

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

WithEvent

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Type: Boolean

Required: No

WorkgroupName

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either AWS Secrets Manager or temporary credentials.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$

Required: No

Response Syntax

{
   "ClusterIdentifier": "string",
   "CreatedAt": number,
   "Database": "string",
   "DbGroups": [ "string" ],
   "DbUser": "string",
   "Id": "string",
   "SecretArn": "string",
   "SessionId": "string",
   "WorkgroupName": "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.

ClusterIdentifier

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

CreatedAt

The date and time (UTC) the statement was created.

Type: Timestamp

Database

The name of the database.

Type: String

DbGroups

A list of colon (:) separated names of database groups.

Type: Array of strings

DbUser

The database user name.

Type: String

Id

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Type: String

Pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$

SecretArn

The name or ARN of the secret that enables access to the database.

Type: String

SessionId

The session identifier of the query.

Type: String

Pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$

WorkgroupName

The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$

Errors

For information about the errors that are common to all actions, see Common Errors.

ActiveSessionsExceededException

The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.

HTTP Status Code: 400

ActiveStatementsExceededException

The number of active statements exceeds the limit.

HTTP Status Code: 400

ExecuteStatementException

The SQL statement encountered an environmental error while running.

HTTP Status Code: 500

InternalServerException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 500

ValidationException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: