@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonNimbleStudioClient extends AmazonWebServiceClient implements AmazonNimbleStudio
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonNimbleStudioClientBuilder builder()
public AcceptEulasResult acceptEulas(AcceptEulasRequest request)
Accept EULAs.
acceptEulas
in interface AmazonNimbleStudio
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.public CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest request)
Create a launch profile.
createLaunchProfile
in interface AmazonNimbleStudio
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.public CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest request)
Creates a streaming image resource in a studio.
createStreamingImage
in interface AmazonNimbleStudio
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.public CreateStreamingSessionResult createStreamingSession(CreateStreamingSessionRequest request)
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.
createStreamingSession
in interface AmazonNimbleStudio
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.public CreateStreamingSessionStreamResult createStreamingSessionStream(CreateStreamingSessionStreamRequest request)
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.
createStreamingSessionStream
in interface AmazonNimbleStudio
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.public CreateStudioResult createStudio(CreateStudioRequest request)
Create a new Studio.
When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration.
In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an AWS KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
createStudio
in interface AmazonNimbleStudio
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.public CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest request)
Creates a studio component resource.
createStudioComponent
in interface AmazonNimbleStudio
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.public DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest request)
Permanently delete a launch profile.
deleteLaunchProfile
in interface AmazonNimbleStudio
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.public DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest request)
Delete a user from launch profile membership.
deleteLaunchProfileMember
in interface AmazonNimbleStudio
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.public DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest request)
Delete streaming image.
deleteStreamingImage
in interface AmazonNimbleStudio
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.public DeleteStreamingSessionResult deleteStreamingSession(DeleteStreamingSessionRequest request)
Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked DELETED.
deleteStreamingSession
in interface AmazonNimbleStudio
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.public DeleteStudioResult deleteStudio(DeleteStudioRequest request)
Delete a studio resource.
deleteStudio
in interface AmazonNimbleStudio
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.public DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest request)
Deletes a studio component resource.
deleteStudioComponent
in interface AmazonNimbleStudio
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.public DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest request)
Delete a user from studio membership.
deleteStudioMember
in interface AmazonNimbleStudio
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.public GetEulaResult getEula(GetEulaRequest request)
Get Eula.
getEula
in interface AmazonNimbleStudio
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.public GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest request)
Get a launch profile.
getLaunchProfile
in interface AmazonNimbleStudio
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.public GetLaunchProfileDetailsResult getLaunchProfileDetails(GetLaunchProfileDetailsRequest request)
Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
getLaunchProfileDetails
in interface AmazonNimbleStudio
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.public GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest request)
Get a launch profile initialization.
getLaunchProfileInitialization
in interface AmazonNimbleStudio
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.public GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest request)
Get a user persona in launch profile membership.
getLaunchProfileMember
in interface AmazonNimbleStudio
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.public GetStreamingImageResult getStreamingImage(GetStreamingImageRequest request)
Get streaming image.
getStreamingImage
in interface AmazonNimbleStudio
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.public GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest request)
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
getStreamingSession
in interface AmazonNimbleStudio
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.public GetStreamingSessionStreamResult getStreamingSessionStream(GetStreamingSessionStreamRequest request)
Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.
getStreamingSessionStream
in interface AmazonNimbleStudio
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.public GetStudioResult getStudio(GetStudioRequest request)
Get a Studio resource.
getStudio
in interface AmazonNimbleStudio
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.public GetStudioComponentResult getStudioComponent(GetStudioComponentRequest request)
Gets a studio component resource.
getStudioComponent
in interface AmazonNimbleStudio
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.public GetStudioMemberResult getStudioMember(GetStudioMemberRequest request)
Get a user's membership in a studio.
getStudioMember
in interface AmazonNimbleStudio
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.public ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest request)
List Eula Acceptances.
listEulaAcceptances
in interface AmazonNimbleStudio
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.public ListEulasResult listEulas(ListEulasRequest request)
List Eulas.
listEulas
in interface AmazonNimbleStudio
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.public ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest request)
Get all users in a given launch profile membership.
listLaunchProfileMembers
in interface AmazonNimbleStudio
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.public ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest request)
List all the launch profiles a studio.
listLaunchProfiles
in interface AmazonNimbleStudio
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.public ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest request)
List the streaming image resources available to this studio.
This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.
listStreamingImages
in interface AmazonNimbleStudio
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.public ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest request)
Lists the streaming image resources in a studio.
listStreamingSessions
in interface AmazonNimbleStudio
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.public ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest request)
Lists the StudioComponents in a studio.
listStudioComponents
in interface AmazonNimbleStudio
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.public ListStudioMembersResult listStudioMembers(ListStudioMembersRequest request)
Get all users in a given studio membership.
listStudioMembers
in interface AmazonNimbleStudio
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.public ListStudiosResult listStudios(ListStudiosRequest request)
List studios in your AWS account in the requested AWS Region.
listStudios
in interface AmazonNimbleStudio
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets the tags for a resource, given its Amazon Resource Names (ARN).
This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
listTagsForResource
in interface AmazonNimbleStudio
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.public PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest request)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembers
in interface AmazonNimbleStudio
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.public PutStudioMembersResult putStudioMembers(PutStudioMembersRequest request)
Add/update users with given persona to studio membership.
putStudioMembers
in interface AmazonNimbleStudio
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.public StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest request)
Repairs the SSO configuration for a given studio.
If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.
After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
startStudioSSOConfigurationRepair
in interface AmazonNimbleStudio
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.public TagResourceResult tagResource(TagResourceRequest request)
Creates tags for a resource, given its ARN.
tagResource
in interface AmazonNimbleStudio
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the tags for a resource.
untagResource
in interface AmazonNimbleStudio
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.public UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest request)
Update a launch profile.
updateLaunchProfile
in interface AmazonNimbleStudio
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.public UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest request)
Update a user persona in launch profile membership.
updateLaunchProfileMember
in interface AmazonNimbleStudio
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.public UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest request)
Update streaming image.
updateStreamingImage
in interface AmazonNimbleStudio
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.public UpdateStudioResult updateStudio(UpdateStudioRequest request)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudio
in interface AmazonNimbleStudio
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.public UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest request)
Updates a studio component resource.
updateStudioComponent
in interface AmazonNimbleStudio
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonNimbleStudio
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonNimbleStudio
shutdown
in class AmazonWebServiceClient