@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.
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.
|
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.
|
ListStreamingSessionsResult |
listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest)
Lists the streaming image resources 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 AWS account in the requested AWS 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.
|
StartStudioSSOConfigurationRepairResult |
startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest)
Repairs the SSO configuration for a given studio.
|
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.
|
static final String ENDPOINT_PREFIX
AcceptEulasResult acceptEulas(AcceptEulasRequest acceptEulasRequest)
Accept EULAs.
acceptEulasRequest
- A collection of EULA acceptances.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest createLaunchProfileRequest)
Create a launch profile.
createLaunchProfileRequest
- A collection of launch profiles.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest createStreamingImageRequest)
Creates a streaming image resource in a studio.
createStreamingImageRequest
- A collection of streaming images.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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 state READY.
createStreamingSessionRequest
- A collection of streaming sessions.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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 state READY.
createStreamingSessionStreamRequest
- A list collection streams.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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 AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an AWS KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
createStudioRequest
- A collection of studio resources.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest createStudioComponentRequest)
Creates a studio component resource.
createStudioComponentRequest
- The studio components.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest deleteLaunchProfileRequest)
Permanently delete a launch profile.
deleteLaunchProfileRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest)
Delete a user from launch profile membership.
deleteLaunchProfileMemberRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest deleteStreamingImageRequest)
Delete streaming image.
deleteStreamingImageRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteStudioResult deleteStudio(DeleteStudioRequest deleteStudioRequest)
Delete a studio resource.
deleteStudioRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest deleteStudioComponentRequest)
Deletes a studio component resource.
deleteStudioComponentRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest deleteStudioMemberRequest)
Delete a user from studio membership.
deleteStudioMemberRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetEulaResult getEula(GetEulaRequest getEulaRequest)
Get Eula.
getEulaRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest getLaunchProfileRequest)
Get a launch profile.
getLaunchProfileRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest)
Get a launch profile initialization.
getLaunchProfileInitializationRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest)
Get a user persona in launch profile membership.
getLaunchProfileMemberRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetStreamingImageResult getStreamingImage(GetStreamingImageRequest getStreamingImageRequest)
Get streaming image.
getStreamingImageRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest getStreamingSessionRequest)
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSessionRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. 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 state READY, the url property will contain a stream to be used with the DCV streaming client.
getStreamingSessionStreamRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetStudioResult getStudio(GetStudioRequest getStudioRequest)
Get a Studio resource.
getStudioRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetStudioComponentResult getStudioComponent(GetStudioComponentRequest getStudioComponentRequest)
Gets a studio component resource.
getStudioComponentRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.GetStudioMemberResult getStudioMember(GetStudioMemberRequest getStudioMemberRequest)
Get a user's membership in a studio.
getStudioMemberRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest listEulaAcceptancesRequest)
List Eula Acceptances.
listEulaAcceptancesRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListEulasResult listEulas(ListEulasRequest listEulasRequest)
List Eulas.
listEulasRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest)
Get all users in a given launch profile membership.
listLaunchProfileMembersRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest listLaunchProfilesRequest)
List all the launch profiles a studio.
listLaunchProfilesRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest listStreamingImagesRequest)
List the streaming image resources available to this studio.
This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.
listStreamingImagesRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest)
Lists the streaming image resources in a studio.
listStreamingSessionsRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest listStudioComponentsRequest)
Lists the StudioComponents in a studio.
listStudioComponentsRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListStudioMembersResult listStudioMembers(ListStudioMembersRequest listStudioMembersRequest)
Get all users in a given studio membership.
listStudioMembersRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.ListStudiosResult listStudios(ListStudiosRequest listStudiosRequest)
List studios in your AWS account in the requested AWS Region.
listStudiosRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembersRequest
- Information about a launch profile membership.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.PutStudioMembersResult putStudioMembers(PutStudioMembersRequest putStudioMembersRequest)
Add/update users with given persona to studio membership.
putStudioMembersRequest
- A launch profile membership collection.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest)
Repairs the SSO configuration for a given studio.
If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.
After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
startStudioSSOConfigurationRepairRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates tags for a resource, given its ARN.
tagResourceRequest
- The ARN for the role that manages access.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes the tags for a resource.
untagResourceRequest
- ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest updateLaunchProfileRequest)
Update a launch profile.
updateLaunchProfileRequest
- The launch profile ID.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest)
Update a user persona in launch profile membership.
updateLaunchProfileMemberRequest
- The principal ID.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest updateStreamingImageRequest)
Update streaming image.
updateStreamingImageRequest
- The streaming image ID.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UpdateStudioResult updateStudio(UpdateStudioRequest updateStudioRequest)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudioRequest
- The studio ID.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest updateStudioComponentRequest)
Updates a studio component resource.
updateStudioComponentRequest
- The studio component ID.ValidationException
- One of the parameters in the request is invalid.InternalServerErrorException
- A service fault has occurred. Please retry your request and contact AWS support if this error continues.ServiceQuotaExceededException
- This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to
request an increase.AccessDeniedException
- You do not have permission to perform this action.ResourceNotFoundException
- A requested resource was not found.ThrottlingException
- The request was denied due to request throttling. Please retry your request.ConflictException
- This request conflicts with another concurrent request. Please retry your request.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.