Class: Aws::RedshiftDataAPIService::Types::ExecuteStatementInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshiftdataapiservice/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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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

#parameters ⇒ Array<Types::SqlParameter>

The parameters for the SQL statement.

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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

#session_id ⇒ String

The session identifier of the query.

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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

#sql ⇒ String

The SQL statement text to run.

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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

#statement_name ⇒ String

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

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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

#wait_time_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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 statement runs.

Returns:

  • (Boolean) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

class ExecuteStatementInput < Struct.new(
  :sql,
  :cluster_identifier,
  :secret_arn,
  :db_user,
  :database,
  :with_event,
  :statement_name,
  :parameters,
  :workgroup_name,
  :client_token,
  :result_format,
  :session_keep_alive_seconds,
  :session_id,
  :wait_time_seconds)
  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) 


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 776

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