@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonNimbleStudioAsync extends AmazonNimbleStudio
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonNimbleStudioAsync
instead.
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.
ENDPOINT_PREFIX
acceptEulas, 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, shutdown, startStreamingSession, startStudioSSOConfigurationRepair, stopStreamingSession, tagResource, untagResource, updateLaunchProfile, updateLaunchProfileMember, updateStreamingImage, updateStudio, updateStudioComponent, waiters
Future<AcceptEulasResult> acceptEulasAsync(AcceptEulasRequest acceptEulasRequest)
Accept EULAs.
acceptEulasRequest
- Future<AcceptEulasResult> acceptEulasAsync(AcceptEulasRequest acceptEulasRequest, AsyncHandler<AcceptEulasRequest,AcceptEulasResult> asyncHandler)
Accept EULAs.
acceptEulasRequest
- asyncHandler
- 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.Future<CreateLaunchProfileResult> createLaunchProfileAsync(CreateLaunchProfileRequest createLaunchProfileRequest)
Create a launch profile.
createLaunchProfileRequest
- Future<CreateLaunchProfileResult> createLaunchProfileAsync(CreateLaunchProfileRequest createLaunchProfileRequest, AsyncHandler<CreateLaunchProfileRequest,CreateLaunchProfileResult> asyncHandler)
Create a launch profile.
createLaunchProfileRequest
- asyncHandler
- 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.Future<CreateStreamingImageResult> createStreamingImageAsync(CreateStreamingImageRequest createStreamingImageRequest)
Creates a streaming image resource in a studio.
createStreamingImageRequest
- Future<CreateStreamingImageResult> createStreamingImageAsync(CreateStreamingImageRequest createStreamingImageRequest, AsyncHandler<CreateStreamingImageRequest,CreateStreamingImageResult> asyncHandler)
Creates a streaming image resource in a studio.
createStreamingImageRequest
- asyncHandler
- 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.Future<CreateStreamingSessionResult> createStreamingSessionAsync(CreateStreamingSessionRequest createStreamingSessionRequest)
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY
state.
createStreamingSessionRequest
- Future<CreateStreamingSessionResult> createStreamingSessionAsync(CreateStreamingSessionRequest createStreamingSessionRequest, AsyncHandler<CreateStreamingSessionRequest,CreateStreamingSessionResult> asyncHandler)
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY
state.
createStreamingSessionRequest
- asyncHandler
- 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.Future<CreateStreamingSessionStreamResult> createStreamingSessionStreamAsync(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest)
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.
createStreamingSessionStreamRequest
- Future<CreateStreamingSessionStreamResult> createStreamingSessionStreamAsync(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest, AsyncHandler<CreateStreamingSessionStreamRequest,CreateStreamingSessionStreamResult> asyncHandler)
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.
createStreamingSessionStreamRequest
- asyncHandler
- 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.Future<CreateStudioResult> createStudioAsync(CreateStudioRequest createStudioRequest)
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.
createStudioRequest
- Future<CreateStudioResult> createStudioAsync(CreateStudioRequest createStudioRequest, AsyncHandler<CreateStudioRequest,CreateStudioResult> asyncHandler)
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.
createStudioRequest
- asyncHandler
- 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.Future<CreateStudioComponentResult> createStudioComponentAsync(CreateStudioComponentRequest createStudioComponentRequest)
Creates a studio component resource.
createStudioComponentRequest
- Future<CreateStudioComponentResult> createStudioComponentAsync(CreateStudioComponentRequest createStudioComponentRequest, AsyncHandler<CreateStudioComponentRequest,CreateStudioComponentResult> asyncHandler)
Creates a studio component resource.
createStudioComponentRequest
- asyncHandler
- 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.Future<DeleteLaunchProfileResult> deleteLaunchProfileAsync(DeleteLaunchProfileRequest deleteLaunchProfileRequest)
Permanently delete a launch profile.
deleteLaunchProfileRequest
- Future<DeleteLaunchProfileResult> deleteLaunchProfileAsync(DeleteLaunchProfileRequest deleteLaunchProfileRequest, AsyncHandler<DeleteLaunchProfileRequest,DeleteLaunchProfileResult> asyncHandler)
Permanently delete a launch profile.
deleteLaunchProfileRequest
- asyncHandler
- 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.Future<DeleteLaunchProfileMemberResult> deleteLaunchProfileMemberAsync(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest)
Delete a user from launch profile membership.
deleteLaunchProfileMemberRequest
- Future<DeleteLaunchProfileMemberResult> deleteLaunchProfileMemberAsync(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest, AsyncHandler<DeleteLaunchProfileMemberRequest,DeleteLaunchProfileMemberResult> asyncHandler)
Delete a user from launch profile membership.
deleteLaunchProfileMemberRequest
- asyncHandler
- 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.Future<DeleteStreamingImageResult> deleteStreamingImageAsync(DeleteStreamingImageRequest deleteStreamingImageRequest)
Delete streaming image.
deleteStreamingImageRequest
- Future<DeleteStreamingImageResult> deleteStreamingImageAsync(DeleteStreamingImageRequest deleteStreamingImageRequest, AsyncHandler<DeleteStreamingImageRequest,DeleteStreamingImageResult> asyncHandler)
Delete streaming image.
deleteStreamingImageRequest
- asyncHandler
- 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.Future<DeleteStreamingSessionResult> deleteStreamingSessionAsync(DeleteStreamingSessionRequest deleteStreamingSessionRequest)
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
.
deleteStreamingSessionRequest
- Future<DeleteStreamingSessionResult> deleteStreamingSessionAsync(DeleteStreamingSessionRequest deleteStreamingSessionRequest, AsyncHandler<DeleteStreamingSessionRequest,DeleteStreamingSessionResult> asyncHandler)
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
.
deleteStreamingSessionRequest
- asyncHandler
- 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.Future<DeleteStudioResult> deleteStudioAsync(DeleteStudioRequest deleteStudioRequest)
Delete a studio resource.
deleteStudioRequest
- Future<DeleteStudioResult> deleteStudioAsync(DeleteStudioRequest deleteStudioRequest, AsyncHandler<DeleteStudioRequest,DeleteStudioResult> asyncHandler)
Delete a studio resource.
deleteStudioRequest
- asyncHandler
- 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.Future<DeleteStudioComponentResult> deleteStudioComponentAsync(DeleteStudioComponentRequest deleteStudioComponentRequest)
Deletes a studio component resource.
deleteStudioComponentRequest
- Future<DeleteStudioComponentResult> deleteStudioComponentAsync(DeleteStudioComponentRequest deleteStudioComponentRequest, AsyncHandler<DeleteStudioComponentRequest,DeleteStudioComponentResult> asyncHandler)
Deletes a studio component resource.
deleteStudioComponentRequest
- asyncHandler
- 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.Future<DeleteStudioMemberResult> deleteStudioMemberAsync(DeleteStudioMemberRequest deleteStudioMemberRequest)
Delete a user from studio membership.
deleteStudioMemberRequest
- Future<DeleteStudioMemberResult> deleteStudioMemberAsync(DeleteStudioMemberRequest deleteStudioMemberRequest, AsyncHandler<DeleteStudioMemberRequest,DeleteStudioMemberResult> asyncHandler)
Delete a user from studio membership.
deleteStudioMemberRequest
- asyncHandler
- 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.Future<GetEulaResult> getEulaAsync(GetEulaRequest getEulaRequest)
Get EULA.
getEulaRequest
- Future<GetEulaResult> getEulaAsync(GetEulaRequest getEulaRequest, AsyncHandler<GetEulaRequest,GetEulaResult> asyncHandler)
Get EULA.
getEulaRequest
- asyncHandler
- 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.Future<GetLaunchProfileResult> getLaunchProfileAsync(GetLaunchProfileRequest getLaunchProfileRequest)
Get a launch profile.
getLaunchProfileRequest
- Future<GetLaunchProfileResult> getLaunchProfileAsync(GetLaunchProfileRequest getLaunchProfileRequest, AsyncHandler<GetLaunchProfileRequest,GetLaunchProfileResult> asyncHandler)
Get a launch profile.
getLaunchProfileRequest
- asyncHandler
- 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.Future<GetLaunchProfileDetailsResult> getLaunchProfileDetailsAsync(GetLaunchProfileDetailsRequest getLaunchProfileDetailsRequest)
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.
getLaunchProfileDetailsRequest
- Future<GetLaunchProfileDetailsResult> getLaunchProfileDetailsAsync(GetLaunchProfileDetailsRequest getLaunchProfileDetailsRequest, AsyncHandler<GetLaunchProfileDetailsRequest,GetLaunchProfileDetailsResult> asyncHandler)
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.
getLaunchProfileDetailsRequest
- asyncHandler
- 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.Future<GetLaunchProfileInitializationResult> getLaunchProfileInitializationAsync(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest)
Get a launch profile initialization.
getLaunchProfileInitializationRequest
- Future<GetLaunchProfileInitializationResult> getLaunchProfileInitializationAsync(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest, AsyncHandler<GetLaunchProfileInitializationRequest,GetLaunchProfileInitializationResult> asyncHandler)
Get a launch profile initialization.
getLaunchProfileInitializationRequest
- asyncHandler
- 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.Future<GetLaunchProfileMemberResult> getLaunchProfileMemberAsync(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest)
Get a user persona in launch profile membership.
getLaunchProfileMemberRequest
- Future<GetLaunchProfileMemberResult> getLaunchProfileMemberAsync(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest, AsyncHandler<GetLaunchProfileMemberRequest,GetLaunchProfileMemberResult> asyncHandler)
Get a user persona in launch profile membership.
getLaunchProfileMemberRequest
- asyncHandler
- 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.Future<GetStreamingImageResult> getStreamingImageAsync(GetStreamingImageRequest getStreamingImageRequest)
Get streaming image.
getStreamingImageRequest
- Future<GetStreamingImageResult> getStreamingImageAsync(GetStreamingImageRequest getStreamingImageRequest, AsyncHandler<GetStreamingImageRequest,GetStreamingImageResult> asyncHandler)
Get streaming image.
getStreamingImageRequest
- asyncHandler
- 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.Future<GetStreamingSessionResult> getStreamingSessionAsync(GetStreamingSessionRequest getStreamingSessionRequest)
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionRequest
- Future<GetStreamingSessionResult> getStreamingSessionAsync(GetStreamingSessionRequest getStreamingSessionRequest, AsyncHandler<GetStreamingSessionRequest,GetStreamingSessionResult> asyncHandler)
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionRequest
- asyncHandler
- 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.Future<GetStreamingSessionBackupResult> getStreamingSessionBackupAsync(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest)
Gets StreamingSessionBackup
resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackupRequest
- Future<GetStreamingSessionBackupResult> getStreamingSessionBackupAsync(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest, AsyncHandler<GetStreamingSessionBackupRequest,GetStreamingSessionBackupResult> asyncHandler)
Gets StreamingSessionBackup
resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackupRequest
- asyncHandler
- 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.Future<GetStreamingSessionStreamResult> getStreamingSessionStreamAsync(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest)
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.
getStreamingSessionStreamRequest
- Future<GetStreamingSessionStreamResult> getStreamingSessionStreamAsync(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest, AsyncHandler<GetStreamingSessionStreamRequest,GetStreamingSessionStreamResult> asyncHandler)
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.
getStreamingSessionStreamRequest
- asyncHandler
- 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.Future<GetStudioResult> getStudioAsync(GetStudioRequest getStudioRequest)
Get a studio resource.
getStudioRequest
- Future<GetStudioResult> getStudioAsync(GetStudioRequest getStudioRequest, AsyncHandler<GetStudioRequest,GetStudioResult> asyncHandler)
Get a studio resource.
getStudioRequest
- asyncHandler
- 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.Future<GetStudioComponentResult> getStudioComponentAsync(GetStudioComponentRequest getStudioComponentRequest)
Gets a studio component resource.
getStudioComponentRequest
- Future<GetStudioComponentResult> getStudioComponentAsync(GetStudioComponentRequest getStudioComponentRequest, AsyncHandler<GetStudioComponentRequest,GetStudioComponentResult> asyncHandler)
Gets a studio component resource.
getStudioComponentRequest
- asyncHandler
- 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.Future<GetStudioMemberResult> getStudioMemberAsync(GetStudioMemberRequest getStudioMemberRequest)
Get a user's membership in a studio.
getStudioMemberRequest
- Future<GetStudioMemberResult> getStudioMemberAsync(GetStudioMemberRequest getStudioMemberRequest, AsyncHandler<GetStudioMemberRequest,GetStudioMemberResult> asyncHandler)
Get a user's membership in a studio.
getStudioMemberRequest
- asyncHandler
- 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.Future<ListEulaAcceptancesResult> listEulaAcceptancesAsync(ListEulaAcceptancesRequest listEulaAcceptancesRequest)
List EULA acceptances.
listEulaAcceptancesRequest
- Future<ListEulaAcceptancesResult> listEulaAcceptancesAsync(ListEulaAcceptancesRequest listEulaAcceptancesRequest, AsyncHandler<ListEulaAcceptancesRequest,ListEulaAcceptancesResult> asyncHandler)
List EULA acceptances.
listEulaAcceptancesRequest
- asyncHandler
- 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.Future<ListEulasResult> listEulasAsync(ListEulasRequest listEulasRequest)
List EULAs.
listEulasRequest
- Future<ListEulasResult> listEulasAsync(ListEulasRequest listEulasRequest, AsyncHandler<ListEulasRequest,ListEulasResult> asyncHandler)
List EULAs.
listEulasRequest
- asyncHandler
- 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.Future<ListLaunchProfileMembersResult> listLaunchProfileMembersAsync(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest)
Get all users in a given launch profile membership.
listLaunchProfileMembersRequest
- Future<ListLaunchProfileMembersResult> listLaunchProfileMembersAsync(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest, AsyncHandler<ListLaunchProfileMembersRequest,ListLaunchProfileMembersResult> asyncHandler)
Get all users in a given launch profile membership.
listLaunchProfileMembersRequest
- asyncHandler
- 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.Future<ListLaunchProfilesResult> listLaunchProfilesAsync(ListLaunchProfilesRequest listLaunchProfilesRequest)
List all the launch profiles a studio.
listLaunchProfilesRequest
- Future<ListLaunchProfilesResult> listLaunchProfilesAsync(ListLaunchProfilesRequest listLaunchProfilesRequest, AsyncHandler<ListLaunchProfilesRequest,ListLaunchProfilesResult> asyncHandler)
List all the launch profiles a studio.
listLaunchProfilesRequest
- asyncHandler
- 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.Future<ListStreamingImagesResult> listStreamingImagesAsync(ListStreamingImagesRequest listStreamingImagesRequest)
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.
listStreamingImagesRequest
- Future<ListStreamingImagesResult> listStreamingImagesAsync(ListStreamingImagesRequest listStreamingImagesRequest, AsyncHandler<ListStreamingImagesRequest,ListStreamingImagesResult> asyncHandler)
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.
listStreamingImagesRequest
- asyncHandler
- 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.Future<ListStreamingSessionBackupsResult> listStreamingSessionBackupsAsync(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest)
Lists the backups of a streaming session in a studio.
listStreamingSessionBackupsRequest
- Future<ListStreamingSessionBackupsResult> listStreamingSessionBackupsAsync(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest, AsyncHandler<ListStreamingSessionBackupsRequest,ListStreamingSessionBackupsResult> asyncHandler)
Lists the backups of a streaming session in a studio.
listStreamingSessionBackupsRequest
- asyncHandler
- 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.Future<ListStreamingSessionsResult> listStreamingSessionsAsync(ListStreamingSessionsRequest listStreamingSessionsRequest)
Lists the streaming sessions in a studio.
listStreamingSessionsRequest
- Future<ListStreamingSessionsResult> listStreamingSessionsAsync(ListStreamingSessionsRequest listStreamingSessionsRequest, AsyncHandler<ListStreamingSessionsRequest,ListStreamingSessionsResult> asyncHandler)
Lists the streaming sessions in a studio.
listStreamingSessionsRequest
- asyncHandler
- 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.Future<ListStudioComponentsResult> listStudioComponentsAsync(ListStudioComponentsRequest listStudioComponentsRequest)
Lists the StudioComponents
in a studio.
listStudioComponentsRequest
- Future<ListStudioComponentsResult> listStudioComponentsAsync(ListStudioComponentsRequest listStudioComponentsRequest, AsyncHandler<ListStudioComponentsRequest,ListStudioComponentsResult> asyncHandler)
Lists the StudioComponents
in a studio.
listStudioComponentsRequest
- asyncHandler
- 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.Future<ListStudioMembersResult> listStudioMembersAsync(ListStudioMembersRequest listStudioMembersRequest)
Get all users in a given studio membership.
ListStudioMembers
only returns admin members.
listStudioMembersRequest
- Future<ListStudioMembersResult> listStudioMembersAsync(ListStudioMembersRequest listStudioMembersRequest, AsyncHandler<ListStudioMembersRequest,ListStudioMembersResult> asyncHandler)
Get all users in a given studio membership.
ListStudioMembers
only returns admin members.
listStudioMembersRequest
- asyncHandler
- 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.Future<ListStudiosResult> listStudiosAsync(ListStudiosRequest listStudiosRequest)
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudiosRequest
- Future<ListStudiosResult> listStudiosAsync(ListStudiosRequest listStudiosRequest, AsyncHandler<ListStudiosRequest,ListStudiosResult> asyncHandler)
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudiosRequest
- asyncHandler
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
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.
listTagsForResourceRequest
- asyncHandler
- 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.Future<PutLaunchProfileMembersResult> putLaunchProfileMembersAsync(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembersRequest
- Future<PutLaunchProfileMembersResult> putLaunchProfileMembersAsync(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest, AsyncHandler<PutLaunchProfileMembersRequest,PutLaunchProfileMembersResult> asyncHandler)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembersRequest
- asyncHandler
- 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.Future<PutStudioMembersResult> putStudioMembersAsync(PutStudioMembersRequest putStudioMembersRequest)
Add/update users with given persona to studio membership.
putStudioMembersRequest
- Future<PutStudioMembersResult> putStudioMembersAsync(PutStudioMembersRequest putStudioMembersRequest, AsyncHandler<PutStudioMembersRequest,PutStudioMembersResult> asyncHandler)
Add/update users with given persona to studio membership.
putStudioMembersRequest
- asyncHandler
- 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.Future<StartStreamingSessionResult> startStreamingSessionAsync(StartStreamingSessionRequest startStreamingSessionRequest)
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.
startStreamingSessionRequest
- Future<StartStreamingSessionResult> startStreamingSessionAsync(StartStreamingSessionRequest startStreamingSessionRequest, AsyncHandler<StartStreamingSessionRequest,StartStreamingSessionResult> asyncHandler)
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.
startStreamingSessionRequest
- asyncHandler
- 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.Future<StartStudioSSOConfigurationRepairResult> startStudioSSOConfigurationRepairAsync(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest)
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.
startStudioSSOConfigurationRepairRequest
- Future<StartStudioSSOConfigurationRepairResult> startStudioSSOConfigurationRepairAsync(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest, AsyncHandler<StartStudioSSOConfigurationRepairRequest,StartStudioSSOConfigurationRepairResult> asyncHandler)
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.
startStudioSSOConfigurationRepairRequest
- asyncHandler
- 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.Future<StopStreamingSessionResult> stopStreamingSessionAsync(StopStreamingSessionRequest stopStreamingSessionRequest)
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.
stopStreamingSessionRequest
- Future<StopStreamingSessionResult> stopStreamingSessionAsync(StopStreamingSessionRequest stopStreamingSessionRequest, AsyncHandler<StopStreamingSessionRequest,StopStreamingSessionResult> asyncHandler)
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.
stopStreamingSessionRequest
- asyncHandler
- 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Creates tags for a resource, given its ARN.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Creates tags for a resource, given its ARN.
tagResourceRequest
- asyncHandler
- 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Deletes the tags for a resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Deletes the tags for a resource.
untagResourceRequest
- asyncHandler
- 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.Future<UpdateLaunchProfileResult> updateLaunchProfileAsync(UpdateLaunchProfileRequest updateLaunchProfileRequest)
Update a launch profile.
updateLaunchProfileRequest
- Future<UpdateLaunchProfileResult> updateLaunchProfileAsync(UpdateLaunchProfileRequest updateLaunchProfileRequest, AsyncHandler<UpdateLaunchProfileRequest,UpdateLaunchProfileResult> asyncHandler)
Update a launch profile.
updateLaunchProfileRequest
- asyncHandler
- 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.Future<UpdateLaunchProfileMemberResult> updateLaunchProfileMemberAsync(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest)
Update a user persona in launch profile membership.
updateLaunchProfileMemberRequest
- Future<UpdateLaunchProfileMemberResult> updateLaunchProfileMemberAsync(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest, AsyncHandler<UpdateLaunchProfileMemberRequest,UpdateLaunchProfileMemberResult> asyncHandler)
Update a user persona in launch profile membership.
updateLaunchProfileMemberRequest
- asyncHandler
- 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.Future<UpdateStreamingImageResult> updateStreamingImageAsync(UpdateStreamingImageRequest updateStreamingImageRequest)
Update streaming image.
updateStreamingImageRequest
- Future<UpdateStreamingImageResult> updateStreamingImageAsync(UpdateStreamingImageRequest updateStreamingImageRequest, AsyncHandler<UpdateStreamingImageRequest,UpdateStreamingImageResult> asyncHandler)
Update streaming image.
updateStreamingImageRequest
- asyncHandler
- 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.Future<UpdateStudioResult> updateStudioAsync(UpdateStudioRequest updateStudioRequest)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioRequest
- Future<UpdateStudioResult> updateStudioAsync(UpdateStudioRequest updateStudioRequest, AsyncHandler<UpdateStudioRequest,UpdateStudioResult> asyncHandler)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioRequest
- asyncHandler
- 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.Future<UpdateStudioComponentResult> updateStudioComponentAsync(UpdateStudioComponentRequest updateStudioComponentRequest)
Updates a studio component resource.
updateStudioComponentRequest
- Future<UpdateStudioComponentResult> updateStudioComponentAsync(UpdateStudioComponentRequest updateStudioComponentRequest, AsyncHandler<UpdateStudioComponentRequest,UpdateStudioComponentResult> asyncHandler)
Updates a studio component resource.
updateStudioComponentRequest
- asyncHandler
- 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.