Skip to content

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL)

Description

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.

Usage

redshiftdataapiservice_execute_statement(Sql, ClusterIdentifier,
  SecretArn, DbUser, Database, WithEvent, StatementName, Parameters,
  WorkgroupName, ClientToken, ResultFormat, SessionKeepAliveSeconds,
  SessionId, WaitTimeSeconds)

Arguments

  • Sql

    [required] The SQL statement text to run.

  • ClusterIdentifier

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

  • SecretArn

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

  • DbUser

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

  • Database

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

  • WithEvent

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

  • StatementName

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

  • Parameters

    The parameters for the SQL statement.

  • WorkgroupName

    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.

  • ClientToken

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

  • ResultFormat

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

  • 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.

  • SessionId

    The session identifier of the query.

  • WaitTimeSeconds

    The number of seconds to wait for the SQL statement to complete execution before returning the response. If the SQL statement does not complete within the specified time, the response returns the current status. The maximum value is 30 seconds.

Value

A list with the following syntax:

list(
  Id = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  ClusterIdentifier = "string",
  DbUser = "string",
  DbGroups = list(
    "string"
  ),
  Database = "string",
  SecretArn = "string",
  WorkgroupName = "string",
  SessionId = "string",
  Status = "SUBMITTED"|"PICKED"|"STARTED"|"FINISHED"|"ABORTED"|"FAILED",
  RedshiftPid = 123,
  HasResultSet = TRUE|FALSE
)

Request syntax

svc$execute_statement(
  Sql = "string",
  ClusterIdentifier = "string",
  SecretArn = "string",
  DbUser = "string",
  Database = "string",
  WithEvent = TRUE|FALSE,
  StatementName = "string",
  Parameters = list(
    list(
      name = "string",
      value = "string"
    )
  ),
  WorkgroupName = "string",
  ClientToken = "string",
  ResultFormat = "JSON"|"CSV",
  SessionKeepAliveSeconds = 123,
  SessionId = "string",
  WaitTimeSeconds = 123
)