Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSessions

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.

Request Syntax


{
   "ClusterIdentifier": "string",
   "Database": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RoleLevel": boolean,
   "SessionId": "string",
   "Status": "string",
   "WorkgroupName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

ClusterIdentifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-z][a-z0-9]*(-[a-z0-9]+)*

Required: No

Database

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

Type: String

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

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.

Type: String

Required: No

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.

Type: Boolean

Required: No

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.

Type: String

Pattern: [a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d{0,2})?

Required: No

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.

Type: String

Valid Values: AVAILABLE | BUSY | CLOSED

Required: No

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.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ([a-z0-9-]{3,63}|arn:(aws(-[a-z]+)*):redshift-serverless:([a-z]{2}(-gov|(-iso[a-z]?))?|eusc-[a-z]+)-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})

Required: No

Response Syntax


{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "ClusterIdentifier": "string",
         "CreatedAt": number,
         "CurrentStatementId": "string",
         "Database": "string",
         "DbUser": "string",
         "SessionAliveSeconds": number,
         "SessionId": "string",
         "SessionTtl": number,
         "Status": "string",
         "UpdatedAt": number,
         "WorkgroupName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Sessions

The sessions that match the request.

Type: Array of SessionData objects

NextToken

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

The Amazon Redshift Data API operation failed due to invalid input.

Message: The exception message.

HTTP Status Code: 500

ResourceNotFoundException

The Amazon Redshift Data API operation failed due to a missing resource.

Message: The exception message.
ResourceId: Resource identifier associated with the exception.

HTTP Status Code: 400

ValidationException

The Amazon Redshift Data API operation failed due to invalid input.

Message: The exception message.

HTTP Status Code: 400