/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.nimblestudio; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.nimblestudio.model.*; import com.amazonaws.services.nimblestudio.waiters.AmazonNimbleStudioWaiters; /** * Interface for accessing AmazonNimbleStudio. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.nimblestudio.AbstractAmazonNimbleStudio} instead. *
**
* Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, * parameters, and more to help you get the most out of Nimble Studio. *
** Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create * content securely within a scalable, private cloud service. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonNimbleStudio { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "nimble"; /** ** Accept EULAs. *
* * @param acceptEulasRequest * @return Result of the AcceptEulas operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.AcceptEulas * @see AWS API * Documentation */ AcceptEulasResult acceptEulas(AcceptEulasRequest acceptEulasRequest); /** *
* Create a launch profile. *
* * @param createLaunchProfileRequest * @return Result of the CreateLaunchProfile operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.CreateLaunchProfile * @see AWS API * Documentation */ CreateLaunchProfileResult createLaunchProfile(CreateLaunchProfileRequest createLaunchProfileRequest); /** *
* Creates a streaming image resource in a studio. *
* * @param createStreamingImageRequest * @return Result of the CreateStreamingImage operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.CreateStreamingImage * @see AWS * API Documentation */ CreateStreamingImageResult createStreamingImage(CreateStreamingImageRequest createStreamingImageRequest); /** *
* Creates a streaming session in a studio. *
*
* After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
* READY
state.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.CreateStreamingSession * @see AWS * API Documentation */ CreateStreamingSessionResult createStreamingSession(CreateStreamingSessionRequest createStreamingSessionRequest); /** *
* 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.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.CreateStreamingSessionStream * @see AWS API Documentation */ CreateStreamingSessionStreamResult createStreamingSessionStream(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest); /** *
* 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. *
* * @param createStudioRequest * @return Result of the CreateStudio operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.CreateStudio * @see AWS API * Documentation */ CreateStudioResult createStudio(CreateStudioRequest createStudioRequest); /** *
* Creates a studio component resource. *
* * @param createStudioComponentRequest * @return Result of the CreateStudioComponent operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.CreateStudioComponent * @see AWS * API Documentation */ CreateStudioComponentResult createStudioComponent(CreateStudioComponentRequest createStudioComponentRequest); /** *
* Permanently delete a launch profile. *
* * @param deleteLaunchProfileRequest * @return Result of the DeleteLaunchProfile operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteLaunchProfile * @see AWS API * Documentation */ DeleteLaunchProfileResult deleteLaunchProfile(DeleteLaunchProfileRequest deleteLaunchProfileRequest); /** *
* Delete a user from launch profile membership. *
* * @param deleteLaunchProfileMemberRequest * @return Result of the DeleteLaunchProfileMember operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteLaunchProfileMember * @see AWS API Documentation */ DeleteLaunchProfileMemberResult deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest); /** *
* Delete streaming image. *
* * @param deleteStreamingImageRequest * @return Result of the DeleteStreamingImage operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteStreamingImage * @see AWS * API Documentation */ DeleteStreamingImageResult deleteStreamingImage(DeleteStreamingImageRequest deleteStreamingImageRequest); /** *
* 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
.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.DeleteStreamingSession * @see AWS * API Documentation */ DeleteStreamingSessionResult deleteStreamingSession(DeleteStreamingSessionRequest deleteStreamingSessionRequest); /** *
* Delete a studio resource. *
* * @param deleteStudioRequest * @return Result of the DeleteStudio operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteStudio * @see AWS API * Documentation */ DeleteStudioResult deleteStudio(DeleteStudioRequest deleteStudioRequest); /** *
* Deletes a studio component resource. *
* * @param deleteStudioComponentRequest * @return Result of the DeleteStudioComponent operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteStudioComponent * @see AWS * API Documentation */ DeleteStudioComponentResult deleteStudioComponent(DeleteStudioComponentRequest deleteStudioComponentRequest); /** *
* Delete a user from studio membership. *
* * @param deleteStudioMemberRequest * @return Result of the DeleteStudioMember operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.DeleteStudioMember * @see AWS API * Documentation */ DeleteStudioMemberResult deleteStudioMember(DeleteStudioMemberRequest deleteStudioMemberRequest); /** *
* Get EULA. *
* * @param getEulaRequest * @return Result of the GetEula operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetEula * @see AWS API * Documentation */ GetEulaResult getEula(GetEulaRequest getEulaRequest); /** *
* Get a launch profile. *
* * @param getLaunchProfileRequest * @return Result of the GetLaunchProfile operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetLaunchProfile * @see AWS API * Documentation */ GetLaunchProfileResult getLaunchProfile(GetLaunchProfileRequest getLaunchProfileRequest); /** *
* 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. *
* * @param getLaunchProfileDetailsRequest * @return Result of the GetLaunchProfileDetails operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetLaunchProfileDetails * @see AWS * API Documentation */ GetLaunchProfileDetailsResult getLaunchProfileDetails(GetLaunchProfileDetailsRequest getLaunchProfileDetailsRequest); /** *
* Get a launch profile initialization. *
* * @param getLaunchProfileInitializationRequest * @return Result of the GetLaunchProfileInitialization operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetLaunchProfileInitialization * @see AWS API Documentation */ GetLaunchProfileInitializationResult getLaunchProfileInitialization(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest); /** *
* Get a user persona in launch profile membership. *
* * @param getLaunchProfileMemberRequest * @return Result of the GetLaunchProfileMember operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetLaunchProfileMember * @see AWS * API Documentation */ GetLaunchProfileMemberResult getLaunchProfileMember(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest); /** *
* Get streaming image. *
* * @param getStreamingImageRequest * @return Result of the GetStreamingImage operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetStreamingImage * @see AWS API * Documentation */ GetStreamingImageResult getStreamingImage(GetStreamingImageRequest getStreamingImageRequest); /** *
* Gets StreamingSession resource. *
** Invoke this operation to poll for a streaming session state while creating or deleting a session. *
* * @param getStreamingSessionRequest * @return Result of the GetStreamingSession operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetStreamingSession * @see AWS API * Documentation */ GetStreamingSessionResult getStreamingSession(GetStreamingSessionRequest getStreamingSessionRequest); /** *
* Gets StreamingSessionBackup
resource.
*
* Invoke this operation to poll for a streaming session backup while stopping a streaming session. *
* * @param getStreamingSessionBackupRequest * @return Result of the GetStreamingSessionBackup operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @sample AmazonNimbleStudio.GetStreamingSessionBackup * @see AWS API Documentation */ GetStreamingSessionBackupResult getStreamingSessionBackup(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest); /** ** 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.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.GetStreamingSessionStream * @see AWS API Documentation */ GetStreamingSessionStreamResult getStreamingSessionStream(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest); /** *
* Get a studio resource. *
* * @param getStudioRequest * @return Result of the GetStudio operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetStudio * @see AWS API * Documentation */ GetStudioResult getStudio(GetStudioRequest getStudioRequest); /** *
* Gets a studio component resource. *
* * @param getStudioComponentRequest * @return Result of the GetStudioComponent operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetStudioComponent * @see AWS API * Documentation */ GetStudioComponentResult getStudioComponent(GetStudioComponentRequest getStudioComponentRequest); /** *
* Get a user's membership in a studio. *
* * @param getStudioMemberRequest * @return Result of the GetStudioMember operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.GetStudioMember * @see AWS API * Documentation */ GetStudioMemberResult getStudioMember(GetStudioMemberRequest getStudioMemberRequest); /** *
* List EULA acceptances. *
* * @param listEulaAcceptancesRequest * @return Result of the ListEulaAcceptances operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListEulaAcceptances * @see AWS API * Documentation */ ListEulaAcceptancesResult listEulaAcceptances(ListEulaAcceptancesRequest listEulaAcceptancesRequest); /** *
* List EULAs. *
* * @param listEulasRequest * @return Result of the ListEulas operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListEulas * @see AWS API * Documentation */ ListEulasResult listEulas(ListEulasRequest listEulasRequest); /** *
* Get all users in a given launch profile membership. *
* * @param listLaunchProfileMembersRequest * @return Result of the ListLaunchProfileMembers operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListLaunchProfileMembers * @see AWS API Documentation */ ListLaunchProfileMembersResult listLaunchProfileMembers(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest); /** *
* List all the launch profiles a studio. *
* * @param listLaunchProfilesRequest * @return Result of the ListLaunchProfiles operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListLaunchProfiles * @see AWS API * Documentation */ ListLaunchProfilesResult listLaunchProfiles(ListLaunchProfilesRequest listLaunchProfilesRequest); /** *
* 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. *
* * @param listStreamingImagesRequest * @return Result of the ListStreamingImages operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListStreamingImages * @see AWS API * Documentation */ ListStreamingImagesResult listStreamingImages(ListStreamingImagesRequest listStreamingImagesRequest); /** *
* Lists the backups of a streaming session in a studio. *
* * @param listStreamingSessionBackupsRequest * @return Result of the ListStreamingSessionBackups operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @sample AmazonNimbleStudio.ListStreamingSessionBackups * @see AWS API Documentation */ ListStreamingSessionBackupsResult listStreamingSessionBackups(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest); /** ** Lists the streaming sessions in a studio. *
* * @param listStreamingSessionsRequest * @return Result of the ListStreamingSessions operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListStreamingSessions * @see AWS * API Documentation */ ListStreamingSessionsResult listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest); /** *
* Lists the StudioComponents
in a studio.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.ListStudioComponents * @see AWS * API Documentation */ ListStudioComponentsResult listStudioComponents(ListStudioComponentsRequest listStudioComponentsRequest); /** *
* Get all users in a given studio membership. *
*
* ListStudioMembers
only returns admin members.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.ListStudioMembers * @see AWS API * Documentation */ ListStudioMembersResult listStudioMembers(ListStudioMembersRequest listStudioMembersRequest); /** *
* List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region. *
* * @param listStudiosRequest * @return Result of the ListStudios operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListStudios * @see AWS API * Documentation */ ListStudiosResult listStudios(ListStudiosRequest listStudiosRequest); /** *
* 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. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *
* Add/update users with given persona to launch profile membership. *
* * @param putLaunchProfileMembersRequest * @return Result of the PutLaunchProfileMembers operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.PutLaunchProfileMembers * @see AWS * API Documentation */ PutLaunchProfileMembersResult putLaunchProfileMembers(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest); /** *
* Add/update users with given persona to studio membership. *
* * @param putStudioMembersRequest * @return Result of the PutStudioMembers operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.PutStudioMembers * @see AWS API * Documentation */ PutStudioMembersResult putStudioMembers(PutStudioMembersRequest putStudioMembersRequest); /** *
* 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.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.StartStreamingSession * @see AWS * API Documentation */ StartStreamingSessionResult startStreamingSession(StartStreamingSessionRequest startStreamingSessionRequest); /** *
* 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. *
* * @param startStudioSSOConfigurationRepairRequest * @return Result of the StartStudioSSOConfigurationRepair operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.StartStudioSSOConfigurationRepair * @see AWS API Documentation */ StartStudioSSOConfigurationRepairResult startStudioSSOConfigurationRepair(StartStudioSSOConfigurationRepairRequest startStudioSSOConfigurationRepairRequest); /** *
* 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.
*
* Please use Amazon Web Services Service Quotas to request an increase. * @sample AmazonNimbleStudio.StopStreamingSession * @see AWS * API Documentation */ StopStreamingSessionResult stopStreamingSession(StopStreamingSessionRequest stopStreamingSessionRequest); /** *
* Creates tags for a resource, given its ARN. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *
* Deletes the tags for a resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *
* Update a launch profile. *
* * @param updateLaunchProfileRequest * @return Result of the UpdateLaunchProfile operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UpdateLaunchProfile * @see AWS API * Documentation */ UpdateLaunchProfileResult updateLaunchProfile(UpdateLaunchProfileRequest updateLaunchProfileRequest); /** *
* Update a user persona in launch profile membership. *
* * @param updateLaunchProfileMemberRequest * @return Result of the UpdateLaunchProfileMember operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UpdateLaunchProfileMember * @see AWS API Documentation */ UpdateLaunchProfileMemberResult updateLaunchProfileMember(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest); /** *
* Update streaming image. *
* * @param updateStreamingImageRequest * @return Result of the UpdateStreamingImage operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UpdateStreamingImage * @see AWS * API Documentation */ UpdateStreamingImageResult updateStreamingImage(UpdateStreamingImageRequest updateStreamingImageRequest); /** *
* Update a Studio resource. *
** Currently, this operation only supports updating the displayName of your studio. *
* * @param updateStudioRequest * @return Result of the UpdateStudio operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UpdateStudio * @see AWS API * Documentation */ UpdateStudioResult updateStudio(UpdateStudioRequest updateStudioRequest); /** *
* Updates a studio component resource. *
* * @param updateStudioComponentRequest * @return Result of the UpdateStudioComponent operation returned by the service. * @throws ResourceNotFoundException * The specified resource could not be found. * @throws ConflictException * Another operation is in progress. * @throws ThrottlingException * The request throughput limit was exceeded. * @throws ValidationException * One of the parameters in the request is invalid. * @throws AccessDeniedException * You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using * the correct access keys. * @throws InternalServerErrorException * An internal error has occurred. Please retry your request. * @throws 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. * @sample AmazonNimbleStudio.UpdateStudioComponent * @see AWS * API Documentation */ UpdateStudioComponentResult updateStudioComponent(UpdateStudioComponentRequest updateStudioComponentRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); AmazonNimbleStudioWaiters waiters(); }