StreamingSession - Amazon Nimble Studio
ContentsSee Also

StreamingSession

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

Contents

arn

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

Type: String

Required: No

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.

Type: String

Valid Values: DEACTIVATED | ACTIVATED

Required: No

backupMode

Shows the current backup setting of the session.

Type: String

Valid Values: AUTOMATIC | DEACTIVATED

Required: No

createdAt

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

Type: Timestamp

Required: No

createdBy

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

Type: String

Required: No

ec2InstanceType

The EC2 Instance type used for the streaming session.

Type: String

Required: No

launchProfileId

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

Type: String

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10.

Required: No

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.

Type: String

Required: No

sessionId

The session ID.

Type: String

Required: No

sessionPersistenceMode

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

Type: String

Valid Values: DEACTIVATED | ACTIVATED

Required: No

startedAt

The time the session entered START_IN_PROGRESS state.

Type: Timestamp

Required: No

startedBy

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

Type: String

Required: No

startedFromBackupId

The backup ID used to restore a streaming session.

Type: String

Required: No

state

The current state.

Type: String

Valid Values: CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | READY | DELETED | CREATE_FAILED | DELETE_FAILED | STOP_IN_PROGRESS | START_IN_PROGRESS | STOPPED | STOP_FAILED | START_FAILED

Required: No

statusCode

The status code.

Type: String

Valid Values: STREAMING_SESSION_READY | STREAMING_SESSION_DELETED | STREAMING_SESSION_CREATE_IN_PROGRESS | STREAMING_SESSION_DELETE_IN_PROGRESS | INTERNAL_ERROR | INSUFFICIENT_CAPACITY | ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR | NETWORK_CONNECTION_ERROR | INITIALIZATION_SCRIPT_ERROR | DECRYPT_STREAMING_IMAGE_ERROR | NETWORK_INTERFACE_ERROR | STREAMING_SESSION_STOPPED | STREAMING_SESSION_STARTED | STREAMING_SESSION_STOP_IN_PROGRESS | STREAMING_SESSION_START_IN_PROGRESS | AMI_VALIDATION_ERROR

Required: No

statusMessage

The status message for the streaming session.

Type: String

Required: No

stopAt

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

Type: Timestamp

Required: No

stoppedAt

The time the session entered STOP_IN_PROGRESS state.

Type: Timestamp

Required: No

stoppedBy

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

Type: String

Required: No

streamingImageId

The ID of the streaming image.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 22.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

tags

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

Type: String to string map

Required: No

terminateAt

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

Type: Timestamp

Required: No

updatedAt

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

Type: Timestamp

Required: No

updatedBy

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

Type: String

Required: No

volumeConfiguration

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Type: VolumeConfiguration object

Required: No

volumeRetentionMode

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

Type: String

Valid Values: RETAIN | DELETE

Required: No

See Also

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