Smaws_Client_RedshiftData.TypesThe Amazon Redshift Data API operation failed due to invalid input.
type nonrec table_member = {schema : string_ option;The schema containing the table.
*)type_ : string_ option;The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
*)name : string_ option;The name of the table.
*)}The properties of a table.
type nonrec table_list = table_member listtype nonrec long = Smaws_Lib.CoreTypes.Int64.ttype nonrec sub_statement_data = {has_result_set : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
*)redshift_query_id : long option;The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
*)result_size : long option;The size in bytes of the returned results. A -1 indicates the value is null.
result_rows : long option;Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
query_string : statement_string option;The SQL statement text.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) that the statement metadata was last updated.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) the statement was created.
*)status : statement_status_string option;The status of the SQL statement. An example is the that the SQL statement finished.
*)error : string_ option;The error message from the cluster if the SQL statement encountered an error while running.
*)duration : long option;The amount of time in nanoseconds that the statement ran.
*)id : uui_d;The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.
}Information about an SQL statement.
type nonrec sub_statement_list = sub_statement_data listtype nonrec statement_string_list = statement_string listtype nonrec sql_parameter = {value : parameter_value;The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see Data types in the Amazon Redshift Database Developer Guide.
*)name : parameter_name;The name of the parameter.
*)}A parameter used in a SQL statement.
type nonrec sql_parameters_list = sql_parameter listtype nonrec statement_data = {session_id : uui_d option;The session identifier of the query.
*)result_format : result_format_string option;The data format of the result of the SQL statement.
*)is_batch_statement : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether the statement is a batch query request.
*)query_parameters : sql_parameters_list option;The parameters used in a SQL statement.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) that the statement metadata was last updated.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) the statement was created.
*)statement_name : statement_name_string option;The name of the SQL statement.
*)status : status_string option;The status of the SQL statement. An example is the that the SQL statement finished.
*)secret_arn : secret_arn option;The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
*)query_strings : statement_string_list option;One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.
*)query_string : statement_string option;The SQL statement.
*)id : uui_d;The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
*)}The SQL statement to run.
type nonrec statement_list = statement_data listtype nonrec boxed_long = Smaws_Lib.CoreTypes.Int64.ttype nonrec field = | BlobValue of blobA value of the BLOB data type.
*)| StringValue of string_A value of the string data type.
*)| DoubleValue of boxed_doubleA value of the double data type.
*)| LongValue of boxed_longA value of the long data type.
*)| BooleanValue of boxed_booleanA value of the Boolean data type.
*)| IsNull of boxed_booleanA value that indicates whether the data is NULL.
*)A data value in a column.
type nonrec field_list = field listtype nonrec sql_records = field_list listtype nonrec sql_list = statement_string listtype nonrec schema_list = string_ listtype nonrec resource_not_found_exception = {resource_id : string_;Resource identifier associated with the exception.
*)message : string_;The exception message.
*)}The Amazon Redshift Data API operation failed due to a missing resource.
The Amazon Redshift Data API operation failed due to timeout.
The Amazon Redshift Data API operation failed due to invalid input.
Connection to a database failed.
type nonrec list_tables_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)tables : table_list option;The tables that match the request pattern.
*)}type nonrec list_tables_request = {workgroup_name : workgroup_name_string option;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.
*)max_results : page_size option;The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)table_pattern : string_ option;A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
schema_pattern : string_ option;A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
connected_database : string_ option;A database name. The connected database is specified when you connect with your authentication credentials.
*)database : string_;The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)}type nonrec list_statements_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)statements : statement_list;The SQL statements.
*)}type nonrec list_statements_request = {workgroup_name : workgroup_name_string option;The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.
cluster_identifier : cluster_identifier_string option;The cluster identifier. Only statements that ran on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified.
database : string_ option;The name of the database when listing statements run against a ClusterIdentifier or WorkgroupName.
role_level : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
*)status : status_string option;The status of the SQL statement to list. Status values are defined as follows:
statement_name : statement_name_string option;The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
max_results : list_statements_limit option;The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.
next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)}type nonrec list_schemas_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)schemas : schema_list option;The schemas that match the request pattern.
*)}type nonrec list_schemas_request = {workgroup_name : workgroup_name_string option;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.
*)max_results : page_size option;The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.
next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)schema_pattern : string_ option;A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
*)connected_database : string_ option;A database name. The connected database is specified when you connect with your authentication credentials.
*)database : string_;The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)}type nonrec database_list = string_ listtype nonrec list_databases_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)databases : database_list option;The names of databases.
*)}type nonrec list_databases_request = {workgroup_name : workgroup_name_string option;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.
*)max_results : page_size option;The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)database : string_;The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)}type nonrec query_records = | CSVRecords of string_The results of the SQL statement in CSV format.
*)The results of the SQL statement.
type nonrec formatted_sql_records = query_records listtype nonrec column_metadata = {column_default : string_ option;The default value of the column.
*)length : integer option;The length of the column.
*)type_name : string_ option;The database-specific data type of the column.
*)table_name : string_ option;The name of the table that includes the column.
*)schema_name : string_ option;The name of the schema that contains the table that includes the column.
*)scale : integer option;The scale value of a decimal number column.
*)precision : integer option;The precision value of a decimal number column, or the column length for a non-numeric column.
*)nullable : integer option;A value that indicates whether the column is nullable.
*)name : string_ option;The name of the column.
*)label : string_ option;The label for the column.
*)is_signed : bool_ option;A value that indicates whether an integer column is signed.
*)is_currency : bool_ option;A value that indicates whether the column contains currency values.
*)is_case_sensitive : bool_ option;A value that indicates whether the column is case-sensitive.
*)}The properties (metadata) of a column.
type nonrec column_metadata_list = column_metadata listtype nonrec get_statement_result_v2_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)result_format : result_format_string option;The data format of the result of the SQL statement.
*)total_num_rows : long option;The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResultV2 operation needed to page through the results.
column_metadata : column_metadata_list option;The properties (metadata) of a column.
*)records : formatted_sql_records;The results of the SQL statement in CSV format.
*)}type nonrec get_statement_result_v2_request = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)id : uui_d;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. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
}type nonrec get_statement_result_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)total_num_rows : long option;The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.
column_metadata : column_metadata_list option;The properties (metadata) of a column.
*)records : sql_records;The results of the SQL statement in JSON format.
*)}type nonrec get_statement_result_request = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)id : uui_d;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. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
}type nonrec execute_statement_exception = {statement_id : string_;Statement identifier of the exception.
*)message : string_;The exception message.
*)}The SQL statement encountered an environmental error while running.
The number of active statements exceeds the limit.
The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.
type nonrec db_group_list = string_ listtype nonrec execute_statement_output = {session_id : uui_d option;The session identifier of the query.
*)workgroup_name : workgroup_name_string option;The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database.
*)database : string_ option;The name of the database.
*)db_groups : db_group_list option;A list of colon (:) separated names of database groups.
*)db_user : string_ option;The database user name.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This element is not returned when connecting to a serverless workgroup.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) the statement was created.
*)id : uui_d 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.
*)}type nonrec execute_statement_input = {session_id : uui_d option;The session identifier of the query.
*)session_keep_alive_seconds : session_alive_seconds option;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.
*)result_format : result_format_string option;The data format of the result of the SQL statement. If no format is specified, the default is JSON.
*)client_token : client_token option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*)workgroup_name : workgroup_name_string option;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.
*)parameters : sql_parameters_list option;The parameters for the SQL statement.
*)statement_name : statement_name_string option;The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*)with_event : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
*)database : string_ option;The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
*)db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)sql : statement_string;The SQL statement text to run.
*)}type nonrec column_list = column_metadata listtype nonrec describe_table_response = {next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)column_list : column_list option;A list of columns in the table.
*)table_name : string_ option;The table name.
*)}type nonrec describe_table_request = {workgroup_name : workgroup_name_string option;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.
*)max_results : page_size option;The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
next_token : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
*)table : string_ option;The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
*)schema : string_ option;The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
*)connected_database : string_ option;A database name. The connected database is specified when you connect with your authentication credentials.
*)database : string_;The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)}type nonrec describe_statement_response = {session_id : string_ option;The session identifier of the query.
*)result_format : result_format_string option;The data format of the result of the SQL statement.
*)workgroup_name : workgroup_name_string option;The serverless workgroup name or Amazon Resource Name (ARN).
*)sub_statements : sub_statement_list option;The SQL statements from a multiple statement run.
*)query_parameters : sql_parameters_list option;The parameters for the SQL statement.
*)redshift_query_id : long option;The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
result_size : long option;The size in bytes of the returned results. A -1 indicates the value is null.
result_rows : long option;Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
query_string : statement_string option;The SQL statement text.
*)has_result_set : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.
*)redshift_pid : long option;The process identifier from Amazon Redshift.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) when the SQL statement was submitted to run.
*)status : status_string option;The status of the SQL statement being described. Status values are defined as follows:
error : string_ option;The error message from the cluster if the SQL statement encountered an error while running.
*)duration : long option;The amount of time in nanoseconds that the statement ran.
*)cluster_identifier : string_ option;The cluster identifier.
*)database : string_ option;The name of the database.
*)db_user : string_ option;The database user name.
*)secret_arn : secret_arn option;The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
*)id : uui_d;The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
*)}type nonrec describe_statement_request = {id : uui_d;The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.
}type nonrec cancel_statement_response = {status : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether the cancel statement succeeded (true).
*)}type nonrec cancel_statement_request = {id : uui_d;The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
}An SQL statement encountered an environmental error while running.
type nonrec batch_execute_statement_output = {session_id : uui_d option;The session identifier of the query.
*)workgroup_name : workgroup_name_string option;The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database.
*)database : string_ option;The name of the database.
*)db_groups : db_group_list option;A list of colon (:) separated names of database groups.
*)db_user : string_ option;The database user name.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This element is not returned when connecting to a serverless workgroup.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time (UTC) the statement was created.
*)id : uui_d 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. This identifier is returned by BatchExecuteStatment.
}type nonrec batch_execute_statement_input = {session_id : uui_d option;The session identifier of the query.
*)session_keep_alive_seconds : session_alive_seconds option;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.
*)result_format : result_format_string option;The data format of the result of the SQL statement. If no format is specified, the default is JSON.
*)client_token : client_token option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*)workgroup_name : workgroup_name_string option;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.
*)parameters : sql_parameters_list option;The parameters for the SQL statements. The parameters are shared across all SQL statements in the batch.
*)statement_name : statement_name_string option;The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
*)with_event : Smaws_Lib.Smithy_api.Types.boolean_ option;A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
*)database : string_ option;The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
*)db_user : string_ option;The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
*)secret_arn : secret_arn option;The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
*)cluster_identifier : cluster_identifier_string option;The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
*)sqls : sql_list;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.
*)}