Module Values.ExecuteStatementOutputSource

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.

Sourcetype nonrec t = {
  1. id : UUID.t option;
    (*

    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.

    *)
  2. createdAt : Timestamp.t option;
    (*

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

    *)
  3. clusterIdentifier : ClusterIdentifierString.t option;
    (*

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

    *)
  4. dbUser : String_.t option;
    (*

    The database user name.

    *)
  5. dbGroups : DbGroupList.t option;
    (*

    A list of colon (:) separated names of database groups.

    *)
  6. database : String_.t option;
    (*

    The name of the database.

    *)
  7. secretArn : SecretArn.t option;
    (*

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

    *)
  8. workgroupName : WorkgroupNameString.t option;
    (*

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

    *)
  9. sessionId : UUID.t option;
    (*

    The session identifier of the query.

    *)
}
Sourcetype nonrec error = [
  1. | `ActiveSessionsExceededException of ActiveSessionsExceededException.t
  2. | `ActiveStatementsExceededException of ActiveStatementsExceededException.t
  3. | `ExecuteStatementException of ExecuteStatementException.t
  4. | `InternalServerException of InternalServerException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `ValidationException of ValidationException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?createdAt:??? -> ?clusterIdentifier:??? -> ?dbUser:??? -> ?dbGroups:??? -> ?database:??? -> ?secretArn:??? -> ?workgroupName:??? -> ?sessionId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ActiveSessionsExceededException of ActiveSessionsExceededException.t | `ActiveStatementsExceededException of ActiveStatementsExceededException.t | `ExecuteStatementException of ExecuteStatementException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ActiveSessionsExceededException of ActiveSessionsExceededException.t | `ActiveStatementsExceededException of ActiveStatementsExceededException.t | `ExecuteStatementException of ExecuteStatementException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `String of String_.t ] list | `String of UUID.t | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t