/AWS1/CL_RSD=>EXECUTESTATEMENT()
¶
About 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:
-
Secrets Manager - when connecting to a cluster, provide the
secret-arn
of a secret stored in Secrets Manager which hasusername
andpassword
. The specified secret contains credentials to connect to thedatabase
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 nameIAM:foo
. Also, permission to call theredshift-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 nameIAM:foo
. Also, permission to call theredshift: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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_SQL
TYPE /AWS1/RSDSTATEMENTSTRING
/AWS1/RSDSTATEMENTSTRING
¶
The SQL statement text to run.
Optional arguments:¶
IV_CLUSTERIDENTIFIER
TYPE /AWS1/RSDCLUSTERIDSTRING
/AWS1/RSDCLUSTERIDSTRING
¶
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
IV_SECRETARN
TYPE /AWS1/RSDSECRETARN
/AWS1/RSDSECRETARN
¶
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
IV_DBUSER
TYPE /AWS1/RSDSTRING
/AWS1/RSDSTRING
¶
The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
IV_DATABASE
TYPE /AWS1/RSDSTRING
/AWS1/RSDSTRING
¶
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
IV_WITHEVENT
TYPE /AWS1/RSDBOOLEAN
/AWS1/RSDBOOLEAN
¶
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
IV_STATEMENTNAME
TYPE /AWS1/RSDSTATEMENTNAMESTRING
/AWS1/RSDSTATEMENTNAMESTRING
¶
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
IT_PARAMETERS
TYPE /AWS1/CL_RSDSQLPARAMETER=>TT_SQLPARAMETERSLIST
TT_SQLPARAMETERSLIST
¶
The parameters for the SQL statement.
IV_WORKGROUPNAME
TYPE /AWS1/RSDWORKGROUPNAMESTRING
/AWS1/RSDWORKGROUPNAMESTRING
¶
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.
IV_CLIENTTOKEN
TYPE /AWS1/RSDCLIENTTOKEN
/AWS1/RSDCLIENTTOKEN
¶
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
IV_SESSIONKEEPALIVESECONDS
TYPE /AWS1/RSDSESSIONALIVESECONDS
/AWS1/RSDSESSIONALIVESECONDS
¶
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.
IV_SESSIONID
TYPE /AWS1/RSDUUID
/AWS1/RSDUUID
¶
The session identifier of the query.