StreamingSessions - Amazon Nimble Studio

StreamingSessions

Represents the collection of streaming sessions in a studio.

URI

/2020-08-01/studios/studioId/streaming-sessions

HTTP methods

GET

Operation ID: ListStreamingSessions

Lists the streaming image resources in a studio.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Query parameters
Name Type Required Description
sessionIds String False

A collection of session IDs.

nextToken String False

The token for the next set of results, or null if there are no more results.

createdBy String False

The user ID.

Responses
Status code Response model Description
200 ListStreamingSessionsOutput

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.

POST

Operation ID: CreateStreamingSession

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 CreateStreamingSessionOutput

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

Request bodies

{ "launchProfileId": "string", "ec2InstanceType": enum, "streamingImageId": "string", "tags": { } }
{ "launchProfileId": "string", "ec2InstanceType": enum, "streamingImageId": "string", "tags": { } }

Response bodies

{ "sessions": [ { "sessionId": "string", "terminateAt": "string", "launchProfileId": "string", "ec2InstanceType": "string", "streamingImageId": "string", "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string", "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "tags": { } } ], "nextToken": "string" }
{ "session": { "sessionId": "string", "terminateAt": "string", "launchProfileId": "string", "ec2InstanceType": "string", "streamingImageId": "string", "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string", "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "tags": { } } }
{ "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.

CreateStreamingSessionInput

Property Type Required Description
launchProfileId

string

False

The launch profile ID.

ec2InstanceType

StreamingInstanceType

False

The EC2 Instance type used for the streaming session.

streamingImageId

string

False

The ID of the streaming image.

tags

Tags

False

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

CreateStreamingSessionOutput

Property Type Required Description
session

StreamingSession

False

The session.

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

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.

ListStreamingSessionsOutput

Property Type Required Description
sessions

Array of type StreamingSession

False

A collection of streaming sessions.

nextToken

string

False

The token for the next set of results, or null if there are no more results.

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.

StreamingInstanceType

  • g4dn.xlarge

  • g4dn.2xlarge

  • g4dn.4xlarge

  • g4dn.8xlarge

  • g4dn.12xlarge

  • g4dn.16xlarge

StreamingSession

Property Type Required Description
sessionId

string

False

The session ID.

terminateAt

string

False

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

launchProfileId

string

False

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

ec2InstanceType

string

False

The EC2 Instance type used for the streaming session.

streamingImageId

string

False

The ID of the streaming image.

createdAt

string

False

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

updatedAt

string

False

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

createdBy

string

False

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

updatedBy

string

False

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

state

StreamingSessionState

False

The current state.

statusCode

StreamingSessionStatusCode

False

The status code.

statusMessage

string

False

The status message for the streaming session.

arn

string

False

The ARN of the resource.

tags

Tags

False

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

StreamingSessionState

The streaming session state.

  • CREATE_IN_PROGRESS

  • DELETE_IN_PROGRESS

  • READY

  • DELETED

  • CREATE_FAILED

  • DELETE_FAILED

StreamingSessionStatusCode

  • 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

Tags

Property Type Required Description

*

string

False

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:

ListStreamingSessions

CreateStreamingSession