/AWS1/CL_RSDSESSIONDATA¶
Contains the metadata for a session returned by ListSessions, including its status, compute target, database connection, and lifecycle timestamps.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_sessionid TYPE /AWS1/RSDUUID /AWS1/RSDUUID¶
The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
iv_status TYPE /AWS1/RSDSESSIONSTATUSSTRING /AWS1/RSDSESSIONSTATUSSTRING¶
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.
iv_createdat TYPE /AWS1/RSDTIMESTAMP /AWS1/RSDTIMESTAMP¶
The date and time (UTC) when the session was created.
Optional arguments:¶
iv_updatedat TYPE /AWS1/RSDTIMESTAMP /AWS1/RSDTIMESTAMP¶
The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.
iv_database TYPE /AWS1/RSDSTRING /AWS1/RSDSTRING¶
The name of the database that the session is connected to.
iv_dbuser TYPE /AWS1/RSDSTRING /AWS1/RSDSTRING¶
The database user name.
iv_clusteridentifier TYPE /AWS1/RSDSTRING /AWS1/RSDSTRING¶
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
iv_workgroupname TYPE /AWS1/RSDWORKGROUPNAMESTRING /AWS1/RSDWORKGROUPNAMESTRING¶
The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
iv_sessionaliveseconds TYPE /AWS1/RSDSESSIONALIVESECONDS /AWS1/RSDSESSIONALIVESECONDS¶
The number of seconds that the session is kept alive after a query finishes.
iv_sessionttl TYPE /AWS1/RSDTIMESTAMP /AWS1/RSDTIMESTAMP¶
The date and time (UTC) when the session is set to expire and be closed.
iv_currentstatementid TYPE /AWS1/RSDUUID /AWS1/RSDUUID¶
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.
Queryable Attributes¶
SessionId¶
The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONID() |
Getter for SESSIONID, with configurable default |
ASK_SESSIONID() |
Getter for SESSIONID w/ exceptions if field has no value |
HAS_SESSIONID() |
Determine if SESSIONID has a value |
Status¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
CreatedAt¶
The date and time (UTC) when the session was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
UpdatedAt¶
The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
Database¶
The name of the database that the session is connected to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATABASE() |
Getter for DATABASE, with configurable default |
ASK_DATABASE() |
Getter for DATABASE w/ exceptions if field has no value |
HAS_DATABASE() |
Determine if DATABASE has a value |
DbUser¶
The database user name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBUSER() |
Getter for DBUSER, with configurable default |
ASK_DBUSER() |
Getter for DBUSER w/ exceptions if field has no value |
HAS_DBUSER() |
Determine if DBUSER has a value |
ClusterIdentifier¶
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERIDENTIFIER() |
Getter for CLUSTERIDENTIFIER, with configurable default |
ASK_CLUSTERIDENTIFIER() |
Getter for CLUSTERIDENTIFIER w/ exceptions if field has no v |
HAS_CLUSTERIDENTIFIER() |
Determine if CLUSTERIDENTIFIER has a value |
WorkgroupName¶
The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKGROUPNAME() |
Getter for WORKGROUPNAME, with configurable default |
ASK_WORKGROUPNAME() |
Getter for WORKGROUPNAME w/ exceptions if field has no value |
HAS_WORKGROUPNAME() |
Determine if WORKGROUPNAME has a value |
SessionAliveSeconds¶
The number of seconds that the session is kept alive after a query finishes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONALIVESECONDS() |
Getter for SESSIONALIVESECONDS, with configurable default |
ASK_SESSIONALIVESECONDS() |
Getter for SESSIONALIVESECONDS w/ exceptions if field has no |
HAS_SESSIONALIVESECONDS() |
Determine if SESSIONALIVESECONDS has a value |
SessionTtl¶
The date and time (UTC) when the session is set to expire and be closed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONTTL() |
Getter for SESSIONTTL, with configurable default |
ASK_SESSIONTTL() |
Getter for SESSIONTTL w/ exceptions if field has no value |
HAS_SESSIONTTL() |
Determine if SESSIONTTL has a value |
CurrentStatementId¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CURRENTSTATEMENTID() |
Getter for CURRENTSTATEMENTID, with configurable default |
ASK_CURRENTSTATEMENTID() |
Getter for CURRENTSTATEMENTID w/ exceptions if field has no |
HAS_CURRENTSTATEMENTID() |
Determine if CURRENTSTATEMENTID has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SESSIONLIST¶
TYPES TT_SESSIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_RSDSESSIONDATA WITH DEFAULT KEY
.