@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonNimbleStudio
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonNimbleStudio
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AcceptEulasResult |
acceptEulas(AcceptEulasRequest acceptEulasRequest)
Accept EULAs.
|
CreateLaunchProfileResult |
createLaunchProfile(CreateLaunchProfileRequest createLaunchProfileRequest)
Create a launch profile.
|
CreateStreamingImageResult |
createStreamingImage(CreateStreamingImageRequest createStreamingImageRequest)
Creates a streaming image resource in a studio.
|
CreateStreamingSessionResult |
createStreamingSession(CreateStreamingSessionRequest createStreamingSessionRequest)
Creates a streaming session in a studio.
|
CreateStreamingSessionStreamResult |
createStreamingSessionStream(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest)
Creates a streaming session stream for a streaming session.
|
CreateStudioResult |
createStudio(CreateStudioRequest createStudioRequest)
Create a new studio.
|
CreateStudioComponentResult |
createStudioComponent(CreateStudioComponentRequest createStudioComponentRequest)
Creates a studio component resource.
|
DeleteLaunchProfileResult |
deleteLaunchProfile(DeleteLaunchProfileRequest deleteLaunchProfileRequest)
Permanently delete a launch profile.
|
DeleteLaunchProfileMemberResult |
deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest)
Delete a user from launch profile membership.
|
DeleteStreamingImageResult |
deleteStreamingImage(DeleteStreamingImageRequest deleteStreamingImageRequest)
Delete streaming image.
|
DeleteStreamingSessionResult |
deleteStreamingSession(DeleteStreamingSessionRequest deleteStreamingSessionRequest)
Deletes streaming session resource.
|
DeleteStudioResult |
deleteStudio(DeleteStudioRequest deleteStudioRequest)
Delete a studio resource.
|
DeleteStudioComponentResult |
deleteStudioComponent(DeleteStudioComponentRequest deleteStudioComponentRequest)
Deletes a studio component resource.
|
DeleteStudioMemberResult |
deleteStudioMember(DeleteStudioMemberRequest deleteStudioMemberRequest)
Delete a user from studio membership.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEulaResult |
getEula(GetEulaRequest getEulaRequest)
Get EULA.
|
GetLaunchProfileResult |
getLaunchProfile(GetLaunchProfileRequest getLaunchProfileRequest)
Get a launch profile.
|
GetLaunchProfileDetailsResult |
getLaunchProfileDetails(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.
|
GetLaunchProfileInitializationResult |
getLaunchProfileInitialization(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest)
Get a launch profile initialization.
|
GetLaunchProfileMemberResult |
getLaunchProfileMember(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest)
Get a user persona in launch profile membership.
|
GetStreamingImageResult |
getStreamingImage(GetStreamingImageRequest getStreamingImageRequest)
Get streaming image.
|
GetStreamingSessionResult |
getStreamingSession(GetStreamingSessionRequest getStreamingSessionRequest)
Gets StreamingSession resource.
|
GetStreamingSessionBackupResult |
getStreamingSessionBackup(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest)
Gets
StreamingSessionBackup resource. |
GetStreamingSessionStreamResult |
getStreamingSessionStream(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest)
Gets a StreamingSessionStream for a streaming session.
|
GetStudioResult |
getStudio(GetStudioRequest getStudioRequest)
Get a studio resource.
|
GetStudioComponentResult |
getStudioComponent(GetStudioComponentRequest getStudioComponentRequest)
Gets a studio component resource.
|
GetStudioMemberResult |
getStudioMember(GetStudioMemberRequest getStudioMemberRequest)
Get a user's membership in a studio.
|
ListEulaAcceptancesResult |
listEulaAcceptances(ListEulaAcceptancesRequest listEulaAcceptancesRequest)
List EULA acceptances.
|
ListEulasResult |
listEulas(ListEulasRequest listEulasRequest)
List EULAs.
|
ListLaunchProfileMembersResult |
listLaunchProfileMembers(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest)
Get all users in a given launch profile membership.
|
ListLaunchProfilesResult |
listLaunchProfiles(ListLaunchProfilesRequest listLaunchProfilesRequest)
List all the launch profiles a studio.
|
ListStreamingImagesResult |
listStreamingImages(ListStreamingImagesRequest listStreamingImagesRequest)
List the streaming image resources available to this studio.
|
ListStreamingSessionBackupsResult |
listStreamingSessionBackups(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest)
Lists the backups of a streaming session in a studio.
|
ListStreamingSessionsResult |
listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest)
Lists the streaming sessions in a studio.
|
ListStudioComponentsResult |
listStudioComponents(ListStudioComponentsRequest listStudioComponentsRequest)
Lists the
StudioComponents in a studio. |
ListStudioMembersResult |
listStudioMembers(ListStudioMembersRequest listStudioMembersRequest)
Get all users in a given studio membership.
|
ListStudiosResult |
listStudios(ListStudiosRequest listStudiosRequest)
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the tags for a resource, given its Amazon Resource Names (ARN).
|
PutLaunchProfileMembersResult |
putLaunchProfileMembers(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest)
Add/update users with given persona to launch profile membership.
|
PutStudioMembersResult |
putStudioMembers(PutStudioMembersRequest putStudioMembersRequest)
Add/update users with given persona to studio membership.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartStreamingSessionResult |
startStreamingSession(StartStreamingSessionRequest startStreamingSessionRequest)
Transitions sessions from the
STOPPED state into the READY state. |
StartStudioSSOConfigurationRepairResult |
startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest)
Repairs the IAM Identity Center configuration for a given studio.
|
StopStreamingSessionResult |
stopStreamingSession(StopStreamingSessionRequest stopStreamingSessionRequest)
Transitions sessions from the
READY state into the STOPPED state. |
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Creates tags for a resource, given its ARN.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the tags for a resource.
|
UpdateLaunchProfileResult |
updateLaunchProfile(UpdateLaunchProfileRequest updateLaunchProfileRequest)
Update a launch profile.
|
UpdateLaunchProfileMemberResult |
updateLaunchProfileMember(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest)
Update a user persona in launch profile membership.
|
UpdateStreamingImageResult |
updateStreamingImage(UpdateStreamingImageRequest updateStreamingImageRequest)
Update streaming image.
|
UpdateStudioResult |
updateStudio(UpdateStudioRequest updateStudioRequest)
Update a Studio resource.
|
UpdateStudioComponentResult |
updateStudioComponent(UpdateStudioComponentRequest updateStudioComponentRequest)
Updates a studio component resource.
|
AmazonNimbleStudioWaiters |
waiters() |
static final String ENDPOINT_PREFIX
AcceptEulasResult acceptEulas(AcceptEulasRequest acceptEulasRequest)
Accept EULAs.
acceptEulasRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest createLaunchProfileRequest)
Create a launch profile.
createLaunchProfileRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest createStreamingImageRequest)
Creates a streaming image resource in a studio.
createStreamingImageRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateStreamingSessionResult createStreamingSession(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateStreamingSessionStreamResult createStreamingSessionStream(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateStudioResult createStudio(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest createStudioComponentRequest)
Creates a studio component resource.
createStudioComponentRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest deleteLaunchProfileRequest)
Permanently delete a launch profile.
deleteLaunchProfileRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest)
Delete a user from launch profile membership.
deleteLaunchProfileMemberRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest deleteStreamingImageRequest)
Delete streaming image.
deleteStreamingImageRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteStreamingSessionResult deleteStreamingSession(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteStudioResult deleteStudio(DeleteStudioRequest deleteStudioRequest)
Delete a studio resource.
deleteStudioRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest deleteStudioComponentRequest)
Deletes a studio component resource.
deleteStudioComponentRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest deleteStudioMemberRequest)
Delete a user from studio membership.
deleteStudioMemberRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetEulaResult getEula(GetEulaRequest getEulaRequest)
Get EULA.
getEulaRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest getLaunchProfileRequest)
Get a launch profile.
getLaunchProfileRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetLaunchProfileDetailsResult getLaunchProfileDetails(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest)
Get a launch profile initialization.
getLaunchProfileInitializationRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest)
Get a user persona in launch profile membership.
getLaunchProfileMemberRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStreamingImageResult getStreamingImage(GetStreamingImageRequest getStreamingImageRequest)
Get streaming image.
getStreamingImageRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest getStreamingSessionRequest)
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStreamingSessionBackupResult getStreamingSessionBackup(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest)
Gets StreamingSessionBackup
resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackupRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.GetStreamingSessionStreamResult getStreamingSessionStream(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStudioResult getStudio(GetStudioRequest getStudioRequest)
Get a studio resource.
getStudioRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStudioComponentResult getStudioComponent(GetStudioComponentRequest getStudioComponentRequest)
Gets a studio component resource.
getStudioComponentRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
GetStudioMemberResult getStudioMember(GetStudioMemberRequest getStudioMemberRequest)
Get a user's membership in a studio.
getStudioMemberRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest listEulaAcceptancesRequest)
List EULA acceptances.
listEulaAcceptancesRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListEulasResult listEulas(ListEulasRequest listEulasRequest)
List EULAs.
listEulasRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest)
Get all users in a given launch profile membership.
listLaunchProfileMembersRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest listLaunchProfilesRequest)
List all the launch profiles a studio.
listLaunchProfilesRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListStreamingImagesResult listStreamingImages(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListStreamingSessionBackupsResult listStreamingSessionBackups(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest)
Lists the backups of a streaming session in a studio.
listStreamingSessionBackupsRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest)
Lists the streaming sessions in a studio.
listStreamingSessionsRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest listStudioComponentsRequest)
Lists the StudioComponents
in a studio.
listStudioComponentsRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListStudioMembersResult listStudioMembers(ListStudioMembersRequest listStudioMembersRequest)
Get all users in a given studio membership.
ListStudioMembers
only returns admin members.
listStudioMembersRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListStudiosResult listStudios(ListStudiosRequest listStudiosRequest)
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudiosRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
ListTagsForResourceResult listTagsForResource(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembersRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
PutStudioMembersResult putStudioMembers(PutStudioMembersRequest putStudioMembersRequest)
Add/update users with given persona to studio membership.
putStudioMembersRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
StartStreamingSessionResult startStreamingSession(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
StopStreamingSessionResult stopStreamingSession(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
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates tags for a resource, given its ARN.
tagResourceRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes the tags for a resource.
untagResourceRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest updateLaunchProfileRequest)
Update a launch profile.
updateLaunchProfileRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest)
Update a user persona in launch profile membership.
updateLaunchProfileMemberRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest updateStreamingImageRequest)
Update streaming image.
updateStreamingImageRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UpdateStudioResult updateStudio(UpdateStudioRequest updateStudioRequest)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest updateStudioComponentRequest)
Updates a studio component resource.
updateStudioComponentRequest
- ResourceNotFoundException
- The specified resource could not be found.ConflictException
- Another operation is in progress.ThrottlingException
- The request throughput limit was exceeded.ValidationException
- One of the parameters in the request is invalid.AccessDeniedException
- You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException
- An internal error has occurred. Please retry your request.ServiceQuotaExceededException
- Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.AmazonNimbleStudioWaiters waiters()