Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateStreamingSession

Creates a streaming session in a studio.

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

Important

This API is only available to customers who created a Nimble Studio cloud studio before June 19th, 2023. This API won't be accessible after June 19th, 2024.

Request Syntax


POST /2020-08-01/studios/studioId/streaming-sessions HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

Length Constraints: Minimum length of 1. Maximum length of 64.

studioId

The studio ID.

Required: Yes

Request Body

The request accepts the following data in JSON format.

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: Yes

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

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "session": { 
      "arn": "string",
      "automaticTerminationMode": "string",
      "backupMode": "string",
      "createdAt": "string",
      "createdBy": "string",
      "ec2InstanceType": "string",
      "launchProfileId": "string",
      "maxBackupsToRetain": number,
      "ownedBy": "string",
      "sessionId": "string",
      "sessionPersistenceMode": "string",
      "startedAt": "string",
      "startedBy": "string",
      "startedFromBackupId": "string",
      "state": "string",
      "statusCode": "string",
      "statusMessage": "string",
      "stopAt": "string",
      "stoppedAt": "string",
      "stoppedBy": "string",
      "streamingImageId": "string",
      "tags": { 
         "string" : "string" 
      },
      "terminateAt": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "volumeConfiguration": { 
         "iops": number,
         "size": number,
         "throughput": number
      },
      "volumeRetentionMode": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

session

The session.

Type: StreamingSession object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 403

ConflictException

Another operation is in progress.

HTTP Status Code: 409

InternalServerErrorException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use AWS Service Quotas to request an increase.

HTTP Status Code: 402

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400