Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465286243.1 KB

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.

post/#X-Amz-Target=PhotonAdminProxyService.DescribeSessions

Headers

X-Amz-Target'PhotonAdminProxyService.DescribeSessions' required

Request body

StackNamestring required

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

FleetNamestring required

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

UserIdstring

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

NextTokenstring

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.

Limitinteger

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

AuthenticationType'API' | 'SAML' | 'USERPOOL' | 'AWS_AD'

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

Response

Success

NextTokenstring

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.