Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchExecuteStatement

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

Amazon Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Amazon 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 Amazon 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",
   "SecretArn": "string",
   "Sqls": [ "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.

Database

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

Type: String

Required: Yes

Sqls

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 40 items.

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 Amazon 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

SecretArn

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

Type: String

Required: No

StatementName

The name of the SQL statements. You can name the SQL statements when you create them 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 statements run.

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 Amazon 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",
   "DbUser": "string",
   "Id": "string",
   "SecretArn": "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

CreatedAt

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

Type: Timestamp

Database

The name of the database.

Type: String

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. This identifier is returned by BatchExecuteStatment.

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

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.

ActiveStatementsExceededException

The number of active statements exceeds the limit.

HTTP Status Code: 400

BatchExecuteStatementException

An SQL statement encountered an environmental error while running.

HTTP Status Code: 500

ValidationException

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

HTTP Status Code: 400