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

StartStreamingSession

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

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/sessionId/start HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json

{
   "backupId": "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.

sessionId

The streaming session ID for the StartStreamingSessionRequest.

Required: Yes

studioId

The studio ID for the StartStreamingSessionRequest.

Required: Yes

Request Body

The request accepts the following data in JSON format.

backupId

The ID of the backup.

Type: String

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

A streaming session is a virtual workstation created using a particular launch profile.

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