NimbleStudio / Client / get_streaming_session_stream
get_streaming_session_stream#
- NimbleStudio.Client.get_streaming_session_stream(**kwargs)#
Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking
CreateStreamingSessionStream
.After the
StreamingSessionStream
changes to theREADY
state, the url property will contain a stream to be used with the DCV streaming client.See also: AWS API Documentation
Request Syntax
response = client.get_streaming_session_stream( sessionId='string', streamId='string', studioId='string' )
- Parameters:
sessionId (string) –
[REQUIRED]
The streaming session ID.
streamId (string) –
[REQUIRED]
The streaming session stream ID.
studioId (string) –
[REQUIRED]
The studio ID.
- Return type:
dict
- Returns:
Response Syntax
{ 'stream': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'expiresAt': datetime(2015, 1, 1), 'ownedBy': 'string', 'state': 'READY'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED', 'statusCode': 'STREAM_CREATE_IN_PROGRESS'|'STREAM_READY'|'STREAM_DELETE_IN_PROGRESS'|'STREAM_DELETED'|'INTERNAL_ERROR'|'NETWORK_CONNECTION_ERROR', 'streamId': 'string', 'url': 'string' } }
Response Structure
(dict) –
stream (dict) –
The stream.
createdAt (datetime) –
The ISO timestamp in seconds for when the resource was created.
createdBy (string) –
The user ID of the user that created the streaming session stream.
expiresAt (datetime) –
The ISO timestamp in seconds for when the resource expires.
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.
state (string) –
The current state.
statusCode (string) –
The streaming session stream status code.
streamId (string) –
The stream ID.
url (string) –
The URL to connect to this stream using the DCV client.
Exceptions