@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonNimbleStudioClient extends AmazonWebServiceClient implements AmazonNimbleStudio
Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.
Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonNimbleStudioClientBuilder builder()
public AcceptEulasResult acceptEulas(AcceptEulasRequest request)
Accept EULAs.
acceptEulas in interface AmazonNimbleStudioacceptEulasRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest request)
Create a launch profile.
createLaunchProfile in interface AmazonNimbleStudiocreateLaunchProfileRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest request)
Creates a streaming image resource in a studio.
createStreamingImage in interface AmazonNimbleStudiocreateStreamingImageRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 the
READY state.
createStreamingSession in interface AmazonNimbleStudiocreateStreamingSessionRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 the READY state.
createStreamingSessionStream in interface AmazonNimbleStudiocreateStreamingSessionStreamRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 KMS key. By default, this key is owned by Amazon Web Services and managed on your
behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key
you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
createStudio in interface AmazonNimbleStudiocreateStudioRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest request)
Creates a studio component resource.
createStudioComponent in interface AmazonNimbleStudiocreateStudioComponentRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest request)
Permanently delete a launch profile.
deleteLaunchProfile in interface AmazonNimbleStudiodeleteLaunchProfileRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest request)
Delete a user from launch profile membership.
deleteLaunchProfileMember in interface AmazonNimbleStudiodeleteLaunchProfileMemberRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest request)
Delete streaming image.
deleteStreamingImage in interface AmazonNimbleStudiodeleteStreamingImageRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 AmazonNimbleStudiodeleteStreamingSessionRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteStudioResult deleteStudio(DeleteStudioRequest request)
Delete a studio resource.
deleteStudio in interface AmazonNimbleStudiodeleteStudioRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest request)
Deletes a studio component resource.
deleteStudioComponent in interface AmazonNimbleStudiodeleteStudioComponentRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest request)
Delete a user from studio membership.
deleteStudioMember in interface AmazonNimbleStudiodeleteStudioMemberRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetEulaResult getEula(GetEulaRequest request)
Get EULA.
getEula in interface AmazonNimbleStudiogetEulaRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest request)
Get a launch profile.
getLaunchProfile in interface AmazonNimbleStudiogetLaunchProfileRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 AmazonNimbleStudiogetLaunchProfileDetailsRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest request)
Get a launch profile initialization.
getLaunchProfileInitialization in interface AmazonNimbleStudiogetLaunchProfileInitializationRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest request)
Get a user persona in launch profile membership.
getLaunchProfileMember in interface AmazonNimbleStudiogetLaunchProfileMemberRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetStreamingImageResult getStreamingImage(GetStreamingImageRequest request)
Get streaming image.
getStreamingImage in interface AmazonNimbleStudiogetStreamingImageRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 AmazonNimbleStudiogetStreamingSessionRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetStreamingSessionBackupResult getStreamingSessionBackup(GetStreamingSessionBackupRequest request)
Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
getStreamingSessionBackup in interface AmazonNimbleStudiogetStreamingSessionBackupRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.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 READY state, the url property will
contain a stream to be used with the DCV streaming client.
getStreamingSessionStream in interface AmazonNimbleStudiogetStreamingSessionStreamRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetStudioResult getStudio(GetStudioRequest request)
Get a studio resource.
getStudio in interface AmazonNimbleStudiogetStudioRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetStudioComponentResult getStudioComponent(GetStudioComponentRequest request)
Gets a studio component resource.
getStudioComponent in interface AmazonNimbleStudiogetStudioComponentRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public GetStudioMemberResult getStudioMember(GetStudioMemberRequest request)
Get a user's membership in a studio.
getStudioMember in interface AmazonNimbleStudiogetStudioMemberRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest request)
List EULA acceptances.
listEulaAcceptances in interface AmazonNimbleStudiolistEulaAcceptancesRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListEulasResult listEulas(ListEulasRequest request)
List EULAs.
listEulas in interface AmazonNimbleStudiolistEulasRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest request)
Get all users in a given launch profile membership.
listLaunchProfileMembers in interface AmazonNimbleStudiolistLaunchProfileMembersRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest request)
List all the launch profiles a studio.
listLaunchProfiles in interface AmazonNimbleStudiolistLaunchProfilesRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest request)
List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
listStreamingImages in interface AmazonNimbleStudiolistStreamingImagesRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListStreamingSessionBackupsResult listStreamingSessionBackups(ListStreamingSessionBackupsRequest request)
Lists the backups of a streaming session in a studio.
listStreamingSessionBackups in interface AmazonNimbleStudiolistStreamingSessionBackupsRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.public ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest request)
Lists the streaming sessions in a studio.
listStreamingSessions in interface AmazonNimbleStudiolistStreamingSessionsRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest request)
Lists the StudioComponents in a studio.
listStudioComponents in interface AmazonNimbleStudiolistStudioComponentsRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListStudioMembersResult listStudioMembers(ListStudioMembersRequest request)
Get all users in a given studio membership.
ListStudioMembers only returns admin members.
listStudioMembers in interface AmazonNimbleStudiolistStudioMembersRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public ListStudiosResult listStudios(ListStudiosRequest request)
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
listStudios in interface AmazonNimbleStudiolistStudiosRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 AmazonNimbleStudiolistTagsForResourceRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest request)
Add/update users with given persona to launch profile membership.
putLaunchProfileMembers in interface AmazonNimbleStudioputLaunchProfileMembersRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public PutStudioMembersResult putStudioMembers(PutStudioMembersRequest request)
Add/update users with given persona to studio membership.
putStudioMembers in interface AmazonNimbleStudioputStudioMembersRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public StartStreamingSessionResult startStreamingSession(StartStreamingSessionRequest request)
Transitions sessions from the STOPPED state into the READY state. The
START_IN_PROGRESS state is the intermediate state between the STOPPED and
READY states.
startStreamingSession in interface AmazonNimbleStudiostartStreamingSessionRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest request)
Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new
IAM Identity Center application is created for the studio and the studio is changed to the READY
state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
startStudioSSOConfigurationRepair in interface AmazonNimbleStudiostartStudioSSOConfigurationRepairRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public StopStreamingSessionResult stopStreamingSession(StopStreamingSessionRequest request)
Transitions sessions from the READY state into the STOPPED state. The
STOP_IN_PROGRESS state is the intermediate state between the READY and
STOPPED states.
stopStreamingSession in interface AmazonNimbleStudiostopStreamingSessionRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public TagResourceResult tagResource(TagResourceRequest request)
Creates tags for a resource, given its ARN.
tagResource in interface AmazonNimbleStudiotagResourceRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the tags for a resource.
untagResource in interface AmazonNimbleStudiountagResourceRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest request)
Update a launch profile.
updateLaunchProfile in interface AmazonNimbleStudioupdateLaunchProfileRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest request)
Update a user persona in launch profile membership.
updateLaunchProfileMember in interface AmazonNimbleStudioupdateLaunchProfileMemberRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest request)
Update streaming image.
updateStreamingImage in interface AmazonNimbleStudioupdateStreamingImageRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UpdateStudioResult updateStudio(UpdateStudioRequest request)
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
updateStudio in interface AmazonNimbleStudioupdateStudioRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
public UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest request)
Updates a studio component resource.
updateStudioComponent in interface AmazonNimbleStudioupdateStudioComponentRequest - ResourceNotFoundException - The specified resource could not be found.ConflictException - Another operation is in progress.ThrottlingException - The request throughput limit was exceeded.ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using
the correct access keys.InternalServerErrorException - An internal error has occurred. Please retry your request.ServiceQuotaExceededException - Your current quota does not allow you to perform the request action. You can request increases for some
quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
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 AmazonNimbleStudiorequest - The originally executed requestpublic AmazonNimbleStudioWaiters waiters()
waiters in interface AmazonNimbleStudiopublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonNimbleStudioshutdown in class AmazonWebServiceClient