@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonNimbleStudioAsyncClient extends AmazonNimbleStudioClient implements AmazonNimbleStudioAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXacceptEulas, builder, createLaunchProfile, createStreamingImage, createStreamingSession, createStreamingSessionStream, createStudio, createStudioComponent, deleteLaunchProfile, deleteLaunchProfileMember, deleteStreamingImage, deleteStreamingSession, deleteStudio, deleteStudioComponent, deleteStudioMember, getCachedResponseMetadata, getEula, getLaunchProfile, getLaunchProfileDetails, getLaunchProfileInitialization, getLaunchProfileMember, getStreamingImage, getStreamingSession, getStreamingSessionBackup, getStreamingSessionStream, getStudio, getStudioComponent, getStudioMember, listEulaAcceptances, listEulas, listLaunchProfileMembers, listLaunchProfiles, listStreamingImages, listStreamingSessionBackups, listStreamingSessions, listStudioComponents, listStudioMembers, listStudios, listTagsForResource, putLaunchProfileMembers, putStudioMembers, startStreamingSession, startStudioSSOConfigurationRepair, stopStreamingSession, tagResource, untagResource, updateLaunchProfile, updateLaunchProfileMember, updateStreamingImage, updateStudio, updateStudioComponent, waitersaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitacceptEulas, createLaunchProfile, createStreamingImage, createStreamingSession, createStreamingSessionStream, createStudio, createStudioComponent, deleteLaunchProfile, deleteLaunchProfileMember, deleteStreamingImage, deleteStreamingSession, deleteStudio, deleteStudioComponent, deleteStudioMember, getCachedResponseMetadata, getEula, getLaunchProfile, getLaunchProfileDetails, getLaunchProfileInitialization, getLaunchProfileMember, getStreamingImage, getStreamingSession, getStreamingSessionBackup, getStreamingSessionStream, getStudio, getStudioComponent, getStudioMember, listEulaAcceptances, listEulas, listLaunchProfileMembers, listLaunchProfiles, listStreamingImages, listStreamingSessionBackups, listStreamingSessions, listStudioComponents, listStudioMembers, listStudios, listTagsForResource, putLaunchProfileMembers, putStudioMembers, startStreamingSession, startStudioSSOConfigurationRepair, stopStreamingSession, tagResource, untagResource, updateLaunchProfile, updateLaunchProfileMember, updateStreamingImage, updateStudio, updateStudioComponent, waiterspublic static AmazonNimbleStudioAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AcceptEulasResult> acceptEulasAsync(AcceptEulasRequest request)
AmazonNimbleStudioAsyncAccept EULAs.
acceptEulasAsync in interface AmazonNimbleStudioAsyncpublic Future<AcceptEulasResult> acceptEulasAsync(AcceptEulasRequest request, AsyncHandler<AcceptEulasRequest,AcceptEulasResult> asyncHandler)
AmazonNimbleStudioAsyncAccept EULAs.
acceptEulasAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLaunchProfileResult> createLaunchProfileAsync(CreateLaunchProfileRequest request)
AmazonNimbleStudioAsyncCreate a launch profile.
createLaunchProfileAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateLaunchProfileResult> createLaunchProfileAsync(CreateLaunchProfileRequest request, AsyncHandler<CreateLaunchProfileRequest,CreateLaunchProfileResult> asyncHandler)
AmazonNimbleStudioAsyncCreate a launch profile.
createLaunchProfileAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStreamingImageResult> createStreamingImageAsync(CreateStreamingImageRequest request)
AmazonNimbleStudioAsyncCreates a streaming image resource in a studio.
createStreamingImageAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateStreamingImageResult> createStreamingImageAsync(CreateStreamingImageRequest request, AsyncHandler<CreateStreamingImageRequest,CreateStreamingImageResult> asyncHandler)
AmazonNimbleStudioAsyncCreates a streaming image resource in a studio.
createStreamingImageAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStreamingSessionResult> createStreamingSessionAsync(CreateStreamingSessionRequest request)
AmazonNimbleStudioAsyncCreates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY state.
createStreamingSessionAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateStreamingSessionResult> createStreamingSessionAsync(CreateStreamingSessionRequest request, AsyncHandler<CreateStreamingSessionRequest,CreateStreamingSessionResult> asyncHandler)
AmazonNimbleStudioAsyncCreates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY state.
createStreamingSessionAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStreamingSessionStreamResult> createStreamingSessionStreamAsync(CreateStreamingSessionStreamRequest request)
AmazonNimbleStudioAsyncCreates 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.
createStreamingSessionStreamAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateStreamingSessionStreamResult> createStreamingSessionStreamAsync(CreateStreamingSessionStreamRequest request, AsyncHandler<CreateStreamingSessionStreamRequest,CreateStreamingSessionStreamResult> asyncHandler)
AmazonNimbleStudioAsyncCreates 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.
createStreamingSessionStreamAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStudioResult> createStudioAsync(CreateStudioRequest request)
AmazonNimbleStudioAsyncCreate 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.
createStudioAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateStudioResult> createStudioAsync(CreateStudioRequest request, AsyncHandler<CreateStudioRequest,CreateStudioResult> asyncHandler)
AmazonNimbleStudioAsyncCreate 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.
createStudioAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStudioComponentResult> createStudioComponentAsync(CreateStudioComponentRequest request)
AmazonNimbleStudioAsyncCreates a studio component resource.
createStudioComponentAsync in interface AmazonNimbleStudioAsyncpublic Future<CreateStudioComponentResult> createStudioComponentAsync(CreateStudioComponentRequest request, AsyncHandler<CreateStudioComponentRequest,CreateStudioComponentResult> asyncHandler)
AmazonNimbleStudioAsyncCreates a studio component resource.
createStudioComponentAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLaunchProfileResult> deleteLaunchProfileAsync(DeleteLaunchProfileRequest request)
AmazonNimbleStudioAsyncPermanently delete a launch profile.
deleteLaunchProfileAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteLaunchProfileResult> deleteLaunchProfileAsync(DeleteLaunchProfileRequest request, AsyncHandler<DeleteLaunchProfileRequest,DeleteLaunchProfileResult> asyncHandler)
AmazonNimbleStudioAsyncPermanently delete a launch profile.
deleteLaunchProfileAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLaunchProfileMemberResult> deleteLaunchProfileMemberAsync(DeleteLaunchProfileMemberRequest request)
AmazonNimbleStudioAsyncDelete a user from launch profile membership.
deleteLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteLaunchProfileMemberResult> deleteLaunchProfileMemberAsync(DeleteLaunchProfileMemberRequest request, AsyncHandler<DeleteLaunchProfileMemberRequest,DeleteLaunchProfileMemberResult> asyncHandler)
AmazonNimbleStudioAsyncDelete a user from launch profile membership.
deleteLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStreamingImageResult> deleteStreamingImageAsync(DeleteStreamingImageRequest request)
AmazonNimbleStudioAsyncDelete streaming image.
deleteStreamingImageAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteStreamingImageResult> deleteStreamingImageAsync(DeleteStreamingImageRequest request, AsyncHandler<DeleteStreamingImageRequest,DeleteStreamingImageResult> asyncHandler)
AmazonNimbleStudioAsyncDelete streaming image.
deleteStreamingImageAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStreamingSessionResult> deleteStreamingSessionAsync(DeleteStreamingSessionRequest request)
AmazonNimbleStudioAsyncDeletes 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.
deleteStreamingSessionAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteStreamingSessionResult> deleteStreamingSessionAsync(DeleteStreamingSessionRequest request, AsyncHandler<DeleteStreamingSessionRequest,DeleteStreamingSessionResult> asyncHandler)
AmazonNimbleStudioAsyncDeletes 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.
deleteStreamingSessionAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStudioResult> deleteStudioAsync(DeleteStudioRequest request)
AmazonNimbleStudioAsyncDelete a studio resource.
deleteStudioAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteStudioResult> deleteStudioAsync(DeleteStudioRequest request, AsyncHandler<DeleteStudioRequest,DeleteStudioResult> asyncHandler)
AmazonNimbleStudioAsyncDelete a studio resource.
deleteStudioAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStudioComponentResult> deleteStudioComponentAsync(DeleteStudioComponentRequest request)
AmazonNimbleStudioAsyncDeletes a studio component resource.
deleteStudioComponentAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteStudioComponentResult> deleteStudioComponentAsync(DeleteStudioComponentRequest request, AsyncHandler<DeleteStudioComponentRequest,DeleteStudioComponentResult> asyncHandler)
AmazonNimbleStudioAsyncDeletes a studio component resource.
deleteStudioComponentAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStudioMemberResult> deleteStudioMemberAsync(DeleteStudioMemberRequest request)
AmazonNimbleStudioAsyncDelete a user from studio membership.
deleteStudioMemberAsync in interface AmazonNimbleStudioAsyncpublic Future<DeleteStudioMemberResult> deleteStudioMemberAsync(DeleteStudioMemberRequest request, AsyncHandler<DeleteStudioMemberRequest,DeleteStudioMemberResult> asyncHandler)
AmazonNimbleStudioAsyncDelete a user from studio membership.
deleteStudioMemberAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEulaResult> getEulaAsync(GetEulaRequest request)
AmazonNimbleStudioAsyncGet EULA.
getEulaAsync in interface AmazonNimbleStudioAsyncpublic Future<GetEulaResult> getEulaAsync(GetEulaRequest request, AsyncHandler<GetEulaRequest,GetEulaResult> asyncHandler)
AmazonNimbleStudioAsyncGet EULA.
getEulaAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLaunchProfileResult> getLaunchProfileAsync(GetLaunchProfileRequest request)
AmazonNimbleStudioAsyncGet a launch profile.
getLaunchProfileAsync in interface AmazonNimbleStudioAsyncpublic Future<GetLaunchProfileResult> getLaunchProfileAsync(GetLaunchProfileRequest request, AsyncHandler<GetLaunchProfileRequest,GetLaunchProfileResult> asyncHandler)
AmazonNimbleStudioAsyncGet a launch profile.
getLaunchProfileAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLaunchProfileDetailsResult> getLaunchProfileDetailsAsync(GetLaunchProfileDetailsRequest request)
AmazonNimbleStudioAsyncLaunch 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.
getLaunchProfileDetailsAsync in interface AmazonNimbleStudioAsyncpublic Future<GetLaunchProfileDetailsResult> getLaunchProfileDetailsAsync(GetLaunchProfileDetailsRequest request, AsyncHandler<GetLaunchProfileDetailsRequest,GetLaunchProfileDetailsResult> asyncHandler)
AmazonNimbleStudioAsyncLaunch 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.
getLaunchProfileDetailsAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLaunchProfileInitializationResult> getLaunchProfileInitializationAsync(GetLaunchProfileInitializationRequest request)
AmazonNimbleStudioAsyncGet a launch profile initialization.
getLaunchProfileInitializationAsync in interface AmazonNimbleStudioAsyncpublic Future<GetLaunchProfileInitializationResult> getLaunchProfileInitializationAsync(GetLaunchProfileInitializationRequest request, AsyncHandler<GetLaunchProfileInitializationRequest,GetLaunchProfileInitializationResult> asyncHandler)
AmazonNimbleStudioAsyncGet a launch profile initialization.
getLaunchProfileInitializationAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLaunchProfileMemberResult> getLaunchProfileMemberAsync(GetLaunchProfileMemberRequest request)
AmazonNimbleStudioAsyncGet a user persona in launch profile membership.
getLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncpublic Future<GetLaunchProfileMemberResult> getLaunchProfileMemberAsync(GetLaunchProfileMemberRequest request, AsyncHandler<GetLaunchProfileMemberRequest,GetLaunchProfileMemberResult> asyncHandler)
AmazonNimbleStudioAsyncGet a user persona in launch profile membership.
getLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStreamingImageResult> getStreamingImageAsync(GetStreamingImageRequest request)
AmazonNimbleStudioAsyncGet streaming image.
getStreamingImageAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStreamingImageResult> getStreamingImageAsync(GetStreamingImageRequest request, AsyncHandler<GetStreamingImageRequest,GetStreamingImageResult> asyncHandler)
AmazonNimbleStudioAsyncGet streaming image.
getStreamingImageAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStreamingSessionResult> getStreamingSessionAsync(GetStreamingSessionRequest request)
AmazonNimbleStudioAsyncGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStreamingSessionResult> getStreamingSessionAsync(GetStreamingSessionRequest request, AsyncHandler<GetStreamingSessionRequest,GetStreamingSessionResult> asyncHandler)
AmazonNimbleStudioAsyncGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStreamingSessionBackupResult> getStreamingSessionBackupAsync(GetStreamingSessionBackupRequest request)
AmazonNimbleStudioAsync
Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackupAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStreamingSessionBackupResult> getStreamingSessionBackupAsync(GetStreamingSessionBackupRequest request, AsyncHandler<GetStreamingSessionBackupRequest,GetStreamingSessionBackupResult> asyncHandler)
AmazonNimbleStudioAsync
Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackupAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStreamingSessionStreamResult> getStreamingSessionStreamAsync(GetStreamingSessionStreamRequest request)
AmazonNimbleStudioAsyncGets 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.
getStreamingSessionStreamAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStreamingSessionStreamResult> getStreamingSessionStreamAsync(GetStreamingSessionStreamRequest request, AsyncHandler<GetStreamingSessionStreamRequest,GetStreamingSessionStreamResult> asyncHandler)
AmazonNimbleStudioAsyncGets 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.
getStreamingSessionStreamAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStudioResult> getStudioAsync(GetStudioRequest request)
AmazonNimbleStudioAsyncGet a studio resource.
getStudioAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStudioResult> getStudioAsync(GetStudioRequest request, AsyncHandler<GetStudioRequest,GetStudioResult> asyncHandler)
AmazonNimbleStudioAsyncGet a studio resource.
getStudioAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStudioComponentResult> getStudioComponentAsync(GetStudioComponentRequest request)
AmazonNimbleStudioAsyncGets a studio component resource.
getStudioComponentAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStudioComponentResult> getStudioComponentAsync(GetStudioComponentRequest request, AsyncHandler<GetStudioComponentRequest,GetStudioComponentResult> asyncHandler)
AmazonNimbleStudioAsyncGets a studio component resource.
getStudioComponentAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStudioMemberResult> getStudioMemberAsync(GetStudioMemberRequest request)
AmazonNimbleStudioAsyncGet a user's membership in a studio.
getStudioMemberAsync in interface AmazonNimbleStudioAsyncpublic Future<GetStudioMemberResult> getStudioMemberAsync(GetStudioMemberRequest request, AsyncHandler<GetStudioMemberRequest,GetStudioMemberResult> asyncHandler)
AmazonNimbleStudioAsyncGet a user's membership in a studio.
getStudioMemberAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEulaAcceptancesResult> listEulaAcceptancesAsync(ListEulaAcceptancesRequest request)
AmazonNimbleStudioAsyncList EULA acceptances.
listEulaAcceptancesAsync in interface AmazonNimbleStudioAsyncpublic Future<ListEulaAcceptancesResult> listEulaAcceptancesAsync(ListEulaAcceptancesRequest request, AsyncHandler<ListEulaAcceptancesRequest,ListEulaAcceptancesResult> asyncHandler)
AmazonNimbleStudioAsyncList EULA acceptances.
listEulaAcceptancesAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEulasResult> listEulasAsync(ListEulasRequest request)
AmazonNimbleStudioAsyncList EULAs.
listEulasAsync in interface AmazonNimbleStudioAsyncpublic Future<ListEulasResult> listEulasAsync(ListEulasRequest request, AsyncHandler<ListEulasRequest,ListEulasResult> asyncHandler)
AmazonNimbleStudioAsyncList EULAs.
listEulasAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLaunchProfileMembersResult> listLaunchProfileMembersAsync(ListLaunchProfileMembersRequest request)
AmazonNimbleStudioAsyncGet all users in a given launch profile membership.
listLaunchProfileMembersAsync in interface AmazonNimbleStudioAsyncpublic Future<ListLaunchProfileMembersResult> listLaunchProfileMembersAsync(ListLaunchProfileMembersRequest request, AsyncHandler<ListLaunchProfileMembersRequest,ListLaunchProfileMembersResult> asyncHandler)
AmazonNimbleStudioAsyncGet all users in a given launch profile membership.
listLaunchProfileMembersAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLaunchProfilesResult> listLaunchProfilesAsync(ListLaunchProfilesRequest request)
AmazonNimbleStudioAsyncList all the launch profiles a studio.
listLaunchProfilesAsync in interface AmazonNimbleStudioAsyncpublic Future<ListLaunchProfilesResult> listLaunchProfilesAsync(ListLaunchProfilesRequest request, AsyncHandler<ListLaunchProfilesRequest,ListLaunchProfilesResult> asyncHandler)
AmazonNimbleStudioAsyncList all the launch profiles a studio.
listLaunchProfilesAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStreamingImagesResult> listStreamingImagesAsync(ListStreamingImagesRequest request)
AmazonNimbleStudioAsyncList 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.
listStreamingImagesAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStreamingImagesResult> listStreamingImagesAsync(ListStreamingImagesRequest request, AsyncHandler<ListStreamingImagesRequest,ListStreamingImagesResult> asyncHandler)
AmazonNimbleStudioAsyncList 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.
listStreamingImagesAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStreamingSessionBackupsResult> listStreamingSessionBackupsAsync(ListStreamingSessionBackupsRequest request)
AmazonNimbleStudioAsyncLists the backups of a streaming session in a studio.
listStreamingSessionBackupsAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStreamingSessionBackupsResult> listStreamingSessionBackupsAsync(ListStreamingSessionBackupsRequest request, AsyncHandler<ListStreamingSessionBackupsRequest,ListStreamingSessionBackupsResult> asyncHandler)
AmazonNimbleStudioAsyncLists the backups of a streaming session in a studio.
listStreamingSessionBackupsAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStreamingSessionsResult> listStreamingSessionsAsync(ListStreamingSessionsRequest request)
AmazonNimbleStudioAsyncLists the streaming sessions in a studio.
listStreamingSessionsAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStreamingSessionsResult> listStreamingSessionsAsync(ListStreamingSessionsRequest request, AsyncHandler<ListStreamingSessionsRequest,ListStreamingSessionsResult> asyncHandler)
AmazonNimbleStudioAsyncLists the streaming sessions in a studio.
listStreamingSessionsAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStudioComponentsResult> listStudioComponentsAsync(ListStudioComponentsRequest request)
AmazonNimbleStudioAsync
Lists the StudioComponents in a studio.
listStudioComponentsAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStudioComponentsResult> listStudioComponentsAsync(ListStudioComponentsRequest request, AsyncHandler<ListStudioComponentsRequest,ListStudioComponentsResult> asyncHandler)
AmazonNimbleStudioAsync
Lists the StudioComponents in a studio.
listStudioComponentsAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStudioMembersResult> listStudioMembersAsync(ListStudioMembersRequest request)
AmazonNimbleStudioAsyncGet all users in a given studio membership.
ListStudioMembers only returns admin members.
listStudioMembersAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStudioMembersResult> listStudioMembersAsync(ListStudioMembersRequest request, AsyncHandler<ListStudioMembersRequest,ListStudioMembersResult> asyncHandler)
AmazonNimbleStudioAsyncGet all users in a given studio membership.
ListStudioMembers only returns admin members.
listStudioMembersAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStudiosResult> listStudiosAsync(ListStudiosRequest request)
AmazonNimbleStudioAsyncList studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudiosAsync in interface AmazonNimbleStudioAsyncpublic Future<ListStudiosResult> listStudiosAsync(ListStudiosRequest request, AsyncHandler<ListStudiosRequest,ListStudiosResult> asyncHandler)
AmazonNimbleStudioAsyncList studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudiosAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonNimbleStudioAsyncGets 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.
listTagsForResourceAsync in interface AmazonNimbleStudioAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonNimbleStudioAsyncGets 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.
listTagsForResourceAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutLaunchProfileMembersResult> putLaunchProfileMembersAsync(PutLaunchProfileMembersRequest request)
AmazonNimbleStudioAsyncAdd/update users with given persona to launch profile membership.
putLaunchProfileMembersAsync in interface AmazonNimbleStudioAsyncpublic Future<PutLaunchProfileMembersResult> putLaunchProfileMembersAsync(PutLaunchProfileMembersRequest request, AsyncHandler<PutLaunchProfileMembersRequest,PutLaunchProfileMembersResult> asyncHandler)
AmazonNimbleStudioAsyncAdd/update users with given persona to launch profile membership.
putLaunchProfileMembersAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutStudioMembersResult> putStudioMembersAsync(PutStudioMembersRequest request)
AmazonNimbleStudioAsyncAdd/update users with given persona to studio membership.
putStudioMembersAsync in interface AmazonNimbleStudioAsyncpublic Future<PutStudioMembersResult> putStudioMembersAsync(PutStudioMembersRequest request, AsyncHandler<PutStudioMembersRequest,PutStudioMembersResult> asyncHandler)
AmazonNimbleStudioAsyncAdd/update users with given persona to studio membership.
putStudioMembersAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartStreamingSessionResult> startStreamingSessionAsync(StartStreamingSessionRequest request)
AmazonNimbleStudioAsync
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.
startStreamingSessionAsync in interface AmazonNimbleStudioAsyncpublic Future<StartStreamingSessionResult> startStreamingSessionAsync(StartStreamingSessionRequest request, AsyncHandler<StartStreamingSessionRequest,StartStreamingSessionResult> asyncHandler)
AmazonNimbleStudioAsync
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.
startStreamingSessionAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartStudioSSOConfigurationRepairResult> startStudioSSOConfigurationRepairAsync(StartStudioSSOConfigurationRepairRequest request)
AmazonNimbleStudioAsyncRepairs 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.
startStudioSSOConfigurationRepairAsync in interface AmazonNimbleStudioAsyncpublic Future<StartStudioSSOConfigurationRepairResult> startStudioSSOConfigurationRepairAsync(StartStudioSSOConfigurationRepairRequest request, AsyncHandler<StartStudioSSOConfigurationRepairRequest,StartStudioSSOConfigurationRepairResult> asyncHandler)
AmazonNimbleStudioAsyncRepairs 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.
startStudioSSOConfigurationRepairAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopStreamingSessionResult> stopStreamingSessionAsync(StopStreamingSessionRequest request)
AmazonNimbleStudioAsync
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.
stopStreamingSessionAsync in interface AmazonNimbleStudioAsyncpublic Future<StopStreamingSessionResult> stopStreamingSessionAsync(StopStreamingSessionRequest request, AsyncHandler<StopStreamingSessionRequest,StopStreamingSessionResult> asyncHandler)
AmazonNimbleStudioAsync
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.
stopStreamingSessionAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonNimbleStudioAsyncCreates tags for a resource, given its ARN.
tagResourceAsync in interface AmazonNimbleStudioAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonNimbleStudioAsyncCreates tags for a resource, given its ARN.
tagResourceAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonNimbleStudioAsyncDeletes the tags for a resource.
untagResourceAsync in interface AmazonNimbleStudioAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonNimbleStudioAsyncDeletes the tags for a resource.
untagResourceAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLaunchProfileResult> updateLaunchProfileAsync(UpdateLaunchProfileRequest request)
AmazonNimbleStudioAsyncUpdate a launch profile.
updateLaunchProfileAsync in interface AmazonNimbleStudioAsyncpublic Future<UpdateLaunchProfileResult> updateLaunchProfileAsync(UpdateLaunchProfileRequest request, AsyncHandler<UpdateLaunchProfileRequest,UpdateLaunchProfileResult> asyncHandler)
AmazonNimbleStudioAsyncUpdate a launch profile.
updateLaunchProfileAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLaunchProfileMemberResult> updateLaunchProfileMemberAsync(UpdateLaunchProfileMemberRequest request)
AmazonNimbleStudioAsyncUpdate a user persona in launch profile membership.
updateLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncpublic Future<UpdateLaunchProfileMemberResult> updateLaunchProfileMemberAsync(UpdateLaunchProfileMemberRequest request, AsyncHandler<UpdateLaunchProfileMemberRequest,UpdateLaunchProfileMemberResult> asyncHandler)
AmazonNimbleStudioAsyncUpdate a user persona in launch profile membership.
updateLaunchProfileMemberAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStreamingImageResult> updateStreamingImageAsync(UpdateStreamingImageRequest request)
AmazonNimbleStudioAsyncUpdate streaming image.
updateStreamingImageAsync in interface AmazonNimbleStudioAsyncpublic Future<UpdateStreamingImageResult> updateStreamingImageAsync(UpdateStreamingImageRequest request, AsyncHandler<UpdateStreamingImageRequest,UpdateStreamingImageResult> asyncHandler)
AmazonNimbleStudioAsyncUpdate streaming image.
updateStreamingImageAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStudioResult> updateStudioAsync(UpdateStudioRequest request)
AmazonNimbleStudioAsyncUpdate a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioAsync in interface AmazonNimbleStudioAsyncpublic Future<UpdateStudioResult> updateStudioAsync(UpdateStudioRequest request, AsyncHandler<UpdateStudioRequest,UpdateStudioResult> asyncHandler)
AmazonNimbleStudioAsyncUpdate a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStudioComponentResult> updateStudioComponentAsync(UpdateStudioComponentRequest request)
AmazonNimbleStudioAsyncUpdates a studio component resource.
updateStudioComponentAsync in interface AmazonNimbleStudioAsyncpublic Future<UpdateStudioComponentResult> updateStudioComponentAsync(UpdateStudioComponentRequest request, AsyncHandler<UpdateStudioComponentRequest,UpdateStudioComponentResult> asyncHandler)
AmazonNimbleStudioAsyncUpdates a studio component resource.
updateStudioComponentAsync in interface AmazonNimbleStudioAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonNimbleStudioshutdown in class AmazonNimbleStudioClient