BatchExecuteStatement - Amazon Redshift Data API

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:

  • AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Request Syntax

{ "ClusterIdentifier": "string", "Database": "string", "DbUser": "string", "SecretArn": "string", "Sqls": [ "string" ], "StatementName": "string", "WithEvent": boolean }

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.

ClusterIdentifier

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

Type: String

Required: Yes

Database

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

Type: String

Required: Yes

Sqls

One or more SQL statements to run.

Type: Array of strings

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

Required: Yes

DbUser

The database user name. This parameter is required when 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 AWS 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

Response Syntax

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

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

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

See Also

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