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

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftDataAPIService::Types::ExecuteStatementInput

Includes:

Structure

Defined in:

lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #cluster_identifier ⇒ String

  The cluster identifier.

• #database ⇒ String

  The name of the database.

• #db_user ⇒ String

  The database user name.

• #parameters ⇒ Array<Types::SqlParameter>

  The parameters for the SQL statement.

• #result_format ⇒ String

  The data format of the result of the SQL statement.

• #secret_arn ⇒ String

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

• #session_id ⇒ String

  The session identifier of the query.

• #session_keep_alive_seconds ⇒ Integer

  The number of seconds to keep the session alive after the query finishes.

• #sql ⇒ String

  The SQL statement text to run.

• #statement_name ⇒ String

  The name of the SQL statement.

• #with_event ⇒ Boolean

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

• #workgroup_name ⇒ String

  The serverless workgroup name or Amazon Resource Name (ARN).

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)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

#parameters ⇒ Array<Types::SqlParameter>

The parameters for the SQL statement.

Returns:

• (Array<Types::SqlParameter>)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

#session_id ⇒ String

The session identifier of the query.

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

#sql ⇒ String

The SQL statement text to run.

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 685

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