StreamingSession - Amazon Nimble Studio

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.

Type: String

Required: No

sessionId

The session ID.

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

Required: No

statusMessage

The status message for 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: