1{ 2 "version": "2.0", 3 "service": "<p>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.</p> <p>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.</p>", 4 "operations": { 5 "AcceptEulas": "<p>Accept EULAs.</p>", 6 "CreateLaunchProfile": "<p>Create a launch profile.</p>", 7 "CreateStreamingImage": "<p>Creates a streaming image resource in a studio.</p>", 8 "CreateStreamingSession": "<p>Creates a streaming session in a studio.</p> <p>After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.</p>", 9 "CreateStreamingSessionStream": "<p>Creates a streaming session stream for a streaming session.</p> <p>After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.</p>", 10 "CreateStudio": "<p>Create a new Studio.</p> <p>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.</p> <p>The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.</p> <p>The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.</p> <p>You may optionally specify a KMS key in the StudioEncryptionConfiguration.</p> <p>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.</p> <p>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.</p> <p>If you delete this grant, the studio will no longer be accessible to your portal users.</p> <p>If you delete the studio KMS key, your studio will no longer be accessible.</p>", 11 "CreateStudioComponent": "<p>Creates a studio component resource.</p>", 12 "DeleteLaunchProfile": "<p>Permanently delete a launch profile.</p>", 13 "DeleteLaunchProfileMember": "<p>Delete a user from launch profile membership.</p>", 14 "DeleteStreamingImage": "<p>Delete streaming image.</p>", 15 "DeleteStreamingSession": "<p>Deletes streaming session resource.</p> <p>After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.</p> <p>A streaming session will count against your streaming session quota until it is marked DELETED.</p>", 16 "DeleteStudio": "<p>Delete a studio resource.</p>", 17 "DeleteStudioComponent": "<p>Deletes a studio component resource.</p>", 18 "DeleteStudioMember": "<p>Delete a user from studio membership.</p>", 19 "GetEula": "<p>Get Eula.</p>", 20 "GetLaunchProfile": "<p>Get a launch profile.</p>", 21 "GetLaunchProfileDetails": "<p>Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.</p>", 22 "GetLaunchProfileInitialization": "<p>Get a launch profile initialization.</p>", 23 "GetLaunchProfileMember": "<p>Get a user persona in launch profile membership.</p>", 24 "GetStreamingImage": "<p>Get streaming image.</p>", 25 "GetStreamingSession": "<p>Gets StreamingSession resource.</p> <p>anvoke this operation to poll for a streaming session state while creating or deleting a session.</p>", 26 "GetStreamingSessionStream": "<p>Gets a StreamingSessionStream for a streaming session.</p> <p>Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.</p> <p>After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.</p>", 27 "GetStudio": "<p>Get a Studio resource.</p>", 28 "GetStudioComponent": "<p>Gets a studio component resource.</p>", 29 "GetStudioMember": "<p>Get a user's membership in a studio.</p>", 30 "ListEulaAcceptances": "<p>List Eula Acceptances.</p>", 31 "ListEulas": "<p>List Eulas.</p>", 32 "ListLaunchProfileMembers": "<p>Get all users in a given launch profile membership.</p>", 33 "ListLaunchProfiles": "<p>List all the launch profiles a studio.</p>", 34 "ListStreamingImages": "<p>List the streaming image resources available to this studio.</p> <p>This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.</p>", 35 "ListStreamingSessions": "<p>Lists the streaming image resources in a studio.</p>", 36 "ListStudioComponents": "<p>Lists the StudioComponents in a studio.</p>", 37 "ListStudioMembers": "<p>Get all users in a given studio membership.</p>", 38 "ListStudios": "<p>List studios in your Amazon Web Services account in the requested Amazon Web Services Region.</p>", 39 "ListTagsForResource": "<p>Gets the tags for a resource, given its Amazon Resource Names (ARN).</p> <p>This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.</p>", 40 "PutLaunchProfileMembers": "<p>Add/update users with given persona to launch profile membership.</p>", 41 "PutStudioMembers": "<p>Add/update users with given persona to studio membership.</p>", 42 "StartStreamingSession": "<p> 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.</p>", 43 "StartStudioSSOConfigurationRepair": "<p>Repairs the Amazon Web Services SSO configuration for a given studio.</p> <p>If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error.</p> <p>If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state.</p> <p>After the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.</p>", 44 "StopStreamingSession": "<p>Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.</p>", 45 "TagResource": "<p>Creates tags for a resource, given its ARN.</p>", 46 "UntagResource": "<p>Deletes the tags for a resource.</p>", 47 "UpdateLaunchProfile": "<p>Update a launch profile.</p>", 48 "UpdateLaunchProfileMember": "<p>Update a user persona in launch profile membership.</p>", 49 "UpdateStreamingImage": "<p>Update streaming image.</p>", 50 "UpdateStudio": "<p>Update a Studio resource.</p> <p>Currently, this operation only supports updating the displayName of your studio.</p>", 51 "UpdateStudioComponent": "<p>Updates a studio component resource.</p>" 52 }, 53 "shapes": { 54 "AcceptEulasRequest": { 55 "base": "<zonbook></zonbook><xhtml></xhtml>", 56 "refs": { 57 } 58 }, 59 "AcceptEulasResponse": { 60 "base": "<zonbook></zonbook><xhtml></xhtml>", 61 "refs": { 62 } 63 }, 64 "AccessDeniedException": { 65 "base": "<p>You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.</p>", 66 "refs": { 67 } 68 }, 69 "ActiveDirectoryComputerAttribute": { 70 "base": "<p>An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.</p>", 71 "refs": { 72 "ActiveDirectoryComputerAttributeList$member": null 73 } 74 }, 75 "ActiveDirectoryComputerAttributeList": { 76 "base": "<p>A collection of LDAP attributes to apply to Active Directory computer accounts that are created for streaming sessions.</p>", 77 "refs": { 78 "ActiveDirectoryConfiguration$computerAttributes": "<p>A collection of custom attributes for an Active Directory computer.</p>", 79 "LaunchProfileInitializationActiveDirectory$computerAttributes": "<p>A collection of custom attributes for an Active Directory computer.</p>" 80 } 81 }, 82 "ActiveDirectoryComputerAttributeName": { 83 "base": "<p>The name for the LDAP attribute.</p>", 84 "refs": { 85 "ActiveDirectoryComputerAttribute$name": "<p>The name for the LDAP attribute.</p>" 86 } 87 }, 88 "ActiveDirectoryComputerAttributeValue": { 89 "base": "<p>The value for the LDAP attribute.</p>", 90 "refs": { 91 "ActiveDirectoryComputerAttribute$value": "<p>The value for the LDAP attribute.</p>" 92 } 93 }, 94 "ActiveDirectoryConfiguration": { 95 "base": "<p>The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.</p>", 96 "refs": { 97 "StudioComponentConfiguration$activeDirectoryConfiguration": "<p>The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.</p>" 98 } 99 }, 100 "ActiveDirectoryDnsIpAddress": { 101 "base": "<zonbook></zonbook><xhtml></xhtml>", 102 "refs": { 103 "ActiveDirectoryDnsIpAddressList$member": null 104 } 105 }, 106 "ActiveDirectoryDnsIpAddressList": { 107 "base": "<zonbook></zonbook><xhtml></xhtml>", 108 "refs": { 109 "LaunchProfileInitializationActiveDirectory$dnsIpAddresses": "<p>The DNS IP address.</p>" 110 } 111 }, 112 "ActiveDirectoryOrganizationalUnitDistinguishedName": { 113 "base": "<p>The fully-qualified distinguished name of the organizational unit to place the computer account in.</p>", 114 "refs": { 115 "ActiveDirectoryConfiguration$organizationalUnitDistinguishedName": "<p>The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.</p>", 116 "LaunchProfileInitializationActiveDirectory$organizationalUnitDistinguishedName": "<p>The name for the organizational unit distinguished name.</p>" 117 } 118 }, 119 "ClientToken": { 120 "base": null, 121 "refs": { 122 "AcceptEulasRequest$clientToken": "<p>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.</p>", 123 "CreateLaunchProfileRequest$clientToken": "<p>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.</p>", 124 "CreateStreamingImageRequest$clientToken": "<p>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.</p>", 125 "CreateStreamingSessionRequest$clientToken": "<p>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.</p>", 126 "CreateStreamingSessionStreamRequest$clientToken": "<p>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.</p>", 127 "CreateStudioComponentRequest$clientToken": "<p>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.</p>", 128 "CreateStudioRequest$clientToken": "<p>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.</p>", 129 "DeleteLaunchProfileMemberRequest$clientToken": "<p>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.</p>", 130 "DeleteLaunchProfileRequest$clientToken": "<p>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.</p>", 131 "DeleteStreamingImageRequest$clientToken": "<p>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.</p>", 132 "DeleteStreamingSessionRequest$clientToken": "<p>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.</p>", 133 "DeleteStudioComponentRequest$clientToken": "<p>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.</p>", 134 "DeleteStudioMemberRequest$clientToken": "<p>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.</p>", 135 "DeleteStudioRequest$clientToken": "<p>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.</p>", 136 "PutLaunchProfileMembersRequest$clientToken": "<p>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.</p>", 137 "PutStudioMembersRequest$clientToken": "<p>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.</p>", 138 "StartStreamingSessionRequest$clientToken": "<p>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.</p>", 139 "StartStudioSSOConfigurationRepairRequest$clientToken": "<p>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.</p>", 140 "StopStreamingSessionRequest$clientToken": "<p>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.</p>", 141 "UpdateLaunchProfileMemberRequest$clientToken": "<p>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.</p>", 142 "UpdateLaunchProfileRequest$clientToken": "<p>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.</p>", 143 "UpdateStreamingImageRequest$clientToken": "<p>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.</p>", 144 "UpdateStudioComponentRequest$clientToken": "<p>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.</p>", 145 "UpdateStudioRequest$clientToken": "<p>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.</p>" 146 } 147 }, 148 "ComputeFarmConfiguration": { 149 "base": "<p>The configuration for a render farm that is associated with a studio resource.</p>", 150 "refs": { 151 "StudioComponentConfiguration$computeFarmConfiguration": "<p>The configuration for a render farm that is associated with a studio resource.</p>" 152 } 153 }, 154 "ConflictException": { 155 "base": "<p>Another operation is in progress. </p>", 156 "refs": { 157 } 158 }, 159 "CreateLaunchProfileRequest": { 160 "base": "<zonbook></zonbook><xhtml></xhtml>", 161 "refs": { 162 } 163 }, 164 "CreateLaunchProfileResponse": { 165 "base": "<zonbook></zonbook><xhtml></xhtml>", 166 "refs": { 167 } 168 }, 169 "CreateStreamingImageRequest": { 170 "base": "<zonbook></zonbook><xhtml></xhtml>", 171 "refs": { 172 } 173 }, 174 "CreateStreamingImageResponse": { 175 "base": "<zonbook></zonbook><xhtml></xhtml>", 176 "refs": { 177 } 178 }, 179 "CreateStreamingSessionRequest": { 180 "base": "<zonbook></zonbook><xhtml></xhtml>", 181 "refs": { 182 } 183 }, 184 "CreateStreamingSessionResponse": { 185 "base": "<zonbook></zonbook><xhtml></xhtml>", 186 "refs": { 187 } 188 }, 189 "CreateStreamingSessionStreamRequest": { 190 "base": "<zonbook></zonbook><xhtml></xhtml>", 191 "refs": { 192 } 193 }, 194 "CreateStreamingSessionStreamResponse": { 195 "base": "<zonbook></zonbook><xhtml></xhtml>", 196 "refs": { 197 } 198 }, 199 "CreateStudioComponentRequest": { 200 "base": "<zonbook></zonbook><xhtml></xhtml>", 201 "refs": { 202 } 203 }, 204 "CreateStudioComponentResponse": { 205 "base": "<p/>", 206 "refs": { 207 } 208 }, 209 "CreateStudioRequest": { 210 "base": "<zonbook></zonbook><xhtml></xhtml>", 211 "refs": { 212 } 213 }, 214 "CreateStudioResponse": { 215 "base": "<zonbook></zonbook><xhtml></xhtml>", 216 "refs": { 217 } 218 }, 219 "DeleteLaunchProfileMemberRequest": { 220 "base": null, 221 "refs": { 222 } 223 }, 224 "DeleteLaunchProfileMemberResponse": { 225 "base": "<zonbook></zonbook><xhtml></xhtml>", 226 "refs": { 227 } 228 }, 229 "DeleteLaunchProfileRequest": { 230 "base": null, 231 "refs": { 232 } 233 }, 234 "DeleteLaunchProfileResponse": { 235 "base": "<zonbook></zonbook><xhtml></xhtml>", 236 "refs": { 237 } 238 }, 239 "DeleteStreamingImageRequest": { 240 "base": null, 241 "refs": { 242 } 243 }, 244 "DeleteStreamingImageResponse": { 245 "base": "<zonbook></zonbook><xhtml></xhtml>", 246 "refs": { 247 } 248 }, 249 "DeleteStreamingSessionRequest": { 250 "base": null, 251 "refs": { 252 } 253 }, 254 "DeleteStreamingSessionResponse": { 255 "base": "<zonbook></zonbook><xhtml></xhtml>", 256 "refs": { 257 } 258 }, 259 "DeleteStudioComponentRequest": { 260 "base": null, 261 "refs": { 262 } 263 }, 264 "DeleteStudioComponentResponse": { 265 "base": "<zonbook></zonbook><xhtml></xhtml>", 266 "refs": { 267 } 268 }, 269 "DeleteStudioMemberRequest": { 270 "base": null, 271 "refs": { 272 } 273 }, 274 "DeleteStudioMemberResponse": { 275 "base": "<zonbook></zonbook><xhtml></xhtml>", 276 "refs": { 277 } 278 }, 279 "DeleteStudioRequest": { 280 "base": null, 281 "refs": { 282 } 283 }, 284 "DeleteStudioResponse": { 285 "base": "<zonbook></zonbook><xhtml></xhtml>", 286 "refs": { 287 } 288 }, 289 "DirectoryId": { 290 "base": "<zonbook></zonbook><xhtml></xhtml>", 291 "refs": { 292 "ActiveDirectoryConfiguration$directoryId": "<p>The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.</p>", 293 "LaunchProfileInitializationActiveDirectory$directoryId": "<p>The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.</p>" 294 } 295 }, 296 "EC2ImageId": { 297 "base": "<zonbook></zonbook><xhtml></xhtml>", 298 "refs": { 299 "CreateStreamingImageRequest$ec2ImageId": "<p>The ID of an EC2 machine image with which to create this streaming image.</p>", 300 "StreamingImage$ec2ImageId": "<p>The ID of an EC2 machine image with which to create the streaming image.</p>" 301 } 302 }, 303 "EC2SubnetId": { 304 "base": "<zonbook></zonbook><xhtml></xhtml>", 305 "refs": { 306 "EC2SubnetIdList$member": null 307 } 308 }, 309 "EC2SubnetIdList": { 310 "base": "<zonbook></zonbook><xhtml></xhtml>", 311 "refs": { 312 "CreateLaunchProfileRequest$ec2SubnetIds": "<p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types. </p>", 313 "LaunchProfile$ec2SubnetIds": "<p>Unique identifiers for a collection of EC2 subnets.</p>" 314 } 315 }, 316 "Eula": { 317 "base": "<p>Represents a EULA resource.</p>", 318 "refs": { 319 "EulaList$member": null, 320 "GetEulaResponse$eula": "<p>The EULA.</p>" 321 } 322 }, 323 "EulaAcceptance": { 324 "base": "<p>The acceptance of a EULA, required to use Amazon-provided streaming images.</p>", 325 "refs": { 326 "EulaAcceptanceList$member": null 327 } 328 }, 329 "EulaAcceptanceId": { 330 "base": "<p>The EULA acceptance ID.</p>", 331 "refs": { 332 "EulaAcceptance$eulaAcceptanceId": "<p>The EULA acceptance ID.</p>" 333 } 334 }, 335 "EulaAcceptanceList": { 336 "base": "<zonbook></zonbook><xhtml></xhtml>", 337 "refs": { 338 "AcceptEulasResponse$eulaAcceptances": "<p>A collection of EULA acceptances.</p>", 339 "ListEulaAcceptancesResponse$eulaAcceptances": "<p>A collection of EULA acceptances.</p>" 340 } 341 }, 342 "EulaId": { 343 "base": "<p>Represents a EULA resource.</p>", 344 "refs": { 345 "Eula$eulaId": "<p>The EULA ID.</p>", 346 "EulaAcceptance$eulaId": "<p>The EULA ID.</p>" 347 } 348 }, 349 "EulaIdList": { 350 "base": "<zonbook></zonbook><xhtml></xhtml>", 351 "refs": { 352 "AcceptEulasRequest$eulaIds": "<p>The EULA ID.</p>", 353 "StreamingImage$eulaIds": "<p>The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.</p>" 354 } 355 }, 356 "EulaList": { 357 "base": "<zonbook></zonbook><xhtml></xhtml>", 358 "refs": { 359 "ListEulasResponse$eulas": "<p>A collection of EULA resources.</p>" 360 } 361 }, 362 "EulaName": { 363 "base": "<zonbook></zonbook><xhtml></xhtml>", 364 "refs": { 365 "Eula$name": "<p>The name for the EULA.</p>" 366 } 367 }, 368 "ExceptionContext": { 369 "base": "<p>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.</p> <p>ExceptionContext enables scripts and other programmatic clients to provide for better error handling.</p>", 370 "refs": { 371 "AccessDeniedException$context": "<p>The exception context.</p>", 372 "ConflictException$context": "<p>The exception context.</p>", 373 "InternalServerErrorException$context": "<p>The exception context.</p>", 374 "ResourceNotFoundException$context": "<p>The exception context.</p>", 375 "ServiceQuotaExceededException$context": "<p>The exception context.</p>", 376 "ThrottlingException$context": "<p>The exception context.</p>", 377 "ValidationException$context": "<p>The exception context.</p>" 378 } 379 }, 380 "GetEulaRequest": { 381 "base": null, 382 "refs": { 383 } 384 }, 385 "GetEulaResponse": { 386 "base": "<zonbook></zonbook><xhtml></xhtml>", 387 "refs": { 388 } 389 }, 390 "GetLaunchProfileDetailsRequest": { 391 "base": null, 392 "refs": { 393 } 394 }, 395 "GetLaunchProfileDetailsResponse": { 396 "base": "<zonbook></zonbook><xhtml></xhtml>", 397 "refs": { 398 } 399 }, 400 "GetLaunchProfileInitializationRequest": { 401 "base": null, 402 "refs": { 403 } 404 }, 405 "GetLaunchProfileInitializationResponse": { 406 "base": "<zonbook></zonbook><xhtml></xhtml>", 407 "refs": { 408 } 409 }, 410 "GetLaunchProfileMemberRequest": { 411 "base": null, 412 "refs": { 413 } 414 }, 415 "GetLaunchProfileMemberResponse": { 416 "base": "<zonbook></zonbook><xhtml></xhtml>", 417 "refs": { 418 } 419 }, 420 "GetLaunchProfileRequest": { 421 "base": null, 422 "refs": { 423 } 424 }, 425 "GetLaunchProfileResponse": { 426 "base": "<zonbook></zonbook><xhtml></xhtml>", 427 "refs": { 428 } 429 }, 430 "GetStreamingImageRequest": { 431 "base": null, 432 "refs": { 433 } 434 }, 435 "GetStreamingImageResponse": { 436 "base": "<zonbook></zonbook><xhtml></xhtml>", 437 "refs": { 438 } 439 }, 440 "GetStreamingSessionRequest": { 441 "base": null, 442 "refs": { 443 } 444 }, 445 "GetStreamingSessionResponse": { 446 "base": "<zonbook></zonbook><xhtml></xhtml>", 447 "refs": { 448 } 449 }, 450 "GetStreamingSessionStreamRequest": { 451 "base": null, 452 "refs": { 453 } 454 }, 455 "GetStreamingSessionStreamResponse": { 456 "base": "<zonbook></zonbook><xhtml></xhtml>", 457 "refs": { 458 } 459 }, 460 "GetStudioComponentRequest": { 461 "base": null, 462 "refs": { 463 } 464 }, 465 "GetStudioComponentResponse": { 466 "base": "<zonbook></zonbook><xhtml></xhtml>", 467 "refs": { 468 } 469 }, 470 "GetStudioMemberRequest": { 471 "base": null, 472 "refs": { 473 } 474 }, 475 "GetStudioMemberResponse": { 476 "base": "<zonbook></zonbook><xhtml></xhtml>", 477 "refs": { 478 } 479 }, 480 "GetStudioRequest": { 481 "base": null, 482 "refs": { 483 } 484 }, 485 "GetStudioResponse": { 486 "base": "<zonbook></zonbook><xhtml></xhtml>", 487 "refs": { 488 } 489 }, 490 "InternalServerErrorException": { 491 "base": "<p>An internal error has occurred. Please retry your request.</p>", 492 "refs": { 493 } 494 }, 495 "LaunchProfile": { 496 "base": "<p>A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs). </p> <pre><code> <p>Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.</p> </code></pre>", 497 "refs": { 498 "CreateLaunchProfileResponse$launchProfile": "<p>The launch profile.</p>", 499 "DeleteLaunchProfileResponse$launchProfile": "<p>The launch profile.</p>", 500 "GetLaunchProfileDetailsResponse$launchProfile": "<p>The launch profile.</p>", 501 "GetLaunchProfileResponse$launchProfile": "<p>The launch profile.</p>", 502 "LaunchProfileList$member": null, 503 "UpdateLaunchProfileResponse$launchProfile": "<p>The launch profile.</p>" 504 } 505 }, 506 "LaunchProfileDescription": { 507 "base": "<p>A human-readable description of the launch profile.</p>", 508 "refs": { 509 "CreateLaunchProfileRequest$description": "<p>The description.</p>", 510 "LaunchProfile$description": "<p>A human-readable description of the launch profile.</p>", 511 "UpdateLaunchProfileRequest$description": "<p>The description.</p>" 512 } 513 }, 514 "LaunchProfileId": { 515 "base": "<zonbook></zonbook><xhtml></xhtml>", 516 "refs": { 517 "LaunchProfile$launchProfileId": "<p>The launch profile ID.</p>", 518 "LaunchProfileInitialization$launchProfileId": "<p>The launch profile ID.</p>" 519 } 520 }, 521 "LaunchProfileInitialization": { 522 "base": "<p>A Launch Profile Initialization contains information required for a workstation or server to connect to a launch profile</p> <p>This includes scripts, endpoints, security groups, subnets, and other configuration.</p>", 523 "refs": { 524 "GetLaunchProfileInitializationResponse$launchProfileInitialization": "<p>The launch profile initialization.</p>" 525 } 526 }, 527 "LaunchProfileInitializationActiveDirectory": { 528 "base": "<p/>", 529 "refs": { 530 "LaunchProfileInitialization$activeDirectory": "<p>A LaunchProfileInitializationActiveDirectory resource.</p>" 531 } 532 }, 533 "LaunchProfileInitializationScript": { 534 "base": "<p/>", 535 "refs": { 536 "LaunchProfileInitializationScriptList$member": null 537 } 538 }, 539 "LaunchProfileInitializationScriptList": { 540 "base": "<zonbook></zonbook><xhtml></xhtml>", 541 "refs": { 542 "LaunchProfileInitialization$systemInitializationScripts": "<p>The system initializtion scripts.</p>", 543 "LaunchProfileInitialization$userInitializationScripts": "<p>The user initializtion scripts.</p>" 544 } 545 }, 546 "LaunchProfileList": { 547 "base": "<zonbook></zonbook><xhtml></xhtml>", 548 "refs": { 549 "ListLaunchProfilesResponse$launchProfiles": "<p>A collection of launch profiles.</p>" 550 } 551 }, 552 "LaunchProfileMembership": { 553 "base": "<p/>", 554 "refs": { 555 "GetLaunchProfileMemberResponse$member": "<p>The member.</p>", 556 "LaunchProfileMembershipList$member": null, 557 "UpdateLaunchProfileMemberResponse$member": "<p>The updated member. </p>" 558 } 559 }, 560 "LaunchProfileMembershipList": { 561 "base": "<p/>", 562 "refs": { 563 "ListLaunchProfileMembersResponse$members": "<p>A list of members.</p>" 564 } 565 }, 566 "LaunchProfileName": { 567 "base": "<zonbook></zonbook><xhtml></xhtml>", 568 "refs": { 569 "CreateLaunchProfileRequest$name": "<p>The name for the launch profile.</p>", 570 "LaunchProfile$name": "<p>A friendly name for the launch profile.</p>", 571 "LaunchProfileInitialization$name": "<p>The name for the launch profile.</p>", 572 "UpdateLaunchProfileRequest$name": "<p>The name for the launch profile.</p>" 573 } 574 }, 575 "LaunchProfilePersona": { 576 "base": "<zonbook></zonbook><xhtml></xhtml>", 577 "refs": { 578 "LaunchProfileMembership$persona": "<p>The persona.</p>", 579 "NewLaunchProfileMember$persona": "<p>The persona.</p>", 580 "UpdateLaunchProfileMemberRequest$persona": "<p>The persona.</p>" 581 } 582 }, 583 "LaunchProfilePlatform": { 584 "base": "<zonbook></zonbook><xhtml></xhtml>", 585 "refs": { 586 "LaunchProfileInitialization$platform": "<p>The platform of the launch platform, either WINDOWS or LINUX.</p>", 587 "StudioComponentInitializationScript$platform": "<p>The platform of the initialization script, either WINDOWS or LINUX.</p>" 588 } 589 }, 590 "LaunchProfileProtocolVersion": { 591 "base": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>", 592 "refs": { 593 "LaunchProfileInitialization$launchProfileProtocolVersion": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>", 594 "LaunchProfileProtocolVersionList$member": null, 595 "StudioComponentInitializationScript$launchProfileProtocolVersion": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>" 596 } 597 }, 598 "LaunchProfileProtocolVersionList": { 599 "base": "<zonbook></zonbook><xhtml></xhtml>", 600 "refs": { 601 "CreateLaunchProfileRequest$launchProfileProtocolVersions": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>", 602 "LaunchProfile$launchProfileProtocolVersions": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>", 603 "UpdateLaunchProfileRequest$launchProfileProtocolVersions": "<p>The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".</p>" 604 } 605 }, 606 "LaunchProfileSecurityGroupIdList": { 607 "base": "<zonbook></zonbook><xhtml></xhtml>", 608 "refs": { 609 "LaunchProfileInitialization$ec2SecurityGroupIds": "<p>The EC2 security groups that control access to the studio component.</p>" 610 } 611 }, 612 "LaunchProfileState": { 613 "base": "<zonbook></zonbook><xhtml></xhtml>", 614 "refs": { 615 "LaunchProfile$state": "<p>The current state.</p>" 616 } 617 }, 618 "LaunchProfileStatusCode": { 619 "base": "<zonbook></zonbook><xhtml></xhtml>", 620 "refs": { 621 "LaunchProfile$statusCode": "<p>The status code.</p>" 622 } 623 }, 624 "LaunchProfileStudioComponentIdList": { 625 "base": "<zonbook></zonbook><xhtml></xhtml>", 626 "refs": { 627 "CreateLaunchProfileRequest$studioComponentIds": "<p>Unique identifiers for a collection of studio components that can be used with this launch profile.</p>", 628 "LaunchProfile$studioComponentIds": "<p>Unique identifiers for a collection of studio components that can be used with this launch profile.</p>", 629 "UpdateLaunchProfileRequest$studioComponentIds": "<p>Unique identifiers for a collection of studio components that can be used with this launch profile.</p>" 630 } 631 }, 632 "LaunchPurpose": { 633 "base": "<p>The launch purpose.</p>", 634 "refs": { 635 "LaunchProfileInitialization$launchPurpose": "<p>The launch purpose.</p>" 636 } 637 }, 638 "LicenseServiceConfiguration": { 639 "base": "<p>The configuration for a license service that is associated with a studio resource.</p>", 640 "refs": { 641 "StudioComponentConfiguration$licenseServiceConfiguration": "<p>The configuration for a license service that is associated with a studio resource.</p>" 642 } 643 }, 644 "LinuxMountPoint": { 645 "base": "<zonbook></zonbook><xhtml></xhtml>", 646 "refs": { 647 "SharedFileSystemConfiguration$linuxMountPoint": "<p>The mount location for a shared file system on a Linux virtual workstation.</p>" 648 } 649 }, 650 "ListEulaAcceptancesRequest": { 651 "base": null, 652 "refs": { 653 } 654 }, 655 "ListEulaAcceptancesResponse": { 656 "base": "<p/>", 657 "refs": { 658 } 659 }, 660 "ListEulasRequest": { 661 "base": null, 662 "refs": { 663 } 664 }, 665 "ListEulasResponse": { 666 "base": "<zonbook></zonbook><xhtml></xhtml>", 667 "refs": { 668 } 669 }, 670 "ListLaunchProfileMembersRequest": { 671 "base": null, 672 "refs": { 673 } 674 }, 675 "ListLaunchProfileMembersResponse": { 676 "base": "<zonbook></zonbook><xhtml></xhtml>", 677 "refs": { 678 } 679 }, 680 "ListLaunchProfilesRequest": { 681 "base": null, 682 "refs": { 683 } 684 }, 685 "ListLaunchProfilesResponse": { 686 "base": "<zonbook></zonbook><xhtml></xhtml>", 687 "refs": { 688 } 689 }, 690 "ListStreamingImagesRequest": { 691 "base": null, 692 "refs": { 693 } 694 }, 695 "ListStreamingImagesResponse": { 696 "base": "<zonbook></zonbook><xhtml></xhtml>", 697 "refs": { 698 } 699 }, 700 "ListStreamingSessionsRequest": { 701 "base": null, 702 "refs": { 703 } 704 }, 705 "ListStreamingSessionsResponse": { 706 "base": "<zonbook></zonbook><xhtml></xhtml>", 707 "refs": { 708 } 709 }, 710 "ListStudioComponentsRequest": { 711 "base": null, 712 "refs": { 713 } 714 }, 715 "ListStudioComponentsResponse": { 716 "base": "<zonbook></zonbook><xhtml></xhtml>", 717 "refs": { 718 } 719 }, 720 "ListStudioMembersRequest": { 721 "base": null, 722 "refs": { 723 } 724 }, 725 "ListStudioMembersResponse": { 726 "base": "<zonbook></zonbook><xhtml></xhtml>", 727 "refs": { 728 } 729 }, 730 "ListStudiosRequest": { 731 "base": null, 732 "refs": { 733 } 734 }, 735 "ListStudiosResponse": { 736 "base": "<zonbook></zonbook><xhtml></xhtml>", 737 "refs": { 738 } 739 }, 740 "ListTagsForResourceRequest": { 741 "base": null, 742 "refs": { 743 } 744 }, 745 "ListTagsForResourceResponse": { 746 "base": "<zonbook></zonbook><xhtml></xhtml>", 747 "refs": { 748 } 749 }, 750 "MaxResults": { 751 "base": null, 752 "refs": { 753 "ListLaunchProfileMembersRequest$maxResults": "<p>The max number of results to return in the response.</p>", 754 "ListLaunchProfilesRequest$maxResults": "<p>The max number of results to return in the response.</p>", 755 "ListStudioComponentsRequest$maxResults": "<p>The max number of results to return in the response.</p>", 756 "ListStudioMembersRequest$maxResults": "<p>The max number of results to return in the response.</p>" 757 } 758 }, 759 "NewLaunchProfileMember": { 760 "base": "<p/>", 761 "refs": { 762 "NewLaunchProfileMemberList$member": null 763 } 764 }, 765 "NewLaunchProfileMemberList": { 766 "base": "<zonbook></zonbook><xhtml></xhtml>", 767 "refs": { 768 "PutLaunchProfileMembersRequest$members": "<p>A list of members.</p>" 769 } 770 }, 771 "NewStudioMember": { 772 "base": "<p/>", 773 "refs": { 774 "NewStudioMemberList$member": null 775 } 776 }, 777 "NewStudioMemberList": { 778 "base": "<zonbook></zonbook><xhtml></xhtml>", 779 "refs": { 780 "PutStudioMembersRequest$members": "<p>A list of members.</p>" 781 } 782 }, 783 "PutLaunchProfileMembersRequest": { 784 "base": "<zonbook></zonbook><xhtml></xhtml>", 785 "refs": { 786 } 787 }, 788 "PutLaunchProfileMembersResponse": { 789 "base": null, 790 "refs": { 791 } 792 }, 793 "PutStudioMembersRequest": { 794 "base": "<zonbook></zonbook><xhtml></xhtml>", 795 "refs": { 796 } 797 }, 798 "PutStudioMembersResponse": { 799 "base": "<zonbook></zonbook><xhtml></xhtml>", 800 "refs": { 801 } 802 }, 803 "Region": { 804 "base": "<zonbook></zonbook><xhtml></xhtml>", 805 "refs": { 806 "Studio$homeRegion": "<p>The Amazon Web Services Region where the studio resource is located.</p>" 807 } 808 }, 809 "ResourceNotFoundException": { 810 "base": "<p>The specified resource could not be found.</p>", 811 "refs": { 812 } 813 }, 814 "ScriptParameterKey": { 815 "base": "<p>A script parameter key.</p>", 816 "refs": { 817 "ScriptParameterKeyValue$key": "<p>A script parameter key.</p>" 818 } 819 }, 820 "ScriptParameterKeyValue": { 821 "base": "<p>A parameter for a studio component script, in the form of a key:value pair.</p>", 822 "refs": { 823 "StudioComponentScriptParameterKeyValueList$member": null 824 } 825 }, 826 "ScriptParameterValue": { 827 "base": "<p>A script parameter value.</p>", 828 "refs": { 829 "ScriptParameterKeyValue$value": "<p>A script parameter value.</p>" 830 } 831 }, 832 "SecurityGroupId": { 833 "base": "<zonbook></zonbook><xhtml></xhtml>", 834 "refs": { 835 "LaunchProfileSecurityGroupIdList$member": null, 836 "StudioComponentSecurityGroupIdList$member": null 837 } 838 }, 839 "ServiceQuotaExceededException": { 840 "base": "<p>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.</p> <p>Please use AWS Service Quotas to request an increase. </p>", 841 "refs": { 842 } 843 }, 844 "SharedFileSystemConfiguration": { 845 "base": "<p>The configuration for a shared file storage system that is associated with a studio resource.</p>", 846 "refs": { 847 "StudioComponentConfiguration$sharedFileSystemConfiguration": "<p>The configuration for a shared file storage system that is associated with a studio resource.</p>" 848 } 849 }, 850 "StartStreamingSessionRequest": { 851 "base": null, 852 "refs": { 853 } 854 }, 855 "StartStreamingSessionResponse": { 856 "base": null, 857 "refs": { 858 } 859 }, 860 "StartStudioSSOConfigurationRepairRequest": { 861 "base": null, 862 "refs": { 863 } 864 }, 865 "StartStudioSSOConfigurationRepairResponse": { 866 "base": "<zonbook></zonbook><xhtml></xhtml>", 867 "refs": { 868 } 869 }, 870 "StopStreamingSessionRequest": { 871 "base": null, 872 "refs": { 873 } 874 }, 875 "StopStreamingSessionResponse": { 876 "base": null, 877 "refs": { 878 } 879 }, 880 "StreamConfiguration": { 881 "base": "<p>A configuration for a streaming session.</p>", 882 "refs": { 883 "LaunchProfile$streamConfiguration": "<p>A configuration for a streaming session.</p>" 884 } 885 }, 886 "StreamConfigurationCreate": { 887 "base": "<p>Configuration for streaming workstations created using this launch profile.</p>", 888 "refs": { 889 "CreateLaunchProfileRequest$streamConfiguration": "<p>A configuration for a streaming session.</p>", 890 "UpdateLaunchProfileRequest$streamConfiguration": "<p>A configuration for a streaming session.</p>" 891 } 892 }, 893 "StreamConfigurationMaxSessionLengthInMinutes": { 894 "base": "<zonbook></zonbook><xhtml></xhtml>", 895 "refs": { 896 "StreamConfiguration$maxSessionLengthInMinutes": "<p>The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.</p>", 897 "StreamConfigurationCreate$maxSessionLengthInMinutes": "<p>The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.</p>" 898 } 899 }, 900 "StreamConfigurationMaxStoppedSessionLengthInMinutes": { 901 "base": null, 902 "refs": { 903 "StreamConfiguration$maxStoppedSessionLengthInMinutes": "<p>Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.</p> <p>If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).</p> <p>If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).</p>", 904 "StreamConfigurationCreate$maxStoppedSessionLengthInMinutes": "<p>The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.</p>" 905 } 906 }, 907 "StreamingClipboardMode": { 908 "base": "<zonbook></zonbook><xhtml></xhtml>", 909 "refs": { 910 "StreamConfiguration$clipboardMode": "<p>Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.</p>", 911 "StreamConfigurationCreate$clipboardMode": "<p>Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.</p>" 912 } 913 }, 914 "StreamingImage": { 915 "base": "<p>Represents a streaming image resource.</p> <p>Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.</p> <p>Amazon provides a number of streaming images that include popular 3rd-party software.</p> <p>You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.</p>", 916 "refs": { 917 "CreateStreamingImageResponse$streamingImage": "<p>The streaming image.</p>", 918 "DeleteStreamingImageResponse$streamingImage": "<p>The streaming image.</p>", 919 "GetStreamingImageResponse$streamingImage": "<p>The streaming image.</p>", 920 "StreamingImageList$member": null, 921 "UpdateStreamingImageResponse$streamingImage": "<p/>" 922 } 923 }, 924 "StreamingImageEncryptionConfiguration": { 925 "base": "<p>Specifies how a streaming image is encrypted.</p>", 926 "refs": { 927 "StreamingImage$encryptionConfiguration": "<p>The encryption configuration.</p>" 928 } 929 }, 930 "StreamingImageEncryptionConfigurationKeyArn": { 931 "base": "<zonbook></zonbook><xhtml></xhtml>", 932 "refs": { 933 "StreamingImageEncryptionConfiguration$keyArn": "<p>The ARN for a KMS key that is used to encrypt studio data.</p>" 934 } 935 }, 936 "StreamingImageEncryptionConfigurationKeyType": { 937 "base": "<p/>", 938 "refs": { 939 "StreamingImageEncryptionConfiguration$keyType": "<p>The type of KMS key that is used to encrypt studio data.</p>" 940 } 941 }, 942 "StreamingImageId": { 943 "base": "<zonbook></zonbook><xhtml></xhtml>", 944 "refs": { 945 "CreateStreamingSessionRequest$streamingImageId": "<p>The ID of the streaming image.</p>", 946 "StreamingImage$streamingImageId": "<p>The ID of the streaming image.</p>", 947 "StreamingImageIdList$member": null, 948 "StreamingSession$streamingImageId": "<p>The ID of the streaming image.</p>" 949 } 950 }, 951 "StreamingImageIdList": { 952 "base": "<p>A list of streaming image IDs that users can select from when launching a streaming session with this launch profile.</p>", 953 "refs": { 954 "StreamConfiguration$streamingImageIds": "<p>The streaming images that users can select from when launching a streaming session with this launch profile.</p>", 955 "StreamConfigurationCreate$streamingImageIds": "<p>The streaming images that users can select from when launching a streaming session with this launch profile.</p>" 956 } 957 }, 958 "StreamingImageList": { 959 "base": "<zonbook></zonbook><xhtml></xhtml>", 960 "refs": { 961 "GetLaunchProfileDetailsResponse$streamingImages": "<p>A collection of streaming images.</p>", 962 "ListStreamingImagesResponse$streamingImages": "<p>A collection of streaming images.</p>" 963 } 964 }, 965 "StreamingImageOwner": { 966 "base": "<p>StreamingImageOwner is the owner of a particular streaming image.</p> <p>This string is either the studioId that contains the streaming image, or the word 'AMAZON' for images provided by Nimble Studio.</p>", 967 "refs": { 968 "StreamingImage$owner": "<p>The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.</p>" 969 } 970 }, 971 "StreamingImagePlatform": { 972 "base": "<p>The platform of this Streaming Image, either WINDOWS or LINUX.</p>", 973 "refs": { 974 "StreamingImage$platform": "<p>The platform of the streaming image, either WINDOWS or LINUX.</p>" 975 } 976 }, 977 "StreamingImageState": { 978 "base": "<zonbook></zonbook><xhtml></xhtml>", 979 "refs": { 980 "StreamingImage$state": "<p>The current state.</p>" 981 } 982 }, 983 "StreamingImageStatusCode": { 984 "base": "<p>The status code.</p>", 985 "refs": { 986 "StreamingImage$statusCode": "<p>The status code.</p>" 987 } 988 }, 989 "StreamingInstanceType": { 990 "base": "<zonbook></zonbook><xhtml></xhtml>", 991 "refs": { 992 "CreateStreamingSessionRequest$ec2InstanceType": "<p>The EC2 Instance type used for the streaming session.</p>", 993 "StreamingInstanceTypeList$member": null 994 } 995 }, 996 "StreamingInstanceTypeList": { 997 "base": "<p>The EC2 instance types that users can select from when launching a streaming session with this launch profile.</p>", 998 "refs": { 999 "StreamConfiguration$ec2InstanceTypes": "<p>The EC2 instance types that users can select from when launching a streaming session with this launch profile.</p>", 1000 "StreamConfigurationCreate$ec2InstanceTypes": "<p>The EC2 instance types that users can select from when launching a streaming session with this launch profile.</p>" 1001 } 1002 }, 1003 "StreamingSession": { 1004 "base": "<p>A streaming session is a virtual workstation created using a particular launch profile.</p>", 1005 "refs": { 1006 "CreateStreamingSessionResponse$session": "<p>The session.</p>", 1007 "DeleteStreamingSessionResponse$session": "<p>The session.</p>", 1008 "GetStreamingSessionResponse$session": "<p>The session.</p>", 1009 "StartStreamingSessionResponse$session": null, 1010 "StopStreamingSessionResponse$session": null, 1011 "StreamingSessionList$member": null 1012 } 1013 }, 1014 "StreamingSessionId": { 1015 "base": "<zonbook></zonbook><xhtml></xhtml>", 1016 "refs": { 1017 "StreamingSession$sessionId": "<p>The session ID.</p>" 1018 } 1019 }, 1020 "StreamingSessionList": { 1021 "base": "<zonbook></zonbook><xhtml></xhtml>", 1022 "refs": { 1023 "ListStreamingSessionsResponse$sessions": "<p>A collection of streaming sessions.</p>" 1024 } 1025 }, 1026 "StreamingSessionState": { 1027 "base": "<p>The streaming session state.</p>", 1028 "refs": { 1029 "StreamingSession$state": "<p>The current state.</p>" 1030 } 1031 }, 1032 "StreamingSessionStatusCode": { 1033 "base": "<zonbook></zonbook><xhtml></xhtml>", 1034 "refs": { 1035 "StreamingSession$statusCode": "<p>The status code.</p>" 1036 } 1037 }, 1038 "StreamingSessionStream": { 1039 "base": "<p>A stream is an active connection to a streaming session, enabling a studio user to control the streaming session using a compatible client. Streaming session streams are compatible with the NICE DCV web client, included in the Nimble Studio portal, or the NICE DCV desktop client.</p>", 1040 "refs": { 1041 "CreateStreamingSessionStreamResponse$stream": "<p>The stream.</p>", 1042 "GetStreamingSessionStreamResponse$stream": "<p>The stream.</p>" 1043 } 1044 }, 1045 "StreamingSessionStreamExpirationInSeconds": { 1046 "base": "<zonbook></zonbook><xhtml></xhtml>", 1047 "refs": { 1048 "CreateStreamingSessionStreamRequest$expirationInSeconds": "<p>The expiration time in seconds.</p>" 1049 } 1050 }, 1051 "StreamingSessionStreamState": { 1052 "base": "<zonbook></zonbook><xhtml></xhtml>", 1053 "refs": { 1054 "StreamingSessionStream$state": "<p>The current state.</p>" 1055 } 1056 }, 1057 "StreamingSessionStreamStatusCode": { 1058 "base": "<zonbook></zonbook><xhtml></xhtml>", 1059 "refs": { 1060 "StreamingSessionStream$statusCode": "<p>The streaming session stream status code.</p>" 1061 } 1062 }, 1063 "String": { 1064 "base": null, 1065 "refs": { 1066 "AcceptEulasRequest$studioId": "<p>A collection of EULA IDs.</p>", 1067 "AccessDeniedException$code": "<p>A more specific error code.</p>", 1068 "AccessDeniedException$message": "<p>A human-readable description of the error.</p>", 1069 "ComputeFarmConfiguration$activeDirectoryUser": "<p>The name of an Active Directory user that is used on ComputeFarm worker instances.</p>", 1070 "ConflictException$code": "<p>A more specific error code.</p>", 1071 "ConflictException$message": "<p>A human-readable description of the error.</p>", 1072 "CreateLaunchProfileRequest$studioId": "<p>The studio ID. </p>", 1073 "CreateStreamingImageRequest$studioId": "<p>The studio ID. </p>", 1074 "CreateStreamingSessionRequest$launchProfileId": "<p>The launch profile ID.</p>", 1075 "CreateStreamingSessionRequest$ownedBy": "<p>The user ID of the user that owns the streaming session.</p>", 1076 "CreateStreamingSessionRequest$studioId": "<p>The studio ID. </p>", 1077 "CreateStreamingSessionStreamRequest$sessionId": "<p>The streaming session ID.</p>", 1078 "CreateStreamingSessionStreamRequest$studioId": "<p>The studio ID. </p>", 1079 "CreateStudioComponentRequest$studioId": "<p>The studio ID. </p>", 1080 "CreateStudioRequest$adminRoleArn": "<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>", 1081 "CreateStudioRequest$userRoleArn": "<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>", 1082 "DeleteLaunchProfileMemberRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1083 "DeleteLaunchProfileMemberRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1084 "DeleteLaunchProfileMemberRequest$studioId": "<p>The studio ID. </p>", 1085 "DeleteLaunchProfileRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1086 "DeleteLaunchProfileRequest$studioId": "<p>The studio ID. </p>", 1087 "DeleteStreamingImageRequest$streamingImageId": "<p>The streaming image ID.</p>", 1088 "DeleteStreamingImageRequest$studioId": "<p>The studio ID. </p>", 1089 "DeleteStreamingSessionRequest$sessionId": "<p>The streaming session ID.</p>", 1090 "DeleteStreamingSessionRequest$studioId": "<p>The studio ID. </p>", 1091 "DeleteStudioComponentRequest$studioComponentId": "<p>The studio component ID.</p>", 1092 "DeleteStudioComponentRequest$studioId": "<p>The studio ID. </p>", 1093 "DeleteStudioMemberRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1094 "DeleteStudioMemberRequest$studioId": "<p>The studio ID. </p>", 1095 "DeleteStudioRequest$studioId": "<p>The studio ID. </p>", 1096 "Eula$content": "<p>The EULA content.</p>", 1097 "EulaAcceptance$acceptedBy": "<p>The ID of the person who accepted the EULA.</p>", 1098 "EulaAcceptance$accepteeId": "<p>The ID of the acceptee.</p>", 1099 "EulaIdList$member": null, 1100 "ExceptionContext$key": null, 1101 "ExceptionContext$value": null, 1102 "GetEulaRequest$eulaId": "<p>The EULA ID.</p>", 1103 "GetLaunchProfileDetailsRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1104 "GetLaunchProfileDetailsRequest$studioId": "<p>The studio ID. </p>", 1105 "GetLaunchProfileInitializationRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1106 "GetLaunchProfileInitializationRequest$launchPurpose": "<p>The launch purpose.</p>", 1107 "GetLaunchProfileInitializationRequest$platform": "<p>The platform where this Launch Profile will be used, either WINDOWS or LINUX.</p>", 1108 "GetLaunchProfileInitializationRequest$studioId": "<p>The studio ID. </p>", 1109 "GetLaunchProfileMemberRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1110 "GetLaunchProfileMemberRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1111 "GetLaunchProfileMemberRequest$studioId": "<p>The studio ID. </p>", 1112 "GetLaunchProfileRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1113 "GetLaunchProfileRequest$studioId": "<p>The studio ID. </p>", 1114 "GetStreamingImageRequest$streamingImageId": "<p>The streaming image ID.</p>", 1115 "GetStreamingImageRequest$studioId": "<p>The studio ID. </p>", 1116 "GetStreamingSessionRequest$sessionId": "<p>The streaming session ID.</p>", 1117 "GetStreamingSessionRequest$studioId": "<p>The studio ID. </p>", 1118 "GetStreamingSessionStreamRequest$sessionId": "<p>The streaming session ID.</p>", 1119 "GetStreamingSessionStreamRequest$streamId": "<p>The streaming session stream ID.</p>", 1120 "GetStreamingSessionStreamRequest$studioId": "<p>The studio ID. </p>", 1121 "GetStudioComponentRequest$studioComponentId": "<p>The studio component ID.</p>", 1122 "GetStudioComponentRequest$studioId": "<p>The studio ID. </p>", 1123 "GetStudioMemberRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1124 "GetStudioMemberRequest$studioId": "<p>The studio ID. </p>", 1125 "GetStudioRequest$studioId": "<p>The studio ID. </p>", 1126 "InternalServerErrorException$code": "<p>A more specific error code.</p>", 1127 "InternalServerErrorException$message": "<p>A human-readable description of the error.</p>", 1128 "LaunchProfile$arn": "<p>The ARN of the resource.</p>", 1129 "LaunchProfile$createdBy": "<p>The user ID of the user that created the launch profile.</p>", 1130 "LaunchProfile$statusMessage": "<p>The status message for the launch profile.</p>", 1131 "LaunchProfile$updatedBy": "<p>The user ID of the user that most recently updated the resource.</p>", 1132 "LaunchProfileInitializationActiveDirectory$directoryName": "<p>The directory name.</p>", 1133 "LaunchProfileMembership$identityStoreId": "<p>The ID of the identity store.</p>", 1134 "LaunchProfileMembership$principalId": "<p>The principal ID.</p>", 1135 "LaunchProfileMembership$sid": "<p>The Active Directory Security Identifier for this user, if available.</p>", 1136 "LaunchProfileStudioComponentIdList$member": null, 1137 "ListEulaAcceptancesRequest$nextToken": "<p>The token to request the next page of results. </p>", 1138 "ListEulaAcceptancesRequest$studioId": "<p>The studio ID. </p>", 1139 "ListEulaAcceptancesResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1140 "ListEulasRequest$nextToken": "<p>The token to request the next page of results. </p>", 1141 "ListEulasResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1142 "ListLaunchProfileMembersRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1143 "ListLaunchProfileMembersRequest$nextToken": "<p>The token to request the next page of results. </p>", 1144 "ListLaunchProfileMembersRequest$studioId": "<p>The studio ID. </p>", 1145 "ListLaunchProfileMembersResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1146 "ListLaunchProfilesRequest$nextToken": "<p>The token to request the next page of results. </p>", 1147 "ListLaunchProfilesRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1148 "ListLaunchProfilesRequest$studioId": "<p>The studio ID. </p>", 1149 "ListLaunchProfilesResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1150 "ListStreamingImagesRequest$nextToken": "<p>The token to request the next page of results. </p>", 1151 "ListStreamingImagesRequest$owner": "<p>Filter this request to streaming images with the given owner</p>", 1152 "ListStreamingImagesRequest$studioId": "<p>The studio ID. </p>", 1153 "ListStreamingImagesResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1154 "ListStreamingSessionsRequest$createdBy": "<p>Filters the request to streaming sessions created by the given user.</p>", 1155 "ListStreamingSessionsRequest$nextToken": "<p>The token to request the next page of results. </p>", 1156 "ListStreamingSessionsRequest$ownedBy": "<p>Filters the request to streaming session owned by the given user</p>", 1157 "ListStreamingSessionsRequest$sessionIds": "<p>Filters the request to only the provided session IDs.</p>", 1158 "ListStreamingSessionsRequest$studioId": "<p>The studio ID. </p>", 1159 "ListStreamingSessionsResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1160 "ListStudioComponentsRequest$nextToken": "<p>The token to request the next page of results. </p>", 1161 "ListStudioComponentsRequest$studioId": "<p>The studio ID. </p>", 1162 "ListStudioComponentsResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1163 "ListStudioMembersRequest$nextToken": "<p>The token to request the next page of results. </p>", 1164 "ListStudioMembersRequest$studioId": "<p>The studio ID. </p>", 1165 "ListStudioMembersResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1166 "ListStudiosRequest$nextToken": "<p>The token to request the next page of results. </p>", 1167 "ListStudiosResponse$nextToken": "<p>The token for the next set of results, or null if there are no more results.</p>", 1168 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</p>", 1169 "NewLaunchProfileMember$principalId": "<p>The principal ID.</p>", 1170 "NewStudioMember$principalId": "<p>The principal ID.</p>", 1171 "PutLaunchProfileMembersRequest$identityStoreId": "<p>The ID of the identity store.</p>", 1172 "PutLaunchProfileMembersRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1173 "PutLaunchProfileMembersRequest$studioId": "<p>The studio ID. </p>", 1174 "PutStudioMembersRequest$identityStoreId": "<p>The ID of the identity store.</p>", 1175 "PutStudioMembersRequest$studioId": "<p>The studio ID. </p>", 1176 "ResourceNotFoundException$code": "<p>A more specific error code.</p>", 1177 "ResourceNotFoundException$message": "<p>A human-readable description of the error.</p>", 1178 "ServiceQuotaExceededException$code": "<p>A more specific error code.</p>", 1179 "ServiceQuotaExceededException$message": "<p>A human-readable description of the error.</p>", 1180 "SharedFileSystemConfiguration$fileSystemId": "<p>The unique identifier for a file system.</p>", 1181 "StartStreamingSessionRequest$sessionId": "<p>The streaming session ID for the StartStreamingSessionRequest.</p>", 1182 "StartStreamingSessionRequest$studioId": "<p>The studio ID for the StartStreamingSessionRequest.</p>", 1183 "StartStudioSSOConfigurationRepairRequest$studioId": "<p>The studio ID. </p>", 1184 "StopStreamingSessionRequest$sessionId": "<p>The streaming session ID for the StopStreamingSessionRequest.</p>", 1185 "StopStreamingSessionRequest$studioId": "<p>The studioId for the StopStreamingSessionRequest.</p>", 1186 "StreamingImage$arn": "<p>The ARN of the resource.</p>", 1187 "StreamingImage$statusMessage": "<p>The status message for the streaming image.</p>", 1188 "StreamingSession$arn": "<p>The ARN of the resource.</p>", 1189 "StreamingSession$createdBy": "<p>The user ID of the user that created the streaming session.</p>", 1190 "StreamingSession$ec2InstanceType": "<p>The EC2 Instance type used for the streaming session.</p>", 1191 "StreamingSession$launchProfileId": "<p>The ID of the launch profile used to control access from the streaming session.</p>", 1192 "StreamingSession$ownedBy": "<p>The user ID of the user that owns the streaming session.</p>", 1193 "StreamingSession$startedBy": "<p>The user ID of the user that started the streaming session.</p>", 1194 "StreamingSession$statusMessage": "<p>The status message for the streaming session.</p>", 1195 "StreamingSession$stoppedBy": "<p>The user ID of the user that stopped the streaming session.</p>", 1196 "StreamingSession$updatedBy": "<p>The user ID of the user that most recently updated the resource.</p>", 1197 "StreamingSessionStream$createdBy": "<p>The user ID of the user that created the streaming session stream.</p>", 1198 "StreamingSessionStream$ownedBy": "<p>The user ID of the user that owns the streaming session.</p>", 1199 "StreamingSessionStream$streamId": "<p>The stream ID.</p>", 1200 "StringList$member": null, 1201 "Studio$adminRoleArn": "<p>The IAM role that studio admins assume when logging in to the Nimble Studio portal.</p>", 1202 "Studio$arn": "<p>The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.</p>", 1203 "Studio$ssoClientId": "<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>", 1204 "Studio$statusMessage": "<p>Additional detail on the studio state.</p>", 1205 "Studio$studioId": "<p>The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.</p>", 1206 "Studio$studioUrl": "<p>The address of the web page for the studio.</p>", 1207 "Studio$userRoleArn": "<p>The IAM role that studio users assume when logging in to the Nimble Studio portal.</p>", 1208 "StudioComponent$arn": "<p>The ARN of the resource.</p>", 1209 "StudioComponent$createdBy": "<p>The user ID of the user that created the studio component.</p>", 1210 "StudioComponent$statusMessage": "<p>The status message for the studio component.</p>", 1211 "StudioComponent$updatedBy": "<p>The user ID of the user that most recently updated the resource.</p>", 1212 "StudioComponentSummary$createdBy": "<p>The user ID of the user that created the studio component.</p>", 1213 "StudioComponentSummary$updatedBy": "<p>The user ID of the user that most recently updated the resource.</p>", 1214 "StudioMembership$identityStoreId": "<p>The ID of the identity store.</p>", 1215 "StudioMembership$principalId": "<p>The principal ID.</p>", 1216 "StudioMembership$sid": "<p>The Active Directory Security Identifier for this user, if available.</p>", 1217 "TagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the resource you want to add tags to. </p>", 1218 "Tags$key": null, 1219 "Tags$value": null, 1220 "ThrottlingException$code": "<p>A more specific error code.</p>", 1221 "ThrottlingException$message": "<p>A human-readable description of the error.</p>", 1222 "UntagResourceRequest$resourceArn": "<p>Identifies the Amazon Resource Name(ARN) key from which you are removing tags. </p>", 1223 "UpdateLaunchProfileMemberRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1224 "UpdateLaunchProfileMemberRequest$principalId": "<p>The principal ID. This currently supports a Amazon Web Services SSO UserId. </p>", 1225 "UpdateLaunchProfileMemberRequest$studioId": "<p>The studio ID. </p>", 1226 "UpdateLaunchProfileRequest$launchProfileId": "<p>The Launch Profile ID.</p>", 1227 "UpdateLaunchProfileRequest$studioId": "<p>The studio ID. </p>", 1228 "UpdateStreamingImageRequest$streamingImageId": "<p>The streaming image ID.</p>", 1229 "UpdateStreamingImageRequest$studioId": "<p>The studio ID. </p>", 1230 "UpdateStudioComponentRequest$studioComponentId": "<p>The studio component ID.</p>", 1231 "UpdateStudioComponentRequest$studioId": "<p>The studio ID. </p>", 1232 "UpdateStudioRequest$adminRoleArn": "<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>", 1233 "UpdateStudioRequest$studioId": "<p>The studio ID. </p>", 1234 "UpdateStudioRequest$userRoleArn": "<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>", 1235 "ValidationException$code": "<p>A more specific error code.</p>", 1236 "ValidationException$message": "<p>A human-readable description of the error.</p>" 1237 } 1238 }, 1239 "StringList": { 1240 "base": null, 1241 "refs": { 1242 "GetLaunchProfileInitializationRequest$launchProfileProtocolVersions": "<p>The launch profile protocol versions supported by the client.</p>", 1243 "ListEulaAcceptancesRequest$eulaIds": "<p>The list of EULA IDs that have been previously accepted.</p>", 1244 "ListEulasRequest$eulaIds": "<p>The list of EULA IDs that should be returned</p>", 1245 "ListLaunchProfilesRequest$states": "<p>Filter this request to launch profiles in any of the given states.</p>", 1246 "ListStudioComponentsRequest$states": "<p>Filters the request to studio components that are in one of the given states. </p>", 1247 "ListStudioComponentsRequest$types": "<p>Filters the request to studio components that are of one of the given types.</p>", 1248 "UntagResourceRequest$tagKeys": "<p>One or more tag keys. Specify only the tag keys, not the tag values.</p>" 1249 } 1250 }, 1251 "Studio": { 1252 "base": "<p>Represents a studio resource.</p> <p>A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.</p> <p>When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via Amazon Web Services SSO and your identity source.</p> <p>The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.</p> <p>The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.</p> <p>Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.</p>", 1253 "refs": { 1254 "CreateStudioResponse$studio": "<p>Information about a studio.</p>", 1255 "DeleteStudioResponse$studio": "<p>Information about a studio.</p>", 1256 "GetStudioResponse$studio": "<p>Information about a studio.</p>", 1257 "StartStudioSSOConfigurationRepairResponse$studio": "<p>Information about a studio.</p>", 1258 "StudioList$member": null, 1259 "UpdateStudioResponse$studio": "<p>Information about a studio.</p>" 1260 } 1261 }, 1262 "StudioComponent": { 1263 "base": "<p>A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.</p> <p>Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.</p> <p>A studio component also has a set of initialization scripts that are returned by <code>GetLaunchProfileInitialization</code>. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.</p>", 1264 "refs": { 1265 "CreateStudioComponentResponse$studioComponent": "<p>Information about the studio component.</p>", 1266 "DeleteStudioComponentResponse$studioComponent": "<p>Information about the studio component.</p>", 1267 "GetStudioComponentResponse$studioComponent": "<p>Information about the studio component.</p>", 1268 "StudioComponentList$member": null, 1269 "UpdateStudioComponentResponse$studioComponent": "<p>Information about the studio component.</p>" 1270 } 1271 }, 1272 "StudioComponentConfiguration": { 1273 "base": "<p>The configuration of the studio component, based on component type.</p>", 1274 "refs": { 1275 "CreateStudioComponentRequest$configuration": "<p>The configuration of the studio component, based on component type.</p>", 1276 "StudioComponent$configuration": "<p>The configuration of the studio component, based on component type.</p>", 1277 "UpdateStudioComponentRequest$configuration": "<p>The configuration of the studio component, based on component type.</p>" 1278 } 1279 }, 1280 "StudioComponentDescription": { 1281 "base": "<zonbook></zonbook><xhtml></xhtml>", 1282 "refs": { 1283 "CreateStudioComponentRequest$description": "<p>The description.</p>", 1284 "StudioComponent$description": "<p>A human-readable description for the studio component resource.</p>", 1285 "StudioComponentSummary$description": "<p>The description.</p>", 1286 "UpdateStudioComponentRequest$description": "<p>The description.</p>" 1287 } 1288 }, 1289 "StudioComponentId": { 1290 "base": "<zonbook></zonbook><xhtml></xhtml>", 1291 "refs": { 1292 "LaunchProfileInitializationActiveDirectory$studioComponentId": "<p>The unique identifier for a studio component resource.</p>", 1293 "LaunchProfileInitializationScript$studioComponentId": "<p>The unique identifier for a studio component resource.</p>", 1294 "StudioComponent$studioComponentId": "<p>The unique identifier for a studio component resource.</p>", 1295 "StudioComponentSummary$studioComponentId": "<p>The unique identifier for a studio component resource.</p>" 1296 } 1297 }, 1298 "StudioComponentInitializationScript": { 1299 "base": "<p>Initialization scripts for studio components.</p>", 1300 "refs": { 1301 "StudioComponentInitializationScriptList$member": null 1302 } 1303 }, 1304 "StudioComponentInitializationScriptContent": { 1305 "base": "<zonbook></zonbook><xhtml></xhtml>", 1306 "refs": { 1307 "LaunchProfileInitializationScript$script": "<p>The initialization script.</p>", 1308 "StudioComponentInitializationScript$script": "<p>The initialization script.</p>" 1309 } 1310 }, 1311 "StudioComponentInitializationScriptList": { 1312 "base": "<zonbook></zonbook><xhtml></xhtml>", 1313 "refs": { 1314 "CreateStudioComponentRequest$initializationScripts": "<p>Initialization scripts for studio components.</p>", 1315 "StudioComponent$initializationScripts": "<p>Initialization scripts for studio components.</p>", 1316 "UpdateStudioComponentRequest$initializationScripts": "<p>Initialization scripts for studio components.</p>" 1317 } 1318 }, 1319 "StudioComponentInitializationScriptRunContext": { 1320 "base": "<zonbook></zonbook><xhtml></xhtml>", 1321 "refs": { 1322 "StudioComponentInitializationScript$runContext": "<p>The method to use when running the initialization script.</p>" 1323 } 1324 }, 1325 "StudioComponentList": { 1326 "base": "<zonbook></zonbook><xhtml></xhtml>", 1327 "refs": { 1328 "ListStudioComponentsResponse$studioComponents": "<p>A collection of studio components.</p>" 1329 } 1330 }, 1331 "StudioComponentName": { 1332 "base": "<zonbook></zonbook><xhtml></xhtml>", 1333 "refs": { 1334 "CreateStudioComponentRequest$name": "<p>The name for the studio component.</p>", 1335 "LaunchProfileInitializationActiveDirectory$studioComponentName": "<p>The name for the studio component.</p>", 1336 "LaunchProfileInitializationScript$studioComponentName": "<p>The name for the studio component.</p>", 1337 "StudioComponent$name": "<p>A friendly name for the studio component resource.</p>", 1338 "StudioComponentSummary$name": "<p>The name for the studio component.</p>", 1339 "UpdateStudioComponentRequest$name": "<p>The name for the studio component.</p>" 1340 } 1341 }, 1342 "StudioComponentScriptParameterKeyValueList": { 1343 "base": "<zonbook></zonbook><xhtml></xhtml>", 1344 "refs": { 1345 "CreateStudioComponentRequest$scriptParameters": "<p>Parameters for the studio component scripts.</p>", 1346 "StudioComponent$scriptParameters": "<p>Parameters for the studio component scripts.</p>", 1347 "UpdateStudioComponentRequest$scriptParameters": "<p>Parameters for the studio component scripts.</p>" 1348 } 1349 }, 1350 "StudioComponentSecurityGroupIdList": { 1351 "base": "<zonbook></zonbook><xhtml></xhtml>", 1352 "refs": { 1353 "CreateStudioComponentRequest$ec2SecurityGroupIds": "<p>The EC2 security groups that control access to the studio component.</p>", 1354 "StudioComponent$ec2SecurityGroupIds": "<p>The EC2 security groups that control access to the studio component.</p>", 1355 "UpdateStudioComponentRequest$ec2SecurityGroupIds": "<p>The EC2 security groups that control access to the studio component.</p>" 1356 } 1357 }, 1358 "StudioComponentState": { 1359 "base": "<p>The current state of the studio component resource.</p> <p>While a studio component is being created, modified, or deleted, its state will equal \"CREATE_IN_PROGRESS\", \"UPDATE_IN_PROGRESS\", or \"DELETE_IN_PROGRESS\"</p> <p>These are called 'transition states'.</p> <p>No modifications may be made to the studio component while it is in a transition state.</p> <p>If creation of the resource fails, the state will change to `CREATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.</p> <p>If updating the resource fails, the state will change to `UPDATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.</p> <p>If deleting the resource fails, the state will change to `DELETE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the \"DELETED\" state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.</p>", 1360 "refs": { 1361 "StudioComponent$state": "<p>The current state.</p>" 1362 } 1363 }, 1364 "StudioComponentStatusCode": { 1365 "base": "<p>The current status of the studio component resource.</p> <p>When the resource is in the 'READY' state, the status code signals what the last mutation made to the resource was.</p> <p>When the resource is in a CREATE_FAILED/UPDATE_FAILED/DELETE_FAILED state, the status code signals what went wrong and why the mutation failed.</p>", 1366 "refs": { 1367 "StudioComponent$statusCode": "<p>The status code.</p>" 1368 } 1369 }, 1370 "StudioComponentSubtype": { 1371 "base": "<zonbook></zonbook><xhtml></xhtml>", 1372 "refs": { 1373 "CreateStudioComponentRequest$subtype": "<p>The specific subtype of a studio component.</p>", 1374 "StudioComponent$subtype": "<p>The specific subtype of a studio component.</p>", 1375 "StudioComponentSummary$subtype": "<p>The specific subtype of a studio component.</p>", 1376 "UpdateStudioComponentRequest$subtype": "<p>The specific subtype of a studio component.</p>" 1377 } 1378 }, 1379 "StudioComponentSummary": { 1380 "base": "<p/>", 1381 "refs": { 1382 "StudioComponentSummaryList$member": null 1383 } 1384 }, 1385 "StudioComponentSummaryList": { 1386 "base": "<zonbook></zonbook><xhtml></xhtml>", 1387 "refs": { 1388 "GetLaunchProfileDetailsResponse$studioComponentSummaries": "<p>A collection of studio component summaries.</p>" 1389 } 1390 }, 1391 "StudioComponentType": { 1392 "base": "<zonbook></zonbook><xhtml></xhtml>", 1393 "refs": { 1394 "CreateStudioComponentRequest$type": "<p>The type of the studio component.</p>", 1395 "StudioComponent$type": "<p>The type of the studio component.</p>", 1396 "StudioComponentSummary$type": "<p>The type of the studio component.</p>", 1397 "UpdateStudioComponentRequest$type": "<p>The type of the studio component.</p>" 1398 } 1399 }, 1400 "StudioEncryptionConfiguration": { 1401 "base": "<p>Configuration of the encryption method that is used for the studio.</p>", 1402 "refs": { 1403 "CreateStudioRequest$studioEncryptionConfiguration": "<p>The studio encryption configuration.</p>", 1404 "Studio$studioEncryptionConfiguration": "<p>Configuration of the encryption method that is used for the studio.</p>" 1405 } 1406 }, 1407 "StudioEncryptionConfigurationKeyArn": { 1408 "base": "<p>The Amazon Resource Name (ARN) for a KMS key that is used to encrypt studio data.</p>", 1409 "refs": { 1410 "StudioEncryptionConfiguration$keyArn": "<p>The ARN for a KMS key that is used to encrypt studio data.</p>" 1411 } 1412 }, 1413 "StudioEncryptionConfigurationKeyType": { 1414 "base": "<p>The type of KMS key that is used to encrypt studio data.</p>", 1415 "refs": { 1416 "StudioEncryptionConfiguration$keyType": "<p>The type of KMS key that is used to encrypt studio data.</p>" 1417 } 1418 }, 1419 "StudioList": { 1420 "base": "<zonbook></zonbook><xhtml></xhtml>", 1421 "refs": { 1422 "ListStudiosResponse$studios": "<p>A collection of studios.</p>" 1423 } 1424 }, 1425 "StudioMembership": { 1426 "base": "<p>A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.</p> <p>When you add a user to your studio using the Nimble Studio console, they are given access to the studio's AWS SSO application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.</p> <p>When you add a user to studio membership with the persona ADMIN, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.</p>", 1427 "refs": { 1428 "GetStudioMemberResponse$member": "<p>The member.</p>", 1429 "StudioMembershipList$member": null 1430 } 1431 }, 1432 "StudioMembershipList": { 1433 "base": "<zonbook></zonbook><xhtml></xhtml>", 1434 "refs": { 1435 "ListStudioMembersResponse$members": "<p>A list of members.</p>" 1436 } 1437 }, 1438 "StudioName": { 1439 "base": "<zonbook></zonbook><xhtml></xhtml>", 1440 "refs": { 1441 "CreateStudioRequest$studioName": "<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>", 1442 "Studio$studioName": "<p>The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.</p>" 1443 } 1444 }, 1445 "StudioPersona": { 1446 "base": "<zonbook></zonbook><xhtml></xhtml>", 1447 "refs": { 1448 "NewStudioMember$persona": "<p>The persona.</p>", 1449 "StudioMembership$persona": "<p>The persona.</p>" 1450 } 1451 }, 1452 "StudioState": { 1453 "base": "<zonbook></zonbook><xhtml></xhtml>", 1454 "refs": { 1455 "Studio$state": "<p>The current state of the studio resource.</p>" 1456 } 1457 }, 1458 "StudioStatusCode": { 1459 "base": "<p>The status code.</p>", 1460 "refs": { 1461 "Studio$statusCode": "<p>Status codes that provide additional detail on the studio state.</p>" 1462 } 1463 }, 1464 "SyntheticComputeFarmConfigurationString": { 1465 "base": null, 1466 "refs": { 1467 "ComputeFarmConfiguration$endpoint": "<p>The endpoint of the ComputeFarm that is accessed by the studio component resource.</p>" 1468 } 1469 }, 1470 "SyntheticCreateStreamingImageRequestStreamingImageDescription": { 1471 "base": "<p>The description.</p>", 1472 "refs": { 1473 "CreateStreamingImageRequest$description": "<p>A human-readable description of the streaming image.</p>" 1474 } 1475 }, 1476 "SyntheticCreateStreamingImageRequestStreamingImageName": { 1477 "base": "<p>A friendly name for a streaming image resource.</p>", 1478 "refs": { 1479 "CreateStreamingImageRequest$name": "<p>A friendly name for a streaming image resource.</p>" 1480 } 1481 }, 1482 "SyntheticCreateStudioRequestStudioDisplayName": { 1483 "base": "<zonbook></zonbook><xhtml></xhtml>", 1484 "refs": { 1485 "CreateStudioRequest$displayName": "<p>A friendly name for the studio.</p>" 1486 } 1487 }, 1488 "SyntheticLicenseServiceConfigurationString": { 1489 "base": null, 1490 "refs": { 1491 "LicenseServiceConfiguration$endpoint": "<p>The endpoint of the license service that is accessed by the studio component resource.</p>" 1492 } 1493 }, 1494 "SyntheticSharedFileSystemConfigurationString": { 1495 "base": null, 1496 "refs": { 1497 "SharedFileSystemConfiguration$endpoint": "<p>The endpoint of the shared file system that is accessed by the studio component resource.</p>", 1498 "SharedFileSystemConfiguration$shareName": "<p>The name of the file share.</p>" 1499 } 1500 }, 1501 "SyntheticStreamingImageStreamingImageDescription": { 1502 "base": "<p>The description.</p>", 1503 "refs": { 1504 "StreamingImage$description": "<p>A human-readable description of the streaming image.</p>" 1505 } 1506 }, 1507 "SyntheticStreamingImageStreamingImageName": { 1508 "base": "<p>A friendly name for a streaming image resource.</p>", 1509 "refs": { 1510 "StreamingImage$name": "<p>A friendly name for a streaming image resource.</p>" 1511 } 1512 }, 1513 "SyntheticStreamingSessionStreamString": { 1514 "base": null, 1515 "refs": { 1516 "StreamingSessionStream$url": "<p>The URL to connect to this stream using the DCV client.</p>" 1517 } 1518 }, 1519 "SyntheticStudioStudioDisplayName": { 1520 "base": "<zonbook></zonbook><xhtml></xhtml>", 1521 "refs": { 1522 "Studio$displayName": "<p>A friendly name for the studio.</p>" 1523 } 1524 }, 1525 "SyntheticUpdateStreamingImageRequestStreamingImageDescription": { 1526 "base": "<p>The description.</p>", 1527 "refs": { 1528 "UpdateStreamingImageRequest$description": "<p>The description.</p>" 1529 } 1530 }, 1531 "SyntheticUpdateStreamingImageRequestStreamingImageName": { 1532 "base": "<p>A friendly name for a streaming image resource.</p>", 1533 "refs": { 1534 "UpdateStreamingImageRequest$name": "<p>The name for the streaming image.</p>" 1535 } 1536 }, 1537 "SyntheticUpdateStudioRequestStudioDisplayName": { 1538 "base": "<zonbook></zonbook><xhtml></xhtml>", 1539 "refs": { 1540 "UpdateStudioRequest$displayName": "<p>A friendly name for the studio.</p>" 1541 } 1542 }, 1543 "TagResourceRequest": { 1544 "base": "<p/>", 1545 "refs": { 1546 } 1547 }, 1548 "TagResourceResponse": { 1549 "base": null, 1550 "refs": { 1551 } 1552 }, 1553 "Tags": { 1554 "base": "<zonbook></zonbook><xhtml></xhtml>", 1555 "refs": { 1556 "CreateLaunchProfileRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1557 "CreateStreamingImageRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1558 "CreateStreamingSessionRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1559 "CreateStudioComponentRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1560 "CreateStudioRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1561 "LaunchProfile$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1562 "ListTagsForResourceResponse$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1563 "StreamingImage$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1564 "StreamingSession$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1565 "Studio$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1566 "StudioComponent$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>", 1567 "TagResourceRequest$tags": "<p>A collection of labels, in the form of key:value pairs, that apply to this resource.</p>" 1568 } 1569 }, 1570 "ThrottlingException": { 1571 "base": "<p>The request throughput limit was exceeded.</p>", 1572 "refs": { 1573 } 1574 }, 1575 "Timestamp": { 1576 "base": "<zonbook></zonbook><xhtml></xhtml>", 1577 "refs": { 1578 "Eula$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1579 "Eula$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>", 1580 "EulaAcceptance$acceptedAt": "<p>The Unix epoch timestamp in seconds for when the EULA was accepted.</p>", 1581 "LaunchProfile$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1582 "LaunchProfile$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>", 1583 "StreamingSession$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1584 "StreamingSession$startedAt": "<p>The time the session entered START_IN_PROGRESS state.</p>", 1585 "StreamingSession$stopAt": "<p>The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves. </p>", 1586 "StreamingSession$stoppedAt": "<p>The time the session entered STOP_IN_PROGRESS state.</p>", 1587 "StreamingSession$terminateAt": "<p>The time the streaming session will automatically terminate if not terminated by the user.</p>", 1588 "StreamingSession$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>", 1589 "StreamingSessionStream$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1590 "StreamingSessionStream$expiresAt": "<p>The Unix epoch timestamp in seconds for when the resource expires.</p>", 1591 "Studio$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1592 "Studio$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>", 1593 "StudioComponent$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1594 "StudioComponent$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>", 1595 "StudioComponentSummary$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>", 1596 "StudioComponentSummary$updatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was updated.</p>" 1597 } 1598 }, 1599 "UntagResourceRequest": { 1600 "base": null, 1601 "refs": { 1602 } 1603 }, 1604 "UntagResourceResponse": { 1605 "base": null, 1606 "refs": { 1607 } 1608 }, 1609 "UpdateLaunchProfileMemberRequest": { 1610 "base": "<p/>", 1611 "refs": { 1612 } 1613 }, 1614 "UpdateLaunchProfileMemberResponse": { 1615 "base": null, 1616 "refs": { 1617 } 1618 }, 1619 "UpdateLaunchProfileRequest": { 1620 "base": "<zonbook></zonbook><xhtml></xhtml>", 1621 "refs": { 1622 } 1623 }, 1624 "UpdateLaunchProfileResponse": { 1625 "base": "<zonbook></zonbook><xhtml></xhtml>", 1626 "refs": { 1627 } 1628 }, 1629 "UpdateStreamingImageRequest": { 1630 "base": "<zonbook></zonbook><xhtml></xhtml>", 1631 "refs": { 1632 } 1633 }, 1634 "UpdateStreamingImageResponse": { 1635 "base": "<p/>", 1636 "refs": { 1637 } 1638 }, 1639 "UpdateStudioComponentRequest": { 1640 "base": "<zonbook></zonbook><xhtml></xhtml>", 1641 "refs": { 1642 } 1643 }, 1644 "UpdateStudioComponentResponse": { 1645 "base": "<zonbook></zonbook><xhtml></xhtml>", 1646 "refs": { 1647 } 1648 }, 1649 "UpdateStudioRequest": { 1650 "base": "<zonbook></zonbook><xhtml></xhtml>", 1651 "refs": { 1652 } 1653 }, 1654 "UpdateStudioResponse": { 1655 "base": "<zonbook></zonbook><xhtml></xhtml>", 1656 "refs": { 1657 } 1658 }, 1659 "ValidationException": { 1660 "base": "<p>One of the parameters in the request is invalid.</p>", 1661 "refs": { 1662 } 1663 }, 1664 "WindowsMountDrive": { 1665 "base": "<zonbook></zonbook><xhtml></xhtml>", 1666 "refs": { 1667 "SharedFileSystemConfiguration$windowsMountDrive": "<p>The mount location for a shared file system on a Windows virtual workstation.</p>" 1668 } 1669 } 1670 } 1671} 1672