POST

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

http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/streaming-sessions

Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in the <code>READY</code> state.

Access Token Required: API Key

Path Parameters

studioIdstringrequired

The studio ID.

Body Params

tagsobject

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

ownedBystring

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.

ec2InstanceTypestring

The EC2 Instance type used for the streaming session.

launchProfileIdstringrequired

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

streamingImageIdstring

The ID of the streaming image.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/streaming-sessions' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}