Skip to content

SessionData

Source code in docs_src/capo_redshift_data/types/session_data.py
class SessionData(TypedDict, closed=True):
    session_id: "capo_redshift_data.types.uuid.UUID"
    """<p>The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>"""
    status: "capo_redshift_data.types.session_status_string.SessionStatusString"
    """<p>The status of the session. Status values are defined as follows:</p> <ul> <li> <p>AVAILABLE – The session is open and ready to run a SQL statement.</p> </li> <li> <p>BUSY – The session is currently running a SQL statement.</p> </li> <li> <p>CLOSED – The session is closed and can no longer run SQL statements.</p> </li> </ul>"""
    created_at: "datetime.datetime"
    """<p>The date and time (UTC) when the session was created.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.</p>"""
    database: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The name of the database that the session is connected to.</p>"""
    db_user: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The database user name.</p>"""
    cluster_identifier: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>"""
    workgroup_name: NotRequired[
        "capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
    ]
    """<p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>"""
    session_alive_seconds: NotRequired[
        "capo_redshift_data.types.session_alive_seconds.SessionAliveSeconds"
    ]
    """<p>The number of seconds that the session is kept alive after a query finishes.</p>"""
    session_ttl: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) when the session is set to expire and be closed.</p>"""
    current_statement_id: NotRequired["capo_redshift_data.types.uuid.UUID"]
    """<p>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 <code>BUSY</code>.</p>"""

cluster_identifier instance-attribute

cluster_identifier: NotRequired[String]

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

created_at instance-attribute

created_at: datetime

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

current_statement_id instance-attribute

current_statement_id: NotRequired[UUID]

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.

database instance-attribute

database: NotRequired[String]

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

db_user instance-attribute

db_user: NotRequired[String]

The database user name.

session_alive_seconds instance-attribute

session_alive_seconds: NotRequired[SessionAliveSeconds]

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

session_id instance-attribute

session_id: UUID

The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

session_ttl instance-attribute

session_ttl: NotRequired[datetime]

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

status instance-attribute

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.

updated_at instance-attribute

updated_at: NotRequired[datetime]

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

workgroup_name instance-attribute

workgroup_name: NotRequired[WorkgroupNameString]

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