WorkspacesPoolSession - Amazon WorkSpaces Service

WorkspacesPoolSession

Describes a pool session.

Contents

PoolId

The identifier of the pool.

Type: String

Pattern: ^wspool-[0-9a-z]{9}$

Required: Yes

SessionId

The identifier of the session.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

UserId

The identifier of the user.

Type: String

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

Required: Yes

AuthenticationType

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

Type: String

Valid Values: SAML

Required: No

ConnectionState

Specifies whether a user is connected to the pool session.

Type: String

Valid Values: CONNECTED | NOT_CONNECTED

Required: No

ExpirationTime

The time that the pool session ended.

Type: Timestamp

Required: No

InstanceId

The identifier for the instance hosting the session.

Type: String

Pattern: ^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$

Required: No

NetworkAccessConfiguration

Describes the network details of the pool.

Type: NetworkAccessConfiguration object

Required: No

StartTime

The time that the pool sission started.

Type: Timestamp

Required: No

See Also

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