StreamingSessionStream - Amazon Nimble Studio

StreamingSessionStream

Represents a streaming session stream.

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.

URI

/2020-08-01/studios/studioId/streaming-sessions/sessionId/streams/streamId

HTTP methods

GET

Operation ID: GetStreamingSessionStream

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

Path parameters
Name Type Required Description
sessionId String True

The session ID.

studioId String True

The studio ID.

streamId String True

The stream ID.

Responses
Status code Response model Description
200 GetStreamingSessionStreamOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

Schemas

Response bodies

{ "stream": { "streamId": "string", "createdAt": "string", "expiresAt": "string", "state": enum, "statusCode": enum, "createdBy": "string", "url": "string" } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }

Properties

AccessDeniedException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ConflictException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ExceptionContext

ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.

ExceptionContext enables scripts and other programmatic clients to provide for better error handling.

Property Type Required Description

*

string

False

GetStreamingSessionStreamOutput

Property Type Required Description
stream

StreamingSessionStream

False

The stream.

InternalServerException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ResourceNotFoundException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ServiceQuotaExceededException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

StreamingSessionStream

Property Type Required Description
streamId

string

False

The stream ID.

createdAt

string

False

The Unix epoch timestamp in seconds for when the resource was created.

expiresAt

string

False

The Unix epoch timestamp in seconds for when the resource expires.

state

StreamingSessionStreamState

False

The current state.

statusCode

StreamingSessionStreamStatusCode

False

The streaming session stream status code.

createdBy

string

False

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

url

string

False

The URL to connect to this stream using the DCV client.

StreamingSessionStreamState

  • READY

  • CREATE_IN_PROGRESS

  • DELETE_IN_PROGRESS

  • DELETED

  • CREATE_FAILED

  • DELETE_FAILED

StreamingSessionStreamStatusCode

  • STREAM_CREATE_IN_PROGRESS

  • STREAM_READY

  • STREAM_DELETE_IN_PROGRESS

  • STREAM_DELETED

  • INTERNAL_ERROR

  • NETWORK_CONNECTION_ERROR

ThrottlingException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ValidationException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

See also

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

GetStreamingSessionStream