You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier.

Returns:

  • (String) —

    The cluster identifier.

#created_at ⇒ Time

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

Returns:

  • (Time) —

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

#database ⇒ String

The name of the database.

Returns:

  • (String) —

    The name of the database.

#db_user ⇒ String

The database user name.

Returns:

  • (String) —

    The database user name.

#duration ⇒ Integer

The amount of time in nanoseconds that the statement ran.

Returns:

  • (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.

Returns:

  • (String) —

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

#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) —

    The identifier of the SQL statement described.

#query_string ⇒ String

The SQL statement text.

Returns:

  • (String) —

    The SQL statement text.

#redshift_pid ⇒ Integer

The process identifier from Amazon Redshift.

Returns:

  • (Integer) —

    The process identifier from Amazon Redshift.

#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) —

    The identifier of the query generated by Amazon Redshift.

#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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

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

#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.

    Possible values:

    • ABORTED
    • ALL
    • FAILED
    • FINISHED
    • PICKED
    • STARTED
    • SUBMITTED

Returns:

  • (String) —

    The status of the SQL statement being described.

#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) —

    The date and time (UTC) that the metadata for the SQL statement was last updated.