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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

The cluster identifier.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#created_atTime

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

Returns:

  • (Time)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#databaseString

The name of the database.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#db_userString

The database user name.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#durationInteger

The amount of time in nanoseconds that the statement ran.

Returns:

  • (Integer)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#errorString

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

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#has_result_setBoolean

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)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#idString

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

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#query_parametersArray<Types::SqlParameter>

The parameters for the SQL statement.

Returns:



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#query_stringString

The SQL statement text.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#redshift_pidInteger

The process identifier from Amazon Redshift.

Returns:

  • (Integer)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#redshift_query_idInteger

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)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#result_rowsInteger

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)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#result_sizeInteger

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

Returns:

  • (Integer)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#secret_arnString

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

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#statusString

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)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#sub_statementsArray<Types::SubStatementData>

The SQL statements from a multiple statement run.

Returns:



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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

#updated_atTime

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)


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 401

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