Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppStream.Types.Session

Description

Synopsis

data Session = Session' {
- networkAccessConfiguration :: Maybe NetworkAccessConfiguration
- maxExpirationTime :: Maybe POSIX
- startTime :: Maybe POSIX
- authenticationType :: Maybe AuthenticationType
- connectionState :: Maybe SessionConnectionState
- id :: Text
- userId :: Text
- stackName :: Text
- fleetName :: Text
- state :: SessionState
}
newSession :: Text -> Text -> Text -> Text -> SessionState -> Session
session_networkAccessConfiguration :: Lens' Session (Maybe NetworkAccessConfiguration)
session_maxExpirationTime :: Lens' Session (Maybe UTCTime)
session_startTime :: Lens' Session (Maybe UTCTime)
session_authenticationType :: Lens' Session (Maybe AuthenticationType)
session_connectionState :: Lens' Session (Maybe SessionConnectionState)
session_id :: Lens' Session Text
session_userId :: Lens' Session Text
session_stackName :: Lens' Session Text
session_fleetName :: Lens' Session Text
session_state :: Lens' Session SessionState

Documentation

data Session Source #

Describes a streaming session.

See: newSession smart constructor.

Constructors

Session'

Fields

networkAccessConfiguration :: Maybe NetworkAccessConfiguration
The network details for the streaming session.
maxExpirationTime :: Maybe POSIX
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.
startTime :: Maybe POSIX
The time when a streaming instance is dedicated for the user.
authenticationType :: Maybe AuthenticationType
The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
connectionState :: Maybe SessionConnectionState
Specifies whether a user is connected to the streaming session.
id :: Text
The identifier of the streaming session.
userId :: Text
The identifier of the user for whom the session was created.
stackName :: Text
The name of the stack for the streaming session.
fleetName :: Text
The name of the fleet for the streaming session.
state :: SessionState
The current state of the streaming session.

Instances

Instances details

Eq Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Read Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods readsPrec :: Int -> ReadS Session # readList :: ReadS [Session] # readPrec :: ReadPrec Session # readListPrec :: ReadPrec [Session] #
Show Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
Generic Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Associated Types type Rep Session :: Type -> Type # Methods from :: Session -> Rep Session x # to :: Rep Session x -> Session #
NFData Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods rnf :: Session -> () #
Hashable Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods hashWithSalt :: Int -> Session -> Int # hash :: Session -> Int #
FromJSON Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session Methods parseJSON :: Value -> Parser Session # parseJSONList :: Value -> Parser [Session] #
type Rep Session Source #
Instance details Defined in Amazonka.AppStream.Types.Session type Rep Session = D1 ('MetaData "Session" "Amazonka.AppStream.Types.Session" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "networkAccessConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkAccessConfiguration)) :: S1 ('MetaSel ('Just "maxExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationType)) :: S1 ('MetaSel ('Just "connectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionConnectionState))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "fleetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SessionState))))))

newSession Source #

Arguments

:: Text	`$sel:id:Session'`
-> Text	`$sel:userId:Session'`
-> Text	`$sel:stackName:Session'`
-> Text	`$sel:fleetName:Session'`
-> SessionState	`$sel:state:Session'`
-> Session

Create a value of Session with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:networkAccessConfiguration:Session', session_networkAccessConfiguration - The network details for the streaming session.

$sel:maxExpirationTime:Session', session_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.

$sel:startTime:Session', session_startTime - The time when a streaming instance is dedicated for the user.

$sel:authenticationType:Session', session_authenticationType - The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

$sel:connectionState:Session', session_connectionState - Specifies whether a user is connected to the streaming session.

$sel:id:Session', session_id - The identifier of the streaming session.

$sel:userId:Session', session_userId - The identifier of the user for whom the session was created.

$sel:stackName:Session', session_stackName - The name of the stack for the streaming session.

$sel:fleetName:Session', session_fleetName - The name of the fleet for the streaming session.

$sel:state:Session', session_state - The current state of the streaming session.

session_networkAccessConfiguration :: Lens' Session (Maybe NetworkAccessConfiguration) Source #

The network details for the streaming session.

session_maxExpirationTime :: Lens' Session (Maybe UTCTime) Source #

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.

session_startTime :: Lens' Session (Maybe UTCTime) Source #

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

session_authenticationType :: Lens' Session (Maybe AuthenticationType) Source #

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

session_connectionState :: Lens' Session (Maybe SessionConnectionState) Source #

Specifies whether a user is connected to the streaming session.

session_id :: Lens' Session Text Source #

The identifier of the streaming session.

session_userId :: Lens' Session Text Source #

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

session_stackName :: Lens' Session Text Source #

The name of the stack for the streaming session.

session_fleetName :: Lens' Session Text Source #

The name of the fleet for the streaming session.

session_state :: Lens' Session SessionState Source #

The current state of the streaming session.