StreamingImageEncryptionConfiguration
Specifies how a streaming image is encrypted.
Contents
keyArn
The ARN for a KMS key that is used to encrypt studio data.
Type: String
Length Constraints: Minimum length of 4.
Pattern: ^arn:.*
Required: No keyType
The type of KMS key that is used to encrypt studio data.
Type: String
Valid Values: CUSTOMER_MANAGED_KEY Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
StreamingSession
StreamingSession
A streaming session is a virtual workstation created using a particular launch profile.
Contents
arn
The ARN of the resource.
Type: String Required: No createdAt
The Unix epoch 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 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
Contents
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 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.
See Also
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 Unix epoch 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for Ruby V3
StreamingSessionStorageRoot
StreamingSessionStorageRoot
The upload storage root location (folder) on streaming workstations where files are uploaded.
Contents
linux
The folder path in Linux workstations where files are uploaded.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$
Required: No windows
The folder path in Windows workstations where files are uploaded.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
StreamingSessionStream
StreamingSessionStream
A stream is an active connection to a streaming session, enabling a studio user to control the streaming session using a compatible client. Streaming session streams are compatible with the NICE DCV web client, included in the Nimble Studio portal, or the NICE DCV desktop client.
Contents
createdAt
The Unix epoch 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 stream.
Type: String Required: No expiresAt
The Unix epoch timestamp in seconds for when the resource expires.
Type: Timestamp 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 state
The current state.
Type: String
Valid Values: READY | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | DELETED | CREATE_FAILED | DELETE_FAILED
Required: No statusCode
The streaming session stream status code.
Type: String
Valid Values: STREAM_CREATE_IN_PROGRESS | STREAM_READY |
STREAM_DELETE_IN_PROGRESS | STREAM_DELETED | INTERNAL_ERROR | NETWORK_CONNECTION_ERROR
Required: No