Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface StreamingSession

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

Hierarchy

  • StreamingSession

Properties

arn? automaticTerminationMode? backupMode? createdAt? createdBy? ec2InstanceType? launchProfileId? maxBackupsToRetain? ownedBy? sessionId? sessionPersistenceMode? startedAt? startedBy? startedFromBackupId? state? statusCode? statusMessage? stopAt? stoppedAt? stoppedBy? streamingImageId? tags? terminateAt? updatedAt? updatedBy? volumeConfiguration? volumeRetentionMode?

Properties

Optional arn

arn?: string

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

Optional automaticTerminationMode

automaticTerminationMode?: string

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.

Optional backupMode

backupMode?: string

Shows the current backup setting of the session.

Optional createdAt

createdAt?: Date

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

Optional createdBy

createdBy?: string

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

Optional ec2InstanceType

ec2InstanceType?: string

The EC2 Instance type used for the streaming session.

Optional launchProfileId

launchProfileId?: string

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

Optional maxBackupsToRetain

maxBackupsToRetain?: number

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.

Optional ownedBy

ownedBy?: string

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.

Optional sessionId

sessionId?: string

The session ID.

Optional sessionPersistenceMode

sessionPersistenceMode?: string

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

Optional startedAt

startedAt?: Date

The time the session entered START_IN_PROGRESS state.

Optional startedBy

startedBy?: string

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

Optional startedFromBackupId

startedFromBackupId?: string

The backup ID used to restore a streaming session.

Optional state

state?: string

The current state.

Optional statusCode

statusCode?: string

The status code.

Optional statusMessage

statusMessage?: string

The status message for the streaming session.

Optional stopAt

stopAt?: Date

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

Optional stoppedAt

stoppedAt?: Date

The time the session entered STOP_IN_PROGRESS state.

Optional stoppedBy

stoppedBy?: string

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

Optional streamingImageId

streamingImageId?: string

The ID of the streaming image.

Optional tags

tags?: Record<string, string>

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

Optional terminateAt

terminateAt?: Date

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

Optional updatedAt

updatedAt?: Date

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

Optional updatedBy

updatedBy?: string

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

Optional volumeConfiguration

volumeConfiguration?: VolumeConfiguration

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Optional volumeRetentionMode

volumeRetentionMode?: string

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

Settings

Member Visibility

Theme