Class: Aws::RedshiftDataAPIService::Types::BatchExecuteStatementInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ String

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

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

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

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ String

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

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#result_format ⇒ String

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

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

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

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The session identifier of the query.

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#session_keep_alive_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#sqls ⇒ Array<String>

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.</p>

Returns:

  • (Array<String>) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#statement_name ⇒ String

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#with_event ⇒ Boolean

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

Returns:

  • (Boolean) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

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.

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 134

class BatchExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :result_format,
  :secret_arn,
  :session_id,
  :session_keep_alive_seconds,
  :sqls,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end