v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14106873.4 KB

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:

  • Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in 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 CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

post/#X-Amz-Target=RedshiftData.ExecuteStatement

Headers

X-Amz-Target'RedshiftData.ExecuteStatement' required

Request body

ClientTokenstring

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

ClusterIdentifierstring

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

Databasestring required

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

DbUserstring

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

SecretArnstring

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

Sqlstring required

The SQL statement text to run.

StatementNamestring

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

WithEventboolean

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

WorkgroupNamestring

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

Response

Success

ClusterIdentifierstring

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

CreatedAtstring date-time

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

Databasestring

The name of the database.

DbUserstring

The database user name.

Idstring

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.

SecretArnstring

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

WorkgroupNamestring

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