Class: Aws::RedshiftDataAPIService::Types::SessionData

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftDataAPIService::Types::SessionData

Defined in:

gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

Contains the metadata for a session returned by ListSessions, including its status, compute target, database connection, and lifecycle timestamps.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_identifier ⇒ String

  The cluster identifier.

• #created_at ⇒ Time

  The date and time (UTC) when the session was created.

• #current_statement_id ⇒ String

  The identifier of the SQL statement currently running in the session.

• #database ⇒ String

  The name of the database that the session is connected to.

• #db_user ⇒ String

  The database user name.

• #session_alive_seconds ⇒ Integer

  The number of seconds that the session is kept alive after a query finishes.

• #session_id ⇒ String

  The session identifier.

• #session_ttl ⇒ Time

  The date and time (UTC) when the session is set to expire and be closed.

• #status ⇒ String

  The status of the session.

• #updated_at ⇒ Time

  The date and time (UTC) that the session metadata was last updated.

• #workgroup_name ⇒ String

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

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

Returns:

• (String)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time (UTC) when the session was created.

Returns:

• (Time)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#current_statement_id ⇒ String

The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.

Returns:

• (String)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

The name of the database that the session is connected to.

Returns:

• (String)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  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 1698

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_alive_seconds ⇒ Integer

The number of seconds that the session is kept alive after a query finishes.

Returns:

• (Integer)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The session identifier. 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 1698

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_ttl ⇒ Time

The date and time (UTC) when the session is set to expire and be closed.

Returns:

• (Time)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the session. Status values are defined as follows:

• AVAILABLE – The session is open and ready to run a SQL statement.

• BUSY – The session is currently running a SQL statement.

• CLOSED – The session is closed and can no longer run SQL statements.

Returns:

• (String)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time (UTC) that the session metadata 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 1698

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

Returns:

• (String)

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

class SessionData < Struct.new(
  :session_id,
  :status,
  :created_at,
  :updated_at,
  :database,
  :db_user,
  :cluster_identifier,
  :workgroup_name,
  :session_alive_seconds,
  :session_ttl,
  :current_statement_id)
  SENSITIVE = []
  include Aws::Structure
end