@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_PREFIX
public AcceptEulasResult acceptEulas(AcceptEulasRequest request)
AmazonNimbleStudio
Accept EULAs.
acceptEulas
in interface AmazonNimbleStudio
request
- A collection of EULA acceptances.public CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest request)
AmazonNimbleStudio
Create a launch profile.
createLaunchProfile
in interface AmazonNimbleStudio
request
- A collection of launch profiles.public CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest request)
AmazonNimbleStudio
Creates a streaming image resource in a studio.
createStreamingImage
in interface AmazonNimbleStudio
request
- A collection of streaming images.public CreateStreamingSessionResult createStreamingSession(CreateStreamingSessionRequest request)
AmazonNimbleStudio
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.
createStreamingSession
in interface AmazonNimbleStudio
request
- A collection of streaming sessions.public CreateStreamingSessionStreamResult createStreamingSessionStream(CreateStreamingSessionStreamRequest request)
AmazonNimbleStudio
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.
createStreamingSessionStream
in interface AmazonNimbleStudio
request
- A list collection streams.public CreateStudioResult createStudio(CreateStudioRequest request)
AmazonNimbleStudio
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 AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an AWS 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 AmazonNimbleStudio
request
- A collection of studio resources.public CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest request)
AmazonNimbleStudio
Creates a studio component resource.
createStudioComponent
in interface AmazonNimbleStudio
request
- The studio components.public DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest request)
AmazonNimbleStudio
Permanently delete a launch profile.
deleteLaunchProfile
in interface AmazonNimbleStudio
public DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest request)
AmazonNimbleStudio
Delete a user from launch profile membership.
deleteLaunchProfileMember
in interface AmazonNimbleStudio
public DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest request)
AmazonNimbleStudio
Delete streaming image.
deleteStreamingImage
in interface AmazonNimbleStudio
public DeleteStreamingSessionResult deleteStreamingSession(DeleteStreamingSessionRequest request)
AmazonNimbleStudio
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.
deleteStreamingSession
in interface AmazonNimbleStudio
public DeleteStudioResult deleteStudio(DeleteStudioRequest request)
AmazonNimbleStudio
Delete a studio resource.
deleteStudio
in interface AmazonNimbleStudio
public DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest request)
AmazonNimbleStudio
Deletes a studio component resource.
deleteStudioComponent
in interface AmazonNimbleStudio
public DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest request)
AmazonNimbleStudio
Delete a user from studio membership.
deleteStudioMember
in interface AmazonNimbleStudio
public GetEulaResult getEula(GetEulaRequest request)
AmazonNimbleStudio
Get Eula.
getEula
in interface AmazonNimbleStudio
public GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest request)
AmazonNimbleStudio
Get a launch profile.
getLaunchProfile
in interface AmazonNimbleStudio
public GetLaunchProfileDetailsResult getLaunchProfileDetails(GetLaunchProfileDetailsRequest request)
AmazonNimbleStudio
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.
getLaunchProfileDetails
in interface AmazonNimbleStudio
public GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest request)
AmazonNimbleStudio
Get a launch profile initialization.
getLaunchProfileInitialization
in interface AmazonNimbleStudio
public GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest request)
AmazonNimbleStudio
Get a user persona in launch profile membership.
getLaunchProfileMember
in interface AmazonNimbleStudio
public GetStreamingImageResult getStreamingImage(GetStreamingImageRequest request)
AmazonNimbleStudio
Get streaming image.
getStreamingImage
in interface AmazonNimbleStudio
public GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest request)
AmazonNimbleStudio
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSession
in interface AmazonNimbleStudio
public GetStreamingSessionStreamResult getStreamingSessionStream(GetStreamingSessionStreamRequest request)
AmazonNimbleStudio
Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.
getStreamingSessionStream
in interface AmazonNimbleStudio
public GetStudioResult getStudio(GetStudioRequest request)
AmazonNimbleStudio
Get a Studio resource.
getStudio
in interface AmazonNimbleStudio
public GetStudioComponentResult getStudioComponent(GetStudioComponentRequest request)
AmazonNimbleStudio
Gets a studio component resource.
getStudioComponent
in interface AmazonNimbleStudio
public GetStudioMemberResult getStudioMember(GetStudioMemberRequest request)
AmazonNimbleStudio
Get a user's membership in a studio.
getStudioMember
in interface AmazonNimbleStudio
public ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest request)
AmazonNimbleStudio
List Eula Acceptances.
listEulaAcceptances
in interface AmazonNimbleStudio
public ListEulasResult listEulas(ListEulasRequest request)
AmazonNimbleStudio
List Eulas.
listEulas
in interface AmazonNimbleStudio
public ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest request)
AmazonNimbleStudio
Get all users in a given launch profile membership.
listLaunchProfileMembers
in interface AmazonNimbleStudio
public ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest request)
AmazonNimbleStudio
List all the launch profiles a studio.
listLaunchProfiles
in interface AmazonNimbleStudio
public ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest request)
AmazonNimbleStudio
List the streaming image resources available to this studio.
This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.
listStreamingImages
in interface AmazonNimbleStudio
public ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest request)
AmazonNimbleStudio
Lists the streaming image resources in a studio.
listStreamingSessions
in interface AmazonNimbleStudio
public ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest request)
AmazonNimbleStudio
Lists the StudioComponents in a studio.
listStudioComponents
in interface AmazonNimbleStudio
public ListStudioMembersResult listStudioMembers(ListStudioMembersRequest request)
AmazonNimbleStudio
Get all users in a given studio membership.
listStudioMembers
in interface AmazonNimbleStudio
public ListStudiosResult listStudios(ListStudiosRequest request)
AmazonNimbleStudio
List studios in your AWS account in the requested AWS Region.
listStudios
in interface AmazonNimbleStudio
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonNimbleStudio
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.
listTagsForResource
in interface AmazonNimbleStudio
public PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest request)
AmazonNimbleStudio
Add/update users with given persona to launch profile membership.
putLaunchProfileMembers
in interface AmazonNimbleStudio
request
- Information about a launch profile membership.public PutStudioMembersResult putStudioMembers(PutStudioMembersRequest request)
AmazonNimbleStudio
Add/update users with given persona to studio membership.
putStudioMembers
in interface AmazonNimbleStudio
request
- A launch profile membership collection.public StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest request)
AmazonNimbleStudio
Repairs the SSO configuration for a given studio.
If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.
After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
startStudioSSOConfigurationRepair
in interface AmazonNimbleStudio
public TagResourceResult tagResource(TagResourceRequest request)
AmazonNimbleStudio
Creates tags for a resource, given its ARN.
tagResource
in interface AmazonNimbleStudio
request
- The ARN for the role that manages access.public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonNimbleStudio
Deletes the tags for a resource.
untagResource
in interface AmazonNimbleStudio
public UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest request)
AmazonNimbleStudio
Update a launch profile.
updateLaunchProfile
in interface AmazonNimbleStudio
request
- The launch profile ID.public UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest request)
AmazonNimbleStudio
Update a user persona in launch profile membership.
updateLaunchProfileMember
in interface AmazonNimbleStudio
request
- The principal ID.public UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest request)
AmazonNimbleStudio
Update streaming image.
updateStreamingImage
in interface AmazonNimbleStudio
request
- The streaming image ID.public UpdateStudioResult updateStudio(UpdateStudioRequest request)
AmazonNimbleStudio
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudio
in interface AmazonNimbleStudio
request
- The studio ID.public UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest request)
AmazonNimbleStudio
Updates a studio component resource.
updateStudioComponent
in interface AmazonNimbleStudio
request
- The studio component ID.public void shutdown()
AmazonNimbleStudio
shutdown
in interface AmazonNimbleStudio
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonNimbleStudio
Response 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 AmazonNimbleStudio
request
- The originally executed request.