Interface WorkspacesInstancesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WorkspacesInstancesAsyncClient extends AwsClient
Service client for accessing Amazon Workspaces Instances asynchronously. This can be created using the static 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.

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

  • Field Details

  • Method Details

    • associateVolume

      default CompletableFuture<AssociateVolumeResponse> associateVolume(AssociateVolumeRequest associateVolumeRequest)

      Attaches a volume to a WorkSpace Instance.

      Parameters:
      associateVolumeRequest - Specifies volume attachment parameters.
      Returns:
      A Java Future containing the result of the AssociateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateVolume

      default CompletableFuture<AssociateVolumeResponse> associateVolume(Consumer<AssociateVolumeRequest.Builder> associateVolumeRequest)

      Attaches a volume to a WorkSpace Instance.


      This is a convenience which creates an instance of the AssociateVolumeRequest.Builder avoiding the need to create one manually via AssociateVolumeRequest.builder()

      Parameters:
      associateVolumeRequest - A Consumer that will call methods on AssociateVolumeRequest.Builder to create a request. Specifies volume attachment parameters.
      Returns:
      A Java Future containing the result of the AssociateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolume

      default CompletableFuture<CreateVolumeResponse> createVolume(CreateVolumeRequest createVolumeRequest)

      Creates a new volume for WorkSpace Instances.

      Parameters:
      createVolumeRequest - Specifies volume creation parameters.
      Returns:
      A Java Future containing the result of the CreateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ServiceQuotaExceededException Indicates that a service quota has been exceeded.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolume

      default CompletableFuture<CreateVolumeResponse> createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest)

      Creates a new volume for WorkSpace Instances.


      This is a convenience which creates an instance of the CreateVolumeRequest.Builder avoiding the need to create one manually via CreateVolumeRequest.builder()

      Parameters:
      createVolumeRequest - A Consumer that will call methods on CreateVolumeRequest.Builder to create a request. Specifies volume creation parameters.
      Returns:
      A Java Future containing the result of the CreateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ServiceQuotaExceededException Indicates that a service quota has been exceeded.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceInstance

      default CompletableFuture<CreateWorkspaceInstanceResponse> createWorkspaceInstance(CreateWorkspaceInstanceRequest createWorkspaceInstanceRequest)

      Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

      Parameters:
      createWorkspaceInstanceRequest - Defines the configuration parameters for creating a new WorkSpaces Instance.
      Returns:
      A Java Future containing the result of the CreateWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ServiceQuotaExceededException Indicates that a service quota has been exceeded.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceInstance

      default CompletableFuture<CreateWorkspaceInstanceResponse> createWorkspaceInstance(Consumer<CreateWorkspaceInstanceRequest.Builder> createWorkspaceInstanceRequest)

      Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.


      This is a convenience which creates an instance of the CreateWorkspaceInstanceRequest.Builder avoiding the need to create one manually via CreateWorkspaceInstanceRequest.builder()

      Parameters:
      createWorkspaceInstanceRequest - A Consumer that will call methods on CreateWorkspaceInstanceRequest.Builder to create a request. Defines the configuration parameters for creating a new WorkSpaces Instance.
      Returns:
      A Java Future containing the result of the CreateWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ServiceQuotaExceededException Indicates that a service quota has been exceeded.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(DeleteVolumeRequest deleteVolumeRequest)

      Deletes a specified volume.

      Parameters:
      deleteVolumeRequest - Specifies the volume to delete.
      Returns:
      A Java Future containing the result of the DeleteVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)

      Deletes a specified volume.


      This is a convenience which creates an instance of the DeleteVolumeRequest.Builder avoiding the need to create one manually via DeleteVolumeRequest.builder()

      Parameters:
      deleteVolumeRequest - A Consumer that will call methods on DeleteVolumeRequest.Builder to create a request. Specifies the volume to delete.
      Returns:
      A Java Future containing the result of the DeleteVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceInstance

      default CompletableFuture<DeleteWorkspaceInstanceResponse> deleteWorkspaceInstance(DeleteWorkspaceInstanceRequest deleteWorkspaceInstanceRequest)

      Deletes the specified WorkSpace

      Parameters:
      deleteWorkspaceInstanceRequest - The WorkSpace to delete
      Returns:
      A Java Future containing the result of the DeleteWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceInstance

      default CompletableFuture<DeleteWorkspaceInstanceResponse> deleteWorkspaceInstance(Consumer<DeleteWorkspaceInstanceRequest.Builder> deleteWorkspaceInstanceRequest)

      Deletes the specified WorkSpace


      This is a convenience which creates an instance of the DeleteWorkspaceInstanceRequest.Builder avoiding the need to create one manually via DeleteWorkspaceInstanceRequest.builder()

      Parameters:
      deleteWorkspaceInstanceRequest - A Consumer that will call methods on DeleteWorkspaceInstanceRequest.Builder to create a request. The WorkSpace to delete
      Returns:
      A Java Future containing the result of the DeleteWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateVolume

      default CompletableFuture<DisassociateVolumeResponse> disassociateVolume(DisassociateVolumeRequest disassociateVolumeRequest)

      Detaches a volume from a WorkSpace Instance.

      Parameters:
      disassociateVolumeRequest - Specifies volume detachment parameters.
      Returns:
      A Java Future containing the result of the DisassociateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateVolume

      default CompletableFuture<DisassociateVolumeResponse> disassociateVolume(Consumer<DisassociateVolumeRequest.Builder> disassociateVolumeRequest)

      Detaches a volume from a WorkSpace Instance.


      This is a convenience which creates an instance of the DisassociateVolumeRequest.Builder avoiding the need to create one manually via DisassociateVolumeRequest.builder()

      Parameters:
      disassociateVolumeRequest - A Consumer that will call methods on DisassociateVolumeRequest.Builder to create a request. Specifies volume detachment parameters.
      Returns:
      A Java Future containing the result of the DisassociateVolume 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • ConflictException Signals a conflict with the current state of the resource.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkspaceInstance

      default CompletableFuture<GetWorkspaceInstanceResponse> getWorkspaceInstance(GetWorkspaceInstanceRequest getWorkspaceInstanceRequest)

      Retrieves detailed information about a specific WorkSpace Instance.

      Parameters:
      getWorkspaceInstanceRequest - Identifies the WorkSpaces Instance to retrieve detailed information for.
      Returns:
      A Java Future containing the result of the GetWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkspaceInstance

      default CompletableFuture<GetWorkspaceInstanceResponse> getWorkspaceInstance(Consumer<GetWorkspaceInstanceRequest.Builder> getWorkspaceInstanceRequest)

      Retrieves detailed information about a specific WorkSpace Instance.


      This is a convenience which creates an instance of the GetWorkspaceInstanceRequest.Builder avoiding the need to create one manually via GetWorkspaceInstanceRequest.builder()

      Parameters:
      getWorkspaceInstanceRequest - A Consumer that will call methods on GetWorkspaceInstanceRequest.Builder to create a request. Identifies the WorkSpaces Instance to retrieve detailed information for.
      Returns:
      A Java Future containing the result of the GetWorkspaceInstance 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceTypes

      default CompletableFuture<ListInstanceTypesResponse> listInstanceTypes(ListInstanceTypesRequest listInstanceTypesRequest)

      Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

      Parameters:
      listInstanceTypesRequest - Defines input parameters for retrieving supported WorkSpaces Instances instance types.
      Returns:
      A Java Future containing the result of the ListInstanceTypes 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceTypes

      default CompletableFuture<ListInstanceTypesResponse> listInstanceTypes(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)

      Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.


      This is a convenience which creates an instance of the ListInstanceTypesRequest.Builder avoiding the need to create one manually via ListInstanceTypesRequest.builder()

      Parameters:
      listInstanceTypesRequest - A Consumer that will call methods on ListInstanceTypesRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances instance types.
      Returns:
      A Java Future containing the result of the ListInstanceTypes 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceTypesPaginator

      default ListInstanceTypesPublisher listInstanceTypesPaginator(ListInstanceTypesRequest listInstanceTypesRequest)

      This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesPublisher publisher = client.listInstanceTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesPublisher publisher = client.listInstanceTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.

      Parameters:
      listInstanceTypesRequest - Defines input parameters for retrieving supported WorkSpaces Instances instance types.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceTypesPaginator

      default ListInstanceTypesPublisher listInstanceTypesPaginator(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)

      This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesPublisher publisher = client.listInstanceTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesPublisher publisher = client.listInstanceTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.


      This is a convenience which creates an instance of the ListInstanceTypesRequest.Builder avoiding the need to create one manually via ListInstanceTypesRequest.builder()

      Parameters:
      listInstanceTypesRequest - A Consumer that will call methods on ListInstanceTypesRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances instance types.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegions

      default CompletableFuture<ListRegionsResponse> listRegions(ListRegionsRequest listRegionsRequest)

      Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

      Parameters:
      listRegionsRequest - Defines input parameters for retrieving supported WorkSpaces Instances regions.
      Returns:
      A Java Future containing the result of the ListRegions 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegions

      default CompletableFuture<ListRegionsResponse> listRegions(Consumer<ListRegionsRequest.Builder> listRegionsRequest)

      Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.


      This is a convenience which creates an instance of the ListRegionsRequest.Builder avoiding the need to create one manually via ListRegionsRequest.builder()

      Parameters:
      listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances regions.
      Returns:
      A Java Future containing the result of the ListRegions 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionsPaginator

      default ListRegionsPublisher listRegionsPaginator(ListRegionsRequest listRegionsRequest)

      This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.

      Parameters:
      listRegionsRequest - Defines input parameters for retrieving supported WorkSpaces Instances regions.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionsPaginator

      default ListRegionsPublisher listRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest)

      This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.


      This is a convenience which creates an instance of the ListRegionsRequest.Builder avoiding the need to create one manually via ListRegionsRequest.builder()

      Parameters:
      listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances regions.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException 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)

      Retrieves tags for a WorkSpace Instance.

      Parameters:
      listTagsForResourceRequest - Specifies the WorkSpace Instance to retrieve tags for.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException 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)

      Retrieves tags for a WorkSpace Instance.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. Specifies the WorkSpace Instance to retrieve tags for.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkspaceInstances

      default CompletableFuture<ListWorkspaceInstancesResponse> listWorkspaceInstances(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)

      Retrieves a collection of WorkSpaces Instances based on specified filters.

      Parameters:
      listWorkspaceInstancesRequest - Defines filters and pagination parameters for retrieving WorkSpaces Instances.
      Returns:
      A Java Future containing the result of the ListWorkspaceInstances 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkspaceInstances

      default CompletableFuture<ListWorkspaceInstancesResponse> listWorkspaceInstances(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)

      Retrieves a collection of WorkSpaces Instances based on specified filters.


      This is a convenience which creates an instance of the ListWorkspaceInstancesRequest.Builder avoiding the need to create one manually via ListWorkspaceInstancesRequest.builder()

      Parameters:
      listWorkspaceInstancesRequest - A Consumer that will call methods on ListWorkspaceInstancesRequest.Builder to create a request. Defines filters and pagination parameters for retrieving WorkSpaces Instances.
      Returns:
      A Java Future containing the result of the ListWorkspaceInstances 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkspaceInstancesPaginator

      default ListWorkspaceInstancesPublisher listWorkspaceInstancesPaginator(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)

      This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesPublisher publisher = client.listWorkspaceInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesPublisher publisher = client.listWorkspaceInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.

      Parameters:
      listWorkspaceInstancesRequest - Defines filters and pagination parameters for retrieving WorkSpaces Instances.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkspaceInstancesPaginator

      default ListWorkspaceInstancesPublisher listWorkspaceInstancesPaginator(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)

      This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesPublisher publisher = client.listWorkspaceInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesPublisher publisher = client.listWorkspaceInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.


      This is a convenience which creates an instance of the ListWorkspaceInstancesRequest.Builder avoiding the need to create one manually via ListWorkspaceInstancesRequest.builder()

      Parameters:
      listWorkspaceInstancesRequest - A Consumer that will call methods on ListWorkspaceInstancesRequest.Builder to create a request. Defines filters and pagination parameters for retrieving WorkSpaces Instances.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds tags to a WorkSpace Instance.

      Parameters:
      tagResourceRequest - Specifies tags to add to a WorkSpace Instance.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException 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)

      Adds tags to a WorkSpace Instance.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Specifies tags to add to a WorkSpace Instance.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException 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)

      Removes tags from a WorkSpace Instance.

      Parameters:
      untagResourceRequest - Specifies tags to remove from a WorkSpace Instance.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException 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)

      Removes tags from a WorkSpace Instance.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. Specifies tags to remove from a WorkSpace Instance.
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Indicates invalid input parameters in the request.
      • AccessDeniedException Indicates insufficient permissions to perform the requested action.
      • ResourceNotFoundException Indicates the requested resource could not be found.
      • ThrottlingException Indicates the request rate has exceeded limits.
      • InternalServerException Indicates an unexpected server-side error occurred.
      • 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.
      • WorkspacesInstancesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default WorkspacesInstancesServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static WorkspacesInstancesAsyncClient create()
      Create a WorkspacesInstancesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static WorkspacesInstancesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a WorkspacesInstancesAsyncClient.