Describe Sessions
appstream_describe_sessions | R Documentation |
Retrieves a list that describes the streaming sessions for a specified stack and fleet¶
Description¶
Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
Usage¶
appstream_describe_sessions(StackName, FleetName, UserId, NextToken,
Limit, AuthenticationType, InstanceId)
Arguments¶
StackName
[required] The name of the stack. This value is case-sensitive.
FleetName
[required] The name of the fleet. This value is case-sensitive.
UserId
The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
NextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Limit
The size of each page of results. The default value is 20 and the maximum value is 50.
AuthenticationType
The authentication method. Specify
API
for a user authenticated using a streaming URL orSAML
for a SAML federated user. The default is to authenticate users using a streaming URL.InstanceId
The identifier for the instance hosting the session.
Value¶
A list with the following syntax:
list(
Sessions = list(
list(
Id = "string",
UserId = "string",
StackName = "string",
FleetName = "string",
State = "ACTIVE"|"PENDING"|"EXPIRED",
ConnectionState = "CONNECTED"|"NOT_CONNECTED",
StartTime = as.POSIXct(
"2015-01-01"
),
MaxExpirationTime = as.POSIXct(
"2015-01-01"
),
AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD",
NetworkAccessConfiguration = list(
EniPrivateIpAddress = "string",
EniId = "string"
),
InstanceId = "string"
)
),
NextToken = "string"
)