Skip to content

Lists the sessions that the caller created in the last 24 hours

Description

Lists the sessions that the caller created in the last 24 hours. By default, only sessions with a status of AVAILABLE or BUSY are returned. You can filter the results by session status, compute target (cluster or serverless workgroup), or database. To retrieve the metadata for a single session, provide the SessionId parameter. Use NextToken to page through the session list.

Returns only the sessions that the caller created. When identity-enhanced role sessions are used, you must provide either the ClusterIdentifier or WorkgroupName parameter to ensure that the IAM Identity Center user can only access the Amazon Redshift IAM Identity Center applications they are assigned. For more information, see Trusted identity propagation overview.

Usage

redshiftdataapiservice_list_sessions(NextToken, MaxResults, SessionId,
  Status, RoleLevel, ClusterIdentifier, WorkgroupName, Database)

Arguments

  • NextToken

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

  • MaxResults

    The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results.

  • SessionId

    The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database.

  • Status

    The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. 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.

  • RoleLevel

    Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.

  • ClusterIdentifier

    The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified.

  • WorkgroupName

    The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.

  • Database

    The name of the database. Only sessions connected to this database are returned.

Value

A list with the following syntax:

list(
  Sessions = list(
    list(
      SessionId = "string",
      Status = "AVAILABLE"|"BUSY"|"CLOSED",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Database = "string",
      DbUser = "string",
      ClusterIdentifier = "string",
      WorkgroupName = "string",
      SessionAliveSeconds = 123,
      SessionTtl = as.POSIXct(
        "2015-01-01"
      ),
      CurrentStatementId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_sessions(
  NextToken = "string",
  MaxResults = 123,
  SessionId = "string",
  Status = "AVAILABLE"|"BUSY"|"CLOSED",
  RoleLevel = TRUE|FALSE,
  ClusterIdentifier = "string",
  WorkgroupName = "string",
  Database = "string"
)