Describe Workspaces Pool Sessions

workspaces_describe_workspaces_pool_sessions

R Documentation

Retrieves a list that describes the streaming sessions for a specified pool¶

Description¶

Retrieves a list that describes the streaming sessions for a specified pool.

Usage¶

workspaces_describe_workspaces_pool_sessions(PoolId, UserId, Limit,
  NextToken)

Arguments¶

PoolId

[required] The identifier of the pool.

UserId

The identifier of the user.

Limit

The maximum number of items to return.

NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Value¶

A list with the following syntax:

list(
  Sessions = list(
    list(
      AuthenticationType = "SAML",
      ConnectionState = "CONNECTED"|"NOT_CONNECTED",
      SessionId = "string",
      InstanceId = "string",
      PoolId = "string",
      ExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      NetworkAccessConfiguration = list(
        EniPrivateIpAddress = "string",
        EniId = "string"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      UserId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_workspaces_pool_sessions(
  PoolId = "string",
  UserId = "string",
  Limit = 123,
  NextToken = "string"
)