@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonNimbleStudio extends Object implements AmazonNimbleStudio
AmazonNimbleStudio. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic AcceptEulasResult acceptEulas(AcceptEulasRequest request)
AmazonNimbleStudioAccept EULAs.
acceptEulas in interface AmazonNimbleStudiopublic CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest request)
AmazonNimbleStudioCreate a launch profile.
createLaunchProfile in interface AmazonNimbleStudiopublic CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest request)
AmazonNimbleStudioCreates a streaming image resource in a studio.
createStreamingImage in interface AmazonNimbleStudiopublic CreateStreamingSessionResult createStreamingSession(CreateStreamingSessionRequest request)
AmazonNimbleStudioCreates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY state.
createStreamingSession in interface AmazonNimbleStudiopublic CreateStreamingSessionStreamResult createStreamingSessionStream(CreateStreamingSessionStreamRequest request)
AmazonNimbleStudioCreates 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.
createStreamingSessionStream in interface AmazonNimbleStudiopublic CreateStudioResult createStudio(CreateStudioRequest request)
AmazonNimbleStudioCreate 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.
createStudio in interface AmazonNimbleStudiopublic CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest request)
AmazonNimbleStudioCreates a studio component resource.
createStudioComponent in interface AmazonNimbleStudiopublic DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest request)
AmazonNimbleStudioPermanently delete a launch profile.
deleteLaunchProfile in interface AmazonNimbleStudiopublic DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest request)
AmazonNimbleStudioDelete a user from launch profile membership.
deleteLaunchProfileMember in interface AmazonNimbleStudiopublic DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest request)
AmazonNimbleStudioDelete streaming image.
deleteStreamingImage in interface AmazonNimbleStudiopublic DeleteStreamingSessionResult deleteStreamingSession(DeleteStreamingSessionRequest request)
AmazonNimbleStudioDeletes 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.
deleteStreamingSession in interface AmazonNimbleStudiopublic DeleteStudioResult deleteStudio(DeleteStudioRequest request)
AmazonNimbleStudioDelete a studio resource.
deleteStudio in interface AmazonNimbleStudiopublic DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest request)
AmazonNimbleStudioDeletes a studio component resource.
deleteStudioComponent in interface AmazonNimbleStudiopublic DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest request)
AmazonNimbleStudioDelete a user from studio membership.
deleteStudioMember in interface AmazonNimbleStudiopublic GetEulaResult getEula(GetEulaRequest request)
AmazonNimbleStudioGet EULA.
getEula in interface AmazonNimbleStudiopublic GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest request)
AmazonNimbleStudioGet a launch profile.
getLaunchProfile in interface AmazonNimbleStudiopublic GetLaunchProfileDetailsResult getLaunchProfileDetails(GetLaunchProfileDetailsRequest request)
AmazonNimbleStudioLaunch 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.
getLaunchProfileDetails in interface AmazonNimbleStudiopublic GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest request)
AmazonNimbleStudioGet a launch profile initialization.
getLaunchProfileInitialization in interface AmazonNimbleStudiopublic GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest request)
AmazonNimbleStudioGet a user persona in launch profile membership.
getLaunchProfileMember in interface AmazonNimbleStudiopublic GetStreamingImageResult getStreamingImage(GetStreamingImageRequest request)
AmazonNimbleStudioGet streaming image.
getStreamingImage in interface AmazonNimbleStudiopublic GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest request)
AmazonNimbleStudioGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSession in interface AmazonNimbleStudiopublic GetStreamingSessionBackupResult getStreamingSessionBackup(GetStreamingSessionBackupRequest request)
AmazonNimbleStudio
Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackup in interface AmazonNimbleStudiopublic GetStreamingSessionStreamResult getStreamingSessionStream(GetStreamingSessionStreamRequest request)
AmazonNimbleStudioGets 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.
getStreamingSessionStream in interface AmazonNimbleStudiopublic GetStudioResult getStudio(GetStudioRequest request)
AmazonNimbleStudioGet a studio resource.
getStudio in interface AmazonNimbleStudiopublic GetStudioComponentResult getStudioComponent(GetStudioComponentRequest request)
AmazonNimbleStudioGets a studio component resource.
getStudioComponent in interface AmazonNimbleStudiopublic GetStudioMemberResult getStudioMember(GetStudioMemberRequest request)
AmazonNimbleStudioGet a user's membership in a studio.
getStudioMember in interface AmazonNimbleStudiopublic ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest request)
AmazonNimbleStudioList EULA acceptances.
listEulaAcceptances in interface AmazonNimbleStudiopublic ListEulasResult listEulas(ListEulasRequest request)
AmazonNimbleStudioList EULAs.
listEulas in interface AmazonNimbleStudiopublic ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest request)
AmazonNimbleStudioGet all users in a given launch profile membership.
listLaunchProfileMembers in interface AmazonNimbleStudiopublic ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest request)
AmazonNimbleStudioList all the launch profiles a studio.
listLaunchProfiles in interface AmazonNimbleStudiopublic ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest request)
AmazonNimbleStudioList 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.
listStreamingImages in interface AmazonNimbleStudiopublic ListStreamingSessionBackupsResult listStreamingSessionBackups(ListStreamingSessionBackupsRequest request)
AmazonNimbleStudioLists the backups of a streaming session in a studio.
listStreamingSessionBackups in interface AmazonNimbleStudiopublic ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest request)
AmazonNimbleStudioLists the streaming sessions in a studio.
listStreamingSessions in interface AmazonNimbleStudiopublic ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest request)
AmazonNimbleStudio
Lists the StudioComponents in a studio.
listStudioComponents in interface AmazonNimbleStudiopublic ListStudioMembersResult listStudioMembers(ListStudioMembersRequest request)
AmazonNimbleStudioGet all users in a given studio membership.
ListStudioMembers only returns admin members.
listStudioMembers in interface AmazonNimbleStudiopublic ListStudiosResult listStudios(ListStudiosRequest request)
AmazonNimbleStudioList studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudios in interface AmazonNimbleStudiopublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonNimbleStudioGets 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.
listTagsForResource in interface AmazonNimbleStudiopublic PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest request)
AmazonNimbleStudioAdd/update users with given persona to launch profile membership.
putLaunchProfileMembers in interface AmazonNimbleStudiopublic PutStudioMembersResult putStudioMembers(PutStudioMembersRequest request)
AmazonNimbleStudioAdd/update users with given persona to studio membership.
putStudioMembers in interface AmazonNimbleStudiopublic StartStreamingSessionResult startStreamingSession(StartStreamingSessionRequest request)
AmazonNimbleStudio
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.
startStreamingSession in interface AmazonNimbleStudiopublic StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest request)
AmazonNimbleStudioRepairs 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.
startStudioSSOConfigurationRepair in interface AmazonNimbleStudiopublic StopStreamingSessionResult stopStreamingSession(StopStreamingSessionRequest request)
AmazonNimbleStudio
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.
stopStreamingSession in interface AmazonNimbleStudiopublic TagResourceResult tagResource(TagResourceRequest request)
AmazonNimbleStudioCreates tags for a resource, given its ARN.
tagResource in interface AmazonNimbleStudiopublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonNimbleStudioDeletes the tags for a resource.
untagResource in interface AmazonNimbleStudiopublic UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest request)
AmazonNimbleStudioUpdate a launch profile.
updateLaunchProfile in interface AmazonNimbleStudiopublic UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest request)
AmazonNimbleStudioUpdate a user persona in launch profile membership.
updateLaunchProfileMember in interface AmazonNimbleStudiopublic UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest request)
AmazonNimbleStudioUpdate streaming image.
updateStreamingImage in interface AmazonNimbleStudiopublic UpdateStudioResult updateStudio(UpdateStudioRequest request)
AmazonNimbleStudioUpdate a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudio in interface AmazonNimbleStudiopublic UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest request)
AmazonNimbleStudioUpdates a studio component resource.
updateStudioComponent in interface AmazonNimbleStudiopublic void shutdown()
AmazonNimbleStudioshutdown in interface AmazonNimbleStudiopublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonNimbleStudioResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonNimbleStudiorequest - The originally executed request.public AmazonNimbleStudioWaiters waiters()
waiters in interface AmazonNimbleStudio