Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeSessions

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.

Request Syntax


{
   "AuthenticationType": "string",
   "FleetName": "string",
   "InstanceId": "string",
   "Limit": number,
   "NextToken": "string",
   "StackName": "string",
   "UserId": "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.

AuthenticationType

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

Type: String

Valid Values: API | SAML | USERPOOL | AWS_AD

Required: No

FleetName

The name of the fleet. This value is case-sensitive.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

InstanceId

The identifier for the instance hosting the session.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Limit

The size of each page of results. The default value is 20 and the maximum value is 50.

Type: Integer

Required: No

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

StackName

The name of the stack. This value is case-sensitive.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

UserId

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

Type: String

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "AuthenticationType": "string",
         "ConnectionState": "string",
         "FleetName": "string",
         "Id": "string",
         "InstanceId": "string",
         "MaxExpirationTime": number,
         "NetworkAccessConfiguration": { 
            "EniId": "string",
            "EniPrivateIpAddress": "string"
         },
         "StackName": "string",
         "StartTime": number,
         "State": "string",
         "UserId": "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.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Minimum length of 1.

Sessions

Information about the streaming sessions.

Type: Array of Session objects

Errors

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

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400