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

Session

Describes a streaming session.

Contents

AuthenticationType

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

Type: String

Valid Values: API | SAML | USERPOOL

Required: No

ConnectionState

Specifies whether a user is connected to the streaming session.

Type: String

Valid Values: CONNECTED | NOT_CONNECTED

Required: No

FleetName

The name of the fleet for the streaming session.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Id

The identifier of the streaming session.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

MaxExpirationTime

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

Type: Timestamp

Required: No

NetworkAccessConfiguration

The network details for the streaming session.

Type: NetworkAccessConfiguration object

Required: No

StackName

The name of the stack for the streaming session.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

StartTime

The time when a streaming instance is dedicated for the user.

Type: Timestamp

Required: No

State

The current state of the streaming session.

Type: String

Valid Values: ACTIVE | PENDING | EXPIRED

Required: Yes

UserId

The identifier of the user for whom the session was created.

Type: String

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

Required: Yes

See Also

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

On this page: