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(maxResults, nextToken, portalId, sessionId,
  sortBy, status, username)

Arguments

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.

portalId

[required] The ID of the web portal for the sessions.

sessionId

The ID of the session.

sortBy

The method in which the returned sessions should be sorted.

status

The status of the session.

username

The username of the session.

Value

A list with the following syntax:

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

Request syntax

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