Amazonka.Nimble.Types.StreamingSession

Documentation

data StreamingSession

A streaming session is a virtual workstation created using a particular launch profile.

See: newStreamingSession smart constructor.

Constructors

StreamingSession'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

• automaticTerminationMode :: Maybe AutomaticTerminationMode

  Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
  • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

  This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

• backupMode :: Maybe SessionBackupMode

  Shows the current backup setting of the session.

• createdAt :: Maybe ISO8601

  The ISO timestamp in seconds for when the resource was created.

• createdBy :: Maybe Text

  The user ID of the user that created the streaming session.

• ec2InstanceType :: Maybe Text

  The EC2 Instance type used for the streaming session.

• launchProfileId :: Maybe Text

  The ID of the launch profile used to control access from the streaming session.

• maxBackupsToRetain :: Maybe Natural

  The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

• ownedBy :: Maybe Text

  The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

• sessionId :: Maybe Text

  The session ID.

• sessionPersistenceMode :: Maybe SessionPersistenceMode

  Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

• startedAt :: Maybe ISO8601

  The time the session entered START_IN_PROGRESS state.

• startedBy :: Maybe Text

  The user ID of the user that started the streaming session.

• startedFromBackupId :: Maybe Text

  The backup ID used to restore a streaming session.

• state :: Maybe StreamingSessionState

  The current state.

• statusCode :: Maybe StreamingSessionStatusCode

  The status code.

• statusMessage :: Maybe Text

  The status message for the streaming session.

• stopAt :: Maybe ISO8601

  The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

• stoppedAt :: Maybe ISO8601

  The time the session entered STOP_IN_PROGRESS state.

• stoppedBy :: Maybe Text

  The user ID of the user that stopped the streaming session.

• streamingImageId :: Maybe Text

  The ID of the streaming image.

• tags :: Maybe (HashMap Text Text)

  A collection of labels, in the form of key-value pairs, that apply to this resource.

• terminateAt :: Maybe ISO8601

  The time the streaming session will automatically terminate if not terminated by the user.

• updatedAt :: Maybe ISO8601

  The ISO timestamp in seconds for when the resource was updated.

• updatedBy :: Maybe Text

  The user ID of the user that most recently updated the resource.

• volumeConfiguration :: Maybe VolumeConfiguration

  Custom volume configuration for the root volumes that are attached to streaming sessions.

  This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

• volumeRetentionMode :: Maybe VolumeRetentionMode

  Determine if an EBS volume created from this streaming session will be backed up.

Instances

FromJSON StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

parseJSON :: Value -> Parser StreamingSession

parseJSONList :: Value -> Parser [StreamingSession]

Generic StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Associated Types

type Rep StreamingSession :: Type -> Type

Methods

from :: StreamingSession -> Rep StreamingSession x

to :: Rep StreamingSession x -> StreamingSession

Read StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

readsPrec :: Int -> ReadS StreamingSession

readList :: ReadS [StreamingSession]

readPrec :: ReadPrec StreamingSession

readListPrec :: ReadPrec [StreamingSession]

Show StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

showsPrec :: Int -> StreamingSession -> ShowS

show :: StreamingSession -> String

showList :: [StreamingSession] -> ShowS

NFData StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

rnf :: StreamingSession -> ()

Eq StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

(==) :: StreamingSession -> StreamingSession -> Bool

(/=) :: StreamingSession -> StreamingSession -> Bool

Hashable StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

Methods

hashWithSalt :: Int -> StreamingSession -> Int

hash :: StreamingSession -> Int

type Rep StreamingSession

Defined in Amazonka.Nimble.Types.StreamingSession

type Rep StreamingSession = D1 ('MetaData "StreamingSession" "Amazonka.Nimble.Types.StreamingSession" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "StreamingSession'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "automaticTerminationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomaticTerminationMode)) :*: S1 ('MetaSel ('Just "backupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionBackupMode)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ec2InstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "launchProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxBackupsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "ownedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sessionPersistenceMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionPersistenceMode))) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "startedFromBackupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingSessionState)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingSessionStatusCode)))) :*: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stopAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "stoppedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "streamingImageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "terminateAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: ((S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "updatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "volumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeConfiguration)) :*: S1 ('MetaSel ('Just "volumeRetentionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeRetentionMode))))))))

newStreamingSession :: StreamingSession

Create a value of StreamingSession 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:arn:StreamingSession', streamingSession_arn - The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

$sel:automaticTerminationMode:StreamingSession', streamingSession_automaticTerminationMode - Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

• When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

$sel:backupMode:StreamingSession', streamingSession_backupMode - Shows the current backup setting of the session.

$sel:createdAt:StreamingSession', streamingSession_createdAt - The ISO timestamp in seconds for when the resource was created.

$sel:createdBy:StreamingSession', streamingSession_createdBy - The user ID of the user that created the streaming session.

$sel:ec2InstanceType:StreamingSession', streamingSession_ec2InstanceType - The EC2 Instance type used for the streaming session.

$sel:launchProfileId:StreamingSession', streamingSession_launchProfileId - The ID of the launch profile used to control access from the streaming session.

$sel:maxBackupsToRetain:StreamingSession', streamingSession_maxBackupsToRetain - The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

$sel:ownedBy:StreamingSession', streamingSession_ownedBy - The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

$sel:sessionId:StreamingSession', streamingSession_sessionId - The session ID.

$sel:sessionPersistenceMode:StreamingSession', streamingSession_sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

$sel:startedAt:StreamingSession', streamingSession_startedAt - The time the session entered START_IN_PROGRESS state.

$sel:startedBy:StreamingSession', streamingSession_startedBy - The user ID of the user that started the streaming session.

$sel:startedFromBackupId:StreamingSession', streamingSession_startedFromBackupId - The backup ID used to restore a streaming session.

$sel:state:StreamingSession', streamingSession_state - The current state.

$sel:statusCode:StreamingSession', streamingSession_statusCode - The status code.

$sel:statusMessage:StreamingSession', streamingSession_statusMessage - The status message for the streaming session.

$sel:stopAt:StreamingSession', streamingSession_stopAt - The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

$sel:stoppedAt:StreamingSession', streamingSession_stoppedAt - The time the session entered STOP_IN_PROGRESS state.

$sel:stoppedBy:StreamingSession', streamingSession_stoppedBy - The user ID of the user that stopped the streaming session.

$sel:streamingImageId:StreamingSession', streamingSession_streamingImageId - The ID of the streaming image.

$sel:tags:StreamingSession', streamingSession_tags - A collection of labels, in the form of key-value pairs, that apply to this resource.

$sel:terminateAt:StreamingSession', streamingSession_terminateAt - The time the streaming session will automatically terminate if not terminated by the user.

$sel:updatedAt:StreamingSession', streamingSession_updatedAt - The ISO timestamp in seconds for when the resource was updated.

$sel:updatedBy:StreamingSession', streamingSession_updatedBy - The user ID of the user that most recently updated the resource.

$sel:volumeConfiguration:StreamingSession', streamingSession_volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

$sel:volumeRetentionMode:StreamingSession', streamingSession_volumeRetentionMode - Determine if an EBS volume created from this streaming session will be backed up.

streamingSession_arn :: Lens' StreamingSession (Maybe Text)

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

streamingSession_automaticTerminationMode :: Lens' StreamingSession (Maybe AutomaticTerminationMode)

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

• When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

streamingSession_backupMode :: Lens' StreamingSession (Maybe SessionBackupMode)

Shows the current backup setting of the session.

streamingSession_createdAt :: Lens' StreamingSession (Maybe UTCTime)

The ISO timestamp in seconds for when the resource was created.

streamingSession_createdBy :: Lens' StreamingSession (Maybe Text)

The user ID of the user that created the streaming session.

streamingSession_ec2InstanceType :: Lens' StreamingSession (Maybe Text)

The EC2 Instance type used for the streaming session.

streamingSession_launchProfileId :: Lens' StreamingSession (Maybe Text)

The ID of the launch profile used to control access from the streaming session.

streamingSession_maxBackupsToRetain :: Lens' StreamingSession (Maybe Natural)

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

streamingSession_ownedBy :: Lens' StreamingSession (Maybe Text)

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

streamingSession_sessionId :: Lens' StreamingSession (Maybe Text)

The session ID.

streamingSession_sessionPersistenceMode :: Lens' StreamingSession (Maybe SessionPersistenceMode)

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

streamingSession_startedAt :: Lens' StreamingSession (Maybe UTCTime)

The time the session entered START_IN_PROGRESS state.

streamingSession_startedBy :: Lens' StreamingSession (Maybe Text)

The user ID of the user that started the streaming session.

streamingSession_startedFromBackupId :: Lens' StreamingSession (Maybe Text)

The backup ID used to restore a streaming session.

streamingSession_state :: Lens' StreamingSession (Maybe StreamingSessionState)

The current state.

streamingSession_statusCode :: Lens' StreamingSession (Maybe StreamingSessionStatusCode)

The status code.

streamingSession_statusMessage :: Lens' StreamingSession (Maybe Text)

The status message for the streaming session.

streamingSession_stopAt :: Lens' StreamingSession (Maybe UTCTime)

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

streamingSession_stoppedAt :: Lens' StreamingSession (Maybe UTCTime)

The time the session entered STOP_IN_PROGRESS state.

streamingSession_stoppedBy :: Lens' StreamingSession (Maybe Text)

The user ID of the user that stopped the streaming session.

streamingSession_streamingImageId :: Lens' StreamingSession (Maybe Text)

The ID of the streaming image.

streamingSession_tags :: Lens' StreamingSession (Maybe (HashMap Text Text))

A collection of labels, in the form of key-value pairs, that apply to this resource.

streamingSession_terminateAt :: Lens' StreamingSession (Maybe UTCTime)

The time the streaming session will automatically terminate if not terminated by the user.

streamingSession_updatedAt :: Lens' StreamingSession (Maybe UTCTime)

The ISO timestamp in seconds for when the resource was updated.

streamingSession_updatedBy :: Lens' StreamingSession (Maybe Text)

The user ID of the user that most recently updated the resource.

streamingSession_volumeConfiguration :: Lens' StreamingSession (Maybe VolumeConfiguration)

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

streamingSession_volumeRetentionMode :: Lens' StreamingSession (Maybe VolumeRetentionMode)

Determine if an EBS volume created from this streaming session will be backed up.