Class: Aws::RedshiftDataAPIService::Types::DescribeStatementResponse

Inherits:

Struct

Object
Struct
Aws::RedshiftDataAPIService::Types::DescribeStatementResponse

show all

Defined in:: gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cluster_identifier ⇒ String
The cluster identifier.
#created_at ⇒ Time
The date and time (UTC) when the SQL statement was submitted to run.
#database ⇒ String
The name of the database.
#db_user ⇒ String
The database user name.
#duration ⇒ Integer
The amount of time in nanoseconds that the statement ran.
#error ⇒ String
The error message from the cluster if the SQL statement encountered an error while running.
#has_result_set ⇒ Boolean
A value that indicates whether the statement has a result set.
#id ⇒ String
The identifier of the SQL statement described.
#query_parameters ⇒ Array<Types::SqlParameter>
The parameters for the SQL statement.
#query_string ⇒ String
The SQL statement text.
#redshift_pid ⇒ Integer
The process identifier from Amazon Redshift.
#redshift_query_id ⇒ Integer
The identifier of the query generated by Amazon Redshift.
#result_format ⇒ String
The data format of the result of the SQL statement.
#result_rows ⇒ Integer
Either the number of rows returned from the SQL statement or the number of rows affected.
#result_size ⇒ Integer
The size in bytes of the returned results.
#secret_arn ⇒ String
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
#session_id ⇒ String
The session identifier of the query.
#status ⇒ String
The status of the SQL statement being described.
#sub_statements ⇒ Array<Types::SubStatementData>
The SQL statements from a multiple statement run.
#updated_at ⇒ Time
The date and time (UTC) that the metadata for the SQL statement was last updated.
#workgroup_name ⇒ String
The serverless workgroup name or Amazon Resource Name (ARN).

Instance Attribute Details

#cluster_identifier ⇒ `String`

The cluster identifier.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time (UTC) when the SQL statement was submitted to run.

Returns:

(Time)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ `String`

The name of the database.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ `String`

The database user name.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ `Integer`

The amount of time in nanoseconds that the statement ran.

Returns:

(Integer)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ `String`

The error message from the cluster if the SQL statement encountered an error while running.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#has_result_set ⇒ `Boolean`

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.

Returns:

(Boolean)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#query_parameters ⇒ `Array<Types::SqlParameter>`

The parameters for the SQL statement.

Returns:

(Array<Types::SqlParameter>)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ `String`

The SQL statement text.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_pid ⇒ `Integer`

The process identifier from Amazon Redshift.

Returns:

(Integer)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_query_id ⇒ `Integer`

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

Returns:

(Integer)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#result_format ⇒ `String`

The data format of the result of the SQL statement.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#result_rows ⇒ `Integer`

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.

Returns:

(Integer)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#result_size ⇒ `Integer`

The size in bytes of the returned results. A -1 indicates the value is null.

Returns:

(Integer)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ `String`

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ `String`

The session identifier of the query.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the SQL statement being described. Status values are defined as follows:

ABORTED - The query run was stopped by the user.
ALL - A status value that includes all query statuses. This value can be used to filter results.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#sub_statements ⇒ `Array<Types::SubStatementData>`

The SQL statements from a multiple statement run.

Returns:

(Array<Types::SubStatementData>)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

Returns:

(Time)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ `String`

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

Returns:

(String)

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

class DescribeStatementResponse < Struct.new(
  :cluster_identifier,
  :created_at,
  :database,
  :db_user,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_parameters,
  :query_string,
  :redshift_pid,
  :redshift_query_id,
  :result_format,
  :result_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RedshiftDataAPIService::Types::DescribeStatementResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

#created_at ⇒ Time

#database ⇒ String

#db_user ⇒ String

#duration ⇒ Integer

#error ⇒ String

#has_result_set ⇒ Boolean

#id ⇒ String

#query_parameters ⇒ Array<Types::SqlParameter>

#query_string ⇒ String

#redshift_pid ⇒ Integer

#redshift_query_id ⇒ Integer

#result_format ⇒ String

#result_rows ⇒ Integer

#result_size ⇒ Integer

#secret_arn ⇒ String

#session_id ⇒ String

#status ⇒ String

#sub_statements ⇒ Array<Types::SubStatementData>

#updated_at ⇒ Time

#workgroup_name ⇒ String

#cluster_identifier ⇒ `String`

#created_at ⇒ `Time`

#database ⇒ `String`

#db_user ⇒ `String`

#duration ⇒ `Integer`

#error ⇒ `String`

#has_result_set ⇒ `Boolean`

#id ⇒ `String`

#query_parameters ⇒ `Array<Types::SqlParameter>`

#query_string ⇒ `String`

#redshift_pid ⇒ `Integer`

#redshift_query_id ⇒ `Integer`

#result_format ⇒ `String`

#result_rows ⇒ `Integer`

#result_size ⇒ `Integer`

#secret_arn ⇒ `String`

#session_id ⇒ `String`

#status ⇒ `String`

#sub_statements ⇒ `Array<Types::SubStatementData>`

#updated_at ⇒ `Time`

#workgroup_name ⇒ `String`