Package software.amazon.awssdk.services.workspaces

Interface WorkSpacesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WorkSpacesAsyncClient extends AwsClient
Service client for accessing Amazon WorkSpaces 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 Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

  • Field Details

  • Method Details

    • acceptAccountLinkInvitation

      default CompletableFuture<AcceptAccountLinkInvitationResponse> acceptAccountLinkInvitation(AcceptAccountLinkInvitationRequest acceptAccountLinkInvitationRequest)

      Accepts the account link invitation.

      There's currently no unlinking capability after you accept the account linking invitation.

      Parameters:
      acceptAccountLinkInvitationRequest -
      Returns:
      A Java Future containing the result of the AcceptAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • acceptAccountLinkInvitation

      default CompletableFuture<AcceptAccountLinkInvitationResponse> acceptAccountLinkInvitation(Consumer<AcceptAccountLinkInvitationRequest.Builder> acceptAccountLinkInvitationRequest)

      Accepts the account link invitation.

      There's currently no unlinking capability after you accept the account linking invitation.


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

      Parameters:
      acceptAccountLinkInvitationRequest - A Consumer that will call methods on AcceptAccountLinkInvitationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AcceptAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateConnectionAlias

      default CompletableFuture<AssociateConnectionAliasResponse> associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest)

      Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

      Parameters:
      associateConnectionAliasRequest -
      Returns:
      A Java Future containing the result of the AssociateConnectionAlias 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.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateConnectionAlias

      default CompletableFuture<AssociateConnectionAliasResponse> associateConnectionAlias(Consumer<AssociateConnectionAliasRequest.Builder> associateConnectionAliasRequest)

      Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .


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

      Parameters:
      associateConnectionAliasRequest - A Consumer that will call methods on AssociateConnectionAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateConnectionAlias 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.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateIpGroups

      default CompletableFuture<AssociateIpGroupsResponse> associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)

      Associates the specified IP access control group with the specified directory.

      Parameters:
      associateIpGroupsRequest -
      Returns:
      A Java Future containing the result of the AssociateIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateIpGroups

      default CompletableFuture<AssociateIpGroupsResponse> associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest)

      Associates the specified IP access control group with the specified directory.


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

      Parameters:
      associateIpGroupsRequest - A Consumer that will call methods on AssociateIpGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateWorkspaceApplication

      default CompletableFuture<AssociateWorkspaceApplicationResponse> associateWorkspaceApplication(AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest)

      Associates the specified application to the specified WorkSpace.

      Parameters:
      associateWorkspaceApplicationRequest -
      Returns:
      A Java Future containing the result of the AssociateWorkspaceApplication 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • ComputeNotCompatibleException The compute type of the WorkSpace is not compatible with the application.
      • OperatingSystemNotCompatibleException The operating system of the WorkSpace is not compatible with the application.
      • ApplicationNotSupportedException The specified application is not supported.
      • IncompatibleApplicationsException The specified application is not compatible with 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateWorkspaceApplication

      default CompletableFuture<AssociateWorkspaceApplicationResponse> associateWorkspaceApplication(Consumer<AssociateWorkspaceApplicationRequest.Builder> associateWorkspaceApplicationRequest)

      Associates the specified application to the specified WorkSpace.


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

      Parameters:
      associateWorkspaceApplicationRequest - A Consumer that will call methods on AssociateWorkspaceApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateWorkspaceApplication 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • ComputeNotCompatibleException The compute type of the WorkSpace is not compatible with the application.
      • OperatingSystemNotCompatibleException The operating system of the WorkSpace is not compatible with the application.
      • ApplicationNotSupportedException The specified application is not supported.
      • IncompatibleApplicationsException The specified application is not compatible with 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • authorizeIpRules

      default CompletableFuture<AuthorizeIpRulesResponse> authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)

      Adds one or more rules to the specified IP access control group.

      This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

      Parameters:
      authorizeIpRulesRequest -
      Returns:
      A Java Future containing the result of the AuthorizeIpRules 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • authorizeIpRules

      default CompletableFuture<AuthorizeIpRulesResponse> authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest)

      Adds one or more rules to the specified IP access control group.

      This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.


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

      Parameters:
      authorizeIpRulesRequest - A Consumer that will call methods on AuthorizeIpRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AuthorizeIpRules 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyWorkspaceImage

      default CompletableFuture<CopyWorkspaceImageResponse> copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)

      Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

      In the China (Ningxia) Region, you can copy images only within the same Region.

      In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

      Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

      Parameters:
      copyWorkspaceImageRequest -
      Returns:
      A Java Future containing the result of the CopyWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • OperationNotSupportedException This operation is not supported.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyWorkspaceImage

      default CompletableFuture<CopyWorkspaceImageResponse> copyWorkspaceImage(Consumer<CopyWorkspaceImageRequest.Builder> copyWorkspaceImageRequest)

      Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

      In the China (Ningxia) Region, you can copy images only within the same Region.

      In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

      Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.


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

      Parameters:
      copyWorkspaceImageRequest - A Consumer that will call methods on CopyWorkspaceImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • OperationNotSupportedException This operation is not supported.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccountLinkInvitation

      default CompletableFuture<CreateAccountLinkInvitationResponse> createAccountLinkInvitation(CreateAccountLinkInvitationRequest createAccountLinkInvitationRequest)

      Creates the account link invitation.

      Parameters:
      createAccountLinkInvitationRequest -
      Returns:
      A Java Future containing the result of the CreateAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • AccessDeniedException The user is not authorized to access a resource.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccountLinkInvitation

      default CompletableFuture<CreateAccountLinkInvitationResponse> createAccountLinkInvitation(Consumer<CreateAccountLinkInvitationRequest.Builder> createAccountLinkInvitationRequest)

      Creates the account link invitation.


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

      Parameters:
      createAccountLinkInvitationRequest - A Consumer that will call methods on CreateAccountLinkInvitationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • AccessDeniedException The user is not authorized to access a resource.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectClientAddIn

      default CompletableFuture<CreateConnectClientAddInResponse> createConnectClientAddIn(CreateConnectClientAddInRequest createConnectClientAddInRequest)

      Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

      This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

      Parameters:
      createConnectClientAddInRequest -
      Returns:
      A Java Future containing the result of the CreateConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceCreationFailedException The resource could not be created.
      • ResourceAlreadyExistsException The specified resource already exists.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectClientAddIn

      default CompletableFuture<CreateConnectClientAddInResponse> createConnectClientAddIn(Consumer<CreateConnectClientAddInRequest.Builder> createConnectClientAddInRequest)

      Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

      This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.


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

      Parameters:
      createConnectClientAddInRequest - A Consumer that will call methods on CreateConnectClientAddInRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceCreationFailedException The resource could not be created.
      • ResourceAlreadyExistsException The specified resource already exists.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectionAlias

      default CompletableFuture<CreateConnectionAliasResponse> createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)

      Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Parameters:
      createConnectionAliasRequest -
      Returns:
      A Java Future containing the result of the CreateConnectionAlias 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.
      • ResourceAlreadyExistsException The specified resource already exists.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectionAlias

      default CompletableFuture<CreateConnectionAliasResponse> createConnectionAlias(Consumer<CreateConnectionAliasRequest.Builder> createConnectionAliasRequest)

      Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.


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

      Parameters:
      createConnectionAliasRequest - A Consumer that will call methods on CreateConnectionAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConnectionAlias 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.
      • ResourceAlreadyExistsException The specified resource already exists.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIpGroup

      default CompletableFuture<CreateIpGroupResponse> createIpGroup(CreateIpGroupRequest createIpGroupRequest)

      Creates an IP access control group.

      An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

      There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

      Parameters:
      createIpGroupRequest -
      Returns:
      A Java Future containing the result of the CreateIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceCreationFailedException The resource could not be created.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIpGroup

      default CompletableFuture<CreateIpGroupResponse> createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest)

      Creates an IP access control group.

      An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

      There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.


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

      Parameters:
      createIpGroupRequest - A Consumer that will call methods on CreateIpGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceCreationFailedException The resource could not be created.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStandbyWorkspaces

      default CompletableFuture<CreateStandbyWorkspacesResponse> createStandbyWorkspaces(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest)

      Creates a standby WorkSpace in a secondary Region.

      Parameters:
      createStandbyWorkspacesRequest -
      Returns:
      A Java Future containing the result of the CreateStandbyWorkspaces 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStandbyWorkspaces

      default CompletableFuture<CreateStandbyWorkspacesResponse> createStandbyWorkspaces(Consumer<CreateStandbyWorkspacesRequest.Builder> createStandbyWorkspacesRequest)

      Creates a standby WorkSpace in a secondary Region.


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

      Parameters:
      createStandbyWorkspacesRequest - A Consumer that will call methods on CreateStandbyWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStandbyWorkspaces 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTags

      default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)

      Creates the specified tags for the specified WorkSpaces resource.

      Parameters:
      createTagsRequest -
      Returns:
      A Java Future containing the result of the CreateTags 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.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTags

      default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)

      Creates the specified tags for the specified WorkSpaces resource.


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

      Parameters:
      createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTags 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.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUpdatedWorkspaceImage

      default CompletableFuture<CreateUpdatedWorkspaceImageResponse> createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest)

      Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

      To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

      • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

      • Microsoft Windows updates and other application updates are not included in the update process.

      • The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

      Parameters:
      createUpdatedWorkspaceImageRequest -
      Returns:
      A Java Future containing the result of the CreateUpdatedWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUpdatedWorkspaceImage

      default CompletableFuture<CreateUpdatedWorkspaceImageResponse> createUpdatedWorkspaceImage(Consumer<CreateUpdatedWorkspaceImageRequest.Builder> createUpdatedWorkspaceImageRequest)

      Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

      To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

      • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

      • Microsoft Windows updates and other application updates are not included in the update process.

      • The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.


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

      Parameters:
      createUpdatedWorkspaceImageRequest - A Consumer that will call methods on CreateUpdatedWorkspaceImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUpdatedWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceBundle

      default CompletableFuture<CreateWorkspaceBundleResponse> createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)

      Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

      Parameters:
      createWorkspaceBundleRequest -
      Returns:
      A Java Future containing the result of the CreateWorkspaceBundle 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.
      • ResourceUnavailableException The specified resource is not available.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceBundle

      default CompletableFuture<CreateWorkspaceBundleResponse> createWorkspaceBundle(Consumer<CreateWorkspaceBundleRequest.Builder> createWorkspaceBundleRequest)

      Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.


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

      Parameters:
      createWorkspaceBundleRequest - A Consumer that will call methods on CreateWorkspaceBundleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkspaceBundle 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.
      • ResourceUnavailableException The specified resource is not available.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceImage

      default CompletableFuture<CreateWorkspaceImageResponse> createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest)

      Creates a new WorkSpace image from an existing WorkSpace.

      Parameters:
      createWorkspaceImageRequest -
      Returns:
      A Java Future containing the result of the CreateWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaceImage

      default CompletableFuture<CreateWorkspaceImageResponse> createWorkspaceImage(Consumer<CreateWorkspaceImageRequest.Builder> createWorkspaceImageRequest)

      Creates a new WorkSpace image from an existing WorkSpace.


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

      Parameters:
      createWorkspaceImageRequest - A Consumer that will call methods on CreateWorkspaceImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaces

      default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)

      Creates one or more WorkSpaces.

      This operation is asynchronous and returns before the WorkSpaces are created.

      • The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      • You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.

      • User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.

      Parameters:
      createWorkspacesRequest -
      Returns:
      A Java Future containing the result of the CreateWorkspaces 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkspaces

      default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest)

      Creates one or more WorkSpaces.

      This operation is asynchronous and returns before the WorkSpaces are created.

      • The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      • You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.

      • User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.


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

      Parameters:
      createWorkspacesRequest - A Consumer that will call methods on CreateWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkspaces 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccountLinkInvitation

      default CompletableFuture<DeleteAccountLinkInvitationResponse> deleteAccountLinkInvitation(DeleteAccountLinkInvitationRequest deleteAccountLinkInvitationRequest)

      Deletes the account link invitation.

      Parameters:
      deleteAccountLinkInvitationRequest -
      Returns:
      A Java Future containing the result of the DeleteAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccountLinkInvitation

      default CompletableFuture<DeleteAccountLinkInvitationResponse> deleteAccountLinkInvitation(Consumer<DeleteAccountLinkInvitationRequest.Builder> deleteAccountLinkInvitationRequest)

      Deletes the account link invitation.


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

      Parameters:
      deleteAccountLinkInvitationRequest - A Consumer that will call methods on DeleteAccountLinkInvitationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccountLinkInvitation 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 You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteClientBranding

      default CompletableFuture<DeleteClientBrandingResponse> deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest)

      Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      After you delete your customized client branding, your login portal reverts to the default client branding.

      Parameters:
      deleteClientBrandingRequest -
      Returns:
      A Java Future containing the result of the DeleteClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteClientBranding

      default CompletableFuture<DeleteClientBrandingResponse> deleteClientBranding(Consumer<DeleteClientBrandingRequest.Builder> deleteClientBrandingRequest)

      Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      After you delete your customized client branding, your login portal reverts to the default client branding.


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

      Parameters:
      deleteClientBrandingRequest - A Consumer that will call methods on DeleteClientBrandingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectClientAddIn

      default CompletableFuture<DeleteConnectClientAddInResponse> deleteConnectClientAddIn(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest)

      Deletes a client-add-in for Amazon Connect that is configured within a directory.

      Parameters:
      deleteConnectClientAddInRequest -
      Returns:
      A Java Future containing the result of the DeleteConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectClientAddIn

      default CompletableFuture<DeleteConnectClientAddInResponse> deleteConnectClientAddIn(Consumer<DeleteConnectClientAddInRequest.Builder> deleteConnectClientAddInRequest)

      Deletes a client-add-in for Amazon Connect that is configured within a directory.


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

      Parameters:
      deleteConnectClientAddInRequest - A Consumer that will call methods on DeleteConnectClientAddInRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectionAlias

      default CompletableFuture<DeleteConnectionAliasResponse> deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)

      Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

      To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

      Parameters:
      deleteConnectionAliasRequest -
      Returns:
      A Java Future containing the result of the DeleteConnectionAlias 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.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectionAlias

      default CompletableFuture<DeleteConnectionAliasResponse> deleteConnectionAlias(Consumer<DeleteConnectionAliasRequest.Builder> deleteConnectionAliasRequest)

      Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

      To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.


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

      Parameters:
      deleteConnectionAliasRequest - A Consumer that will call methods on DeleteConnectionAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConnectionAlias 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.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIpGroup

      default CompletableFuture<DeleteIpGroupResponse> deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)

      Deletes the specified IP access control group.

      You cannot delete an IP access control group that is associated with a directory.

      Parameters:
      deleteIpGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIpGroup

      default CompletableFuture<DeleteIpGroupResponse> deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest)

      Deletes the specified IP access control group.

      You cannot delete an IP access control group that is associated with a directory.


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

      Parameters:
      deleteIpGroupRequest - A Consumer that will call methods on DeleteIpGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)

      Deletes the specified tags from the specified WorkSpaces resource.

      Parameters:
      deleteTagsRequest -
      Returns:
      A Java Future containing the result of the DeleteTags 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.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)

      Deletes the specified tags from the specified WorkSpaces resource.


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

      Parameters:
      deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTags 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.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceBundle

      default CompletableFuture<DeleteWorkspaceBundleResponse> deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)

      Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

      Parameters:
      deleteWorkspaceBundleRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkspaceBundle 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceBundle

      default CompletableFuture<DeleteWorkspaceBundleResponse> deleteWorkspaceBundle(Consumer<DeleteWorkspaceBundleRequest.Builder> deleteWorkspaceBundleRequest)

      Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.


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

      Parameters:
      deleteWorkspaceBundleRequest - A Consumer that will call methods on DeleteWorkspaceBundleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkspaceBundle 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceImage

      default CompletableFuture<DeleteWorkspaceImageResponse> deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)

      Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

      Parameters:
      deleteWorkspaceImageRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkspaceImage 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.
      • ResourceAssociatedException The resource is associated with a directory.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkspaceImage

      default CompletableFuture<DeleteWorkspaceImageResponse> deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest)

      Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.


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

      Parameters:
      deleteWorkspaceImageRequest - A Consumer that will call methods on DeleteWorkspaceImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkspaceImage 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.
      • ResourceAssociatedException The resource is associated with a directory.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deployWorkspaceApplications

      default CompletableFuture<DeployWorkspaceApplicationsResponse> deployWorkspaceApplications(DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest)

      Deploys associated applications to the specified WorkSpace

      Parameters:
      deployWorkspaceApplicationsRequest -
      Returns:
      A Java Future containing the result of the DeployWorkspaceApplications 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • IncompatibleApplicationsException The specified application is not compatible with 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deployWorkspaceApplications

      default CompletableFuture<DeployWorkspaceApplicationsResponse> deployWorkspaceApplications(Consumer<DeployWorkspaceApplicationsRequest.Builder> deployWorkspaceApplicationsRequest)

      Deploys associated applications to the specified WorkSpace


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

      Parameters:
      deployWorkspaceApplicationsRequest - A Consumer that will call methods on DeployWorkspaceApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeployWorkspaceApplications 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • IncompatibleApplicationsException The specified application is not compatible with 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterWorkspaceDirectory

      default CompletableFuture<DeregisterWorkspaceDirectoryResponse> deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)

      Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

      Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

      To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

      Parameters:
      deregisterWorkspaceDirectoryRequest -
      Returns:
      A Java Future containing the result of the DeregisterWorkspaceDirectory 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterWorkspaceDirectory

      default CompletableFuture<DeregisterWorkspaceDirectoryResponse> deregisterWorkspaceDirectory(Consumer<DeregisterWorkspaceDirectoryRequest.Builder> deregisterWorkspaceDirectoryRequest)

      Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

      Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

      To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.


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

      Parameters:
      deregisterWorkspaceDirectoryRequest - A Consumer that will call methods on DeregisterWorkspaceDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterWorkspaceDirectory 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccount

      default CompletableFuture<DescribeAccountResponse> describeAccount(DescribeAccountRequest describeAccountRequest)

      Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

      Parameters:
      describeAccountRequest -
      Returns:
      A Java Future containing the result of the DescribeAccount 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccount

      default CompletableFuture<DescribeAccountResponse> describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest)

      Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.


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

      Parameters:
      describeAccountRequest - A Consumer that will call methods on DescribeAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccount 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountModifications

      default CompletableFuture<DescribeAccountModificationsResponse> describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)

      Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

      Parameters:
      describeAccountModificationsRequest -
      Returns:
      A Java Future containing the result of the DescribeAccountModifications 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountModifications

      default CompletableFuture<DescribeAccountModificationsResponse> describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest)

      Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.


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

      Parameters:
      describeAccountModificationsRequest - A Consumer that will call methods on DescribeAccountModificationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccountModifications 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationAssociations

      default CompletableFuture<DescribeApplicationAssociationsResponse> describeApplicationAssociations(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest)

      Describes the associations between the application and the specified associated resources.

      Parameters:
      describeApplicationAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeApplicationAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationAssociations

      default CompletableFuture<DescribeApplicationAssociationsResponse> describeApplicationAssociations(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest)

      Describes the associations between the application and the specified associated resources.


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

      Parameters:
      describeApplicationAssociationsRequest - A Consumer that will call methods on DescribeApplicationAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeApplicationAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationAssociationsPaginator

      default DescribeApplicationAssociationsPublisher describeApplicationAssociationsPaginator(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest)

      This is a variant of describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest) 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.workspaces.paginators.DescribeApplicationAssociationsPublisher publisher = client.describeApplicationAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsPublisher publisher = client.describeApplicationAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse 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 describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest) operation.

      Parameters:
      describeApplicationAssociationsRequest -
      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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationAssociationsPaginator

      default DescribeApplicationAssociationsPublisher describeApplicationAssociationsPaginator(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest)

      This is a variant of describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest) 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.workspaces.paginators.DescribeApplicationAssociationsPublisher publisher = client.describeApplicationAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsPublisher publisher = client.describeApplicationAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse 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 describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest) operation.


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

      Parameters:
      describeApplicationAssociationsRequest - A Consumer that will call methods on DescribeApplicationAssociationsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplications

      default CompletableFuture<DescribeApplicationsResponse> describeApplications(DescribeApplicationsRequest describeApplicationsRequest)

      Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

      Parameters:
      describeApplicationsRequest -
      Returns:
      A Java Future containing the result of the DescribeApplications 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplications

      default CompletableFuture<DescribeApplicationsResponse> describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest)

      Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.


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

      Parameters:
      describeApplicationsRequest - A Consumer that will call methods on DescribeApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeApplications 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationsPaginator

      default DescribeApplicationsPublisher describeApplicationsPaginator(DescribeApplicationsRequest describeApplicationsRequest)

      This is a variant of describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest) 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.workspaces.paginators.DescribeApplicationsPublisher publisher = client.describeApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsPublisher publisher = client.describeApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse 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 describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest) operation.

      Parameters:
      describeApplicationsRequest -
      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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApplicationsPaginator

      default DescribeApplicationsPublisher describeApplicationsPaginator(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest)

      This is a variant of describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest) 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.workspaces.paginators.DescribeApplicationsPublisher publisher = client.describeApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsPublisher publisher = client.describeApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse 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 describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest) operation.


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

      Parameters:
      describeApplicationsRequest - A Consumer that will call methods on DescribeApplicationsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBundleAssociations

      default CompletableFuture<DescribeBundleAssociationsResponse> describeBundleAssociations(DescribeBundleAssociationsRequest describeBundleAssociationsRequest)

      Describes the associations between the applications and the specified bundle.

      Parameters:
      describeBundleAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeBundleAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBundleAssociations

      default CompletableFuture<DescribeBundleAssociationsResponse> describeBundleAssociations(Consumer<DescribeBundleAssociationsRequest.Builder> describeBundleAssociationsRequest)

      Describes the associations between the applications and the specified bundle.


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

      Parameters:
      describeBundleAssociationsRequest - A Consumer that will call methods on DescribeBundleAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBundleAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClientBranding

      default CompletableFuture<DescribeClientBrandingResponse> describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest)

      Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      Only device types that have branding information configured will be shown in the response.

      Parameters:
      describeClientBrandingRequest -
      Returns:
      A Java Future containing the result of the DescribeClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClientBranding

      default CompletableFuture<DescribeClientBrandingResponse> describeClientBranding(Consumer<DescribeClientBrandingRequest.Builder> describeClientBrandingRequest)

      Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      Only device types that have branding information configured will be shown in the response.


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

      Parameters:
      describeClientBrandingRequest - A Consumer that will call methods on DescribeClientBrandingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClientProperties

      default CompletableFuture<DescribeClientPropertiesResponse> describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)

      Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

      Parameters:
      describeClientPropertiesRequest -
      Returns:
      A Java Future containing the result of the DescribeClientProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClientProperties

      default CompletableFuture<DescribeClientPropertiesResponse> describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest)

      Retrieves a list that describes one or more specified Amazon WorkSpaces clients.


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

      Parameters:
      describeClientPropertiesRequest - A Consumer that will call methods on DescribeClientPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeClientProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectClientAddIns

      default CompletableFuture<DescribeConnectClientAddInsResponse> describeConnectClientAddIns(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest)

      Retrieves a list of Amazon Connect client add-ins that have been created.

      Parameters:
      describeConnectClientAddInsRequest -
      Returns:
      A Java Future containing the result of the DescribeConnectClientAddIns 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectClientAddIns

      default CompletableFuture<DescribeConnectClientAddInsResponse> describeConnectClientAddIns(Consumer<DescribeConnectClientAddInsRequest.Builder> describeConnectClientAddInsRequest)

      Retrieves a list of Amazon Connect client add-ins that have been created.


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

      Parameters:
      describeConnectClientAddInsRequest - A Consumer that will call methods on DescribeConnectClientAddInsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectClientAddIns 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionAliasPermissions

      default CompletableFuture<DescribeConnectionAliasPermissionsResponse> describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest)

      Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Parameters:
      describeConnectionAliasPermissionsRequest -
      Returns:
      A Java Future containing the result of the DescribeConnectionAliasPermissions 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionAliasPermissions

      default CompletableFuture<DescribeConnectionAliasPermissionsResponse> describeConnectionAliasPermissions(Consumer<DescribeConnectionAliasPermissionsRequest.Builder> describeConnectionAliasPermissionsRequest)

      Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.


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

      Parameters:
      describeConnectionAliasPermissionsRequest - A Consumer that will call methods on DescribeConnectionAliasPermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectionAliasPermissions 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionAliases

      default CompletableFuture<DescribeConnectionAliasesResponse> describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest)

      Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Parameters:
      describeConnectionAliasesRequest -
      Returns:
      A Java Future containing the result of the DescribeConnectionAliases 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionAliases

      default CompletableFuture<DescribeConnectionAliasesResponse> describeConnectionAliases(Consumer<DescribeConnectionAliasesRequest.Builder> describeConnectionAliasesRequest)

      Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.


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

      Parameters:
      describeConnectionAliasesRequest - A Consumer that will call methods on DescribeConnectionAliasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectionAliases 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImageAssociations

      default CompletableFuture<DescribeImageAssociationsResponse> describeImageAssociations(DescribeImageAssociationsRequest describeImageAssociationsRequest)

      Describes the associations between the applications and the specified image.

      Parameters:
      describeImageAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeImageAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImageAssociations

      default CompletableFuture<DescribeImageAssociationsResponse> describeImageAssociations(Consumer<DescribeImageAssociationsRequest.Builder> describeImageAssociationsRequest)

      Describes the associations between the applications and the specified image.


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

      Parameters:
      describeImageAssociationsRequest - A Consumer that will call methods on DescribeImageAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeImageAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIpGroups

      default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)

      Describes one or more of your IP access control groups.

      Parameters:
      describeIpGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIpGroups

      default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest)

      Describes one or more of your IP access control groups.


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

      Parameters:
      describeIpGroupsRequest - A Consumer that will call methods on DescribeIpGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIpGroups

      default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups()

      Describes one or more of your IP access control groups.

      Returns:
      A Java Future containing the result of the DescribeIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTags

      default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)

      Describes the specified tags for the specified WorkSpaces resource.

      Parameters:
      describeTagsRequest -
      Returns:
      A Java Future containing the result of the DescribeTags 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.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTags

      default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)

      Describes the specified tags for the specified WorkSpaces resource.


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

      Parameters:
      describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTags 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.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceAssociations

      default CompletableFuture<DescribeWorkspaceAssociationsResponse> describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest)

      Describes the associations betweens applications and the specified WorkSpace.

      Parameters:
      describeWorkspaceAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceAssociations

      default CompletableFuture<DescribeWorkspaceAssociationsResponse> describeWorkspaceAssociations(Consumer<DescribeWorkspaceAssociationsRequest.Builder> describeWorkspaceAssociationsRequest)

      Describes the associations betweens applications and the specified WorkSpace.


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

      Parameters:
      describeWorkspaceAssociationsRequest - A Consumer that will call methods on DescribeWorkspaceAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceAssociations 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundles

      default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)

      Retrieves a list that describes the available WorkSpace bundles.

      You can filter the results using either bundle ID or owner, but not both.

      Parameters:
      describeWorkspaceBundlesRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceBundles 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundles

      default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)

      Retrieves a list that describes the available WorkSpace bundles.

      You can filter the results using either bundle ID or owner, but not both.


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

      Parameters:
      describeWorkspaceBundlesRequest - A Consumer that will call methods on DescribeWorkspaceBundlesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceBundles 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundles

      default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles()

      Retrieves a list that describes the available WorkSpace bundles.

      You can filter the results using either bundle ID or owner, but not both.

      Returns:
      A Java Future containing the result of the DescribeWorkspaceBundles 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundlesPaginator

      default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator()

      This is a variant of describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) 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.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse 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 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 describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) operation.

      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundlesPaginator

      default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)

      This is a variant of describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) 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.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse 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 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 describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) operation.

      Parameters:
      describeWorkspaceBundlesRequest -
      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceBundlesPaginator

      default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)

      This is a variant of describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) 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.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse 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 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 describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest) operation.


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

      Parameters:
      describeWorkspaceBundlesRequest - A Consumer that will call methods on DescribeWorkspaceBundlesRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectories

      default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)

      Describes the available directories that are registered with Amazon WorkSpaces.

      Parameters:
      describeWorkspaceDirectoriesRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceDirectories 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectories

      default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)

      Describes the available directories that are registered with Amazon WorkSpaces.


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

      Parameters:
      describeWorkspaceDirectoriesRequest - A Consumer that will call methods on DescribeWorkspaceDirectoriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceDirectories 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectories

      default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories()

      Describes the available directories that are registered with Amazon WorkSpaces.

      Returns:
      A Java Future containing the result of the DescribeWorkspaceDirectories 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectoriesPaginator

      default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator()

      This is a variant of describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) 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.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse 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 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 describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) operation.

      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectoriesPaginator

      default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)

      This is a variant of describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) 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.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse 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 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 describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) operation.

      Parameters:
      describeWorkspaceDirectoriesRequest -
      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceDirectoriesPaginator

      default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)

      This is a variant of describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) 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.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse 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 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 describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest) operation.


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

      Parameters:
      describeWorkspaceDirectoriesRequest - A Consumer that will call methods on DescribeWorkspaceDirectoriesRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceImagePermissions

      default CompletableFuture<DescribeWorkspaceImagePermissionsResponse> describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest)

      Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

      Parameters:
      describeWorkspaceImagePermissionsRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceImagePermissions 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.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceImagePermissions

      default CompletableFuture<DescribeWorkspaceImagePermissionsResponse> describeWorkspaceImagePermissions(Consumer<DescribeWorkspaceImagePermissionsRequest.Builder> describeWorkspaceImagePermissionsRequest)

      Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.


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

      Parameters:
      describeWorkspaceImagePermissionsRequest - A Consumer that will call methods on DescribeWorkspaceImagePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceImagePermissions 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.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceImages

      default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)

      Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

      Parameters:
      describeWorkspaceImagesRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceImages 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceImages

      default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest)

      Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.


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

      Parameters:
      describeWorkspaceImagesRequest - A Consumer that will call methods on DescribeWorkspaceImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceImages 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceImages

      default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages()

      Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

      Returns:
      A Java Future containing the result of the DescribeWorkspaceImages 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.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceSnapshots

      default CompletableFuture<DescribeWorkspaceSnapshotsResponse> describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)

      Describes the snapshots for the specified WorkSpace.

      Parameters:
      describeWorkspaceSnapshotsRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceSnapshots 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaceSnapshots

      default CompletableFuture<DescribeWorkspaceSnapshotsResponse> describeWorkspaceSnapshots(Consumer<DescribeWorkspaceSnapshotsRequest.Builder> describeWorkspaceSnapshotsRequest)

      Describes the snapshots for the specified WorkSpace.


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

      Parameters:
      describeWorkspaceSnapshotsRequest - A Consumer that will call methods on DescribeWorkspaceSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceSnapshots 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaces

      default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)

      Describes the specified WorkSpaces.

      You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

      Parameters:
      describeWorkspacesRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaces 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaces

      default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)

      Describes the specified WorkSpaces.

      You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.


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

      Parameters:
      describeWorkspacesRequest - A Consumer that will call methods on DescribeWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaces 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspaces

      default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces()

      Describes the specified WorkSpaces.

      You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

      Returns:
      A Java Future containing the result of the DescribeWorkspaces 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesConnectionStatus

      default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)

      Describes the connection status of the specified WorkSpaces.

      Parameters:
      describeWorkspacesConnectionStatusRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspacesConnectionStatus 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesConnectionStatus

      default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)

      Describes the connection status of the specified WorkSpaces.


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

      Parameters:
      describeWorkspacesConnectionStatusRequest - A Consumer that will call methods on DescribeWorkspacesConnectionStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspacesConnectionStatus 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesConnectionStatus

      default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus()

      Describes the connection status of the specified WorkSpaces.

      Returns:
      A Java Future containing the result of the DescribeWorkspacesConnectionStatus 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesPaginator

      default DescribeWorkspacesPublisher describeWorkspacesPaginator()

      This is a variant of describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) 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.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse 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 Limit 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 describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) operation.

      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesPaginator

      default DescribeWorkspacesPublisher describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)

      This is a variant of describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) 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.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse 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 Limit 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 describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) operation.

      Parameters:
      describeWorkspacesRequest -
      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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkspacesPaginator

      default DescribeWorkspacesPublisher describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)

      This is a variant of describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) 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.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse 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 Limit 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 describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest) operation.


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

      Parameters:
      describeWorkspacesRequest - A Consumer that will call methods on DescribeWorkspacesRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateConnectionAlias

      default CompletableFuture<DisassociateConnectionAliasResponse> disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest)

      Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

      Parameters:
      disassociateConnectionAliasRequest -
      Returns:
      A Java Future containing the result of the DisassociateConnectionAlias 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateConnectionAlias

      default CompletableFuture<DisassociateConnectionAliasResponse> disassociateConnectionAlias(Consumer<DisassociateConnectionAliasRequest.Builder> disassociateConnectionAliasRequest)

      Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .


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

      Parameters:
      disassociateConnectionAliasRequest - A Consumer that will call methods on DisassociateConnectionAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateConnectionAlias 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceNotFoundException The resource could not be found.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateIpGroups

      default CompletableFuture<DisassociateIpGroupsResponse> disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)

      Disassociates the specified IP access control group from the specified directory.

      Parameters:
      disassociateIpGroupsRequest -
      Returns:
      A Java Future containing the result of the DisassociateIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateIpGroups

      default CompletableFuture<DisassociateIpGroupsResponse> disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest)

      Disassociates the specified IP access control group from the specified directory.


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

      Parameters:
      disassociateIpGroupsRequest - A Consumer that will call methods on DisassociateIpGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateIpGroups 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateWorkspaceApplication

      default CompletableFuture<DisassociateWorkspaceApplicationResponse> disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest)

      Disassociates the specified application from a WorkSpace.

      Parameters:
      disassociateWorkspaceApplicationRequest -
      Returns:
      A Java Future containing the result of the DisassociateWorkspaceApplication 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateWorkspaceApplication

      default CompletableFuture<DisassociateWorkspaceApplicationResponse> disassociateWorkspaceApplication(Consumer<DisassociateWorkspaceApplicationRequest.Builder> disassociateWorkspaceApplicationRequest)

      Disassociates the specified application from a WorkSpace.


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

      Parameters:
      disassociateWorkspaceApplicationRequest - A Consumer that will call methods on DisassociateWorkspaceApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateWorkspaceApplication 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceInUseException The specified resource is currently in use.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountLink

      default CompletableFuture<GetAccountLinkResponse> getAccountLink(GetAccountLinkRequest getAccountLinkRequest)

      Retrieves account link information.

      Parameters:
      getAccountLinkRequest -
      Returns:
      A Java Future containing the result of the GetAccountLink 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountLink

      default CompletableFuture<GetAccountLinkResponse> getAccountLink(Consumer<GetAccountLinkRequest.Builder> getAccountLinkRequest)

      Retrieves account link information.


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

      Parameters:
      getAccountLinkRequest - A Consumer that will call methods on GetAccountLinkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccountLink 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importClientBranding

      default CompletableFuture<ImportClientBrandingResponse> importClientBranding(ImportClientBrandingRequest importClientBrandingRequest)

      Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

      • You must specify at least one platform type when importing client branding.

      • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.

      • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.

      • Imported data can take up to a minute to appear in the WorkSpaces client.

      Parameters:
      importClientBrandingRequest -
      Returns:
      A Java Future containing the result of the ImportClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importClientBranding

      default CompletableFuture<ImportClientBrandingResponse> importClientBranding(Consumer<ImportClientBrandingRequest.Builder> importClientBrandingRequest)

      Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

      After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

      • You must specify at least one platform type when importing client branding.

      • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.

      • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.

      • Imported data can take up to a minute to appear in the WorkSpaces client.


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

      Parameters:
      importClientBrandingRequest - A Consumer that will call methods on ImportClientBrandingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportClientBranding 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importWorkspaceImage

      default CompletableFuture<ImportWorkspaceImageResponse> importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)

      Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

      Parameters:
      importWorkspaceImageRequest -
      Returns:
      A Java Future containing the result of the ImportWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importWorkspaceImage

      default CompletableFuture<ImportWorkspaceImageResponse> importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest)

      Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.


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

      Parameters:
      importWorkspaceImageRequest - A Consumer that will call methods on ImportWorkspaceImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportWorkspaceImage 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.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceAlreadyExistsException The specified resource already exists.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountLinks

      default CompletableFuture<ListAccountLinksResponse> listAccountLinks(ListAccountLinksRequest listAccountLinksRequest)

      Lists all account links.

      Parameters:
      listAccountLinksRequest -
      Returns:
      A Java Future containing the result of the ListAccountLinks 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountLinks

      default CompletableFuture<ListAccountLinksResponse> listAccountLinks(Consumer<ListAccountLinksRequest.Builder> listAccountLinksRequest)

      Lists all account links.


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

      Parameters:
      listAccountLinksRequest - A Consumer that will call methods on ListAccountLinksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccountLinks 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountLinksPaginator

      default ListAccountLinksPublisher listAccountLinksPaginator(ListAccountLinksRequest listAccountLinksRequest)

      This is a variant of listAccountLinks(software.amazon.awssdk.services.workspaces.model.ListAccountLinksRequest) 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.workspaces.paginators.ListAccountLinksPublisher publisher = client.listAccountLinksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.ListAccountLinksPublisher publisher = client.listAccountLinksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.ListAccountLinksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.ListAccountLinksResponse 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 listAccountLinks(software.amazon.awssdk.services.workspaces.model.ListAccountLinksRequest) operation.

      Parameters:
      listAccountLinksRequest -
      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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountLinksPaginator

      default ListAccountLinksPublisher listAccountLinksPaginator(Consumer<ListAccountLinksRequest.Builder> listAccountLinksRequest)

      This is a variant of listAccountLinks(software.amazon.awssdk.services.workspaces.model.ListAccountLinksRequest) 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.workspaces.paginators.ListAccountLinksPublisher publisher = client.listAccountLinksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.workspaces.paginators.ListAccountLinksPublisher publisher = client.listAccountLinksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.ListAccountLinksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.workspaces.model.ListAccountLinksResponse 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 listAccountLinks(software.amazon.awssdk.services.workspaces.model.ListAccountLinksRequest) operation.


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

      Parameters:
      listAccountLinksRequest - A Consumer that will call methods on ListAccountLinksRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagementCidrRanges

      default CompletableFuture<ListAvailableManagementCidrRangesResponse> listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)

      Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

      This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

      The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

      Parameters:
      listAvailableManagementCidrRangesRequest -
      Returns:
      A Java Future containing the result of the ListAvailableManagementCidrRanges 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagementCidrRanges

      default CompletableFuture<ListAvailableManagementCidrRangesResponse> listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest)

      Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

      This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

      The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.


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

      Parameters:
      listAvailableManagementCidrRangesRequest - A Consumer that will call methods on ListAvailableManagementCidrRangesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableManagementCidrRanges 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • migrateWorkspace

      default CompletableFuture<MigrateWorkspaceResponse> migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)

      Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

      The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

      For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

      Parameters:
      migrateWorkspaceRequest -
      Returns:
      A Java Future containing the result of the MigrateWorkspace 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • migrateWorkspace

      default CompletableFuture<MigrateWorkspaceResponse> migrateWorkspace(Consumer<MigrateWorkspaceRequest.Builder> migrateWorkspaceRequest)

      Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

      The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

      For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.


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

      Parameters:
      migrateWorkspaceRequest - A Consumer that will call methods on MigrateWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the MigrateWorkspace 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyAccount

      default CompletableFuture<ModifyAccountResponse> modifyAccount(ModifyAccountRequest modifyAccountRequest)

      Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

      Parameters:
      modifyAccountRequest -
      Returns:
      A Java Future containing the result of the ModifyAccount 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • ResourceUnavailableException The specified resource is not available.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyAccount

      default CompletableFuture<ModifyAccountResponse> modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest)

      Modifies the configuration of Bring Your Own License (BYOL) for the specified account.


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

      Parameters:
      modifyAccountRequest - A Consumer that will call methods on ModifyAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyAccount 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • ResourceUnavailableException The specified resource is not available.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyCertificateBasedAuthProperties

      default CompletableFuture<ModifyCertificateBasedAuthPropertiesResponse> modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest)

      Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

      Parameters:
      modifyCertificateBasedAuthPropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifyCertificateBasedAuthProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyCertificateBasedAuthProperties

      default CompletableFuture<ModifyCertificateBasedAuthPropertiesResponse> modifyCertificateBasedAuthProperties(Consumer<ModifyCertificateBasedAuthPropertiesRequest.Builder> modifyCertificateBasedAuthPropertiesRequest)

      Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.


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

      Parameters:
      modifyCertificateBasedAuthPropertiesRequest - A Consumer that will call methods on ModifyCertificateBasedAuthPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyCertificateBasedAuthProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyClientProperties

      default CompletableFuture<ModifyClientPropertiesResponse> modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)

      Modifies the properties of the specified Amazon WorkSpaces clients.

      Parameters:
      modifyClientPropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifyClientProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyClientProperties

      default CompletableFuture<ModifyClientPropertiesResponse> modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest)

      Modifies the properties of the specified Amazon WorkSpaces clients.


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

      Parameters:
      modifyClientPropertiesRequest - A Consumer that will call methods on ModifyClientPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyClientProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifySamlProperties

      default CompletableFuture<ModifySamlPropertiesResponse> modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest)

      Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

      Parameters:
      modifySamlPropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifySamlProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifySamlProperties

      default CompletableFuture<ModifySamlPropertiesResponse> modifySamlProperties(Consumer<ModifySamlPropertiesRequest.Builder> modifySamlPropertiesRequest)

      Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.


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

      Parameters:
      modifySamlPropertiesRequest - A Consumer that will call methods on ModifySamlPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifySamlProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifySelfservicePermissions

      default CompletableFuture<ModifySelfservicePermissionsResponse> modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)

      Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

      Parameters:
      modifySelfservicePermissionsRequest -
      Returns:
      A Java Future containing the result of the ModifySelfservicePermissions 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifySelfservicePermissions

      default CompletableFuture<ModifySelfservicePermissionsResponse> modifySelfservicePermissions(Consumer<ModifySelfservicePermissionsRequest.Builder> modifySelfservicePermissionsRequest)

      Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.


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

      Parameters:
      modifySelfservicePermissionsRequest - A Consumer that will call methods on ModifySelfservicePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifySelfservicePermissions 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceAccessProperties

      default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)

      Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

      Parameters:
      modifyWorkspaceAccessPropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifyWorkspaceAccessProperties 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.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceAccessProperties

      default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> modifyWorkspaceAccessProperties(Consumer<ModifyWorkspaceAccessPropertiesRequest.Builder> modifyWorkspaceAccessPropertiesRequest)

      Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.


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

      Parameters:
      modifyWorkspaceAccessPropertiesRequest - A Consumer that will call methods on ModifyWorkspaceAccessPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyWorkspaceAccessProperties 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.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceCreationProperties

      default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)

      Modify the default properties used to create WorkSpaces.

      Parameters:
      modifyWorkspaceCreationPropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifyWorkspaceCreationProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceCreationProperties

      default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> modifyWorkspaceCreationProperties(Consumer<ModifyWorkspaceCreationPropertiesRequest.Builder> modifyWorkspaceCreationPropertiesRequest)

      Modify the default properties used to create WorkSpaces.


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

      Parameters:
      modifyWorkspaceCreationPropertiesRequest - A Consumer that will call methods on ModifyWorkspaceCreationPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyWorkspaceCreationProperties 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceProperties

      default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)

      Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      Parameters:
      modifyWorkspacePropertiesRequest -
      Returns:
      A Java Future containing the result of the ModifyWorkspaceProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
      • UnsupportedWorkspaceConfigurationException The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceProperties

      default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)

      Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.


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

      Parameters:
      modifyWorkspacePropertiesRequest - A Consumer that will call methods on ModifyWorkspacePropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyWorkspaceProperties 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
      • UnsupportedWorkspaceConfigurationException The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • ResourceUnavailableException The specified resource is not available.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceState

      default CompletableFuture<ModifyWorkspaceStateResponse> modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)

      Sets the state of the specified WorkSpace.

      To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

      Parameters:
      modifyWorkspaceStateRequest -
      Returns:
      A Java Future containing the result of the ModifyWorkspaceState 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyWorkspaceState

      default CompletableFuture<ModifyWorkspaceStateResponse> modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest)

      Sets the state of the specified WorkSpace.

      To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.


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

      Parameters:
      modifyWorkspaceStateRequest - A Consumer that will call methods on ModifyWorkspaceStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyWorkspaceState 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • ResourceNotFoundException The resource could not be found.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootWorkspaces

      default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)

      Reboots the specified WorkSpaces.

      You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

      This operation is asynchronous and returns before the WorkSpaces have rebooted.

      Parameters:
      rebootWorkspacesRequest -
      Returns:
      A Java Future containing the result of the RebootWorkspaces 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.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootWorkspaces

      default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest)

      Reboots the specified WorkSpaces.

      You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

      This operation is asynchronous and returns before the WorkSpaces have rebooted.


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

      Parameters:
      rebootWorkspacesRequest - A Consumer that will call methods on RebootWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebootWorkspaces 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.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebuildWorkspaces

      default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)

      Rebuilds the specified WorkSpace.

      You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

      Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

      This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

      Parameters:
      rebuildWorkspacesRequest -
      Returns:
      A Java Future containing the result of the RebuildWorkspaces 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.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebuildWorkspaces

      default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest)

      Rebuilds the specified WorkSpace.

      You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

      Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

      This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.


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

      Parameters:
      rebuildWorkspacesRequest - A Consumer that will call methods on RebuildWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebuildWorkspaces 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.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerWorkspaceDirectory

      default CompletableFuture<RegisterWorkspaceDirectoryResponse> registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)

      Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

      Parameters:
      registerWorkspaceDirectoryRequest -
      Returns:
      A Java Future containing the result of the RegisterWorkspaceDirectory 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • AccessDeniedException The user is not authorized to access a resource.
      • WorkspacesDefaultRoleNotFoundException The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • UnsupportedNetworkConfigurationException The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerWorkspaceDirectory

      default CompletableFuture<RegisterWorkspaceDirectoryResponse> registerWorkspaceDirectory(Consumer<RegisterWorkspaceDirectoryRequest.Builder> registerWorkspaceDirectoryRequest)

      Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.


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

      Parameters:
      registerWorkspaceDirectoryRequest - A Consumer that will call methods on RegisterWorkspaceDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterWorkspaceDirectory 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • AccessDeniedException The user is not authorized to access a resource.
      • WorkspacesDefaultRoleNotFoundException The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • UnsupportedNetworkConfigurationException The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rejectAccountLinkInvitation

      default CompletableFuture<RejectAccountLinkInvitationResponse> rejectAccountLinkInvitation(RejectAccountLinkInvitationRequest rejectAccountLinkInvitationRequest)

      Rejects the account link invitation.

      Parameters:
      rejectAccountLinkInvitationRequest -
      Returns:
      A Java Future containing the result of the RejectAccountLinkInvitation 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rejectAccountLinkInvitation

      default CompletableFuture<RejectAccountLinkInvitationResponse> rejectAccountLinkInvitation(Consumer<RejectAccountLinkInvitationRequest.Builder> rejectAccountLinkInvitationRequest)

      Rejects the account link invitation.


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

      Parameters:
      rejectAccountLinkInvitationRequest - A Consumer that will call methods on RejectAccountLinkInvitationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RejectAccountLinkInvitation 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
      • ResourceNotFoundException The resource could not be found.
      • ConflictException The TargetAccountId is already linked or invited.
      • InternalServerException Unexpected server error occured.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreWorkspace

      default CompletableFuture<RestoreWorkspaceResponse> restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)

      Restores the specified WorkSpace to its last known healthy state.

      You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

      Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

      This operation is asynchronous and returns before the WorkSpace is completely restored.

      Parameters:
      restoreWorkspaceRequest -
      Returns:
      A Java Future containing the result of the RestoreWorkspace 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreWorkspace

      default CompletableFuture<RestoreWorkspaceResponse> restoreWorkspace(Consumer<RestoreWorkspaceRequest.Builder> restoreWorkspaceRequest)

      Restores the specified WorkSpace to its last known healthy state.

      You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

      Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

      This operation is asynchronous and returns before the WorkSpace is completely restored.


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

      Parameters:
      restoreWorkspaceRequest - A Consumer that will call methods on RestoreWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestoreWorkspace 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a resource.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • revokeIpRules

      default CompletableFuture<RevokeIpRulesResponse> revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)

      Removes one or more rules from the specified IP access control group.

      Parameters:
      revokeIpRulesRequest -
      Returns:
      A Java Future containing the result of the RevokeIpRules 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • revokeIpRules

      default CompletableFuture<RevokeIpRulesResponse> revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest)

      Removes one or more rules from the specified IP access control group.


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

      Parameters:
      revokeIpRulesRequest - A Consumer that will call methods on RevokeIpRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RevokeIpRules 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startWorkspaces

      default CompletableFuture<StartWorkspacesResponse> startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)

      Starts the specified WorkSpaces.

      You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.

      Parameters:
      startWorkspacesRequest -
      Returns:
      A Java Future containing the result of the StartWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startWorkspaces

      default CompletableFuture<StartWorkspacesResponse> startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)

      Starts the specified WorkSpaces.

      You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.


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

      Parameters:
      startWorkspacesRequest - A Consumer that will call methods on StartWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopWorkspaces

      default CompletableFuture<StopWorkspacesResponse> stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)

      Stops the specified WorkSpaces.

      You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

      Parameters:
      stopWorkspacesRequest -
      Returns:
      A Java Future containing the result of the StopWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopWorkspaces

      default CompletableFuture<StopWorkspacesResponse> stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest)

      Stops the specified WorkSpaces.

      You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.


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

      Parameters:
      stopWorkspacesRequest - A Consumer that will call methods on StopWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateWorkspaces

      default CompletableFuture<TerminateWorkspacesResponse> terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)

      Terminates the specified WorkSpaces.

      Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.

      You can terminate a WorkSpace that is in any state except SUSPENDED.

      This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

      To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

      Parameters:
      terminateWorkspacesRequest -
      Returns:
      A Java Future containing the result of the TerminateWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateWorkspaces

      default CompletableFuture<TerminateWorkspacesResponse> terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest)

      Terminates the specified WorkSpaces.

      Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.

      You can terminate a WorkSpace that is in any state except SUSPENDED.

      This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

      To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.


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

      Parameters:
      terminateWorkspacesRequest - A Consumer that will call methods on TerminateWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TerminateWorkspaces 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.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectClientAddIn

      default CompletableFuture<UpdateConnectClientAddInResponse> updateConnectClientAddIn(UpdateConnectClientAddInRequest updateConnectClientAddInRequest)

      Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

      Parameters:
      updateConnectClientAddInRequest -
      Returns:
      A Java Future containing the result of the UpdateConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectClientAddIn

      default CompletableFuture<UpdateConnectClientAddInResponse> updateConnectClientAddIn(Consumer<UpdateConnectClientAddInRequest.Builder> updateConnectClientAddInRequest)

      Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.


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

      Parameters:
      updateConnectClientAddInRequest - A Consumer that will call methods on UpdateConnectClientAddInRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnectClientAddIn 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectionAliasPermission

      default CompletableFuture<UpdateConnectionAliasPermissionResponse> updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest)

      Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      • Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

      • To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

      Parameters:
      updateConnectionAliasPermissionRequest -
      Returns:
      A Java Future containing the result of the UpdateConnectionAliasPermission 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectionAliasPermission

      default CompletableFuture<UpdateConnectionAliasPermissionResponse> updateConnectionAliasPermission(Consumer<UpdateConnectionAliasPermissionRequest.Builder> updateConnectionAliasPermissionRequest)

      Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

      • Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

      • To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.


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

      Parameters:
      updateConnectionAliasPermissionRequest - A Consumer that will call methods on UpdateConnectionAliasPermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnectionAliasPermission 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • ResourceNotFoundException The resource could not be found.
      • ResourceAssociatedException The resource is associated with a directory.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRulesOfIpGroup

      default CompletableFuture<UpdateRulesOfIpGroupResponse> updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)

      Replaces the current rules of the specified IP access control group with the specified rules.

      Parameters:
      updateRulesOfIpGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateRulesOfIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRulesOfIpGroup

      default CompletableFuture<UpdateRulesOfIpGroupResponse> updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest)

      Replaces the current rules of the specified IP access control group with the specified rules.


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

      Parameters:
      updateRulesOfIpGroupRequest - A Consumer that will call methods on UpdateRulesOfIpGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRulesOfIpGroup 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.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceLimitExceededException Your resource limits have been exceeded.
      • InvalidResourceStateException The state of the resource is not valid for this operation.
      • AccessDeniedException The user is not authorized to access a 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkspaceBundle

      default CompletableFuture<UpdateWorkspaceBundleResponse> updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)

      Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

      Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

      Parameters:
      updateWorkspaceBundleRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkspaceBundle 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkspaceBundle

      default CompletableFuture<UpdateWorkspaceBundleResponse> updateWorkspaceBundle(Consumer<UpdateWorkspaceBundleRequest.Builder> updateWorkspaceBundleRequest)

      Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

      Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.


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

      Parameters:
      updateWorkspaceBundleRequest - A Consumer that will call methods on UpdateWorkspaceBundleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkspaceBundle 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.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkspaceImagePermission

      default CompletableFuture<UpdateWorkspaceImagePermissionResponse> updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest)

      Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

      After an image has been shared, the recipient account can copy the image to other Regions as needed.

      In the China (Ningxia) Region, you can copy images only within the same Region.

      In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

      For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

      • To delete an image that has been shared, you must unshare the image before you delete it.

      • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

      Parameters:
      updateWorkspaceImagePermissionRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkspaceImagePermission 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.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkspaceImagePermission

      default CompletableFuture<UpdateWorkspaceImagePermissionResponse> updateWorkspaceImagePermission(Consumer<UpdateWorkspaceImagePermissionRequest.Builder> updateWorkspaceImagePermissionRequest)

      Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

      After an image has been shared, the recipient account can copy the image to other Regions as needed.

      In the China (Ningxia) Region, you can copy images only within the same Region.

      In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

      For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

      • To delete an image that has been shared, you must unshare the image before you delete it.

      • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.


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

      Parameters:
      updateWorkspaceImagePermissionRequest - A Consumer that will call methods on UpdateWorkspaceImagePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkspaceImagePermission 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.
      • ResourceNotFoundException The resource could not be found.
      • ResourceUnavailableException The specified resource is not available.
      • AccessDeniedException The user is not authorized to access a resource.
      • InvalidParameterValuesException One or more parameter values are not valid.
      • OperationNotSupportedException This operation is not supported.
      • 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.
      • WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default WorkSpacesServiceClientConfiguration 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 WorkSpacesAsyncClient create()
      Create a WorkSpacesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static WorkSpacesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a WorkSpacesAsyncClient.