{ "version":"2.0", "metadata":{ "apiVersion":"2020-08-01", "endpointPrefix":"nimble", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AmazonNimbleStudio", "serviceId":"nimble", "signatureVersion":"v4", "signingName":"nimble", "uid":"nimble-2020-08-01" }, "operations":{ "AcceptEulas":{ "name":"AcceptEulas", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/eula-acceptances", "responseCode":200 }, "input":{"shape":"AcceptEulasRequest"}, "output":{"shape":"AcceptEulasResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Accept EULAs.

" }, "CreateLaunchProfile":{ "name":"CreateLaunchProfile", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles", "responseCode":200 }, "input":{"shape":"CreateLaunchProfileRequest"}, "output":{"shape":"CreateLaunchProfileResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Create a launch profile.

" }, "CreateStreamingImage":{ "name":"CreateStreamingImage", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/streaming-images", "responseCode":200 }, "input":{"shape":"CreateStreamingImageRequest"}, "output":{"shape":"CreateStreamingImageResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a streaming image resource in a studio.

" }, "CreateStreamingSession":{ "name":"CreateStreamingSession", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions", "responseCode":200 }, "input":{"shape":"CreateStreamingSessionRequest"}, "output":{"shape":"CreateStreamingSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a streaming session in a studio.

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

" }, "CreateStreamingSessionStream":{ "name":"CreateStreamingSessionStream", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/streams", "responseCode":200 }, "input":{"shape":"CreateStreamingSessionStreamRequest"}, "output":{"shape":"CreateStreamingSessionStreamResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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 the `READY` state.

", "idempotent":true }, "CreateStudio":{ "name":"CreateStudio", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios", "responseCode":200 }, "input":{"shape":"CreateStudioRequest"}, "output":{"shape":"CreateStudioResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

" }, "CreateStudioComponent":{ "name":"CreateStudioComponent", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/studio-components", "responseCode":200 }, "input":{"shape":"CreateStudioComponentRequest"}, "output":{"shape":"CreateStudioComponentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a studio component resource.

" }, "DeleteLaunchProfile":{ "name":"DeleteLaunchProfile", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}", "responseCode":200 }, "input":{"shape":"DeleteLaunchProfileRequest"}, "output":{"shape":"DeleteLaunchProfileResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Permanently delete a launch profile.

", "idempotent":true }, "DeleteLaunchProfileMember":{ "name":"DeleteLaunchProfileMember", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/membership/{principalId}", "responseCode":200 }, "input":{"shape":"DeleteLaunchProfileMemberRequest"}, "output":{"shape":"DeleteLaunchProfileMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Delete a user from launch profile membership.

", "idempotent":true }, "DeleteStreamingImage":{ "name":"DeleteStreamingImage", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/streaming-images/{streamingImageId}", "responseCode":200 }, "input":{"shape":"DeleteStreamingImageRequest"}, "output":{"shape":"DeleteStreamingImageResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Delete streaming image.

", "idempotent":true }, "DeleteStreamingSession":{ "name":"DeleteStreamingSession", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}", "responseCode":200 }, "input":{"shape":"DeleteStreamingSessionRequest"}, "output":{"shape":"DeleteStreamingSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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`.

", "idempotent":true }, "DeleteStudio":{ "name":"DeleteStudio", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}", "responseCode":200 }, "input":{"shape":"DeleteStudioRequest"}, "output":{"shape":"DeleteStudioResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Delete a studio resource.

", "idempotent":true }, "DeleteStudioComponent":{ "name":"DeleteStudioComponent", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}", "responseCode":200 }, "input":{"shape":"DeleteStudioComponentRequest"}, "output":{"shape":"DeleteStudioComponentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Deletes a studio component resource.

", "idempotent":true }, "DeleteStudioMember":{ "name":"DeleteStudioMember", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/studios/{studioId}/membership/{principalId}", "responseCode":200 }, "input":{"shape":"DeleteStudioMemberRequest"}, "output":{"shape":"DeleteStudioMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Delete a user from studio membership.

", "idempotent":true }, "GetEula":{ "name":"GetEula", "http":{ "method":"GET", "requestUri":"/2020-08-01/eulas/{eulaId}", "responseCode":200 }, "input":{"shape":"GetEulaRequest"}, "output":{"shape":"GetEulaResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get EULA.

" }, "GetLaunchProfile":{ "name":"GetLaunchProfile", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}", "responseCode":200 }, "input":{"shape":"GetLaunchProfileRequest"}, "output":{"shape":"GetLaunchProfileResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get a launch profile.

" }, "GetLaunchProfileDetails":{ "name":"GetLaunchProfileDetails", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/details", "responseCode":200 }, "input":{"shape":"GetLaunchProfileDetailsRequest"}, "output":{"shape":"GetLaunchProfileDetailsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

" }, "GetLaunchProfileInitialization":{ "name":"GetLaunchProfileInitialization", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/init", "responseCode":200 }, "input":{"shape":"GetLaunchProfileInitializationRequest"}, "output":{"shape":"GetLaunchProfileInitializationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get a launch profile initialization.

" }, "GetLaunchProfileMember":{ "name":"GetLaunchProfileMember", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/membership/{principalId}", "responseCode":200 }, "input":{"shape":"GetLaunchProfileMemberRequest"}, "output":{"shape":"GetLaunchProfileMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get a user persona in launch profile membership.

" }, "GetStreamingImage":{ "name":"GetStreamingImage", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-images/{streamingImageId}", "responseCode":200 }, "input":{"shape":"GetStreamingImageRequest"}, "output":{"shape":"GetStreamingImageResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get streaming image.

" }, "GetStreamingSession":{ "name":"GetStreamingSession", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}", "responseCode":200 }, "input":{"shape":"GetStreamingSessionRequest"}, "output":{"shape":"GetStreamingSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

" }, "GetStreamingSessionBackup":{ "name":"GetStreamingSessionBackup", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-session-backups/{backupId}", "responseCode":200 }, "input":{"shape":"GetStreamingSessionBackupRequest"}, "output":{"shape":"GetStreamingSessionBackupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Gets `StreamingSessionBackup` resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

" }, "GetStreamingSessionStream":{ "name":"GetStreamingSessionStream", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/streams/{streamId}", "responseCode":200 }, "input":{"shape":"GetStreamingSessionStreamRequest"}, "output":{"shape":"GetStreamingSessionStreamResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking `CreateStreamingSessionStream`.

After the `StreamingSessionStream` changes to the `READY` state, the url property will contain a stream to be used with the DCV streaming client.

" }, "GetStudio":{ "name":"GetStudio", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}", "responseCode":200 }, "input":{"shape":"GetStudioRequest"}, "output":{"shape":"GetStudioResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get a studio resource.

" }, "GetStudioComponent":{ "name":"GetStudioComponent", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}", "responseCode":200 }, "input":{"shape":"GetStudioComponentRequest"}, "output":{"shape":"GetStudioComponentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets a studio component resource.

" }, "GetStudioMember":{ "name":"GetStudioMember", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/membership/{principalId}", "responseCode":200 }, "input":{"shape":"GetStudioMemberRequest"}, "output":{"shape":"GetStudioMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get a user's membership in a studio.

" }, "ListEulaAcceptances":{ "name":"ListEulaAcceptances", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/eula-acceptances", "responseCode":200 }, "input":{"shape":"ListEulaAcceptancesRequest"}, "output":{"shape":"ListEulaAcceptancesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List EULA acceptances.

" }, "ListEulas":{ "name":"ListEulas", "http":{ "method":"GET", "requestUri":"/2020-08-01/eulas", "responseCode":200 }, "input":{"shape":"ListEulasRequest"}, "output":{"shape":"ListEulasResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List EULAs.

" }, "ListLaunchProfileMembers":{ "name":"ListLaunchProfileMembers", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/membership", "responseCode":200 }, "input":{"shape":"ListLaunchProfileMembersRequest"}, "output":{"shape":"ListLaunchProfileMembersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get all users in a given launch profile membership.

" }, "ListLaunchProfiles":{ "name":"ListLaunchProfiles", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles", "responseCode":200 }, "input":{"shape":"ListLaunchProfilesRequest"}, "output":{"shape":"ListLaunchProfilesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List all the launch profiles a studio.

" }, "ListStreamingImages":{ "name":"ListStreamingImages", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-images", "responseCode":200 }, "input":{"shape":"ListStreamingImagesRequest"}, "output":{"shape":"ListStreamingImagesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List the streaming image resources available to this studio.

This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

" }, "ListStreamingSessionBackups":{ "name":"ListStreamingSessionBackups", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-session-backups", "responseCode":200 }, "input":{"shape":"ListStreamingSessionBackupsRequest"}, "output":{"shape":"ListStreamingSessionBackupsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Lists the backups of a streaming session in a studio.

" }, "ListStreamingSessions":{ "name":"ListStreamingSessions", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions", "responseCode":200 }, "input":{"shape":"ListStreamingSessionsRequest"}, "output":{"shape":"ListStreamingSessionsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists the streaming sessions in a studio.

" }, "ListStudioComponents":{ "name":"ListStudioComponents", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/studio-components", "responseCode":200 }, "input":{"shape":"ListStudioComponentsRequest"}, "output":{"shape":"ListStudioComponentsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists the `StudioComponents` in a studio.

" }, "ListStudioMembers":{ "name":"ListStudioMembers", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios/{studioId}/membership", "responseCode":200 }, "input":{"shape":"ListStudioMembersRequest"}, "output":{"shape":"ListStudioMembersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get all users in a given studio membership.

`ListStudioMembers` only returns admin members.

" }, "ListStudios":{ "name":"ListStudios", "http":{ "method":"GET", "requestUri":"/2020-08-01/studios", "responseCode":200 }, "input":{"shape":"ListStudiosRequest"}, "output":{"shape":"ListStudiosResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/2020-08-01/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets the tags for a resource, given its Amazon Resource Names (ARN).

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.

" }, "PutLaunchProfileMembers":{ "name":"PutLaunchProfileMembers", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/membership", "responseCode":200 }, "input":{"shape":"PutLaunchProfileMembersRequest"}, "output":{"shape":"PutLaunchProfileMembersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Add/update users with given persona to launch profile membership.

" }, "PutStudioMembers":{ "name":"PutStudioMembers", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/membership", "responseCode":200 }, "input":{"shape":"PutStudioMembersRequest"}, "output":{"shape":"PutStudioMembersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Add/update users with given persona to studio membership.

" }, "StartStreamingSession":{ "name":"StartStreamingSession", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/start", "responseCode":200 }, "input":{"shape":"StartStreamingSessionRequest"}, "output":{"shape":"StartStreamingSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "StartStudioSSOConfigurationRepair":{ "name":"StartStudioSSOConfigurationRepair", "http":{ "method":"PUT", "requestUri":"/2020-08-01/studios/{studioId}/sso-configuration", "responseCode":200 }, "input":{"shape":"StartStudioSSOConfigurationRepairRequest"}, "output":{"shape":"StartStudioSSOConfigurationRepairResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Repairs the IAM Identity Center configuration for a given studio.

If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the `READY` state.

After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

", "idempotent":true }, "StopStreamingSession":{ "name":"StopStreamingSession", "http":{ "method":"POST", "requestUri":"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop", "responseCode":200 }, "input":{"shape":"StopStreamingSessionRequest"}, "output":{"shape":"StopStreamingSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/2020-08-01/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates tags for a resource, given its ARN.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/2020-08-01/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Deletes the tags for a resource.

", "idempotent":true }, "UpdateLaunchProfile":{ "name":"UpdateLaunchProfile", "http":{ "method":"PATCH", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}", "responseCode":200 }, "input":{"shape":"UpdateLaunchProfileRequest"}, "output":{"shape":"UpdateLaunchProfileResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Update a launch profile.

" }, "UpdateLaunchProfileMember":{ "name":"UpdateLaunchProfileMember", "http":{ "method":"PATCH", "requestUri":"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}/membership/{principalId}", "responseCode":200 }, "input":{"shape":"UpdateLaunchProfileMemberRequest"}, "output":{"shape":"UpdateLaunchProfileMemberResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Update a user persona in launch profile membership.

" }, "UpdateStreamingImage":{ "name":"UpdateStreamingImage", "http":{ "method":"PATCH", "requestUri":"/2020-08-01/studios/{studioId}/streaming-images/{streamingImageId}", "responseCode":200 }, "input":{"shape":"UpdateStreamingImageRequest"}, "output":{"shape":"UpdateStreamingImageResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Update streaming image.

" }, "UpdateStudio":{ "name":"UpdateStudio", "http":{ "method":"PATCH", "requestUri":"/2020-08-01/studios/{studioId}", "responseCode":200 }, "input":{"shape":"UpdateStudioRequest"}, "output":{"shape":"UpdateStudioResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

" }, "UpdateStudioComponent":{ "name":"UpdateStudioComponent", "http":{ "method":"PATCH", "requestUri":"/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}", "responseCode":200 }, "input":{"shape":"UpdateStudioComponentRequest"}, "output":{"shape":"UpdateStudioComponentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates a studio component resource.

" } }, "shapes":{ "AcceptEulasRequest":{ "type":"structure", "required":["studioId"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "eulaIds":{ "shape":"EulaIdList", "documentation":"

The EULA ID.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "AcceptEulasResponse":{ "type":"structure", "members":{ "eulaAcceptances":{ "shape":"EulaAcceptanceList", "documentation":"

A collection of EULA acceptances.

" } } }, "AccessDeniedException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

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

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ActiveDirectoryComputerAttribute":{ "type":"structure", "members":{ "name":{ "shape":"ActiveDirectoryComputerAttributeName", "documentation":"

The name for the LDAP attribute.

" }, "value":{ "shape":"ActiveDirectoryComputerAttributeValue", "documentation":"

The value for the LDAP attribute.

" } }, "documentation":"

An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

" }, "ActiveDirectoryComputerAttributeList":{ "type":"list", "member":{"shape":"ActiveDirectoryComputerAttribute"}, "documentation":"

A collection of LDAP attributes to apply to Active Directory computer accounts that are created for streaming sessions.

", "max":50, "min":0, "sensitive":true }, "ActiveDirectoryComputerAttributeName":{ "type":"string", "documentation":"

The name for the LDAP attribute.

", "max":40, "min":1 }, "ActiveDirectoryComputerAttributeValue":{ "type":"string", "documentation":"

The value for the LDAP attribute.

", "max":64, "min":1 }, "ActiveDirectoryConfiguration":{ "type":"structure", "members":{ "computerAttributes":{ "shape":"ActiveDirectoryComputerAttributeList", "documentation":"

A collection of custom attributes for an Active Directory computer.

" }, "directoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.

" }, "organizationalUnitDistinguishedName":{ "shape":"ActiveDirectoryOrganizationalUnitDistinguishedName", "documentation":"

The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

" } }, "documentation":"

The configuration for a Directory Service for Microsoft Active Directory studio resource.

" }, "ActiveDirectoryDnsIpAddress":{"type":"string"}, "ActiveDirectoryDnsIpAddressList":{ "type":"list", "member":{"shape":"ActiveDirectoryDnsIpAddress"}, "max":10, "min":0 }, "ActiveDirectoryOrganizationalUnitDistinguishedName":{ "type":"string", "documentation":"

The fully-qualified distinguished name of the organizational unit to place the computer account in.

", "max":2000, "min":1 }, "AutomaticTerminationMode":{ "type":"string", "enum":[ "DEACTIVATED", "ACTIVATED" ] }, "ClientToken":{ "type":"string", "max":64, "min":1 }, "ComputeFarmConfiguration":{ "type":"structure", "members":{ "activeDirectoryUser":{ "shape":"String", "documentation":"

The name of an Active Directory user that is used on ComputeFarm worker instances.

" }, "endpoint":{ "shape":"SensitiveString", "documentation":"

The endpoint of the ComputeFarm that is accessed by the studio component resource.

" } }, "documentation":"

The configuration for a render farm that is associated with a studio resource.

" }, "ConflictException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

Another operation is in progress.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateLaunchProfileRequest":{ "type":"structure", "required":[ "ec2SubnetIds", "launchProfileProtocolVersions", "name", "streamConfiguration", "studioComponentIds", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "description":{ "shape":"LaunchProfileDescription", "documentation":"

The description.

" }, "ec2SubnetIds":{ "shape":"EC2SubnetIdList", "documentation":"

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

" }, "launchProfileProtocolVersions":{ "shape":"LaunchProfileProtocolVersionList", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

" }, "name":{ "shape":"LaunchProfileName", "documentation":"

The name for the launch profile.

" }, "streamConfiguration":{ "shape":"StreamConfigurationCreate", "documentation":"

A configuration for a streaming session.

" }, "studioComponentIds":{ "shape":"LaunchProfileStudioComponentIdList", "documentation":"

Unique identifiers for a collection of studio components that can be used with this launch profile.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "tags":{ "shape":"Tags", "documentation":"

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

" } } }, "CreateLaunchProfileResponse":{ "type":"structure", "members":{ "launchProfile":{ "shape":"LaunchProfile", "documentation":"

The launch profile.

" } } }, "CreateStreamingImageRequest":{ "type":"structure", "required":[ "ec2ImageId", "name", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "description":{ "shape":"StreamingImageDescription", "documentation":"

A human-readable description of the streaming image.

" }, "ec2ImageId":{ "shape":"EC2ImageId", "documentation":"

The ID of an EC2 machine image with which to create this streaming image.

" }, "name":{ "shape":"StreamingImageName", "documentation":"

A friendly name for a streaming image resource.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "tags":{ "shape":"Tags", "documentation":"

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

" } } }, "CreateStreamingImageResponse":{ "type":"structure", "members":{ "streamingImage":{ "shape":"StreamingImage", "documentation":"

The streaming image.

" } } }, "CreateStreamingSessionRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "ec2InstanceType":{ "shape":"StreamingInstanceType", "documentation":"

The EC2 Instance type used for the streaming session.

" }, "launchProfileId":{ "shape":"String", "documentation":"

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

" }, "ownedBy":{ "shape":"String", "documentation":"

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.

" }, "streamingImageId":{ "shape":"StreamingImageId", "documentation":"

The ID of the streaming image.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "tags":{ "shape":"Tags", "documentation":"

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

" } } }, "CreateStreamingSessionResponse":{ "type":"structure", "members":{ "session":{ "shape":"StreamingSession", "documentation":"

The session.

" } } }, "CreateStreamingSessionStreamRequest":{ "type":"structure", "required":[ "sessionId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "expirationInSeconds":{ "shape":"StreamingSessionStreamExpirationInSeconds", "documentation":"

The expiration time in seconds.

" }, "sessionId":{ "shape":"String", "documentation":"

The streaming session ID.

", "location":"uri", "locationName":"sessionId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "CreateStreamingSessionStreamResponse":{ "type":"structure", "members":{ "stream":{ "shape":"StreamingSessionStream", "documentation":"

The stream.

" } } }, "CreateStudioComponentRequest":{ "type":"structure", "required":[ "name", "studioId", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "configuration":{ "shape":"StudioComponentConfiguration", "documentation":"

The configuration of the studio component, based on component type.

" }, "description":{ "shape":"StudioComponentDescription", "documentation":"

The description.

" }, "ec2SecurityGroupIds":{ "shape":"StudioComponentSecurityGroupIdList", "documentation":"

The EC2 security groups that control access to the studio component.

" }, "initializationScripts":{ "shape":"StudioComponentInitializationScriptList", "documentation":"

Initialization scripts for studio components.

" }, "name":{ "shape":"StudioComponentName", "documentation":"

The name for the studio component.

" }, "runtimeRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", "documentation":"

Parameters for the studio component scripts.

" }, "secureInitializationRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "subtype":{ "shape":"StudioComponentSubtype", "documentation":"

The specific subtype of a studio component.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "type":{ "shape":"StudioComponentType", "documentation":"

The type of the studio component.

" } } }, "CreateStudioComponentResponse":{ "type":"structure", "members":{ "studioComponent":{ "shape":"StudioComponent", "documentation":"

Information about the studio component.

" } } }, "CreateStudioRequest":{ "type":"structure", "required":[ "adminRoleArn", "displayName", "studioName", "userRoleArn" ], "members":{ "adminRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that studio admins will assume when logging in to the Nimble Studio portal.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "displayName":{ "shape":"StudioDisplayName", "documentation":"

A friendly name for the studio.

" }, "studioEncryptionConfiguration":{ "shape":"StudioEncryptionConfiguration", "documentation":"

The studio encryption configuration.

" }, "studioName":{ "shape":"StudioName", "documentation":"

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "userRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that studio users will assume when logging in to the Nimble Studio portal.

" } } }, "CreateStudioResponse":{ "type":"structure", "members":{ "studio":{ "shape":"Studio", "documentation":"

Information about a studio.

" } } }, "DeleteLaunchProfileMemberRequest":{ "type":"structure", "required":[ "launchProfileId", "principalId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"uri", "locationName":"principalId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteLaunchProfileMemberResponse":{ "type":"structure", "members":{ } }, "DeleteLaunchProfileRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteLaunchProfileResponse":{ "type":"structure", "members":{ "launchProfile":{ "shape":"LaunchProfile", "documentation":"

The launch profile.

" } } }, "DeleteStreamingImageRequest":{ "type":"structure", "required":[ "streamingImageId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "streamingImageId":{ "shape":"String", "documentation":"

The streaming image ID.

", "location":"uri", "locationName":"streamingImageId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteStreamingImageResponse":{ "type":"structure", "members":{ "streamingImage":{ "shape":"StreamingImage", "documentation":"

The streaming image.

" } } }, "DeleteStreamingSessionRequest":{ "type":"structure", "required":[ "sessionId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "sessionId":{ "shape":"String", "documentation":"

The streaming session ID.

", "location":"uri", "locationName":"sessionId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteStreamingSessionResponse":{ "type":"structure", "members":{ "session":{ "shape":"StreamingSession", "documentation":"

The session.

" } } }, "DeleteStudioComponentRequest":{ "type":"structure", "required":[ "studioComponentId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "studioComponentId":{ "shape":"String", "documentation":"

The studio component ID.

", "location":"uri", "locationName":"studioComponentId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteStudioComponentResponse":{ "type":"structure", "members":{ "studioComponent":{ "shape":"StudioComponent", "documentation":"

Information about the studio component.

" } } }, "DeleteStudioMemberRequest":{ "type":"structure", "required":[ "principalId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"uri", "locationName":"principalId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteStudioMemberResponse":{ "type":"structure", "members":{ } }, "DeleteStudioRequest":{ "type":"structure", "required":["studioId"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "DeleteStudioResponse":{ "type":"structure", "required":["studio"], "members":{ "studio":{ "shape":"Studio", "documentation":"

Information about a studio.

" } } }, "DirectoryId":{"type":"string"}, "EC2ImageId":{ "type":"string", "pattern":"^ami-[0-9A-z]+$" }, "EC2SubnetId":{"type":"string"}, "EC2SubnetIdList":{ "type":"list", "member":{"shape":"EC2SubnetId"}, "max":6, "min":0 }, "Eula":{ "type":"structure", "members":{ "content":{ "shape":"String", "documentation":"

The EULA content.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "eulaId":{ "shape":"EulaId", "documentation":"

The EULA ID.

" }, "name":{ "shape":"EulaName", "documentation":"

The name for the EULA.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" } }, "documentation":"

Represents a EULA resource.

" }, "EulaAcceptance":{ "type":"structure", "members":{ "acceptedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the EULA was accepted.

" }, "acceptedBy":{ "shape":"String", "documentation":"

The ID of the person who accepted the EULA.

" }, "accepteeId":{ "shape":"String", "documentation":"

The ID of the acceptee.

" }, "eulaAcceptanceId":{ "shape":"EulaAcceptanceId", "documentation":"

The EULA acceptance ID.

" }, "eulaId":{ "shape":"EulaId", "documentation":"

The EULA ID.

" } }, "documentation":"

The acceptance of a EULA, required to use Amazon-provided streaming images.

" }, "EulaAcceptanceId":{ "type":"string", "documentation":"

The EULA acceptance ID.

", "max":22, "min":0, "pattern":"^[a-zA-Z0-9-_]*$" }, "EulaAcceptanceList":{ "type":"list", "member":{"shape":"EulaAcceptance"} }, "EulaId":{ "type":"string", "documentation":"

Represents a EULA resource.

", "max":22, "min":0, "pattern":"^[a-zA-Z0-9-_]*$" }, "EulaIdList":{ "type":"list", "member":{"shape":"String"} }, "EulaList":{ "type":"list", "member":{"shape":"Eula"} }, "EulaName":{ "type":"string", "max":64, "min":0 }, "ExceptionContext":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, "documentation":"

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.

`ExceptionContext` allows scripts and other programmatic clients to provide better error handling.

" }, "GetEulaRequest":{ "type":"structure", "required":["eulaId"], "members":{ "eulaId":{ "shape":"String", "documentation":"

The EULA ID.

", "location":"uri", "locationName":"eulaId" } } }, "GetEulaResponse":{ "type":"structure", "members":{ "eula":{ "shape":"Eula", "documentation":"

The EULA.

" } } }, "GetLaunchProfileDetailsRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetLaunchProfileDetailsResponse":{ "type":"structure", "members":{ "launchProfile":{ "shape":"LaunchProfile", "documentation":"

The launch profile.

" }, "streamingImages":{ "shape":"StreamingImageList", "documentation":"

A collection of streaming images.

" }, "studioComponentSummaries":{ "shape":"StudioComponentSummaryList", "documentation":"

A collection of studio component summaries.

" } } }, "GetLaunchProfileInitializationRequest":{ "type":"structure", "required":[ "launchProfileId", "launchProfileProtocolVersions", "launchPurpose", "platform", "studioId" ], "members":{ "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "launchProfileProtocolVersions":{ "shape":"StringList", "documentation":"

The launch profile protocol versions supported by the client.

", "location":"querystring", "locationName":"launchProfileProtocolVersions" }, "launchPurpose":{ "shape":"String", "documentation":"

The launch purpose.

", "location":"querystring", "locationName":"launchPurpose" }, "platform":{ "shape":"String", "documentation":"

The platform where this Launch Profile will be used, either Windows or Linux.

", "location":"querystring", "locationName":"platform" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetLaunchProfileInitializationResponse":{ "type":"structure", "members":{ "launchProfileInitialization":{ "shape":"LaunchProfileInitialization", "documentation":"

The launch profile initialization.

" } } }, "GetLaunchProfileMemberRequest":{ "type":"structure", "required":[ "launchProfileId", "principalId", "studioId" ], "members":{ "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"uri", "locationName":"principalId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetLaunchProfileMemberResponse":{ "type":"structure", "members":{ "member":{ "shape":"LaunchProfileMembership", "documentation":"

The member.

" } } }, "GetLaunchProfileRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetLaunchProfileResponse":{ "type":"structure", "members":{ "launchProfile":{ "shape":"LaunchProfile", "documentation":"

The launch profile.

" } } }, "GetStreamingImageRequest":{ "type":"structure", "required":[ "streamingImageId", "studioId" ], "members":{ "streamingImageId":{ "shape":"String", "documentation":"

The streaming image ID.

", "location":"uri", "locationName":"streamingImageId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStreamingImageResponse":{ "type":"structure", "members":{ "streamingImage":{ "shape":"StreamingImage", "documentation":"

The streaming image.

" } } }, "GetStreamingSessionBackupRequest":{ "type":"structure", "required":[ "backupId", "studioId" ], "members":{ "backupId":{ "shape":"String", "documentation":"

The ID of the backup.

", "location":"uri", "locationName":"backupId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStreamingSessionBackupResponse":{ "type":"structure", "members":{ "streamingSessionBackup":{ "shape":"StreamingSessionBackup", "documentation":"

Information about the streaming session backup.

" } } }, "GetStreamingSessionRequest":{ "type":"structure", "required":[ "sessionId", "studioId" ], "members":{ "sessionId":{ "shape":"String", "documentation":"

The streaming session ID.

", "location":"uri", "locationName":"sessionId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStreamingSessionResponse":{ "type":"structure", "members":{ "session":{ "shape":"StreamingSession", "documentation":"

The session.

" } } }, "GetStreamingSessionStreamRequest":{ "type":"structure", "required":[ "sessionId", "streamId", "studioId" ], "members":{ "sessionId":{ "shape":"String", "documentation":"

The streaming session ID.

", "location":"uri", "locationName":"sessionId" }, "streamId":{ "shape":"String", "documentation":"

The streaming session stream ID.

", "location":"uri", "locationName":"streamId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStreamingSessionStreamResponse":{ "type":"structure", "members":{ "stream":{ "shape":"StreamingSessionStream", "documentation":"

The stream.

" } } }, "GetStudioComponentRequest":{ "type":"structure", "required":[ "studioComponentId", "studioId" ], "members":{ "studioComponentId":{ "shape":"String", "documentation":"

The studio component ID.

", "location":"uri", "locationName":"studioComponentId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStudioComponentResponse":{ "type":"structure", "members":{ "studioComponent":{ "shape":"StudioComponent", "documentation":"

Information about the studio component.

" } } }, "GetStudioMemberRequest":{ "type":"structure", "required":[ "principalId", "studioId" ], "members":{ "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"uri", "locationName":"principalId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStudioMemberResponse":{ "type":"structure", "members":{ "member":{ "shape":"StudioMembership", "documentation":"

The member.

" } } }, "GetStudioRequest":{ "type":"structure", "required":["studioId"], "members":{ "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "GetStudioResponse":{ "type":"structure", "required":["studio"], "members":{ "studio":{ "shape":"Studio", "documentation":"

Information about a studio.

" } } }, "InternalServerErrorException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

An internal error has occurred. Please retry your request.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "LaunchProfile":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "createdBy":{ "shape":"String", "documentation":"

The user ID of the user that created the launch profile.

" }, "description":{ "shape":"LaunchProfileDescription", "documentation":"

A human-readable description of the launch profile.

" }, "ec2SubnetIds":{ "shape":"EC2SubnetIdList", "documentation":"

Unique identifiers for a collection of EC2 subnets.

" }, "launchProfileId":{ "shape":"LaunchProfileId", "documentation":"

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

" }, "launchProfileProtocolVersions":{ "shape":"LaunchProfileProtocolVersionList", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

" }, "name":{ "shape":"LaunchProfileName", "documentation":"

A friendly name for the launch profile.

" }, "state":{ "shape":"LaunchProfileState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"LaunchProfileStatusCode", "documentation":"

The status code.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message for the launch profile.

" }, "streamConfiguration":{ "shape":"StreamConfiguration", "documentation":"

A configuration for a streaming session.

" }, "studioComponentIds":{ "shape":"LaunchProfileStudioComponentIdList", "documentation":"

Unique identifiers for a collection of studio components that can be used with this launch profile.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" }, "updatedBy":{ "shape":"String", "documentation":"

The user ID of the user that most recently updated the resource.

" }, "validationResults":{ "shape":"ValidationResults", "documentation":"

The list of the latest validation results.

" } }, "documentation":"

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).

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.

" }, "LaunchProfileDescription":{ "type":"string", "documentation":"

A human-readable description of the launch profile.

", "max":256, "min":0, "sensitive":true }, "LaunchProfileId":{ "type":"string", "max":22, "min":0, "pattern":"^[a-zA-Z0-9-_]*$" }, "LaunchProfileInitialization":{ "type":"structure", "members":{ "activeDirectory":{ "shape":"LaunchProfileInitializationActiveDirectory", "documentation":"

A `LaunchProfileInitializationActiveDirectory` resource.

" }, "ec2SecurityGroupIds":{ "shape":"LaunchProfileSecurityGroupIdList", "documentation":"

The EC2 security groups that control access to the studio component.

" }, "launchProfileId":{ "shape":"LaunchProfileId", "documentation":"

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

" }, "launchProfileProtocolVersion":{ "shape":"LaunchProfileProtocolVersion", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

" }, "launchPurpose":{ "shape":"LaunchPurpose", "documentation":"

The launch purpose.

" }, "name":{ "shape":"LaunchProfileName", "documentation":"

The name for the launch profile.

" }, "platform":{ "shape":"LaunchProfilePlatform", "documentation":"

The platform of the launch platform, either Windows or Linux.

" }, "systemInitializationScripts":{ "shape":"LaunchProfileInitializationScriptList", "documentation":"

The system initializtion scripts.

" }, "userInitializationScripts":{ "shape":"LaunchProfileInitializationScriptList", "documentation":"

The user initializtion scripts.

" } }, "documentation":"

A launch profile initialization contains information required for a workstation or server to connect to a launch profile.

This includes scripts, endpoints, security groups, subnets, and other configuration.

" }, "LaunchProfileInitializationActiveDirectory":{ "type":"structure", "members":{ "computerAttributes":{ "shape":"ActiveDirectoryComputerAttributeList", "documentation":"

A collection of custom attributes for an Active Directory computer.

" }, "directoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.

" }, "directoryName":{ "shape":"String", "documentation":"

The directory name.

" }, "dnsIpAddresses":{ "shape":"ActiveDirectoryDnsIpAddressList", "documentation":"

The DNS IP address.

" }, "organizationalUnitDistinguishedName":{ "shape":"ActiveDirectoryOrganizationalUnitDistinguishedName", "documentation":"

The name for the organizational unit distinguished name.

" }, "studioComponentId":{ "shape":"StudioComponentId", "documentation":"

The unique identifier for a studio component resource.

" }, "studioComponentName":{ "shape":"StudioComponentName", "documentation":"

The name for the studio component.

" } }, "documentation":"

The launch profile initialization Active Directory contains information required for the launch profile to connect to the Active Directory.

" }, "LaunchProfileInitializationScript":{ "type":"structure", "members":{ "runtimeRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

" }, "script":{ "shape":"StudioComponentInitializationScriptContent", "documentation":"

The initialization script.

" }, "secureInitializationRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

" }, "studioComponentId":{ "shape":"StudioComponentId", "documentation":"

The unique identifier for a studio component resource.

" }, "studioComponentName":{ "shape":"StudioComponentName", "documentation":"

The name for the studio component.

" } }, "documentation":"

The launch profile initialization script is used when start streaming session runs.

" }, "LaunchProfileInitializationScriptList":{ "type":"list", "member":{"shape":"LaunchProfileInitializationScript"} }, "LaunchProfileList":{ "type":"list", "member":{"shape":"LaunchProfile"} }, "LaunchProfileMembership":{ "type":"structure", "members":{ "identityStoreId":{ "shape":"String", "documentation":"

The ID of the identity store.

" }, "persona":{ "shape":"LaunchProfilePersona", "documentation":"

The persona.

" }, "principalId":{ "shape":"String", "documentation":"

The principal ID.

" }, "sid":{ "shape":"String", "documentation":"

The Active Directory Security Identifier for this user, if available.

" } }, "documentation":"

Studio admins can use launch profile membership to delegate launch profile access to studio users in the Nimble Studio portal without writing or maintaining complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.

A launch profile member (type USER) provides the following permissions to that launch profile:

- GetLaunchProfile

- GetLaunchProfileInitialization

- GetLaunchProfileMembers

- GetLaunchProfileMember

- CreateStreamingSession

- GetLaunchProfileDetails

" }, "LaunchProfileMembershipList":{ "type":"list", "member":{"shape":"LaunchProfileMembership"}, "max":20, "min":0 }, "LaunchProfileName":{ "type":"string", "max":64, "min":1, "sensitive":true }, "LaunchProfilePersona":{ "type":"string", "enum":["USER"] }, "LaunchProfilePlatform":{ "type":"string", "enum":[ "LINUX", "WINDOWS" ] }, "LaunchProfileProtocolVersion":{ "type":"string", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

", "max":10, "min":0, "pattern":"^2021\\-03\\-31$" }, "LaunchProfileProtocolVersionList":{ "type":"list", "member":{"shape":"LaunchProfileProtocolVersion"} }, "LaunchProfileSecurityGroupIdList":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "min":1 }, "LaunchProfileState":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED" ] }, "LaunchProfileStateList":{ "type":"list", "member":{"shape":"LaunchProfileState"} }, "LaunchProfileStatusCode":{ "type":"string", "enum":[ "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION" ] }, "LaunchProfileStudioComponentIdList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "LaunchProfileValidationState":{ "type":"string", "enum":[ "VALIDATION_NOT_STARTED", "VALIDATION_IN_PROGRESS", "VALIDATION_SUCCESS", "VALIDATION_FAILED", "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" ] }, "LaunchProfileValidationStatusCode":{ "type":"string", "enum":[ "VALIDATION_NOT_STARTED", "VALIDATION_IN_PROGRESS", "VALIDATION_SUCCESS", "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION", "VALIDATION_FAILED_SUBNET_NOT_FOUND", "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION", "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY", "VALIDATION_FAILED_UNAUTHORIZED", "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" ] }, "LaunchProfileValidationStatusMessage":{"type":"string"}, "LaunchProfileValidationType":{ "type":"string", "enum":[ "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT", "VALIDATE_SUBNET_ASSOCIATION", "VALIDATE_NETWORK_ACL_ASSOCIATION", "VALIDATE_SECURITY_GROUP_ASSOCIATION" ] }, "LaunchPurpose":{ "type":"string", "documentation":"

The launch purpose.

", "max":64, "min":0, "pattern":"^[A-Z0-9_]+$" }, "LicenseServiceConfiguration":{ "type":"structure", "members":{ "endpoint":{ "shape":"SensitiveString", "documentation":"

The endpoint of the license service that is accessed by the studio component resource.

" } }, "documentation":"

The configuration for a license service that is associated with a studio resource.

" }, "LinuxMountPoint":{ "type":"string", "max":128, "min":0, "pattern":"^(/?|(\\$HOME)?(/[^/\\n\\s\\\\]+)*)$", "sensitive":true }, "ListEulaAcceptancesRequest":{ "type":"structure", "required":["studioId"], "members":{ "eulaIds":{ "shape":"StringList", "documentation":"

The list of EULA IDs that have been previously accepted.

", "location":"querystring", "locationName":"eulaIds" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListEulaAcceptancesResponse":{ "type":"structure", "members":{ "eulaAcceptances":{ "shape":"EulaAcceptanceList", "documentation":"

A collection of EULA acceptances.

" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" } } }, "ListEulasRequest":{ "type":"structure", "members":{ "eulaIds":{ "shape":"StringList", "documentation":"

The list of EULA IDs that should be returned

", "location":"querystring", "locationName":"eulaIds" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" } } }, "ListEulasResponse":{ "type":"structure", "members":{ "eulas":{ "shape":"EulaList", "documentation":"

A collection of EULA resources.

" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" } } }, "ListLaunchProfileMembersRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The max number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListLaunchProfileMembersResponse":{ "type":"structure", "members":{ "members":{ "shape":"LaunchProfileMembershipList", "documentation":"

A list of members.

" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" } } }, "ListLaunchProfilesRequest":{ "type":"structure", "required":["studioId"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The max number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"querystring", "locationName":"principalId" }, "states":{ "shape":"LaunchProfileStateList", "documentation":"

Filter this request to launch profiles in any of the given states.

", "location":"querystring", "locationName":"states" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListLaunchProfilesResponse":{ "type":"structure", "members":{ "launchProfiles":{ "shape":"LaunchProfileList", "documentation":"

A collection of launch profiles.

" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" } } }, "ListStreamingImagesRequest":{ "type":"structure", "required":["studioId"], "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "owner":{ "shape":"String", "documentation":"

Filter this request to streaming images with the given owner

", "location":"querystring", "locationName":"owner" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListStreamingImagesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" }, "streamingImages":{ "shape":"StreamingImageList", "documentation":"

A collection of streaming images.

" } } }, "ListStreamingSessionBackupsRequest":{ "type":"structure", "required":["studioId"], "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "ownedBy":{ "shape":"String", "documentation":"

The user ID of the user that owns the streaming session.

", "location":"querystring", "locationName":"ownedBy" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListStreamingSessionBackupsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" }, "streamingSessionBackups":{ "shape":"StreamingSessionBackupList", "documentation":"

Information about the streaming session backups.

" } } }, "ListStreamingSessionsRequest":{ "type":"structure", "required":["studioId"], "members":{ "createdBy":{ "shape":"String", "documentation":"

Filters the request to streaming sessions created by the given user.

", "location":"querystring", "locationName":"createdBy" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "ownedBy":{ "shape":"String", "documentation":"

Filters the request to streaming session owned by the given user

", "location":"querystring", "locationName":"ownedBy" }, "sessionIds":{ "shape":"String", "documentation":"

Filters the request to only the provided session IDs.

", "location":"querystring", "locationName":"sessionIds" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListStreamingSessionsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" }, "sessions":{ "shape":"StreamingSessionList", "documentation":"

A collection of streaming sessions.

" } } }, "ListStudioComponentsRequest":{ "type":"structure", "required":["studioId"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The max number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "states":{ "shape":"StudioComponentStateList", "documentation":"

Filters the request to studio components that are in one of the given states.

", "location":"querystring", "locationName":"states" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "types":{ "shape":"StudioComponentTypeList", "documentation":"

Filters the request to studio components that are of one of the given types.

", "location":"querystring", "locationName":"types" } } }, "ListStudioComponentsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" }, "studioComponents":{ "shape":"StudioComponentList", "documentation":"

A collection of studio components.

" } } }, "ListStudioMembersRequest":{ "type":"structure", "required":["studioId"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The max number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "ListStudioMembersResponse":{ "type":"structure", "members":{ "members":{ "shape":"StudioMembershipList", "documentation":"

A list of admin members.

" }, "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" } } }, "ListStudiosRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

", "location":"querystring", "locationName":"nextToken" } } }, "ListStudiosResponse":{ "type":"structure", "required":["studios"], "members":{ "nextToken":{ "shape":"String", "documentation":"

The token for the next set of results, or null if there are no more results.

" }, "studios":{ "shape":"StudioList", "documentation":"

A collection of studios.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

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

" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NewLaunchProfileMember":{ "type":"structure", "required":[ "persona", "principalId" ], "members":{ "persona":{ "shape":"LaunchProfilePersona", "documentation":"

The persona.

" }, "principalId":{ "shape":"String", "documentation":"

The principal ID.

" } }, "documentation":"

A new member that is added to a launch profile.

" }, "NewLaunchProfileMemberList":{ "type":"list", "member":{"shape":"NewLaunchProfileMember"}, "max":20, "min":1 }, "NewStudioMember":{ "type":"structure", "required":[ "persona", "principalId" ], "members":{ "persona":{ "shape":"StudioPersona", "documentation":"

The persona.

" }, "principalId":{ "shape":"String", "documentation":"

The principal ID.

" } }, "documentation":"

A new studio user's membership.

" }, "NewStudioMemberList":{ "type":"list", "member":{"shape":"NewStudioMember"}, "max":20, "min":1 }, "PutLaunchProfileMembersRequest":{ "type":"structure", "required":[ "identityStoreId", "launchProfileId", "members", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "identityStoreId":{ "shape":"String", "documentation":"

The ID of the identity store.

" }, "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "members":{ "shape":"NewLaunchProfileMemberList", "documentation":"

A list of members.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "PutLaunchProfileMembersResponse":{ "type":"structure", "members":{ } }, "PutStudioMembersRequest":{ "type":"structure", "required":[ "identityStoreId", "members", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "identityStoreId":{ "shape":"String", "documentation":"

The ID of the identity store.

" }, "members":{ "shape":"NewStudioMemberList", "documentation":"

A list of members.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "PutStudioMembersResponse":{ "type":"structure", "members":{ } }, "Region":{ "type":"string", "max":50, "min":0, "pattern":"[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

The specified resource could not be found.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RoleArn":{ "type":"string", "max":2048, "min":0 }, "ScriptParameterKey":{ "type":"string", "documentation":"

A script parameter key.

", "max":64, "min":1, "pattern":"^[a-zA-Z_][a-zA-Z0-9_]+$" }, "ScriptParameterKeyValue":{ "type":"structure", "members":{ "key":{ "shape":"ScriptParameterKey", "documentation":"

A script parameter key.

" }, "value":{ "shape":"ScriptParameterValue", "documentation":"

A script parameter value.

" } }, "documentation":"

A parameter for a studio component script, in the form of a key-value pair.

" }, "ScriptParameterValue":{ "type":"string", "documentation":"

A script parameter value.

", "max":256, "min":1 }, "SecurityGroupId":{"type":"string"}, "SensitiveString":{ "type":"string", "sensitive":true }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

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 Amazon Web Services Service Quotas to request an increase.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SessionBackupMode":{ "type":"string", "enum":[ "AUTOMATIC", "DEACTIVATED" ] }, "SessionPersistenceMode":{ "type":"string", "enum":[ "DEACTIVATED", "ACTIVATED" ] }, "SharedFileSystemConfiguration":{ "type":"structure", "members":{ "endpoint":{ "shape":"SensitiveString", "documentation":"

The endpoint of the shared file system that is accessed by the studio component resource.

" }, "fileSystemId":{ "shape":"String", "documentation":"

The unique identifier for a file system.

" }, "linuxMountPoint":{ "shape":"LinuxMountPoint", "documentation":"

The mount location for a shared file system on a Linux virtual workstation.

" }, "shareName":{ "shape":"SensitiveString", "documentation":"

The name of the file share.

" }, "windowsMountDrive":{ "shape":"WindowsMountDrive", "documentation":"

The mount location for a shared file system on a Windows virtual workstation.

" } }, "documentation":"

The configuration for a shared file storage system that is associated with a studio resource.

" }, "StartStreamingSessionRequest":{ "type":"structure", "required":[ "sessionId", "studioId" ], "members":{ "backupId":{ "shape":"String", "documentation":"

The ID of the backup.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "sessionId":{ "shape":"String", "documentation":"

The streaming session ID for the `StartStreamingSessionRequest`.

", "location":"uri", "locationName":"sessionId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID for the StartStreamingSessionRequest.

", "location":"uri", "locationName":"studioId" } } }, "StartStreamingSessionResponse":{ "type":"structure", "members":{ "session":{"shape":"StreamingSession"} } }, "StartStudioSSOConfigurationRepairRequest":{ "type":"structure", "required":["studioId"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "StartStudioSSOConfigurationRepairResponse":{ "type":"structure", "required":["studio"], "members":{ "studio":{ "shape":"Studio", "documentation":"

Information about a studio.

" } } }, "StopStreamingSessionRequest":{ "type":"structure", "required":[ "sessionId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "sessionId":{ "shape":"String", "documentation":"

The streaming session ID for the `StopStreamingSessionRequest`.

", "location":"uri", "locationName":"sessionId" }, "studioId":{ "shape":"String", "documentation":"

The studioId for the StopStreamingSessionRequest.

", "location":"uri", "locationName":"studioId" }, "volumeRetentionMode":{ "shape":"VolumeRetentionMode", "documentation":"

Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

" } } }, "StopStreamingSessionResponse":{ "type":"structure", "members":{ "session":{"shape":"StreamingSession"} } }, "StreamConfiguration":{ "type":"structure", "required":[ "clipboardMode", "ec2InstanceTypes", "streamingImageIds" ], "members":{ "automaticTerminationMode":{ "shape":"AutomaticTerminationMode", "documentation":"

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state.

- When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`.

- When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`. When allowed, the default value for this parameter is `DEACTIVATED`.

" }, "clipboardMode":{ "shape":"StreamingClipboardMode", "documentation":"

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

" }, "ec2InstanceTypes":{ "shape":"StreamingInstanceTypeList", "documentation":"

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

" }, "maxSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxSessionLengthInMinutes", "documentation":"

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.

" }, "maxStoppedSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxStoppedSessionLengthInMinutes", "documentation":"

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.

This field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`.

If the value is 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 (instead of `STOPPED`).

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 (instead of terminated).

" }, "sessionBackup":{ "shape":"StreamConfigurationSessionBackup", "documentation":"

Information about the streaming session backup.

" }, "sessionPersistenceMode":{ "shape":"SessionPersistenceMode", "documentation":"

Determine if a streaming session created from this launch profile can configure persistent storage. This means that `volumeConfiguration` and `automaticTerminationMode` are configured.

" }, "sessionStorage":{ "shape":"StreamConfigurationSessionStorage", "documentation":"

The upload storage for a streaming session.

" }, "streamingImageIds":{ "shape":"StreamingImageIdList", "documentation":"

The streaming images that users can select from when launching a streaming session with this launch profile.

" }, "volumeConfiguration":{ "shape":"VolumeConfiguration", "documentation":"

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`.

" } }, "documentation":"

A configuration for a streaming session.

" }, "StreamConfigurationCreate":{ "type":"structure", "required":[ "clipboardMode", "ec2InstanceTypes", "streamingImageIds" ], "members":{ "automaticTerminationMode":{ "shape":"AutomaticTerminationMode", "documentation":"

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state.

- When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`.

- When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`. When allowed, the default value for this parameter is `DEACTIVATED`.

" }, "clipboardMode":{ "shape":"StreamingClipboardMode", "documentation":"

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

" }, "ec2InstanceTypes":{ "shape":"StreamingInstanceTypeList", "documentation":"

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

" }, "maxSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxSessionLengthInMinutes", "documentation":"

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.

" }, "maxStoppedSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxStoppedSessionLengthInMinutes", "documentation":"

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.

This field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`.

If the value is 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 (instead of `STOPPED`).

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 (instead of terminated).

" }, "sessionBackup":{ "shape":"StreamConfigurationSessionBackup", "documentation":"

Configures how streaming sessions are backed up when launched from this launch profile.

" }, "sessionPersistenceMode":{ "shape":"SessionPersistenceMode", "documentation":"

Determine if a streaming session created from this launch profile can configure persistent storage. This means that `volumeConfiguration` and `automaticTerminationMode` are configured.

" }, "sessionStorage":{ "shape":"StreamConfigurationSessionStorage", "documentation":"

The upload storage for a streaming workstation that is created using this launch profile.

" }, "streamingImageIds":{ "shape":"StreamingImageIdList", "documentation":"

The streaming images that users can select from when launching a streaming session with this launch profile.

" }, "volumeConfiguration":{ "shape":"VolumeConfiguration", "documentation":"

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`.

" } }, "documentation":"

Configuration for streaming workstations created using this launch profile.

" }, "StreamConfigurationMaxBackupsToRetain":{ "type":"integer", "max":10, "min":0 }, "StreamConfigurationMaxSessionLengthInMinutes":{ "type":"integer", "box":true, "max":43200, "min":1 }, "StreamConfigurationMaxStoppedSessionLengthInMinutes":{ "type":"integer", "max":5760, "min":0 }, "StreamConfigurationSessionBackup":{ "type":"structure", "members":{ "maxBackupsToRetain":{ "shape":"StreamConfigurationMaxBackupsToRetain", "documentation":"

The maximum number of backups that each streaming session created from this launch profile can have.

" }, "mode":{ "shape":"SessionBackupMode", "documentation":"

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is `DEACTIVATED`, which means that backups are deactivated. To allow backups, set this value to `AUTOMATIC`.

" } }, "documentation":"

Configures how streaming sessions are backed up when launched from this launch profile.

" }, "StreamConfigurationSessionStorage":{ "type":"structure", "required":["mode"], "members":{ "mode":{ "shape":"StreamingSessionStorageModeList", "documentation":"

Allows artists to upload files to their workstations. The only valid option is `UPLOAD`.

" }, "root":{ "shape":"StreamingSessionStorageRoot", "documentation":"

The configuration for the upload storage root of the streaming session.

" } }, "documentation":"

The configuration for a streaming session’s upload storage.

" }, "StreamingClipboardMode":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "StreamingImage":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "description":{ "shape":"StreamingImageDescription", "documentation":"

A human-readable description of the streaming image.

" }, "ec2ImageId":{ "shape":"EC2ImageId", "documentation":"

The ID of an EC2 machine image with which to create the streaming image.

" }, "encryptionConfiguration":{ "shape":"StreamingImageEncryptionConfiguration", "documentation":"

The encryption configuration.

" }, "eulaIds":{ "shape":"EulaIdList", "documentation":"

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

" }, "name":{ "shape":"StreamingImageName", "documentation":"

A friendly name for a streaming image resource.

" }, "owner":{ "shape":"StreamingImageOwner", "documentation":"

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.

" }, "platform":{ "shape":"StreamingImagePlatform", "documentation":"

The platform of the streaming image, either Windows or Linux.

" }, "state":{ "shape":"StreamingImageState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"StreamingImageStatusCode", "documentation":"

The status code.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message for the streaming image.

" }, "streamingImageId":{ "shape":"StreamingImageId", "documentation":"

The ID of the streaming image.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" } }, "documentation":"

Represents a streaming image resource.

Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

Amazon provides a number of streaming images that include popular 3rd-party software.

You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.

" }, "StreamingImageDescription":{ "type":"string", "documentation":"

The description.

", "max":256, "min":0, "sensitive":true }, "StreamingImageEncryptionConfiguration":{ "type":"structure", "required":["keyType"], "members":{ "keyArn":{ "shape":"StreamingImageEncryptionConfigurationKeyArn", "documentation":"

The ARN for a KMS key that is used to encrypt studio data.

" }, "keyType":{ "shape":"StreamingImageEncryptionConfigurationKeyType", "documentation":"

The type of KMS key that is used to encrypt studio data.

" } }, "documentation":"

Specifies how a streaming image is encrypted.

" }, "StreamingImageEncryptionConfigurationKeyArn":{ "type":"string", "min":4, "pattern":"^arn:.*" }, "StreamingImageEncryptionConfigurationKeyType":{ "type":"string", "enum":["CUSTOMER_MANAGED_KEY"] }, "StreamingImageId":{ "type":"string", "max":22, "min":0, "pattern":"^[a-zA-Z0-9-_]*$" }, "StreamingImageIdList":{ "type":"list", "member":{"shape":"StreamingImageId"}, "documentation":"

A list of streaming image IDs that users can select from when launching a streaming session with this launch profile.

", "max":20, "min":1 }, "StreamingImageList":{ "type":"list", "member":{"shape":"StreamingImage"} }, "StreamingImageName":{ "type":"string", "documentation":"

A friendly name for a streaming image resource.

", "max":64, "min":0, "sensitive":true }, "StreamingImageOwner":{ "type":"string", "documentation":"

StreamingImageOwner is the owner of a particular streaming image.

This string is either the studioId that contains the streaming image, or the word `AMAZON` for images provided by Nimble Studio.

" }, "StreamingImagePlatform":{ "type":"string", "documentation":"

The platform of this streaming image, either Windows or Linux.

", "pattern":"^[a-zA-Z]*$" }, "StreamingImageState":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED" ] }, "StreamingImageStatusCode":{ "type":"string", "documentation":"

The status code.

", "enum":[ "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR", "ACCESS_DENIED" ] }, "StreamingInstanceType":{ "type":"string", "enum":[ "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g3.4xlarge", "g3s.xlarge", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.16xlarge" ] }, "StreamingInstanceTypeList":{ "type":"list", "member":{"shape":"StreamingInstanceType"}, "documentation":"

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

", "max":30, "min":1 }, "StreamingSession":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "automaticTerminationMode":{ "shape":"AutomaticTerminationMode", "documentation":"

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state.

- When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`.

- When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`. When allowed, the default value for this parameter is `DEACTIVATED`.

" }, "backupMode":{ "shape":"SessionBackupMode", "documentation":"

Shows the current backup setting of the session.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "createdBy":{ "shape":"String", "documentation":"

The user ID of the user that created the streaming session.

" }, "ec2InstanceType":{ "shape":"String", "documentation":"

The EC2 Instance type used for the streaming session.

" }, "launchProfileId":{ "shape":"String", "documentation":"

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

" }, "maxBackupsToRetain":{ "shape":"StreamConfigurationMaxBackupsToRetain", "documentation":"

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

" }, "ownedBy":{ "shape":"String", "documentation":"

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.

" }, "sessionId":{ "shape":"StreamingSessionId", "documentation":"

The session ID.

" }, "sessionPersistenceMode":{ "shape":"SessionPersistenceMode", "documentation":"

Determine if a streaming session created from this launch profile can configure persistent storage. This means that `volumeConfiguration` and `automaticTerminationMode` are configured.

" }, "startedAt":{ "shape":"Timestamp", "documentation":"

The time the session entered `START_IN_PROGRESS` state.

" }, "startedBy":{ "shape":"String", "documentation":"

The user ID of the user that started the streaming session.

" }, "startedFromBackupId":{ "shape":"String", "documentation":"

The backup ID used to restore a streaming session.

" }, "state":{ "shape":"StreamingSessionState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"StreamingSessionStatusCode", "documentation":"

The status code.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message for the streaming session.

" }, "stopAt":{ "shape":"Timestamp", "documentation":"

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

" }, "stoppedAt":{ "shape":"Timestamp", "documentation":"

The time the session entered `STOP_IN_PROGRESS` state.

" }, "stoppedBy":{ "shape":"String", "documentation":"

The user ID of the user that stopped the streaming session.

" }, "streamingImageId":{ "shape":"StreamingImageId", "documentation":"

The ID of the streaming image.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "terminateAt":{ "shape":"Timestamp", "documentation":"

The time the streaming session will automatically terminate if not terminated by the user.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" }, "updatedBy":{ "shape":"String", "documentation":"

The user ID of the user that most recently updated the resource.

" }, "volumeConfiguration":{ "shape":"VolumeConfiguration", "documentation":"

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`.

" }, "volumeRetentionMode":{ "shape":"VolumeRetentionMode", "documentation":"

Determine if an EBS volume created from this streaming session will be backed up.

" } }, "documentation":"

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

" }, "StreamingSessionBackup":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "backupId":{ "shape":"String", "documentation":"

The ID of the backup.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in for when the resource was created.

" }, "launchProfileId":{ "shape":"String", "documentation":"

The ID of the launch profile which allowed the backups for the streaming session.

" }, "ownedBy":{ "shape":"String", "documentation":"

The user ID of the user that owns the streaming session.

" }, "sessionId":{ "shape":"StreamingSessionId", "documentation":"

The streaming session ID for the `StreamingSessionBackup`.

" }, "state":{"shape":"StreamingSessionState"}, "statusCode":{ "shape":"StreamingSessionStatusCode", "documentation":"

The status code.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message for the streaming session backup.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" } }, "documentation":"

Information about the streaming session backup.

" }, "StreamingSessionBackupList":{ "type":"list", "member":{"shape":"StreamingSessionBackup"} }, "StreamingSessionId":{"type":"string"}, "StreamingSessionList":{ "type":"list", "member":{"shape":"StreamingSession"} }, "StreamingSessionState":{ "type":"string", "documentation":"

The streaming session state.

", "enum":[ "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED" ] }, "StreamingSessionStatusCode":{ "type":"string", "enum":[ "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR" ] }, "StreamingSessionStorageMode":{ "type":"string", "enum":["UPLOAD"] }, "StreamingSessionStorageModeList":{ "type":"list", "member":{"shape":"StreamingSessionStorageMode"}, "min":1 }, "StreamingSessionStorageRoot":{ "type":"structure", "members":{ "linux":{ "shape":"StreamingSessionStorageRootPathLinux", "documentation":"

The folder path in Linux workstations where files are uploaded.

" }, "windows":{ "shape":"StreamingSessionStorageRootPathWindows", "documentation":"

The folder path in Windows workstations where files are uploaded.

" } }, "documentation":"

The upload storage root location (folder) on streaming workstations where files are uploaded.

" }, "StreamingSessionStorageRootPathLinux":{ "type":"string", "max":128, "min":1, "pattern":"^(\\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$", "sensitive":true }, "StreamingSessionStorageRootPathWindows":{ "type":"string", "max":128, "min":1, "pattern":"^((\\%HOMEPATH\\%)|[a-zA-Z]:)[\\\\/](?:[a-zA-Z0-9_-]+[\\\\/])*[a-zA-Z0-9_-]+$", "sensitive":true }, "StreamingSessionStream":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "createdBy":{ "shape":"String", "documentation":"

The user ID of the user that created the streaming session stream.

" }, "expiresAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource expires.

" }, "ownedBy":{ "shape":"String", "documentation":"

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.

" }, "state":{ "shape":"StreamingSessionStreamState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"StreamingSessionStreamStatusCode", "documentation":"

The streaming session stream status code.

" }, "streamId":{ "shape":"String", "documentation":"

The stream ID.

" }, "url":{ "shape":"SensitiveString", "documentation":"

The URL to connect to this stream using the DCV client.

" } }, "documentation":"

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.

" }, "StreamingSessionStreamExpirationInSeconds":{ "type":"integer", "box":true, "max":3600, "min":60 }, "StreamingSessionStreamState":{ "type":"string", "enum":[ "READY", "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "CREATE_FAILED", "DELETE_FAILED" ] }, "StreamingSessionStreamStatusCode":{ "type":"string", "enum":[ "STREAM_CREATE_IN_PROGRESS", "STREAM_READY", "STREAM_DELETE_IN_PROGRESS", "STREAM_DELETED", "INTERNAL_ERROR", "NETWORK_CONNECTION_ERROR" ] }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Studio":{ "type":"structure", "members":{ "adminRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

" }, "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "displayName":{ "shape":"StudioDisplayName", "documentation":"

A friendly name for the studio.

" }, "homeRegion":{ "shape":"Region", "documentation":"

The Amazon Web Services Region where the studio resource is located.

" }, "ssoClientId":{ "shape":"String", "documentation":"

The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.

" }, "state":{ "shape":"StudioState", "documentation":"

The current state of the studio resource.

" }, "statusCode":{ "shape":"StudioStatusCode", "documentation":"

Status codes that provide additional detail on the studio state.

" }, "statusMessage":{ "shape":"String", "documentation":"

Additional detail on the studio state.

" }, "studioEncryptionConfiguration":{ "shape":"StudioEncryptionConfiguration", "documentation":"

Configuration of the encryption method that is used for the studio.

" }, "studioId":{ "shape":"String", "documentation":"

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

" }, "studioName":{ "shape":"StudioName", "documentation":"

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

" }, "studioUrl":{ "shape":"String", "documentation":"

The address of the web page for the studio.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" }, "userRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that studio users assume when logging in to the Nimble Studio portal.

" } }, "documentation":"

Represents a studio resource.

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.

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 IAM Identity Center and your identity source.

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.

Your studio roles must trust the `identity.nimble.amazonaws.com` service principal to function properly.

" }, "StudioComponent":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

" }, "configuration":{ "shape":"StudioComponentConfiguration", "documentation":"

The configuration of the studio component, based on component type.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "createdBy":{ "shape":"String", "documentation":"

The user ID of the user that created the studio component.

" }, "description":{ "shape":"StudioComponentDescription", "documentation":"

A human-readable description for the studio component resource.

" }, "ec2SecurityGroupIds":{ "shape":"StudioComponentSecurityGroupIdList", "documentation":"

The EC2 security groups that control access to the studio component.

" }, "initializationScripts":{ "shape":"StudioComponentInitializationScriptList", "documentation":"

Initialization scripts for studio components.

" }, "name":{ "shape":"StudioComponentName", "documentation":"

A friendly name for the studio component resource.

" }, "runtimeRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", "documentation":"

Parameters for the studio component scripts.

" }, "secureInitializationRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

" }, "state":{ "shape":"StudioComponentState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"StudioComponentStatusCode", "documentation":"

The status code.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message for the studio component.

" }, "studioComponentId":{ "shape":"StudioComponentId", "documentation":"

The unique identifier for a studio component resource.

" }, "subtype":{ "shape":"StudioComponentSubtype", "documentation":"

The specific subtype of a studio component.

" }, "tags":{ "shape":"Tags", "documentation":"

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

" }, "type":{ "shape":"StudioComponentType", "documentation":"

The type of the studio component.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" }, "updatedBy":{ "shape":"String", "documentation":"

The user ID of the user that most recently updated the resource.

" } }, "documentation":"

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.

Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

A studio component also has a set of initialization scripts that are returned by `GetLaunchProfileInitialization`. 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.

" }, "StudioComponentConfiguration":{ "type":"structure", "members":{ "activeDirectoryConfiguration":{ "shape":"ActiveDirectoryConfiguration", "documentation":"

The configuration for a Directory Service for Microsoft Active Directory studio resource.

" }, "computeFarmConfiguration":{ "shape":"ComputeFarmConfiguration", "documentation":"

The configuration for a render farm that is associated with a studio resource.

" }, "licenseServiceConfiguration":{ "shape":"LicenseServiceConfiguration", "documentation":"

The configuration for a license service that is associated with a studio resource.

" }, "sharedFileSystemConfiguration":{ "shape":"SharedFileSystemConfiguration", "documentation":"

The configuration for a shared file storage system that is associated with a studio resource.

" } }, "documentation":"

The configuration of the studio component, based on component type.

", "union":true }, "StudioComponentDescription":{ "type":"string", "max":256, "min":0, "sensitive":true }, "StudioComponentId":{ "type":"string", "max":22, "min":0, "pattern":"^[a-zA-Z0-9-_]*$" }, "StudioComponentInitializationScript":{ "type":"structure", "members":{ "launchProfileProtocolVersion":{ "shape":"LaunchProfileProtocolVersion", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

" }, "platform":{ "shape":"LaunchProfilePlatform", "documentation":"

The platform of the initialization script, either Windows or Linux.

" }, "runContext":{ "shape":"StudioComponentInitializationScriptRunContext", "documentation":"

The method to use when running the initialization script.

" }, "script":{ "shape":"StudioComponentInitializationScriptContent", "documentation":"

The initialization script.

" } }, "documentation":"

Initialization scripts for studio components.

" }, "StudioComponentInitializationScriptContent":{ "type":"string", "max":5120, "min":1, "sensitive":true }, "StudioComponentInitializationScriptList":{ "type":"list", "member":{"shape":"StudioComponentInitializationScript"} }, "StudioComponentInitializationScriptRunContext":{ "type":"string", "enum":[ "SYSTEM_INITIALIZATION", "USER_INITIALIZATION" ] }, "StudioComponentList":{ "type":"list", "member":{"shape":"StudioComponent"}, "max":50, "min":0 }, "StudioComponentName":{ "type":"string", "max":64, "min":0, "sensitive":true }, "StudioComponentScriptParameterKeyValueList":{ "type":"list", "member":{"shape":"ScriptParameterKeyValue"}, "max":30, "min":0, "sensitive":true }, "StudioComponentSecurityGroupIdList":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":30, "min":0 }, "StudioComponentState":{ "type":"string", "documentation":"

The current state of the studio component resource.

While a studio component is being created, modified, or deleted, its state will be `CREATE_IN_PROGRESS`, `UPDATE_IN_PROGRESS`, or `DELETE_IN_PROGRESS`.

These are called transition states.

No modifications may be made to the studio component while it is in a transition state.

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.

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.

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.

", "enum":[ "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED" ] }, "StudioComponentStateList":{ "type":"list", "member":{"shape":"StudioComponentState"} }, "StudioComponentStatusCode":{ "type":"string", "documentation":"

The current status of the studio component resource.

When the resource is in the `READY` state, the status code signals what the last mutation made to the resource was.

When the resource is in a `CREATE_FAILED`, `UPDATE_FAILED`, or `DELETE_FAILED` state, the status code signals what went wrong and why the mutation failed.

", "enum":[ "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR" ] }, "StudioComponentSubtype":{ "type":"string", "enum":[ "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM" ] }, "StudioComponentSummary":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was created.

" }, "createdBy":{ "shape":"String", "documentation":"

The user ID of the user that created the studio component.

" }, "description":{ "shape":"StudioComponentDescription", "documentation":"

The description.

" }, "name":{ "shape":"StudioComponentName", "documentation":"

The name for the studio component.

" }, "studioComponentId":{ "shape":"StudioComponentId", "documentation":"

The unique identifier for a studio component resource.

" }, "subtype":{ "shape":"StudioComponentSubtype", "documentation":"

The specific subtype of a studio component.

" }, "type":{ "shape":"StudioComponentType", "documentation":"

The type of the studio component.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The ISO timestamp in seconds for when the resource was updated.

" }, "updatedBy":{ "shape":"String", "documentation":"

The user ID of the user that most recently updated the resource.

" } }, "documentation":"

The studio component's summary.

" }, "StudioComponentSummaryList":{ "type":"list", "member":{"shape":"StudioComponentSummary"} }, "StudioComponentType":{ "type":"string", "enum":[ "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM" ] }, "StudioComponentTypeList":{ "type":"list", "member":{"shape":"StudioComponentType"} }, "StudioDisplayName":{ "type":"string", "max":64, "min":0, "sensitive":true }, "StudioEncryptionConfiguration":{ "type":"structure", "required":["keyType"], "members":{ "keyArn":{ "shape":"StudioEncryptionConfigurationKeyArn", "documentation":"

The ARN for a KMS key that is used to encrypt studio data.

" }, "keyType":{ "shape":"StudioEncryptionConfigurationKeyType", "documentation":"

The type of KMS key that is used to encrypt studio data.

" } }, "documentation":"

Configuration of the encryption method that is used for the studio.

" }, "StudioEncryptionConfigurationKeyArn":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) for a KMS key that is used to encrypt studio data.

", "min":4, "pattern":"^arn:.*" }, "StudioEncryptionConfigurationKeyType":{ "type":"string", "documentation":"

The type of KMS key that is used to encrypt studio data.

", "enum":[ "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY" ] }, "StudioList":{ "type":"list", "member":{"shape":"Studio"} }, "StudioMembership":{ "type":"structure", "members":{ "identityStoreId":{ "shape":"String", "documentation":"

The ID of the identity store.

" }, "persona":{ "shape":"StudioPersona", "documentation":"

The persona.

" }, "principalId":{ "shape":"String", "documentation":"

The principal ID.

" }, "sid":{ "shape":"String", "documentation":"

The Active Directory Security Identifier for this user, if available.

" } }, "documentation":"

A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.

When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center 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.

When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.

" }, "StudioMembershipList":{ "type":"list", "member":{"shape":"StudioMembership"}, "max":20, "min":0 }, "StudioName":{ "type":"string", "max":64, "min":3, "pattern":"^[a-z0-9]*$" }, "StudioPersona":{ "type":"string", "enum":["ADMINISTRATOR"] }, "StudioState":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED" ] }, "StudioStatusCode":{ "type":"string", "documentation":"

The status code.

", "enum":[ "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED" ] }, "TagResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource you want to add tags to.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"Tags", "documentation":"

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

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "Tags":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "ThrottlingException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

The request throughput limit was exceeded.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"

Identifies the Amazon Resource Name(ARN) key from which you are removing tags.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"StringList", "documentation":"

One or more tag keys. Specify only the tag keys, not the tag values.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateLaunchProfileMemberRequest":{ "type":"structure", "required":[ "launchProfileId", "persona", "principalId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "persona":{ "shape":"LaunchProfilePersona", "documentation":"

The persona.

" }, "principalId":{ "shape":"String", "documentation":"

The principal ID. This currently supports a IAM Identity Center UserId.

", "location":"uri", "locationName":"principalId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "UpdateLaunchProfileMemberResponse":{ "type":"structure", "members":{ "member":{ "shape":"LaunchProfileMembership", "documentation":"

The updated member.

" } } }, "UpdateLaunchProfileRequest":{ "type":"structure", "required":[ "launchProfileId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "description":{ "shape":"LaunchProfileDescription", "documentation":"

The description.

" }, "launchProfileId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"launchProfileId" }, "launchProfileProtocolVersions":{ "shape":"LaunchProfileProtocolVersionList", "documentation":"

The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".

" }, "name":{ "shape":"LaunchProfileName", "documentation":"

The name for the launch profile.

" }, "streamConfiguration":{ "shape":"StreamConfigurationCreate", "documentation":"

A configuration for a streaming session.

" }, "studioComponentIds":{ "shape":"LaunchProfileStudioComponentIdList", "documentation":"

Unique identifiers for a collection of studio components that can be used with this launch profile.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "UpdateLaunchProfileResponse":{ "type":"structure", "members":{ "launchProfile":{ "shape":"LaunchProfile", "documentation":"

The launch profile.

" } } }, "UpdateStreamingImageRequest":{ "type":"structure", "required":[ "streamingImageId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "description":{ "shape":"StreamingImageDescription", "documentation":"

The description.

" }, "name":{ "shape":"StreamingImageName", "documentation":"

The name for the streaming image.

" }, "streamingImageId":{ "shape":"String", "documentation":"

The streaming image ID.

", "location":"uri", "locationName":"streamingImageId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" } } }, "UpdateStreamingImageResponse":{ "type":"structure", "members":{ "streamingImage":{"shape":"StreamingImage"} } }, "UpdateStudioComponentRequest":{ "type":"structure", "required":[ "studioComponentId", "studioId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "configuration":{ "shape":"StudioComponentConfiguration", "documentation":"

The configuration of the studio component, based on component type.

" }, "description":{ "shape":"StudioComponentDescription", "documentation":"

The description.

" }, "ec2SecurityGroupIds":{ "shape":"StudioComponentSecurityGroupIdList", "documentation":"

The EC2 security groups that control access to the studio component.

" }, "initializationScripts":{ "shape":"StudioComponentInitializationScriptList", "documentation":"

Initialization scripts for studio components.

" }, "name":{ "shape":"StudioComponentName", "documentation":"

The name for the studio component.

" }, "runtimeRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", "documentation":"

Parameters for the studio component scripts.

" }, "secureInitializationRoleArn":{ "shape":"RoleArn", "documentation":"

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

" }, "studioComponentId":{ "shape":"String", "documentation":"

The studio component ID.

", "location":"uri", "locationName":"studioComponentId" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "subtype":{ "shape":"StudioComponentSubtype", "documentation":"

The specific subtype of a studio component.

" }, "type":{ "shape":"StudioComponentType", "documentation":"

The type of the studio component.

" } } }, "UpdateStudioComponentResponse":{ "type":"structure", "members":{ "studioComponent":{ "shape":"StudioComponent", "documentation":"

Information about the studio component.

" } } }, "UpdateStudioRequest":{ "type":"structure", "required":["studioId"], "members":{ "adminRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

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

", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "displayName":{ "shape":"StudioDisplayName", "documentation":"

A friendly name for the studio.

" }, "studioId":{ "shape":"String", "documentation":"

The studio ID.

", "location":"uri", "locationName":"studioId" }, "userRoleArn":{ "shape":"RoleArn", "documentation":"

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

" } } }, "UpdateStudioResponse":{ "type":"structure", "required":["studio"], "members":{ "studio":{ "shape":"Studio", "documentation":"

Information about a studio.

" } } }, "ValidationException":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"

A more specific error code.

" }, "context":{ "shape":"ExceptionContext", "documentation":"

The exception context.

" }, "message":{ "shape":"String", "documentation":"

A human-readable description of the error.

" } }, "documentation":"

One of the parameters in the request is invalid.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationResult":{ "type":"structure", "required":[ "state", "statusCode", "statusMessage", "type" ], "members":{ "state":{ "shape":"LaunchProfileValidationState", "documentation":"

The current state.

" }, "statusCode":{ "shape":"LaunchProfileValidationStatusCode", "documentation":"

The status code. This will contain the failure reason if the state is `VALIDATION_FAILED`.

" }, "statusMessage":{ "shape":"LaunchProfileValidationStatusMessage", "documentation":"

The status message for the validation result.

" }, "type":{ "shape":"LaunchProfileValidationType", "documentation":"

The type of the validation result.

" } }, "documentation":"

The launch profile validation result.

" }, "ValidationResults":{ "type":"list", "member":{"shape":"ValidationResult"} }, "VolumeConfiguration":{ "type":"structure", "members":{ "iops":{ "shape":"VolumeIops", "documentation":"

The number of I/O operations per second for the root volume that is attached to streaming session.

" }, "size":{ "shape":"VolumeSizeInGiB", "documentation":"

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

" }, "throughput":{ "shape":"VolumeThroughputInMiBs", "documentation":"

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

" } }, "documentation":"

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`.

" }, "VolumeIops":{ "type":"integer", "box":true, "max":16000, "min":3000 }, "VolumeRetentionMode":{ "type":"string", "enum":[ "RETAIN", "DELETE" ] }, "VolumeSizeInGiB":{ "type":"integer", "box":true, "max":16000, "min":100 }, "VolumeThroughputInMiBs":{ "type":"integer", "box":true, "max":1000, "min":125 }, "WindowsMountDrive":{ "type":"string", "pattern":"^[A-Z]$" } }, "documentation":"

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.

" }