Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

DescribeSessions

Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Request Syntax

{
   "AuthenticationType": "string",
   "FleetName": "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

Required: No

FleetName

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

UserId

The user ID.

Type: String

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

Required: No

Response Syntax

{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "AuthenticationType": "string",
         "FleetName": "string",
         "Id": "string",
         "StackName": "string",
         "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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: