Interface NimbleAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<AcceptEulasResponse> acceptEulas
(Consumer<AcceptEulasRequest.Builder> acceptEulasRequest) Accept EULAs.default CompletableFuture
<AcceptEulasResponse> acceptEulas
(AcceptEulasRequest acceptEulasRequest) Accept EULAs.static NimbleAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aNimbleAsyncClient
.static NimbleAsyncClient
create()
Create aNimbleAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createLaunchProfile
(Consumer<CreateLaunchProfileRequest.Builder> createLaunchProfileRequest) Create a launch profile.createLaunchProfile
(CreateLaunchProfileRequest createLaunchProfileRequest) Create a launch profile.createStreamingImage
(Consumer<CreateStreamingImageRequest.Builder> createStreamingImageRequest) Creates a streaming image resource in a studio.createStreamingImage
(CreateStreamingImageRequest createStreamingImageRequest) Creates a streaming image resource in a studio.createStreamingSession
(Consumer<CreateStreamingSessionRequest.Builder> createStreamingSessionRequest) Creates a streaming session in a studio.createStreamingSession
(CreateStreamingSessionRequest createStreamingSessionRequest) Creates a streaming session in a studio.createStreamingSessionStream
(Consumer<CreateStreamingSessionStreamRequest.Builder> createStreamingSessionStreamRequest) Creates a streaming session stream for a streaming session.createStreamingSessionStream
(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest) Creates a streaming session stream for a streaming session.default CompletableFuture
<CreateStudioResponse> createStudio
(Consumer<CreateStudioRequest.Builder> createStudioRequest) Create a new studio.default CompletableFuture
<CreateStudioResponse> createStudio
(CreateStudioRequest createStudioRequest) Create a new studio.createStudioComponent
(Consumer<CreateStudioComponentRequest.Builder> createStudioComponentRequest) Creates a studio component resource.createStudioComponent
(CreateStudioComponentRequest createStudioComponentRequest) Creates a studio component resource.deleteLaunchProfile
(Consumer<DeleteLaunchProfileRequest.Builder> deleteLaunchProfileRequest) Permanently delete a launch profile.deleteLaunchProfile
(DeleteLaunchProfileRequest deleteLaunchProfileRequest) Permanently delete a launch profile.deleteLaunchProfileMember
(Consumer<DeleteLaunchProfileMemberRequest.Builder> deleteLaunchProfileMemberRequest) Delete a user from launch profile membership.deleteLaunchProfileMember
(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest) Delete a user from launch profile membership.deleteStreamingImage
(Consumer<DeleteStreamingImageRequest.Builder> deleteStreamingImageRequest) Delete streaming image.deleteStreamingImage
(DeleteStreamingImageRequest deleteStreamingImageRequest) Delete streaming image.deleteStreamingSession
(Consumer<DeleteStreamingSessionRequest.Builder> deleteStreamingSessionRequest) Deletes streaming session resource.deleteStreamingSession
(DeleteStreamingSessionRequest deleteStreamingSessionRequest) Deletes streaming session resource.default CompletableFuture
<DeleteStudioResponse> deleteStudio
(Consumer<DeleteStudioRequest.Builder> deleteStudioRequest) Delete a studio resource.default CompletableFuture
<DeleteStudioResponse> deleteStudio
(DeleteStudioRequest deleteStudioRequest) Delete a studio resource.deleteStudioComponent
(Consumer<DeleteStudioComponentRequest.Builder> deleteStudioComponentRequest) Deletes a studio component resource.deleteStudioComponent
(DeleteStudioComponentRequest deleteStudioComponentRequest) Deletes a studio component resource.deleteStudioMember
(Consumer<DeleteStudioMemberRequest.Builder> deleteStudioMemberRequest) Delete a user from studio membership.deleteStudioMember
(DeleteStudioMemberRequest deleteStudioMemberRequest) Delete a user from studio membership.default CompletableFuture
<GetEulaResponse> getEula
(Consumer<GetEulaRequest.Builder> getEulaRequest) Get EULA.default CompletableFuture
<GetEulaResponse> getEula
(GetEulaRequest getEulaRequest) Get EULA.getLaunchProfile
(Consumer<GetLaunchProfileRequest.Builder> getLaunchProfileRequest) Get a launch profile.getLaunchProfile
(GetLaunchProfileRequest getLaunchProfileRequest) Get a launch profile.getLaunchProfileDetails
(Consumer<GetLaunchProfileDetailsRequest.Builder> getLaunchProfileDetailsRequest) Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.getLaunchProfileDetails
(GetLaunchProfileDetailsRequest getLaunchProfileDetailsRequest) Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.getLaunchProfileInitialization
(Consumer<GetLaunchProfileInitializationRequest.Builder> getLaunchProfileInitializationRequest) Get a launch profile initialization.getLaunchProfileInitialization
(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest) Get a launch profile initialization.getLaunchProfileMember
(Consumer<GetLaunchProfileMemberRequest.Builder> getLaunchProfileMemberRequest) Get a user persona in launch profile membership.getLaunchProfileMember
(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest) Get a user persona in launch profile membership.getStreamingImage
(Consumer<GetStreamingImageRequest.Builder> getStreamingImageRequest) Get streaming image.getStreamingImage
(GetStreamingImageRequest getStreamingImageRequest) Get streaming image.getStreamingSession
(Consumer<GetStreamingSessionRequest.Builder> getStreamingSessionRequest) Gets StreamingSession resource.getStreamingSession
(GetStreamingSessionRequest getStreamingSessionRequest) Gets StreamingSession resource.getStreamingSessionBackup
(Consumer<GetStreamingSessionBackupRequest.Builder> getStreamingSessionBackupRequest) GetsStreamingSessionBackup
resource.getStreamingSessionBackup
(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest) GetsStreamingSessionBackup
resource.getStreamingSessionStream
(Consumer<GetStreamingSessionStreamRequest.Builder> getStreamingSessionStreamRequest) Gets a StreamingSessionStream for a streaming session.getStreamingSessionStream
(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest) Gets a StreamingSessionStream for a streaming session.default CompletableFuture
<GetStudioResponse> getStudio
(Consumer<GetStudioRequest.Builder> getStudioRequest) Get a studio resource.default CompletableFuture
<GetStudioResponse> getStudio
(GetStudioRequest getStudioRequest) Get a studio resource.getStudioComponent
(Consumer<GetStudioComponentRequest.Builder> getStudioComponentRequest) Gets a studio component resource.getStudioComponent
(GetStudioComponentRequest getStudioComponentRequest) Gets a studio component resource.default CompletableFuture
<GetStudioMemberResponse> getStudioMember
(Consumer<GetStudioMemberRequest.Builder> getStudioMemberRequest) Get a user's membership in a studio.default CompletableFuture
<GetStudioMemberResponse> getStudioMember
(GetStudioMemberRequest getStudioMemberRequest) Get a user's membership in a studio.listEulaAcceptances
(Consumer<ListEulaAcceptancesRequest.Builder> listEulaAcceptancesRequest) List EULA acceptances.listEulaAcceptances
(ListEulaAcceptancesRequest listEulaAcceptancesRequest) List EULA acceptances.default ListEulaAcceptancesPublisher
listEulaAcceptancesPaginator
(Consumer<ListEulaAcceptancesRequest.Builder> listEulaAcceptancesRequest) This is a variant oflistEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation.default ListEulaAcceptancesPublisher
listEulaAcceptancesPaginator
(ListEulaAcceptancesRequest listEulaAcceptancesRequest) This is a variant oflistEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation.default CompletableFuture
<ListEulasResponse> listEulas
(Consumer<ListEulasRequest.Builder> listEulasRequest) List EULAs.default CompletableFuture
<ListEulasResponse> listEulas
(ListEulasRequest listEulasRequest) List EULAs.default ListEulasPublisher
listEulasPaginator
(Consumer<ListEulasRequest.Builder> listEulasRequest) This is a variant oflistEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation.default ListEulasPublisher
listEulasPaginator
(ListEulasRequest listEulasRequest) This is a variant oflistEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation.listLaunchProfileMembers
(Consumer<ListLaunchProfileMembersRequest.Builder> listLaunchProfileMembersRequest) Get all users in a given launch profile membership.listLaunchProfileMembers
(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest) Get all users in a given launch profile membership.listLaunchProfileMembersPaginator
(Consumer<ListLaunchProfileMembersRequest.Builder> listLaunchProfileMembersRequest) This is a variant oflistLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation.listLaunchProfileMembersPaginator
(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest) This is a variant oflistLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation.listLaunchProfiles
(Consumer<ListLaunchProfilesRequest.Builder> listLaunchProfilesRequest) List all the launch profiles a studio.listLaunchProfiles
(ListLaunchProfilesRequest listLaunchProfilesRequest) List all the launch profiles a studio.default ListLaunchProfilesPublisher
listLaunchProfilesPaginator
(Consumer<ListLaunchProfilesRequest.Builder> listLaunchProfilesRequest) This is a variant oflistLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation.default ListLaunchProfilesPublisher
listLaunchProfilesPaginator
(ListLaunchProfilesRequest listLaunchProfilesRequest) This is a variant oflistLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation.listStreamingImages
(Consumer<ListStreamingImagesRequest.Builder> listStreamingImagesRequest) List the streaming image resources available to this studio.listStreamingImages
(ListStreamingImagesRequest listStreamingImagesRequest) List the streaming image resources available to this studio.default ListStreamingImagesPublisher
listStreamingImagesPaginator
(Consumer<ListStreamingImagesRequest.Builder> listStreamingImagesRequest) This is a variant oflistStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation.default ListStreamingImagesPublisher
listStreamingImagesPaginator
(ListStreamingImagesRequest listStreamingImagesRequest) This is a variant oflistStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation.listStreamingSessionBackups
(Consumer<ListStreamingSessionBackupsRequest.Builder> listStreamingSessionBackupsRequest) Lists the backups of a streaming session in a studio.listStreamingSessionBackups
(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest) Lists the backups of a streaming session in a studio.listStreamingSessionBackupsPaginator
(Consumer<ListStreamingSessionBackupsRequest.Builder> listStreamingSessionBackupsRequest) This is a variant oflistStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation.listStreamingSessionBackupsPaginator
(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest) This is a variant oflistStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation.listStreamingSessions
(Consumer<ListStreamingSessionsRequest.Builder> listStreamingSessionsRequest) Lists the streaming sessions in a studio.listStreamingSessions
(ListStreamingSessionsRequest listStreamingSessionsRequest) Lists the streaming sessions in a studio.default ListStreamingSessionsPublisher
listStreamingSessionsPaginator
(Consumer<ListStreamingSessionsRequest.Builder> listStreamingSessionsRequest) This is a variant oflistStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation.default ListStreamingSessionsPublisher
listStreamingSessionsPaginator
(ListStreamingSessionsRequest listStreamingSessionsRequest) This is a variant oflistStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation.listStudioComponents
(Consumer<ListStudioComponentsRequest.Builder> listStudioComponentsRequest) Lists theStudioComponents
in a studio.listStudioComponents
(ListStudioComponentsRequest listStudioComponentsRequest) Lists theStudioComponents
in a studio.default ListStudioComponentsPublisher
listStudioComponentsPaginator
(Consumer<ListStudioComponentsRequest.Builder> listStudioComponentsRequest) This is a variant oflistStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation.default ListStudioComponentsPublisher
listStudioComponentsPaginator
(ListStudioComponentsRequest listStudioComponentsRequest) This is a variant oflistStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation.listStudioMembers
(Consumer<ListStudioMembersRequest.Builder> listStudioMembersRequest) Get all users in a given studio membership.listStudioMembers
(ListStudioMembersRequest listStudioMembersRequest) Get all users in a given studio membership.default ListStudioMembersPublisher
listStudioMembersPaginator
(Consumer<ListStudioMembersRequest.Builder> listStudioMembersRequest) This is a variant oflistStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation.default ListStudioMembersPublisher
listStudioMembersPaginator
(ListStudioMembersRequest listStudioMembersRequest) This is a variant oflistStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation.default CompletableFuture
<ListStudiosResponse> listStudios
(Consumer<ListStudiosRequest.Builder> listStudiosRequest) List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.default CompletableFuture
<ListStudiosResponse> listStudios
(ListStudiosRequest listStudiosRequest) List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.default ListStudiosPublisher
listStudiosPaginator
(Consumer<ListStudiosRequest.Builder> listStudiosRequest) This is a variant oflistStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation.default ListStudiosPublisher
listStudiosPaginator
(ListStudiosRequest listStudiosRequest) This is a variant oflistStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets the tags for a resource, given its Amazon Resource Names (ARN).listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets the tags for a resource, given its Amazon Resource Names (ARN).putLaunchProfileMembers
(Consumer<PutLaunchProfileMembersRequest.Builder> putLaunchProfileMembersRequest) Add/update users with given persona to launch profile membership.putLaunchProfileMembers
(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest) Add/update users with given persona to launch profile membership.putStudioMembers
(Consumer<PutStudioMembersRequest.Builder> putStudioMembersRequest) Add/update users with given persona to studio membership.putStudioMembers
(PutStudioMembersRequest putStudioMembersRequest) Add/update users with given persona to studio membership.default NimbleServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartStreamingSession
(Consumer<StartStreamingSessionRequest.Builder> startStreamingSessionRequest) Transitions sessions from theSTOPPED
state into theREADY
state.startStreamingSession
(StartStreamingSessionRequest startStreamingSessionRequest) Transitions sessions from theSTOPPED
state into theREADY
state.startStudioSSOConfigurationRepair
(Consumer<StartStudioSsoConfigurationRepairRequest.Builder> startStudioSsoConfigurationRepairRequest) Repairs the IAM Identity Center configuration for a given studio.startStudioSSOConfigurationRepair
(StartStudioSsoConfigurationRepairRequest startStudioSsoConfigurationRepairRequest) Repairs the IAM Identity Center configuration for a given studio.stopStreamingSession
(Consumer<StopStreamingSessionRequest.Builder> stopStreamingSessionRequest) Transitions sessions from theREADY
state into theSTOPPED
state.stopStreamingSession
(StopStreamingSessionRequest stopStreamingSessionRequest) Transitions sessions from theREADY
state into theSTOPPED
state.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tags for a resource, given its ARN.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Creates tags for a resource, given its ARN.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes the tags for a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes the tags for a resource.updateLaunchProfile
(Consumer<UpdateLaunchProfileRequest.Builder> updateLaunchProfileRequest) Update a launch profile.updateLaunchProfile
(UpdateLaunchProfileRequest updateLaunchProfileRequest) Update a launch profile.updateLaunchProfileMember
(Consumer<UpdateLaunchProfileMemberRequest.Builder> updateLaunchProfileMemberRequest) Update a user persona in launch profile membership.updateLaunchProfileMember
(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest) Update a user persona in launch profile membership.updateStreamingImage
(Consumer<UpdateStreamingImageRequest.Builder> updateStreamingImageRequest) Update streaming image.updateStreamingImage
(UpdateStreamingImageRequest updateStreamingImageRequest) Update streaming image.default CompletableFuture
<UpdateStudioResponse> updateStudio
(Consumer<UpdateStudioRequest.Builder> updateStudioRequest) Update a Studio resource.default CompletableFuture
<UpdateStudioResponse> updateStudio
(UpdateStudioRequest updateStudioRequest) Update a Studio resource.updateStudioComponent
(Consumer<UpdateStudioComponentRequest.Builder> updateStudioComponentRequest) Updates a studio component resource.updateStudioComponent
(UpdateStudioComponentRequest updateStudioComponentRequest) Updates a studio component resource.default NimbleAsyncWaiter
waiter()
Create an instance ofNimbleAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptEulas
Accept EULAs.
- Parameters:
acceptEulasRequest
-- Returns:
- A Java Future containing the result of the AcceptEulas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptEulas
default CompletableFuture<AcceptEulasResponse> acceptEulas(Consumer<AcceptEulasRequest.Builder> acceptEulasRequest) Accept EULAs.
This is a convenience which creates an instance of the
AcceptEulasRequest.Builder
avoiding the need to create one manually viaAcceptEulasRequest.builder()
- Parameters:
acceptEulasRequest
- AConsumer
that will call methods onAcceptEulasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AcceptEulas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLaunchProfile
default CompletableFuture<CreateLaunchProfileResponse> createLaunchProfile(CreateLaunchProfileRequest createLaunchProfileRequest) Create a launch profile.
- Parameters:
createLaunchProfileRequest
-- Returns:
- A Java Future containing the result of the CreateLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLaunchProfile
default CompletableFuture<CreateLaunchProfileResponse> createLaunchProfile(Consumer<CreateLaunchProfileRequest.Builder> createLaunchProfileRequest) Create a launch profile.
This is a convenience which creates an instance of the
CreateLaunchProfileRequest.Builder
avoiding the need to create one manually viaCreateLaunchProfileRequest.builder()
- Parameters:
createLaunchProfileRequest
- AConsumer
that will call methods onCreateLaunchProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingImage
default CompletableFuture<CreateStreamingImageResponse> createStreamingImage(CreateStreamingImageRequest createStreamingImageRequest) Creates a streaming image resource in a studio.
- Parameters:
createStreamingImageRequest
-- Returns:
- A Java Future containing the result of the CreateStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingImage
default CompletableFuture<CreateStreamingImageResponse> createStreamingImage(Consumer<CreateStreamingImageRequest.Builder> createStreamingImageRequest) Creates a streaming image resource in a studio.
This is a convenience which creates an instance of the
CreateStreamingImageRequest.Builder
avoiding the need to create one manually viaCreateStreamingImageRequest.builder()
- Parameters:
createStreamingImageRequest
- AConsumer
that will call methods onCreateStreamingImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingSession
default CompletableFuture<CreateStreamingSessionResponse> createStreamingSession(CreateStreamingSessionRequest createStreamingSessionRequest) Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY
state.- Parameters:
createStreamingSessionRequest
-- Returns:
- A Java Future containing the result of the CreateStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingSession
default CompletableFuture<CreateStreamingSessionResponse> createStreamingSession(Consumer<CreateStreamingSessionRequest.Builder> createStreamingSessionRequest) Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READY
state.
This is a convenience which creates an instance of the
CreateStreamingSessionRequest.Builder
avoiding the need to create one manually viaCreateStreamingSessionRequest.builder()
- Parameters:
createStreamingSessionRequest
- AConsumer
that will call methods onCreateStreamingSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingSessionStream
default CompletableFuture<CreateStreamingSessionStreamResponse> createStreamingSessionStream(CreateStreamingSessionStreamRequest createStreamingSessionStreamRequest) Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the
READY
state.- Parameters:
createStreamingSessionStreamRequest
-- Returns:
- A Java Future containing the result of the CreateStreamingSessionStream operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingSessionStream
default CompletableFuture<CreateStreamingSessionStreamResponse> createStreamingSessionStream(Consumer<CreateStreamingSessionStreamRequest.Builder> createStreamingSessionStreamRequest) Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the
READY
state.
This is a convenience which creates an instance of the
CreateStreamingSessionStreamRequest.Builder
avoiding the need to create one manually viaCreateStreamingSessionStreamRequest.builder()
- Parameters:
createStreamingSessionStreamRequest
- AConsumer
that will call methods onCreateStreamingSessionStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStreamingSessionStream operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStudio
default CompletableFuture<CreateStudioResponse> createStudio(CreateStudioRequest createStudioRequest) Create a new studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the
AmazonNimbleStudio-StudioUser
managed policy attached for the portal to function properly.The admin role must have the
AmazonNimbleStudio-StudioAdmin
managed policy attached for the portal to function properly.You may optionally specify a KMS key in the
StudioEncryptionConfiguration
.In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling
CreateStudio
to encrypt this data using a key you own and manage.When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
- Parameters:
createStudioRequest
-- Returns:
- A Java Future containing the result of the CreateStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStudio
default CompletableFuture<CreateStudioResponse> createStudio(Consumer<CreateStudioRequest.Builder> createStudioRequest) Create a new studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the
AmazonNimbleStudio-StudioUser
managed policy attached for the portal to function properly.The admin role must have the
AmazonNimbleStudio-StudioAdmin
managed policy attached for the portal to function properly.You may optionally specify a KMS key in the
StudioEncryptionConfiguration
.In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling
CreateStudio
to encrypt this data using a key you own and manage.When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
This is a convenience which creates an instance of the
CreateStudioRequest.Builder
avoiding the need to create one manually viaCreateStudioRequest.builder()
- Parameters:
createStudioRequest
- AConsumer
that will call methods onCreateStudioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStudioComponent
default CompletableFuture<CreateStudioComponentResponse> createStudioComponent(CreateStudioComponentRequest createStudioComponentRequest) Creates a studio component resource.
- Parameters:
createStudioComponentRequest
-- Returns:
- A Java Future containing the result of the CreateStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStudioComponent
default CompletableFuture<CreateStudioComponentResponse> createStudioComponent(Consumer<CreateStudioComponentRequest.Builder> createStudioComponentRequest) Creates a studio component resource.
This is a convenience which creates an instance of the
CreateStudioComponentRequest.Builder
avoiding the need to create one manually viaCreateStudioComponentRequest.builder()
- Parameters:
createStudioComponentRequest
- AConsumer
that will call methods onCreateStudioComponentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLaunchProfile
default CompletableFuture<DeleteLaunchProfileResponse> deleteLaunchProfile(DeleteLaunchProfileRequest deleteLaunchProfileRequest) Permanently delete a launch profile.
- Parameters:
deleteLaunchProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLaunchProfile
default CompletableFuture<DeleteLaunchProfileResponse> deleteLaunchProfile(Consumer<DeleteLaunchProfileRequest.Builder> deleteLaunchProfileRequest) Permanently delete a launch profile.
This is a convenience which creates an instance of the
DeleteLaunchProfileRequest.Builder
avoiding the need to create one manually viaDeleteLaunchProfileRequest.builder()
- Parameters:
deleteLaunchProfileRequest
- AConsumer
that will call methods onDeleteLaunchProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLaunchProfileMember
default CompletableFuture<DeleteLaunchProfileMemberResponse> deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest deleteLaunchProfileMemberRequest) Delete a user from launch profile membership.
- Parameters:
deleteLaunchProfileMemberRequest
-- Returns:
- A Java Future containing the result of the DeleteLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLaunchProfileMember
default CompletableFuture<DeleteLaunchProfileMemberResponse> deleteLaunchProfileMember(Consumer<DeleteLaunchProfileMemberRequest.Builder> deleteLaunchProfileMemberRequest) Delete a user from launch profile membership.
This is a convenience which creates an instance of the
DeleteLaunchProfileMemberRequest.Builder
avoiding the need to create one manually viaDeleteLaunchProfileMemberRequest.builder()
- Parameters:
deleteLaunchProfileMemberRequest
- AConsumer
that will call methods onDeleteLaunchProfileMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamingImage
default CompletableFuture<DeleteStreamingImageResponse> deleteStreamingImage(DeleteStreamingImageRequest deleteStreamingImageRequest) Delete streaming image.
- Parameters:
deleteStreamingImageRequest
-- Returns:
- A Java Future containing the result of the DeleteStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamingImage
default CompletableFuture<DeleteStreamingImageResponse> deleteStreamingImage(Consumer<DeleteStreamingImageRequest.Builder> deleteStreamingImageRequest) Delete streaming image.
This is a convenience which creates an instance of the
DeleteStreamingImageRequest.Builder
avoiding the need to create one manually viaDeleteStreamingImageRequest.builder()
- Parameters:
deleteStreamingImageRequest
- AConsumer
that will call methods onDeleteStreamingImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamingSession
default CompletableFuture<DeleteStreamingSessionResponse> deleteStreamingSession(DeleteStreamingSessionRequest deleteStreamingSessionRequest) Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a
DELETED
state.A streaming session will count against your streaming session quota until it is marked
DELETED
.- Parameters:
deleteStreamingSessionRequest
-- Returns:
- A Java Future containing the result of the DeleteStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamingSession
default CompletableFuture<DeleteStreamingSessionResponse> deleteStreamingSession(Consumer<DeleteStreamingSessionRequest.Builder> deleteStreamingSessionRequest) Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a
DELETED
state.A streaming session will count against your streaming session quota until it is marked
DELETED
.
This is a convenience which creates an instance of the
DeleteStreamingSessionRequest.Builder
avoiding the need to create one manually viaDeleteStreamingSessionRequest.builder()
- Parameters:
deleteStreamingSessionRequest
- AConsumer
that will call methods onDeleteStreamingSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudio
default CompletableFuture<DeleteStudioResponse> deleteStudio(DeleteStudioRequest deleteStudioRequest) Delete a studio resource.
- Parameters:
deleteStudioRequest
-- Returns:
- A Java Future containing the result of the DeleteStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudio
default CompletableFuture<DeleteStudioResponse> deleteStudio(Consumer<DeleteStudioRequest.Builder> deleteStudioRequest) Delete a studio resource.
This is a convenience which creates an instance of the
DeleteStudioRequest.Builder
avoiding the need to create one manually viaDeleteStudioRequest.builder()
- Parameters:
deleteStudioRequest
- AConsumer
that will call methods onDeleteStudioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudioComponent
default CompletableFuture<DeleteStudioComponentResponse> deleteStudioComponent(DeleteStudioComponentRequest deleteStudioComponentRequest) Deletes a studio component resource.
- Parameters:
deleteStudioComponentRequest
-- Returns:
- A Java Future containing the result of the DeleteStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudioComponent
default CompletableFuture<DeleteStudioComponentResponse> deleteStudioComponent(Consumer<DeleteStudioComponentRequest.Builder> deleteStudioComponentRequest) Deletes a studio component resource.
This is a convenience which creates an instance of the
DeleteStudioComponentRequest.Builder
avoiding the need to create one manually viaDeleteStudioComponentRequest.builder()
- Parameters:
deleteStudioComponentRequest
- AConsumer
that will call methods onDeleteStudioComponentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudioMember
default CompletableFuture<DeleteStudioMemberResponse> deleteStudioMember(DeleteStudioMemberRequest deleteStudioMemberRequest) Delete a user from studio membership.
- Parameters:
deleteStudioMemberRequest
-- Returns:
- A Java Future containing the result of the DeleteStudioMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStudioMember
default CompletableFuture<DeleteStudioMemberResponse> deleteStudioMember(Consumer<DeleteStudioMemberRequest.Builder> deleteStudioMemberRequest) Delete a user from studio membership.
This is a convenience which creates an instance of the
DeleteStudioMemberRequest.Builder
avoiding the need to create one manually viaDeleteStudioMemberRequest.builder()
- Parameters:
deleteStudioMemberRequest
- AConsumer
that will call methods onDeleteStudioMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStudioMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEula
Get EULA.
- Parameters:
getEulaRequest
-- Returns:
- A Java Future containing the result of the GetEula operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEula
Get EULA.
This is a convenience which creates an instance of the
GetEulaRequest.Builder
avoiding the need to create one manually viaGetEulaRequest.builder()
- Parameters:
getEulaRequest
- AConsumer
that will call methods onGetEulaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEula operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfile
default CompletableFuture<GetLaunchProfileResponse> getLaunchProfile(GetLaunchProfileRequest getLaunchProfileRequest) Get a launch profile.
- Parameters:
getLaunchProfileRequest
-- Returns:
- A Java Future containing the result of the GetLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfile
default CompletableFuture<GetLaunchProfileResponse> getLaunchProfile(Consumer<GetLaunchProfileRequest.Builder> getLaunchProfileRequest) Get a launch profile.
This is a convenience which creates an instance of the
GetLaunchProfileRequest.Builder
avoiding the need to create one manually viaGetLaunchProfileRequest.builder()
- Parameters:
getLaunchProfileRequest
- AConsumer
that will call methods onGetLaunchProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileDetails
default CompletableFuture<GetLaunchProfileDetailsResponse> getLaunchProfileDetails(GetLaunchProfileDetailsRequest getLaunchProfileDetailsRequest) Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
- Parameters:
getLaunchProfileDetailsRequest
-- Returns:
- A Java Future containing the result of the GetLaunchProfileDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileDetails
default CompletableFuture<GetLaunchProfileDetailsResponse> getLaunchProfileDetails(Consumer<GetLaunchProfileDetailsRequest.Builder> getLaunchProfileDetailsRequest) Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
This is a convenience which creates an instance of the
GetLaunchProfileDetailsRequest.Builder
avoiding the need to create one manually viaGetLaunchProfileDetailsRequest.builder()
- Parameters:
getLaunchProfileDetailsRequest
- AConsumer
that will call methods onGetLaunchProfileDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLaunchProfileDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileInitialization
default CompletableFuture<GetLaunchProfileInitializationResponse> getLaunchProfileInitialization(GetLaunchProfileInitializationRequest getLaunchProfileInitializationRequest) Get a launch profile initialization.
- Parameters:
getLaunchProfileInitializationRequest
-- Returns:
- A Java Future containing the result of the GetLaunchProfileInitialization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileInitialization
default CompletableFuture<GetLaunchProfileInitializationResponse> getLaunchProfileInitialization(Consumer<GetLaunchProfileInitializationRequest.Builder> getLaunchProfileInitializationRequest) Get a launch profile initialization.
This is a convenience which creates an instance of the
GetLaunchProfileInitializationRequest.Builder
avoiding the need to create one manually viaGetLaunchProfileInitializationRequest.builder()
- Parameters:
getLaunchProfileInitializationRequest
- AConsumer
that will call methods onGetLaunchProfileInitializationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLaunchProfileInitialization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileMember
default CompletableFuture<GetLaunchProfileMemberResponse> getLaunchProfileMember(GetLaunchProfileMemberRequest getLaunchProfileMemberRequest) Get a user persona in launch profile membership.
- Parameters:
getLaunchProfileMemberRequest
-- Returns:
- A Java Future containing the result of the GetLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLaunchProfileMember
default CompletableFuture<GetLaunchProfileMemberResponse> getLaunchProfileMember(Consumer<GetLaunchProfileMemberRequest.Builder> getLaunchProfileMemberRequest) Get a user persona in launch profile membership.
This is a convenience which creates an instance of the
GetLaunchProfileMemberRequest.Builder
avoiding the need to create one manually viaGetLaunchProfileMemberRequest.builder()
- Parameters:
getLaunchProfileMemberRequest
- AConsumer
that will call methods onGetLaunchProfileMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingImage
default CompletableFuture<GetStreamingImageResponse> getStreamingImage(GetStreamingImageRequest getStreamingImageRequest) Get streaming image.
- Parameters:
getStreamingImageRequest
-- Returns:
- A Java Future containing the result of the GetStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingImage
default CompletableFuture<GetStreamingImageResponse> getStreamingImage(Consumer<GetStreamingImageRequest.Builder> getStreamingImageRequest) Get streaming image.
This is a convenience which creates an instance of the
GetStreamingImageRequest.Builder
avoiding the need to create one manually viaGetStreamingImageRequest.builder()
- Parameters:
getStreamingImageRequest
- AConsumer
that will call methods onGetStreamingImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSession
default CompletableFuture<GetStreamingSessionResponse> getStreamingSession(GetStreamingSessionRequest getStreamingSessionRequest) Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
- Parameters:
getStreamingSessionRequest
-- Returns:
- A Java Future containing the result of the GetStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSession
default CompletableFuture<GetStreamingSessionResponse> getStreamingSession(Consumer<GetStreamingSessionRequest.Builder> getStreamingSessionRequest) Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
This is a convenience which creates an instance of the
GetStreamingSessionRequest.Builder
avoiding the need to create one manually viaGetStreamingSessionRequest.builder()
- Parameters:
getStreamingSessionRequest
- AConsumer
that will call methods onGetStreamingSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSessionBackup
default CompletableFuture<GetStreamingSessionBackupResponse> getStreamingSessionBackup(GetStreamingSessionBackupRequest getStreamingSessionBackupRequest) Gets
StreamingSessionBackup
resource.Invoke this operation to poll for a streaming session backup while stopping a streaming session.
- Parameters:
getStreamingSessionBackupRequest
-- Returns:
- A Java Future containing the result of the GetStreamingSessionBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSessionBackup
default CompletableFuture<GetStreamingSessionBackupResponse> getStreamingSessionBackup(Consumer<GetStreamingSessionBackupRequest.Builder> getStreamingSessionBackupRequest) Gets
StreamingSessionBackup
resource.Invoke this operation to poll for a streaming session backup while stopping a streaming session.
This is a convenience which creates an instance of the
GetStreamingSessionBackupRequest.Builder
avoiding the need to create one manually viaGetStreamingSessionBackupRequest.builder()
- Parameters:
getStreamingSessionBackupRequest
- AConsumer
that will call methods onGetStreamingSessionBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamingSessionBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSessionStream
default CompletableFuture<GetStreamingSessionStreamResponse> getStreamingSessionStream(GetStreamingSessionStreamRequest getStreamingSessionStreamRequest) Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking
CreateStreamingSessionStream
.After the
StreamingSessionStream
changes to theREADY
state, the url property will contain a stream to be used with the DCV streaming client.- Parameters:
getStreamingSessionStreamRequest
-- Returns:
- A Java Future containing the result of the GetStreamingSessionStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamingSessionStream
default CompletableFuture<GetStreamingSessionStreamResponse> getStreamingSessionStream(Consumer<GetStreamingSessionStreamRequest.Builder> getStreamingSessionStreamRequest) Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking
CreateStreamingSessionStream
.After the
StreamingSessionStream
changes to theREADY
state, the url property will contain a stream to be used with the DCV streaming client.
This is a convenience which creates an instance of the
GetStreamingSessionStreamRequest.Builder
avoiding the need to create one manually viaGetStreamingSessionStreamRequest.builder()
- Parameters:
getStreamingSessionStreamRequest
- AConsumer
that will call methods onGetStreamingSessionStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamingSessionStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudio
Get a studio resource.
- Parameters:
getStudioRequest
-- Returns:
- A Java Future containing the result of the GetStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudio
default CompletableFuture<GetStudioResponse> getStudio(Consumer<GetStudioRequest.Builder> getStudioRequest) Get a studio resource.
This is a convenience which creates an instance of the
GetStudioRequest.Builder
avoiding the need to create one manually viaGetStudioRequest.builder()
- Parameters:
getStudioRequest
- AConsumer
that will call methods onGetStudioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudioComponent
default CompletableFuture<GetStudioComponentResponse> getStudioComponent(GetStudioComponentRequest getStudioComponentRequest) Gets a studio component resource.
- Parameters:
getStudioComponentRequest
-- Returns:
- A Java Future containing the result of the GetStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudioComponent
default CompletableFuture<GetStudioComponentResponse> getStudioComponent(Consumer<GetStudioComponentRequest.Builder> getStudioComponentRequest) Gets a studio component resource.
This is a convenience which creates an instance of the
GetStudioComponentRequest.Builder
avoiding the need to create one manually viaGetStudioComponentRequest.builder()
- Parameters:
getStudioComponentRequest
- AConsumer
that will call methods onGetStudioComponentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudioMember
default CompletableFuture<GetStudioMemberResponse> getStudioMember(GetStudioMemberRequest getStudioMemberRequest) Get a user's membership in a studio.
- Parameters:
getStudioMemberRequest
-- Returns:
- A Java Future containing the result of the GetStudioMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStudioMember
default CompletableFuture<GetStudioMemberResponse> getStudioMember(Consumer<GetStudioMemberRequest.Builder> getStudioMemberRequest) Get a user's membership in a studio.
This is a convenience which creates an instance of the
GetStudioMemberRequest.Builder
avoiding the need to create one manually viaGetStudioMemberRequest.builder()
- Parameters:
getStudioMemberRequest
- AConsumer
that will call methods onGetStudioMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStudioMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulaAcceptances
default CompletableFuture<ListEulaAcceptancesResponse> listEulaAcceptances(ListEulaAcceptancesRequest listEulaAcceptancesRequest) List EULA acceptances.
- Parameters:
listEulaAcceptancesRequest
-- Returns:
- A Java Future containing the result of the ListEulaAcceptances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulaAcceptances
default CompletableFuture<ListEulaAcceptancesResponse> listEulaAcceptances(Consumer<ListEulaAcceptancesRequest.Builder> listEulaAcceptancesRequest) List EULA acceptances.
This is a convenience which creates an instance of the
ListEulaAcceptancesRequest.Builder
avoiding the need to create one manually viaListEulaAcceptancesRequest.builder()
- Parameters:
listEulaAcceptancesRequest
- AConsumer
that will call methods onListEulaAcceptancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEulaAcceptances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulaAcceptancesPaginator
default ListEulaAcceptancesPublisher listEulaAcceptancesPaginator(ListEulaAcceptancesRequest listEulaAcceptancesRequest) This is a variant of
listEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListEulaAcceptancesPublisher publisher = client.listEulaAcceptancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListEulaAcceptancesPublisher publisher = client.listEulaAcceptancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation.- Parameters:
listEulaAcceptancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulaAcceptancesPaginator
default ListEulaAcceptancesPublisher listEulaAcceptancesPaginator(Consumer<ListEulaAcceptancesRequest.Builder> listEulaAcceptancesRequest) This is a variant of
listEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListEulaAcceptancesPublisher publisher = client.listEulaAcceptancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListEulaAcceptancesPublisher publisher = client.listEulaAcceptancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEulaAcceptances(software.amazon.awssdk.services.nimble.model.ListEulaAcceptancesRequest)
operation.
This is a convenience which creates an instance of the
ListEulaAcceptancesRequest.Builder
avoiding the need to create one manually viaListEulaAcceptancesRequest.builder()
- Parameters:
listEulaAcceptancesRequest
- AConsumer
that will call methods onListEulaAcceptancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulas
List EULAs.
- Parameters:
listEulasRequest
-- Returns:
- A Java Future containing the result of the ListEulas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulas
default CompletableFuture<ListEulasResponse> listEulas(Consumer<ListEulasRequest.Builder> listEulasRequest) List EULAs.
This is a convenience which creates an instance of the
ListEulasRequest.Builder
avoiding the need to create one manually viaListEulasRequest.builder()
- Parameters:
listEulasRequest
- AConsumer
that will call methods onListEulasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEulas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulasPaginator
This is a variant of
listEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListEulasPublisher publisher = client.listEulasPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListEulasPublisher publisher = client.listEulasPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListEulasResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListEulasResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation.- Parameters:
listEulasRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEulasPaginator
This is a variant of
listEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListEulasPublisher publisher = client.listEulasPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListEulasPublisher publisher = client.listEulasPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListEulasResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListEulasResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEulas(software.amazon.awssdk.services.nimble.model.ListEulasRequest)
operation.
This is a convenience which creates an instance of the
ListEulasRequest.Builder
avoiding the need to create one manually viaListEulasRequest.builder()
- Parameters:
listEulasRequest
- AConsumer
that will call methods onListEulasRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfileMembers
default CompletableFuture<ListLaunchProfileMembersResponse> listLaunchProfileMembers(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest) Get all users in a given launch profile membership.
- Parameters:
listLaunchProfileMembersRequest
-- Returns:
- A Java Future containing the result of the ListLaunchProfileMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfileMembers
default CompletableFuture<ListLaunchProfileMembersResponse> listLaunchProfileMembers(Consumer<ListLaunchProfileMembersRequest.Builder> listLaunchProfileMembersRequest) Get all users in a given launch profile membership.
This is a convenience which creates an instance of the
ListLaunchProfileMembersRequest.Builder
avoiding the need to create one manually viaListLaunchProfileMembersRequest.builder()
- Parameters:
listLaunchProfileMembersRequest
- AConsumer
that will call methods onListLaunchProfileMembersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLaunchProfileMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfileMembersPaginator
default ListLaunchProfileMembersPublisher listLaunchProfileMembersPaginator(ListLaunchProfileMembersRequest listLaunchProfileMembersRequest) This is a variant of
listLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListLaunchProfileMembersPublisher publisher = client.listLaunchProfileMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListLaunchProfileMembersPublisher publisher = client.listLaunchProfileMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation.- Parameters:
listLaunchProfileMembersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfileMembersPaginator
default ListLaunchProfileMembersPublisher listLaunchProfileMembersPaginator(Consumer<ListLaunchProfileMembersRequest.Builder> listLaunchProfileMembersRequest) This is a variant of
listLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListLaunchProfileMembersPublisher publisher = client.listLaunchProfileMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListLaunchProfileMembersPublisher publisher = client.listLaunchProfileMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLaunchProfileMembers(software.amazon.awssdk.services.nimble.model.ListLaunchProfileMembersRequest)
operation.
This is a convenience which creates an instance of the
ListLaunchProfileMembersRequest.Builder
avoiding the need to create one manually viaListLaunchProfileMembersRequest.builder()
- Parameters:
listLaunchProfileMembersRequest
- AConsumer
that will call methods onListLaunchProfileMembersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfiles
default CompletableFuture<ListLaunchProfilesResponse> listLaunchProfiles(ListLaunchProfilesRequest listLaunchProfilesRequest) List all the launch profiles a studio.
- Parameters:
listLaunchProfilesRequest
-- Returns:
- A Java Future containing the result of the ListLaunchProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfiles
default CompletableFuture<ListLaunchProfilesResponse> listLaunchProfiles(Consumer<ListLaunchProfilesRequest.Builder> listLaunchProfilesRequest) List all the launch profiles a studio.
This is a convenience which creates an instance of the
ListLaunchProfilesRequest.Builder
avoiding the need to create one manually viaListLaunchProfilesRequest.builder()
- Parameters:
listLaunchProfilesRequest
- AConsumer
that will call methods onListLaunchProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLaunchProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfilesPaginator
default ListLaunchProfilesPublisher listLaunchProfilesPaginator(ListLaunchProfilesRequest listLaunchProfilesRequest) This is a variant of
listLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListLaunchProfilesPublisher publisher = client.listLaunchProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListLaunchProfilesPublisher publisher = client.listLaunchProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListLaunchProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation.- Parameters:
listLaunchProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLaunchProfilesPaginator
default ListLaunchProfilesPublisher listLaunchProfilesPaginator(Consumer<ListLaunchProfilesRequest.Builder> listLaunchProfilesRequest) This is a variant of
listLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListLaunchProfilesPublisher publisher = client.listLaunchProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListLaunchProfilesPublisher publisher = client.listLaunchProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListLaunchProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLaunchProfiles(software.amazon.awssdk.services.nimble.model.ListLaunchProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListLaunchProfilesRequest.Builder
avoiding the need to create one manually viaListLaunchProfilesRequest.builder()
- Parameters:
listLaunchProfilesRequest
- AConsumer
that will call methods onListLaunchProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingImages
default CompletableFuture<ListStreamingImagesResponse> listStreamingImages(ListStreamingImagesRequest listStreamingImagesRequest) List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
- Parameters:
listStreamingImagesRequest
-- Returns:
- A Java Future containing the result of the ListStreamingImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingImages
default CompletableFuture<ListStreamingImagesResponse> listStreamingImages(Consumer<ListStreamingImagesRequest.Builder> listStreamingImagesRequest) List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
This is a convenience which creates an instance of the
ListStreamingImagesRequest.Builder
avoiding the need to create one manually viaListStreamingImagesRequest.builder()
- Parameters:
listStreamingImagesRequest
- AConsumer
that will call methods onListStreamingImagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreamingImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingImagesPaginator
default ListStreamingImagesPublisher listStreamingImagesPaginator(ListStreamingImagesRequest listStreamingImagesRequest) This is a variant of
listStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingImagesPublisher publisher = client.listStreamingImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingImagesPublisher publisher = client.listStreamingImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingImagesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation.- Parameters:
listStreamingImagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingImagesPaginator
default ListStreamingImagesPublisher listStreamingImagesPaginator(Consumer<ListStreamingImagesRequest.Builder> listStreamingImagesRequest) This is a variant of
listStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingImagesPublisher publisher = client.listStreamingImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingImagesPublisher publisher = client.listStreamingImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingImagesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingImages(software.amazon.awssdk.services.nimble.model.ListStreamingImagesRequest)
operation.
This is a convenience which creates an instance of the
ListStreamingImagesRequest.Builder
avoiding the need to create one manually viaListStreamingImagesRequest.builder()
- Parameters:
listStreamingImagesRequest
- AConsumer
that will call methods onListStreamingImagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionBackups
default CompletableFuture<ListStreamingSessionBackupsResponse> listStreamingSessionBackups(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest) Lists the backups of a streaming session in a studio.
- Parameters:
listStreamingSessionBackupsRequest
-- Returns:
- A Java Future containing the result of the ListStreamingSessionBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionBackups
default CompletableFuture<ListStreamingSessionBackupsResponse> listStreamingSessionBackups(Consumer<ListStreamingSessionBackupsRequest.Builder> listStreamingSessionBackupsRequest) Lists the backups of a streaming session in a studio.
This is a convenience which creates an instance of the
ListStreamingSessionBackupsRequest.Builder
avoiding the need to create one manually viaListStreamingSessionBackupsRequest.builder()
- Parameters:
listStreamingSessionBackupsRequest
- AConsumer
that will call methods onListStreamingSessionBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreamingSessionBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionBackupsPaginator
default ListStreamingSessionBackupsPublisher listStreamingSessionBackupsPaginator(ListStreamingSessionBackupsRequest listStreamingSessionBackupsRequest) This is a variant of
listStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingSessionBackupsPublisher publisher = client.listStreamingSessionBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingSessionBackupsPublisher publisher = client.listStreamingSessionBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation.- Parameters:
listStreamingSessionBackupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionBackupsPaginator
default ListStreamingSessionBackupsPublisher listStreamingSessionBackupsPaginator(Consumer<ListStreamingSessionBackupsRequest.Builder> listStreamingSessionBackupsRequest) This is a variant of
listStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingSessionBackupsPublisher publisher = client.listStreamingSessionBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingSessionBackupsPublisher publisher = client.listStreamingSessionBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingSessionBackups(software.amazon.awssdk.services.nimble.model.ListStreamingSessionBackupsRequest)
operation.
This is a convenience which creates an instance of the
ListStreamingSessionBackupsRequest.Builder
avoiding the need to create one manually viaListStreamingSessionBackupsRequest.builder()
- Parameters:
listStreamingSessionBackupsRequest
- AConsumer
that will call methods onListStreamingSessionBackupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessions
default CompletableFuture<ListStreamingSessionsResponse> listStreamingSessions(ListStreamingSessionsRequest listStreamingSessionsRequest) Lists the streaming sessions in a studio.
- Parameters:
listStreamingSessionsRequest
-- Returns:
- A Java Future containing the result of the ListStreamingSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessions
default CompletableFuture<ListStreamingSessionsResponse> listStreamingSessions(Consumer<ListStreamingSessionsRequest.Builder> listStreamingSessionsRequest) Lists the streaming sessions in a studio.
This is a convenience which creates an instance of the
ListStreamingSessionsRequest.Builder
avoiding the need to create one manually viaListStreamingSessionsRequest.builder()
- Parameters:
listStreamingSessionsRequest
- AConsumer
that will call methods onListStreamingSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreamingSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionsPaginator
default ListStreamingSessionsPublisher listStreamingSessionsPaginator(ListStreamingSessionsRequest listStreamingSessionsRequest) This is a variant of
listStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingSessionsPublisher publisher = client.listStreamingSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingSessionsPublisher publisher = client.listStreamingSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation.- Parameters:
listStreamingSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingSessionsPaginator
default ListStreamingSessionsPublisher listStreamingSessionsPaginator(Consumer<ListStreamingSessionsRequest.Builder> listStreamingSessionsRequest) This is a variant of
listStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStreamingSessionsPublisher publisher = client.listStreamingSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStreamingSessionsPublisher publisher = client.listStreamingSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStreamingSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamingSessions(software.amazon.awssdk.services.nimble.model.ListStreamingSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListStreamingSessionsRequest.Builder
avoiding the need to create one manually viaListStreamingSessionsRequest.builder()
- Parameters:
listStreamingSessionsRequest
- AConsumer
that will call methods onListStreamingSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioComponents
default CompletableFuture<ListStudioComponentsResponse> listStudioComponents(ListStudioComponentsRequest listStudioComponentsRequest) Lists the
StudioComponents
in a studio.- Parameters:
listStudioComponentsRequest
-- Returns:
- A Java Future containing the result of the ListStudioComponents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioComponents
default CompletableFuture<ListStudioComponentsResponse> listStudioComponents(Consumer<ListStudioComponentsRequest.Builder> listStudioComponentsRequest) Lists the
StudioComponents
in a studio.
This is a convenience which creates an instance of the
ListStudioComponentsRequest.Builder
avoiding the need to create one manually viaListStudioComponentsRequest.builder()
- Parameters:
listStudioComponentsRequest
- AConsumer
that will call methods onListStudioComponentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStudioComponents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioComponentsPaginator
default ListStudioComponentsPublisher listStudioComponentsPaginator(ListStudioComponentsRequest listStudioComponentsRequest) This is a variant of
listStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudioComponentsPublisher publisher = client.listStudioComponentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudioComponentsPublisher publisher = client.listStudioComponentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudioComponentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudioComponentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation.- Parameters:
listStudioComponentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioComponentsPaginator
default ListStudioComponentsPublisher listStudioComponentsPaginator(Consumer<ListStudioComponentsRequest.Builder> listStudioComponentsRequest) This is a variant of
listStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudioComponentsPublisher publisher = client.listStudioComponentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudioComponentsPublisher publisher = client.listStudioComponentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudioComponentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudioComponentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudioComponents(software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListStudioComponentsRequest.Builder
avoiding the need to create one manually viaListStudioComponentsRequest.builder()
- Parameters:
listStudioComponentsRequest
- AConsumer
that will call methods onListStudioComponentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioMembers
default CompletableFuture<ListStudioMembersResponse> listStudioMembers(ListStudioMembersRequest listStudioMembersRequest) Get all users in a given studio membership.
ListStudioMembers
only returns admin members.- Parameters:
listStudioMembersRequest
-- Returns:
- A Java Future containing the result of the ListStudioMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioMembers
default CompletableFuture<ListStudioMembersResponse> listStudioMembers(Consumer<ListStudioMembersRequest.Builder> listStudioMembersRequest) Get all users in a given studio membership.
ListStudioMembers
only returns admin members.
This is a convenience which creates an instance of the
ListStudioMembersRequest.Builder
avoiding the need to create one manually viaListStudioMembersRequest.builder()
- Parameters:
listStudioMembersRequest
- AConsumer
that will call methods onListStudioMembersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStudioMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioMembersPaginator
default ListStudioMembersPublisher listStudioMembersPaginator(ListStudioMembersRequest listStudioMembersRequest) This is a variant of
listStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudioMembersPublisher publisher = client.listStudioMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudioMembersPublisher publisher = client.listStudioMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudioMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudioMembersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation.- Parameters:
listStudioMembersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudioMembersPaginator
default ListStudioMembersPublisher listStudioMembersPaginator(Consumer<ListStudioMembersRequest.Builder> listStudioMembersRequest) This is a variant of
listStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudioMembersPublisher publisher = client.listStudioMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudioMembersPublisher publisher = client.listStudioMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudioMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudioMembersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudioMembers(software.amazon.awssdk.services.nimble.model.ListStudioMembersRequest)
operation.
This is a convenience which creates an instance of the
ListStudioMembersRequest.Builder
avoiding the need to create one manually viaListStudioMembersRequest.builder()
- Parameters:
listStudioMembersRequest
- AConsumer
that will call methods onListStudioMembersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudios
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
- Parameters:
listStudiosRequest
-- Returns:
- A Java Future containing the result of the ListStudios operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudios
default CompletableFuture<ListStudiosResponse> listStudios(Consumer<ListStudiosRequest.Builder> listStudiosRequest) List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
This is a convenience which creates an instance of the
ListStudiosRequest.Builder
avoiding the need to create one manually viaListStudiosRequest.builder()
- Parameters:
listStudiosRequest
- AConsumer
that will call methods onListStudiosRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStudios operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudiosPaginator
This is a variant of
listStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudiosPublisher publisher = client.listStudiosPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudiosPublisher publisher = client.listStudiosPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudiosResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudiosResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation.- Parameters:
listStudiosRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStudiosPaginator
default ListStudiosPublisher listStudiosPaginator(Consumer<ListStudiosRequest.Builder> listStudiosRequest) This is a variant of
listStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.nimble.paginators.ListStudiosPublisher publisher = client.listStudiosPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.nimble.paginators.ListStudiosPublisher publisher = client.listStudiosPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.nimble.model.ListStudiosResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.nimble.model.ListStudiosResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStudios(software.amazon.awssdk.services.nimble.model.ListStudiosRequest)
operation.
This is a convenience which creates an instance of the
ListStudiosRequest.Builder
avoiding the need to create one manually viaListStudiosRequest.builder()
- Parameters:
listStudiosRequest
- AConsumer
that will call methods onListStudiosRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets the tags for a resource, given its Amazon Resource Names (ARN).
This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets the tags for a resource, given its Amazon Resource Names (ARN).
This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLaunchProfileMembers
default CompletableFuture<PutLaunchProfileMembersResponse> putLaunchProfileMembers(PutLaunchProfileMembersRequest putLaunchProfileMembersRequest) Add/update users with given persona to launch profile membership.
- Parameters:
putLaunchProfileMembersRequest
-- Returns:
- A Java Future containing the result of the PutLaunchProfileMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLaunchProfileMembers
default CompletableFuture<PutLaunchProfileMembersResponse> putLaunchProfileMembers(Consumer<PutLaunchProfileMembersRequest.Builder> putLaunchProfileMembersRequest) Add/update users with given persona to launch profile membership.
This is a convenience which creates an instance of the
PutLaunchProfileMembersRequest.Builder
avoiding the need to create one manually viaPutLaunchProfileMembersRequest.builder()
- Parameters:
putLaunchProfileMembersRequest
- AConsumer
that will call methods onPutLaunchProfileMembersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLaunchProfileMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putStudioMembers
default CompletableFuture<PutStudioMembersResponse> putStudioMembers(PutStudioMembersRequest putStudioMembersRequest) Add/update users with given persona to studio membership.
- Parameters:
putStudioMembersRequest
-- Returns:
- A Java Future containing the result of the PutStudioMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putStudioMembers
default CompletableFuture<PutStudioMembersResponse> putStudioMembers(Consumer<PutStudioMembersRequest.Builder> putStudioMembersRequest) Add/update users with given persona to studio membership.
This is a convenience which creates an instance of the
PutStudioMembersRequest.Builder
avoiding the need to create one manually viaPutStudioMembersRequest.builder()
- Parameters:
putStudioMembersRequest
- AConsumer
that will call methods onPutStudioMembersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutStudioMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startStreamingSession
default CompletableFuture<StartStreamingSessionResponse> startStreamingSession(StartStreamingSessionRequest startStreamingSessionRequest) Transitions sessions from the
STOPPED
state into theREADY
state. TheSTART_IN_PROGRESS
state is the intermediate state between theSTOPPED
andREADY
states.- Parameters:
startStreamingSessionRequest
-- Returns:
- A Java Future containing the result of the StartStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startStreamingSession
default CompletableFuture<StartStreamingSessionResponse> startStreamingSession(Consumer<StartStreamingSessionRequest.Builder> startStreamingSessionRequest) Transitions sessions from the
STOPPED
state into theREADY
state. TheSTART_IN_PROGRESS
state is the intermediate state between theSTOPPED
andREADY
states.
This is a convenience which creates an instance of the
StartStreamingSessionRequest.Builder
avoiding the need to create one manually viaStartStreamingSessionRequest.builder()
- Parameters:
startStreamingSessionRequest
- AConsumer
that will call methods onStartStreamingSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startStudioSSOConfigurationRepair
default CompletableFuture<StartStudioSsoConfigurationRepairResponse> startStudioSSOConfigurationRepair(StartStudioSsoConfigurationRepairRequest startStudioSsoConfigurationRepairRequest) Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the
READY
state.After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
- Parameters:
startStudioSsoConfigurationRepairRequest
-- Returns:
- A Java Future containing the result of the StartStudioSSOConfigurationRepair operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startStudioSSOConfigurationRepair
default CompletableFuture<StartStudioSsoConfigurationRepairResponse> startStudioSSOConfigurationRepair(Consumer<StartStudioSsoConfigurationRepairRequest.Builder> startStudioSsoConfigurationRepairRequest) Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the
READY
state.After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
This is a convenience which creates an instance of the
StartStudioSsoConfigurationRepairRequest.Builder
avoiding the need to create one manually viaStartStudioSsoConfigurationRepairRequest.builder()
- Parameters:
startStudioSsoConfigurationRepairRequest
- AConsumer
that will call methods onStartStudioSsoConfigurationRepairRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartStudioSSOConfigurationRepair operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopStreamingSession
default CompletableFuture<StopStreamingSessionResponse> stopStreamingSession(StopStreamingSessionRequest stopStreamingSessionRequest) Transitions sessions from the
READY
state into theSTOPPED
state. TheSTOP_IN_PROGRESS
state is the intermediate state between theREADY
andSTOPPED
states.- Parameters:
stopStreamingSessionRequest
-- Returns:
- A Java Future containing the result of the StopStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopStreamingSession
default CompletableFuture<StopStreamingSessionResponse> stopStreamingSession(Consumer<StopStreamingSessionRequest.Builder> stopStreamingSessionRequest) Transitions sessions from the
READY
state into theSTOPPED
state. TheSTOP_IN_PROGRESS
state is the intermediate state between theREADY
andSTOPPED
states.
This is a convenience which creates an instance of the
StopStreamingSessionRequest.Builder
avoiding the need to create one manually viaStopStreamingSessionRequest.builder()
- Parameters:
stopStreamingSessionRequest
- AConsumer
that will call methods onStopStreamingSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopStreamingSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Creates tags for a resource, given its ARN.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tags for a resource, given its ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes the tags for a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes the tags for a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLaunchProfile
default CompletableFuture<UpdateLaunchProfileResponse> updateLaunchProfile(UpdateLaunchProfileRequest updateLaunchProfileRequest) Update a launch profile.
- Parameters:
updateLaunchProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLaunchProfile
default CompletableFuture<UpdateLaunchProfileResponse> updateLaunchProfile(Consumer<UpdateLaunchProfileRequest.Builder> updateLaunchProfileRequest) Update a launch profile.
This is a convenience which creates an instance of the
UpdateLaunchProfileRequest.Builder
avoiding the need to create one manually viaUpdateLaunchProfileRequest.builder()
- Parameters:
updateLaunchProfileRequest
- AConsumer
that will call methods onUpdateLaunchProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateLaunchProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLaunchProfileMember
default CompletableFuture<UpdateLaunchProfileMemberResponse> updateLaunchProfileMember(UpdateLaunchProfileMemberRequest updateLaunchProfileMemberRequest) Update a user persona in launch profile membership.
- Parameters:
updateLaunchProfileMemberRequest
-- Returns:
- A Java Future containing the result of the UpdateLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLaunchProfileMember
default CompletableFuture<UpdateLaunchProfileMemberResponse> updateLaunchProfileMember(Consumer<UpdateLaunchProfileMemberRequest.Builder> updateLaunchProfileMemberRequest) Update a user persona in launch profile membership.
This is a convenience which creates an instance of the
UpdateLaunchProfileMemberRequest.Builder
avoiding the need to create one manually viaUpdateLaunchProfileMemberRequest.builder()
- Parameters:
updateLaunchProfileMemberRequest
- AConsumer
that will call methods onUpdateLaunchProfileMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateLaunchProfileMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStreamingImage
default CompletableFuture<UpdateStreamingImageResponse> updateStreamingImage(UpdateStreamingImageRequest updateStreamingImageRequest) Update streaming image.
- Parameters:
updateStreamingImageRequest
-- Returns:
- A Java Future containing the result of the UpdateStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStreamingImage
default CompletableFuture<UpdateStreamingImageResponse> updateStreamingImage(Consumer<UpdateStreamingImageRequest.Builder> updateStreamingImageRequest) Update streaming image.
This is a convenience which creates an instance of the
UpdateStreamingImageRequest.Builder
avoiding the need to create one manually viaUpdateStreamingImageRequest.builder()
- Parameters:
updateStreamingImageRequest
- AConsumer
that will call methods onUpdateStreamingImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStreamingImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStudio
default CompletableFuture<UpdateStudioResponse> updateStudio(UpdateStudioRequest updateStudioRequest) Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
- Parameters:
updateStudioRequest
-- Returns:
- A Java Future containing the result of the UpdateStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStudio
default CompletableFuture<UpdateStudioResponse> updateStudio(Consumer<UpdateStudioRequest.Builder> updateStudioRequest) Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
This is a convenience which creates an instance of the
UpdateStudioRequest.Builder
avoiding the need to create one manually viaUpdateStudioRequest.builder()
- Parameters:
updateStudioRequest
- AConsumer
that will call methods onUpdateStudioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStudio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStudioComponent
default CompletableFuture<UpdateStudioComponentResponse> updateStudioComponent(UpdateStudioComponentRequest updateStudioComponentRequest) Updates a studio component resource.
- Parameters:
updateStudioComponentRequest
-- Returns:
- A Java Future containing the result of the UpdateStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStudioComponent
default CompletableFuture<UpdateStudioComponentResponse> updateStudioComponent(Consumer<UpdateStudioComponentRequest.Builder> updateStudioComponentRequest) Updates a studio component resource.
This is a convenience which creates an instance of the
UpdateStudioComponentRequest.Builder
avoiding the need to create one manually viaUpdateStudioComponentRequest.builder()
- Parameters:
updateStudioComponentRequest
- AConsumer
that will call methods onUpdateStudioComponentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStudioComponent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NimbleException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofNimbleAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
NimbleAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aNimbleAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aNimbleAsyncClient
.
-