Amazon Nimble Studio
Welcome
API Version 2020-08-01
Amazon Nimble Studio: Welcome
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
AcceptEulas ... 4
Request Syntax ... 4
URI Request Parameters ... 4
Request Body ... 4
Response Syntax ... 4
Response Elements ... 5
Errors ... 5
See Also ... 6
CreateLaunchProfile ... 7
Request Syntax ... 7
URI Request Parameters ... 7
Request Body ... 7
Response Syntax ... 9
Response Elements ... 9
Errors ... 10
See Also ... 10
CreateStreamingImage ... 12
Request Syntax ... 12
URI Request Parameters ... 12
Request Body ... 12
Response Syntax ... 13
Response Elements ... 13
Errors ... 14
See Also ... 14
CreateStreamingSession ... 16
Request Syntax ... 16
URI Request Parameters ... 16
Request Body ... 16
Response Syntax ... 17
Response Elements ... 18
Errors ... 18
See Also ... 19
CreateStreamingSessionStream ... 20
Request Syntax ... 20
URI Request Parameters ... 20
Request Body ... 20
Response Syntax ... 20
Response Elements ... 21
Errors ... 21
See Also ... 22
CreateStudio ... 23
Request Syntax ... 23
URI Request Parameters ... 23
Request Body ... 24
Response Syntax ... 24
Response Elements ... 25
Errors ... 25
See Also ... 26
CreateStudioComponent ... 27
Request Syntax ... 27
URI Request Parameters ... 28
Request Body ... 28
Response Syntax ... 29
Response Elements ... 30
Errors ... 30
See Also ... 31
DeleteLaunchProfile ... 32
Request Syntax ... 32
URI Request Parameters ... 32
Request Body ... 32
Response Syntax ... 32
Response Elements ... 33
Errors ... 33
See Also ... 34
DeleteLaunchProfileMember ... 35
Request Syntax ... 35
URI Request Parameters ... 35
Request Body ... 35
Response Syntax ... 35
Response Elements ... 35
Errors ... 35
See Also ... 36
DeleteStreamingImage ... 37
Request Syntax ... 37
URI Request Parameters ... 37
Request Body ... 37
Response Syntax ... 37
Response Elements ... 38
Errors ... 38
See Also ... 39
DeleteStreamingSession ... 40
Request Syntax ... 40
URI Request Parameters ... 40
Request Body ... 40
Response Syntax ... 40
Response Elements ... 41
Errors ... 41
See Also ... 42
DeleteStudio ... 43
Request Syntax ... 43
URI Request Parameters ... 43
Request Body ... 43
Response Syntax ... 43
Response Elements ... 44
Errors ... 44
See Also ... 45
DeleteStudioComponent ... 46
Request Syntax ... 46
URI Request Parameters ... 46
Request Body ... 46
Response Syntax ... 46
Response Elements ... 47
Errors ... 47
See Also ... 48
DeleteStudioMember ... 49
Request Syntax ... 49
URI Request Parameters ... 49
Request Body ... 49
Response Syntax ... 49
Response Elements ... 49
Errors ... 49
See Also ... 50
GetEula ... 51
Request Syntax ... 51
URI Request Parameters ... 51
Request Body ... 51
Response Syntax ... 51
Response Elements ... 51
Errors ... 51
See Also ... 52
GetLaunchProfile ... 53
Request Syntax ... 53
URI Request Parameters ... 53
Request Body ... 53
Response Syntax ... 53
Response Elements ... 54
Errors ... 54
See Also ... 55
GetLaunchProfileDetails ... 56
Request Syntax ... 56
URI Request Parameters ... 56
Request Body ... 56
Response Syntax ... 56
Response Elements ... 57
Errors ... 58
See Also ... 59
GetLaunchProfileInitialization ... 60
Request Syntax ... 60
URI Request Parameters ... 60
Request Body ... 60
Response Syntax ... 60
Response Elements ... 61
Errors ... 61
See Also ... 62
GetLaunchProfileMember ... 63
Request Syntax ... 63
URI Request Parameters ... 63
Request Body ... 63
Response Syntax ... 63
Response Elements ... 63
Errors ... 64
See Also ... 64
GetStreamingImage ... 66
Request Syntax ... 66
URI Request Parameters ... 66
Request Body ... 66
Response Syntax ... 66
Response Elements ... 67
Errors ... 67
See Also ... 68
GetStreamingSession ... 69
Request Syntax ... 69
URI Request Parameters ... 69
Request Body ... 69
Response Syntax ... 69
Response Elements ... 70
Errors ... 70
See Also ... 71
GetStreamingSessionStream ... 72
Request Syntax ... 72
URI Request Parameters ... 72
Request Body ... 72
Response Syntax ... 72
Response Elements ... 73
Errors ... 73
See Also ... 74
GetStudio ... 75
Request Syntax ... 75
URI Request Parameters ... 75
Request Body ... 75
Response Syntax ... 75
Response Elements ... 75
Errors ... 76
See Also ... 76
GetStudioComponent ... 78
Request Syntax ... 78
URI Request Parameters ... 78
Request Body ... 78
Response Syntax ... 78
Response Elements ... 79
Errors ... 79
See Also ... 80
GetStudioMember ... 81
Request Syntax ... 81
URI Request Parameters ... 81
Request Body ... 81
Response Syntax ... 81
Response Elements ... 81
Errors ... 82
See Also ... 82
ListEulaAcceptances ... 84
Request Syntax ... 84
URI Request Parameters ... 84
Request Body ... 84
Response Syntax ... 84
Response Elements ... 84
Errors ... 85
See Also ... 85
ListEulas ... 87
Request Syntax ... 87
URI Request Parameters ... 87
Request Body ... 87
Response Syntax ... 87
Response Elements ... 87
Errors ... 88
See Also ... 88
ListLaunchProfileMembers ... 90
Request Syntax ... 90
URI Request Parameters ... 90
Request Body ... 90
Response Syntax ... 90
Response Elements ... 91
Errors ... 91
See Also ... 92
ListLaunchProfiles ... 93
Request Syntax ... 93
URI Request Parameters ... 93
Request Body ... 93
Response Syntax ... 93
Response Elements ... 94
Errors ... 94
See Also ... 95
ListStreamingImages ... 96
Request Syntax ... 96
URI Request Parameters ... 96
Request Body ... 96
Response Syntax ... 96
Response Elements ... 97
Errors ... 97
See Also ... 98
ListStreamingSessions ... 99
Request Syntax ... 99
URI Request Parameters ... 99
Request Body ... 99
Response Syntax ... 99
Response Elements ... 100
Errors ... 100
See Also ... 101
ListStudioComponents ... 102
Request Syntax ... 102
URI Request Parameters ... 102
Request Body ... 102
Response Syntax ... 102
Response Elements ... 103
Errors ... 104
See Also ... 105
ListStudioMembers ... 106
Request Syntax ... 106
URI Request Parameters ... 106
Request Body ... 106
Response Syntax ... 106
Response Elements ... 106
Errors ... 107
See Also ... 108
ListStudios ... 109
Request Syntax ... 109
URI Request Parameters ... 109
Request Body ... 109
Response Syntax ... 109
Response Elements ... 110
Errors ... 110
See Also ... 111
ListTagsForResource ... 112
Request Syntax ... 112
URI Request Parameters ... 112
Request Body ... 112
Response Syntax ... 112
Response Elements ... 112
Errors ... 112
See Also ... 113
PutLaunchProfileMembers ... 114
Request Syntax ... 114
URI Request Parameters ... 114
Request Body ... 114
Response Syntax ... 115
Response Elements ... 115
Errors ... 115
See Also ... 116
PutStudioMembers ... 117
Request Syntax ... 117
URI Request Parameters ... 117
Request Body ... 117
Response Syntax ... 118
Response Elements ... 118
Errors ... 118
See Also ... 118
StartStreamingSession ... 120
Request Syntax ... 120
URI Request Parameters ... 120
Request Body ... 120
Response Syntax ... 120
Response Elements ... 121
Errors ... 121
See Also ... 122
StartStudioSSOConfigurationRepair ... 123
Request Syntax ... 123
URI Request Parameters ... 123
Request Body ... 123
Response Syntax ... 123
Response Elements ... 124
Errors ... 124
See Also ... 125
StopStreamingSession ... 126
Request Syntax ... 126
URI Request Parameters ... 126
Request Body ... 126
Response Syntax ... 126
Response Elements ... 127
Errors ... 127
See Also ... 128
TagResource ... 129
Request Syntax ... 129
URI Request Parameters ... 129
Request Body ... 129
Response Syntax ... 129
Response Elements ... 129
Errors ... 129
See Also ... 130
UntagResource ... 131
Request Syntax ... 131
URI Request Parameters ... 131
Request Body ... 131
Response Syntax ... 131
Response Elements ... 131
Errors ... 131
See Also ... 132
UpdateLaunchProfile ... 133
Request Syntax ... 133
URI Request Parameters ... 133
Request Body ... 133
Response Syntax ... 134
Response Elements ... 135
Errors ... 135
See Also ... 136
UpdateLaunchProfileMember ... 137
Request Syntax ... 137
URI Request Parameters ... 137
Request Body ... 137
Response Syntax ... 138
Response Elements ... 138
Errors ... 138
See Also ... 139
UpdateStreamingImage ... 140
Request Syntax ... 140
URI Request Parameters ... 140
Request Body ... 140
Response Syntax ... 141
Response Elements ... 141
Errors ... 141
See Also ... 142
UpdateStudio ... 143
Request Syntax ... 143
URI Request Parameters ... 143
Request Body ... 143
Response Syntax ... 144
Response Elements ... 144
Errors ... 144
See Also ... 145
UpdateStudioComponent ... 146
Request Syntax ... 146
URI Request Parameters ... 146
Request Body ... 147
Response Syntax ... 148
Response Elements ... 149
Errors ... 149
See Also ... 150
Data Types ... 151
ActiveDirectoryComputerAttribute ... 152
Contents ... 152
See Also ... 152
ActiveDirectoryConfiguration ... 153
Contents ... 153
See Also ... 153
ComputeFarmConfiguration ... 154
Contents ... 154
See Also ... 154
Eula ... 155
Contents ... 155
See Also ... 155
EulaAcceptance ... 157
Contents ... 157
See Also ... 157
LaunchProfile ... 159
Contents ... 159
See Also ... 161
LaunchProfileInitialization ... 162
Contents ... 162
See Also ... 163
LaunchProfileInitializationActiveDirectory ... 164
Contents ... 164
See Also ... 165
LaunchProfileInitializationScript ... 166
Contents ... 166
See Also ... 166
LaunchProfileMembership ... 167
Contents ... 167
See Also ... 167
LicenseServiceConfiguration ... 169
Contents ... 169
See Also ... 169
NewLaunchProfileMember ... 170
Contents ... 170
See Also ... 170
NewStudioMember ... 171
Contents ... 171
See Also ... 171
ScriptParameterKeyValue ... 172
Contents ... 172
See Also ... 172
SharedFileSystemConfiguration ... 173
Contents ... 173
See Also ... 173
StreamConfiguration ... 175
Contents ... 175
See Also ... 176
StreamConfigurationCreate ... 177
Contents ... 177
See Also ... 178
StreamConfigurationSessionStorage ... 179
Contents ... 179
See Also ... 179
StreamingImage ... 180
Contents ... 180
See Also ... 182
StreamingImageEncryptionConfiguration ... 183
Contents ... 183
See Also ... 183
StreamingSession ... 184
Contents ... 184
See Also ... 186
StreamingSessionStorageRoot ... 188
Contents ... 188
See Also ... 188
StreamingSessionStream ... 189
Contents ... 189
See Also ... 190
Studio ... 191
Contents ... 191
See Also ... 193
StudioComponent ... 194
Contents ... 194
See Also ... 196
StudioComponentConfiguration ... 198
Contents ... 198
See Also ... 198
StudioComponentInitializationScript ... 199
Contents ... 199
See Also ... 199
StudioComponentSummary ... 200
Contents ... 200
See Also ... 201
StudioEncryptionConfiguration ... 202
Contents ... 202
See Also ... 202
StudioMembership ... 203
Contents ... 203
See Also ... 203
ValidationResult ... 204
Contents ... 204
See Also ... 204
Common Parameters ... 206
Common Errors ... 208
Welcome
Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.
Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• AcceptEulas (p. 4)
• CreateLaunchProfile (p. 7)
• CreateStreamingImage (p. 12)
• CreateStreamingSession (p. 16)
• CreateStreamingSessionStream (p. 20)
• CreateStudio (p. 23)
• CreateStudioComponent (p. 27)
• DeleteLaunchProfile (p. 32)
• DeleteLaunchProfileMember (p. 35)
• DeleteStreamingImage (p. 37)
• DeleteStreamingSession (p. 40)
• DeleteStudio (p. 43)
• DeleteStudioComponent (p. 46)
• DeleteStudioMember (p. 49)
• GetEula (p. 51)
• GetLaunchProfile (p. 53)
• GetLaunchProfileDetails (p. 56)
• GetLaunchProfileInitialization (p. 60)
• GetLaunchProfileMember (p. 63)
• GetStreamingImage (p. 66)
• GetStreamingSession (p. 69)
• GetStreamingSessionStream (p. 72)
• GetStudio (p. 75)
• GetStudioComponent (p. 78)
• GetStudioMember (p. 81)
• ListEulaAcceptances (p. 84)
• ListEulas (p. 87)
• ListLaunchProfileMembers (p. 90)
• ListLaunchProfiles (p. 93)
• ListStreamingImages (p. 96)
• ListStreamingSessions (p. 99)
• ListStudioComponents (p. 102)
• ListStudioMembers (p. 106)
• ListStudios (p. 109)
• ListTagsForResource (p. 112)
• PutLaunchProfileMembers (p. 114)
• PutStudioMembers (p. 117)
• StartStreamingSession (p. 120)
• StartStudioSSOConfigurationRepair (p. 123)
• StopStreamingSession (p. 126)
• TagResource (p. 129)
• UntagResource (p. 131)
• UpdateLaunchProfile (p. 133)
• UpdateLaunchProfileMember (p. 137)
• UpdateStreamingImage (p. 140)
• UpdateStudio (p. 143)
• UpdateStudioComponent (p. 146)
AcceptEulas
AcceptEulas
Accept EULAs.
Request Syntax
POST /2020-08-01/studios/studioId/eula-acceptances HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "eulaIds": [ "string" ] }
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 4)
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 (p. 4)
A collection of EULA IDs.
Required: Yes
Request Body
The request accepts the following data in JSON format.
eulaIds (p. 4) The EULA ID.
Type: Array of strings Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"eulaAcceptances": [ {
"acceptedAt": number, "acceptedBy": "string", "accepteeId": "string",
Response Elements
"eulaAcceptanceId": "string", "eulaId": "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.
eulaAcceptances (p. 4)
A collection of EULA acceptances.
Type: Array of EulaAcceptance (p. 157) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
ValidationException
One of the parameters in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateLaunchProfile
CreateLaunchProfile
Create a launch profile.
Request Syntax
POST /2020-08-01/studios/studioId/launch-profiles HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json {
"description": "string", "ec2SubnetIds": [ "string" ],
"launchProfileProtocolVersions": [ "string" ], "name": "string",
"streamConfiguration": { "clipboardMode": "string",
"ec2InstanceTypes": [ "string" ], "maxSessionLengthInMinutes": number, "maxStoppedSessionLengthInMinutes": number, "sessionStorage": {
"mode": [ "string" ], "root": {
"linux": "string", "windows": "string"
} },
"streamingImageIds": [ "string" ] },
"studioComponentIds": [ "string" ], "tags": {
"string" : "string"
} }
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 7)
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 (p. 7)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Request Body
description (p. 7) The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No ec2SubnetIds (p. 7)
Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 6 items.
Required: Yes
launchProfileProtocolVersions (p. 7)
The version number of the protocol that is used by the launch profile. The only valid version is
"2021-03-31".
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: ^2021\-03\-31$
Required: Yes name (p. 7)
The name for the launch profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
streamConfiguration (p. 7)
A configuration for a streaming session.
Type: StreamConfigurationCreate (p. 177) object Required: Yes
studioComponentIds (p. 7)
Unique identifiers for a collection of studio components that can be used with this launch profile.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes tags (p. 7)
A collection of labels, in the form of key:value pairs, that apply to this resource.
Type: String to string map
Response Syntax
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "launchProfile": {
"arn": "string", "createdAt": number, "createdBy": "string", "description": "string", "ec2SubnetIds": [ "string" ], "launchProfileId": "string",
"launchProfileProtocolVersions": [ "string" ], "name": "string",
"state": "string", "statusCode": "string", "statusMessage": "string", "streamConfiguration": { "clipboardMode": "string",
"ec2InstanceTypes": [ "string" ], "maxSessionLengthInMinutes": number, "maxStoppedSessionLengthInMinutes": number, "sessionStorage": {
"mode": [ "string" ], "root": {
"linux": "string", "windows": "string"
} },
"streamingImageIds": [ "string" ] },
"studioComponentIds": [ "string" ], "tags": {
"string" : "string"
},
"updatedAt": number, "updatedBy": "string", "validationResults": [ {
"state": "string", "statusCode": "string", "statusMessage": "string", "type": "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.
launchProfile (p. 9) The launch profile.
Errors
Type: LaunchProfile (p. 159) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateStreamingImage
CreateStreamingImage
Creates a streaming image resource in a studio.
Request Syntax
POST /2020-08-01/studios/studioId/streaming-images HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "description": "string", "ec2ImageId": "string", "name": "string", "tags": {
"string" : "string"
} }
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 12)
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 (p. 12)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
description (p. 12)
A human-readable description of the streaming image.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No ec2ImageId (p. 12)
The ID of an EC2 machine image with which to create this streaming image.
Type: String
Response Syntax
Pattern: ^ami-[0-9A-z]+$
Required: Yes name (p. 12)
A friendly name for a streaming image resource.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: Yes tags (p. 12)
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 { "streamingImage": {
"arn": "string",
"description": "string", "ec2ImageId": "string", "encryptionConfiguration": { "keyArn": "string",
"keyType": "string"
},
"eulaIds": [ "string" ], "name": "string",
"owner": "string", "platform": "string", "state": "string", "statusCode": "string", "statusMessage": "string", "streamingImageId": "string", "tags": {
"string" : "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.
streamingImage (p. 13) The streaming image.
Type: StreamingImage (p. 180) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateStreamingSession
CreateStreamingSession
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.
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 (p. 16)
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 (p. 16) The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
ec2InstanceType (p. 16)
The EC2 Instance type used for the streaming session.
Type: String
Valid Values: g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge
Required: No launchProfileId (p. 16)
The launch profile ID.
Response Syntax
Type: String Required: No ownedBy (p. 16)
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 (p. 16)
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 (p. 16)
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", "createdAt": number, "createdBy": "string", "ec2InstanceType": "string", "launchProfileId": "string", "ownedBy": "string",
"sessionId": "string", "startedAt": number, "startedBy": "string", "state": "string", "statusCode": "string", "statusMessage": "string", "stopAt": number,
"stoppedAt": number, "stoppedBy": "string", "streamingImageId": "string", "tags": {
"string" : "string"
},
"terminateAt": number, "updatedAt": number, "updatedBy": "string"
}
Response Elements
}
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 (p. 17) The session.
Type: StreamingSession (p. 184) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateStreamingSessionStream
CreateStreamingSessionStream
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.
Request Syntax
POST /2020-08-01/studios/studioId/streaming-sessions/sessionId/streams HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "expirationInSeconds": number }
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 20)
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 (p. 20)
The streaming session ID.
Required: Yes studioId (p. 20)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
expirationInSeconds (p. 20) The expiration time in seconds.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 3600.
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "stream": {
"createdAt": number, "createdBy": "string", "expiresAt": number, "ownedBy": "string", "state": "string", "statusCode": "string", "streamId": "string", "url": "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.
stream (p. 20) The stream.
Type: StreamingSessionStream (p. 189) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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.
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateStudio
CreateStudio
Create a new Studio.
When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration.
In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
Request Syntax
POST /2020-08-01/studios HTTP/1.1 X-Amz-Client-Token: clientToken Content-type: application/json { "adminRoleArn": "string", "displayName": "string",
"studioEncryptionConfiguration": { "keyArn": "string",
"keyType": "string"
},
"studioName": "string", "tags": {
"string" : "string"
},
"userRoleArn": "string"
}
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 23)
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.
Request Body
Request Body
The request accepts the following data in JSON format.
adminRoleArn (p. 23)
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
Type: String Required: Yes displayName (p. 23)
A friendly name for the studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: Yes
studioEncryptionConfiguration (p. 23) The studio encryption configuration.
Type: StudioEncryptionConfiguration (p. 202) object Required: No
studioName (p. 23)
The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern: ^[a-z0-9]*$
Required: Yes tags (p. 23)
A collection of labels, in the form of key:value pairs, that apply to this resource.
Type: String to string map Required: No
userRoleArn (p. 23)
The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
Type: String Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "studio": {
"adminRoleArn": "string", "arn": "string",
"createdAt": number, "displayName": "string", "homeRegion": "string", "ssoClientId": "string", "state": "string", "statusCode": "string", "statusMessage": "string",
"studioEncryptionConfiguration": { "keyArn": "string",
"keyType": "string"
},
"studioId": "string", "studioName": "string", "studioUrl": "string", "tags": {
"string" : "string"
},
"updatedAt": number, "userRoleArn": "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.
studio (p. 24)
Information about a studio.
Type: Studio (p. 191) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateStudioComponent
CreateStudioComponent
Creates a studio component resource.
Request Syntax
POST /2020-08-01/studios/studioId/studio-components HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "configuration": {
"activeDirectoryConfiguration": { "computerAttributes": [
{
"name": "string", "value": "string"
} ],
"directoryId": "string",
"organizationalUnitDistinguishedName": "string"
},
"computeFarmConfiguration": { "activeDirectoryUser": "string", "endpoint": "string"
},
"licenseServiceConfiguration": { "endpoint": "string"
},
"sharedFileSystemConfiguration": { "endpoint": "string",
"fileSystemId": "string", "linuxMountPoint": "string", "shareName": "string",
"windowsMountDrive": "string"
} },
"description": "string",
"ec2SecurityGroupIds": [ "string" ], "initializationScripts": [
{
"launchProfileProtocolVersion": "string", "platform": "string",
"runContext": "string", "script": "string"
} ],
"name": "string", "scriptParameters": [ {
"key": "string", "value": "string"
} ],
"subtype": "string", "tags": {
"string" : "string"
},
"type": "string"
}
URI Request Parameters
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 27)
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 (p. 27) The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
configuration (p. 27)
The configuration of the studio component, based on component type.
Type: StudioComponentConfiguration (p. 198) object Required: No
description (p. 27) The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
ec2SecurityGroupIds (p. 27)
The EC2 security groups that control access to the studio component.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Required: No
initializationScripts (p. 27)
Initialization scripts for studio components.
Type: Array of StudioComponentInitializationScript (p. 199) objects Required: No
name (p. 27)
The name for the studio component.
Type: String
Response Syntax
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: Yes scriptParameters (p. 27)
Parameters for the studio component scripts.
Type: Array of ScriptParameterKeyValue (p. 172) objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Required: No subtype (p. 27)
The specific subtype of a studio component.
Type: String
Valid Values: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM
Required: No tags (p. 27)
A collection of labels, in the form of key:value pairs, that apply to this resource.
Type: String to string map Required: No
type (p. 27)
The type of the studio component.
Type: String
Valid Values: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"studioComponent": { "arn": "string", "configuration": {
"activeDirectoryConfiguration": { "computerAttributes": [ {
"name": "string", "value": "string"
} ],
"directoryId": "string",
"organizationalUnitDistinguishedName": "string"
},
"computeFarmConfiguration": { "activeDirectoryUser": "string",
Response Elements
"endpoint": "string"
},
"licenseServiceConfiguration": { "endpoint": "string"
},
"sharedFileSystemConfiguration": { "endpoint": "string",
"fileSystemId": "string", "linuxMountPoint": "string", "shareName": "string",
"windowsMountDrive": "string"
} },
"createdAt": number, "createdBy": "string", "description": "string",
"ec2SecurityGroupIds": [ "string" ], "initializationScripts": [
{
"launchProfileProtocolVersion": "string", "platform": "string",
"runContext": "string", "script": "string"
} ],
"name": "string", "scriptParameters": [ {
"key": "string", "value": "string"
} ],
"state": "string", "statusCode": "string", "statusMessage": "string", "studioComponentId": "string", "subtype": "string",
"tags": {
"string" : "string"
},
"type": "string", "updatedAt": number, "updatedBy": "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.
studioComponent (p. 29)
Information about the studio component.
Type: StudioComponent (p. 194) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteLaunchProfile
DeleteLaunchProfile
Permanently delete a launch profile.
Request Syntax
DELETE /2020-08-01/studios/studioId/launch-profiles/launchProfileId HTTP/1.1 X-Amz-Client-Token: clientToken
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 32)
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.
launchProfileId (p. 32) The Launch Profile ID.
Required: Yes studioId (p. 32)
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "launchProfile": {
"arn": "string", "createdAt": number, "createdBy": "string", "description": "string", "ec2SubnetIds": [ "string" ], "launchProfileId": "string",
"launchProfileProtocolVersions": [ "string" ], "name": "string",
"state": "string", "statusCode": "string", "statusMessage": "string", "streamConfiguration": {
Response Elements
"clipboardMode": "string",
"ec2InstanceTypes": [ "string" ], "maxSessionLengthInMinutes": number, "maxStoppedSessionLengthInMinutes": number, "sessionStorage": {
"mode": [ "string" ], "root": {
"linux": "string", "windows": "string"
} },
"streamingImageIds": [ "string" ] },
"studioComponentIds": [ "string" ], "tags": {
"string" : "string"
},
"updatedAt": number, "updatedBy": "string", "validationResults": [ {
"state": "string", "statusCode": "string", "statusMessage": "string", "type": "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.
launchProfile (p. 32) The launch profile.
Type: LaunchProfile (p. 159) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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.
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteLaunchProfileMember
DeleteLaunchProfileMember
Delete a user from launch profile membership.
Request Syntax
DELETE /2020-08-01/studios/studioId/launch-profiles/launchProfileId/membership/principalId HTTP/1.1
X-Amz-Client-Token: clientToken
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 35)
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.
launchProfileId (p. 35) The Launch Profile ID.
Required: Yes principalId (p. 35)
The principal ID. This currently supports a AWS SSO UserId.
Required: Yes studioId (p. 35)
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteStreamingImage
DeleteStreamingImage
Delete streaming image.
Request Syntax
DELETE /2020-08-01/studios/studioId/streaming-images/streamingImageId HTTP/1.1 X-Amz-Client-Token: clientToken
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 37)
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.
streamingImageId (p. 37) The streaming image ID.
Required: Yes studioId (p. 37)
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "streamingImage": {
"arn": "string",
"description": "string", "ec2ImageId": "string", "encryptionConfiguration": { "keyArn": "string",
"keyType": "string"
},
"eulaIds": [ "string" ], "name": "string",
"owner": "string", "platform": "string", "state": "string", "statusCode": "string",
Response Elements
"statusMessage": "string", "streamingImageId": "string", "tags": {
"string" : "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.
streamingImage (p. 37) The streaming image.
Type: StreamingImage (p. 180) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
ValidationException
One of the parameters in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteStreamingSession
DeleteStreamingSession
Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked DELETED.
Request Syntax
DELETE /2020-08-01/studios/studioId/streaming-sessions/sessionId HTTP/1.1 X-Amz-Client-Token: clientToken
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 40)
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 (p. 40)
The streaming session ID.
Required: Yes studioId (p. 40)
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "session": {
"arn": "string", "createdAt": number, "createdBy": "string", "ec2InstanceType": "string", "launchProfileId": "string", "ownedBy": "string",
"sessionId": "string", "startedAt": number,
Response Elements
"startedBy": "string", "state": "string", "statusCode": "string", "statusMessage": "string", "stopAt": number,
"stoppedAt": number, "stoppedBy": "string", "streamingImageId": "string", "tags": {
"string" : "string"
},
"terminateAt": number, "updatedAt": number, "updatedBy": "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 (p. 40) The session.
Type: StreamingSession (p. 184) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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.
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
