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

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

#cluster_identifier ⇒ String

The cluster identifier.

Returns:

  • (String) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_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) 


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 448

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_rows,
  :result_size,
  :secret_arn,
  :session_id,
  :status,
  :sub_statements,
  :updated_at,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end