List Sessions

workspacesweb_list_sessions

R Documentation

Lists information for multiple secure browser sessions from a specific portal

Description

Lists information for multiple secure browser sessions from a specific portal.

Usage

workspacesweb_list_sessions(portalId, username, sessionId, sortBy,
  status, maxResults, nextToken)

Arguments

portalId	[required] The ID of the web portal for the sessions.
username	The username of the session.
sessionId	The ID of the session.
sortBy	The method in which the returned sessions should be sorted.
status	The status of the session.
maxResults	The maximum number of results to be included in the next page.
nextToken	The pagination token used to retrieve the next page of results for this operation.

Value

A list with the following syntax:

list(
  sessions = list(
    list(
      portalArn = "string",
      sessionId = "string",
      username = "string",
      status = "Active"|"Terminated",
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      endTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_sessions(
  portalId = "string",
  username = "string",
  sessionId = "string",
  sortBy = "StartTimeAscending"|"StartTimeDescending",
  status = "Active"|"Terminated",
  maxResults = 123,
  nextToken = "string"
)