com.amazonaws.services.workspaces.AmazonWorkspacesAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workspaces Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.workspaces;
import javax.annotation.Generated;
import com.amazonaws.services.workspaces.model.*;
/**
* Interface for accessing Amazon WorkSpaces asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.workspaces.AbstractAmazonWorkspacesAsync} instead.
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkspacesAsync extends AmazonWorkspaces {
/**
*
* Accepts the account link invitation.
*
*
*
* There's currently no unlinking capability after you accept the account linking invitation.
*
*
*
* @param acceptAccountLinkInvitationRequest
* @return A Java Future containing the result of the AcceptAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsync.AcceptAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future acceptAccountLinkInvitationAsync(
AcceptAccountLinkInvitationRequest acceptAccountLinkInvitationRequest);
/**
*
* Accepts the account link invitation.
*
*
*
* There's currently no unlinking capability after you accept the account linking invitation.
*
*
*
* @param acceptAccountLinkInvitationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AcceptAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.AcceptAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future acceptAccountLinkInvitationAsync(
AcceptAccountLinkInvitationRequest acceptAccountLinkInvitationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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
* .
*
*
*
* @param associateConnectionAliasRequest
* @return A Java Future containing the result of the AssociateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsync.AssociateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future associateConnectionAliasAsync(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
* .
*
*
*
* @param associateConnectionAliasRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AssociateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.AssociateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future associateConnectionAliasAsync(AssociateConnectionAliasRequest associateConnectionAliasRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Associates the specified IP access control group with the specified directory.
*
*
* @param associateIpGroupsRequest
* @return A Java Future containing the result of the AssociateIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsync.AssociateIpGroups
* @see AWS
* API Documentation
*/
java.util.concurrent.Future associateIpGroupsAsync(AssociateIpGroupsRequest associateIpGroupsRequest);
/**
*
* Associates the specified IP access control group with the specified directory.
*
*
* @param associateIpGroupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AssociateIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.AssociateIpGroups
* @see AWS
* API Documentation
*/
java.util.concurrent.Future associateIpGroupsAsync(AssociateIpGroupsRequest associateIpGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Associates the specified application to the specified WorkSpace.
*
*
* @param associateWorkspaceApplicationRequest
* @return A Java Future containing the result of the AssociateWorkspaceApplication operation returned by the
* service.
* @sample AmazonWorkspacesAsync.AssociateWorkspaceApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future associateWorkspaceApplicationAsync(
AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest);
/**
*
* Associates the specified application to the specified WorkSpace.
*
*
* @param associateWorkspaceApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AssociateWorkspaceApplication operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.AssociateWorkspaceApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future associateWorkspaceApplicationAsync(
AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param authorizeIpRulesRequest
* @return A Java Future containing the result of the AuthorizeIpRules operation returned by the service.
* @sample AmazonWorkspacesAsync.AuthorizeIpRules
* @see AWS
* API Documentation
*/
java.util.concurrent.Future authorizeIpRulesAsync(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.
*
*
* @param authorizeIpRulesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AuthorizeIpRules operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.AuthorizeIpRules
* @see AWS
* API Documentation
*/
java.util.concurrent.Future authorizeIpRulesAsync(AuthorizeIpRulesRequest authorizeIpRulesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param copyWorkspaceImageRequest
* @return A Java Future containing the result of the CopyWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsync.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
java.util.concurrent.Future copyWorkspaceImageAsync(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.
*
*
*
* @param copyWorkspaceImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CopyWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
java.util.concurrent.Future copyWorkspaceImageAsync(CopyWorkspaceImageRequest copyWorkspaceImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates the account link invitation.
*
*
* @param createAccountLinkInvitationRequest
* @return A Java Future containing the result of the CreateAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future createAccountLinkInvitationAsync(
CreateAccountLinkInvitationRequest createAccountLinkInvitationRequest);
/**
*
* Creates the account link invitation.
*
*
* @param createAccountLinkInvitationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future createAccountLinkInvitationAsync(
CreateAccountLinkInvitationRequest createAccountLinkInvitationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createConnectClientAddInRequest
* @return A Java Future containing the result of the CreateConnectClientAddIn operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateConnectClientAddIn
* @see AWS API Documentation
*/
java.util.concurrent.Future createConnectClientAddInAsync(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.
*
*
* @param createConnectClientAddInRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateConnectClientAddIn operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateConnectClientAddIn
* @see AWS API Documentation
*/
java.util.concurrent.Future createConnectClientAddInAsync(CreateConnectClientAddInRequest createConnectClientAddInRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
* @param createConnectionAliasRequest
* @return A Java Future containing the result of the CreateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future createConnectionAliasAsync(CreateConnectionAliasRequest createConnectionAliasRequest);
/**
*
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
* @param createConnectionAliasRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future createConnectionAliasAsync(CreateConnectionAliasRequest createConnectionAliasRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createIpGroupRequest
* @return A Java Future containing the result of the CreateIpGroup operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateIpGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createIpGroupAsync(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.
*
*
* @param createIpGroupRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateIpGroup operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateIpGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createIpGroupAsync(CreateIpGroupRequest createIpGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a standby WorkSpace in a secondary Region.
*
*
* @param createStandbyWorkspacesRequest
* @return A Java Future containing the result of the CreateStandbyWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateStandbyWorkspaces
* @see AWS API Documentation
*/
java.util.concurrent.Future createStandbyWorkspacesAsync(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest);
/**
*
* Creates a standby WorkSpace in a secondary Region.
*
*
* @param createStandbyWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateStandbyWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateStandbyWorkspaces
* @see AWS API Documentation
*/
java.util.concurrent.Future createStandbyWorkspacesAsync(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates the specified tags for the specified WorkSpaces resource.
*
*
* @param createTagsRequest
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTagsAsync(CreateTagsRequest createTagsRequest);
/**
*
* Creates the specified tags for the specified WorkSpaces resource.
*
*
* @param createTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTagsAsync(CreateTagsRequest createTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
*
* @param createUpdatedWorkspaceImageRequest
* @return A Java Future containing the result of the CreateUpdatedWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future createUpdatedWorkspaceImageAsync(
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.
*
*
*
*
*
* @param createUpdatedWorkspaceImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateUpdatedWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future createUpdatedWorkspaceImageAsync(
CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom
* WorkSpaces Image and Bundle.
*
*
* @param createWorkspaceBundleRequest
* @return A Java Future containing the result of the CreateWorkspaceBundle operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateWorkspaceBundle
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspaceBundleAsync(CreateWorkspaceBundleRequest createWorkspaceBundleRequest);
/**
*
* Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom
* WorkSpaces Image and Bundle.
*
*
* @param createWorkspaceBundleRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWorkspaceBundle operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateWorkspaceBundle
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspaceBundleAsync(CreateWorkspaceBundleRequest createWorkspaceBundleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new WorkSpace image from an existing WorkSpace.
*
*
* @param createWorkspaceImageRequest
* @return A Java Future containing the result of the CreateWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspaceImageAsync(CreateWorkspaceImageRequest createWorkspaceImageRequest);
/**
*
* Creates a new WorkSpace image from an existing WorkSpace.
*
*
* @param createWorkspaceImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspaceImageAsync(CreateWorkspaceImageRequest createWorkspaceImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* -
*
* Review your running mode to ensure you are using one that is optimal for your needs and budget. For more
* information on switching running modes, see Can I switch between hourly and monthly billing?
*
*
*
*
*
* @param createWorkspacesRequest
* @return A Java Future containing the result of the CreateWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createWorkspacesAsync(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.
*
*
* -
*
* Review your running mode to ensure you are using one that is optimal for your needs and budget. For more
* information on switching running modes, see Can I switch between hourly and monthly billing?
*
*
*
*
*
* @param createWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a pool of WorkSpaces.
*
*
* @param createWorkspacesPoolRequest
* @return A Java Future containing the result of the CreateWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsync.CreateWorkspacesPool
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspacesPoolAsync(CreateWorkspacesPoolRequest createWorkspacesPoolRequest);
/**
*
* Creates a pool of WorkSpaces.
*
*
* @param createWorkspacesPoolRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.CreateWorkspacesPool
* @see AWS API Documentation
*/
java.util.concurrent.Future createWorkspacesPoolAsync(CreateWorkspacesPoolRequest createWorkspacesPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the account link invitation.
*
*
* @param deleteAccountLinkInvitationRequest
* @return A Java Future containing the result of the DeleteAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteAccountLinkInvitationAsync(
DeleteAccountLinkInvitationRequest deleteAccountLinkInvitationRequest);
/**
*
* Deletes the account link invitation.
*
*
* @param deleteAccountLinkInvitationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteAccountLinkInvitationAsync(
DeleteAccountLinkInvitationRequest deleteAccountLinkInvitationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteClientBrandingRequest
* @return A Java Future containing the result of the DeleteClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteClientBrandingAsync(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.
*
*
* @param deleteClientBrandingRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteClientBrandingAsync(DeleteClientBrandingRequest deleteClientBrandingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
*
*
* @param deleteConnectClientAddInRequest
* @return A Java Future containing the result of the DeleteConnectClientAddIn operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteConnectClientAddInAsync(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest);
/**
*
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
*
*
* @param deleteConnectClientAddInRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteConnectClientAddIn operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteConnectClientAddInAsync(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param deleteConnectionAliasRequest
* @return A Java Future containing the result of the DeleteConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteConnectionAliasAsync(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.
*
*
*
* @param deleteConnectionAliasRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteConnectionAliasAsync(DeleteConnectionAliasRequest deleteConnectionAliasRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified IP access control group.
*
*
* You cannot delete an IP access control group that is associated with a directory.
*
*
* @param deleteIpGroupRequest
* @return A Java Future containing the result of the DeleteIpGroup operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteIpGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteIpGroupAsync(DeleteIpGroupRequest deleteIpGroupRequest);
/**
*
* Deletes the specified IP access control group.
*
*
* You cannot delete an IP access control group that is associated with a directory.
*
*
* @param deleteIpGroupRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteIpGroup operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteIpGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteIpGroupAsync(DeleteIpGroupRequest deleteIpGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified tags from the specified WorkSpaces resource.
*
*
* @param deleteTagsRequest
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteTagsAsync(DeleteTagsRequest deleteTagsRequest);
/**
*
* Deletes the specified tags from the specified WorkSpaces resource.
*
*
* @param deleteTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteTagsAsync(DeleteTagsRequest deleteTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces
* Bundle or Image.
*
*
* @param deleteWorkspaceBundleRequest
* @return A Java Future containing the result of the DeleteWorkspaceBundle operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteWorkspaceBundleAsync(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest);
/**
*
* Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces
* Bundle or Image.
*
*
* @param deleteWorkspaceBundleRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteWorkspaceBundle operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteWorkspaceBundleAsync(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteWorkspaceImageRequest
* @return A Java Future containing the result of the DeleteWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsync.DeleteWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteWorkspaceImageAsync(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.
*
*
* @param deleteWorkspaceImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeleteWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteWorkspaceImageAsync(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deploys associated applications to the specified WorkSpace
*
*
* @param deployWorkspaceApplicationsRequest
* @return A Java Future containing the result of the DeployWorkspaceApplications operation returned by the service.
* @sample AmazonWorkspacesAsync.DeployWorkspaceApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future deployWorkspaceApplicationsAsync(
DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest);
/**
*
* Deploys associated applications to the specified WorkSpace
*
*
* @param deployWorkspaceApplicationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeployWorkspaceApplications operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DeployWorkspaceApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future deployWorkspaceApplicationsAsync(
DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param deregisterWorkspaceDirectoryRequest
* @return A Java Future containing the result of the DeregisterWorkspaceDirectory operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
java.util.concurrent.Future deregisterWorkspaceDirectoryAsync(
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.
*
*
*
* @param deregisterWorkspaceDirectoryRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeregisterWorkspaceDirectory operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
java.util.concurrent.Future deregisterWorkspaceDirectoryAsync(
DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param describeAccountRequest
* @return A Java Future containing the result of the DescribeAccount operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeAccount
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAccountAsync(DescribeAccountRequest describeAccountRequest);
/**
*
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param describeAccountRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeAccount operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeAccount
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAccountAsync(DescribeAccountRequest describeAccountRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
* specified account.
*
*
* @param describeAccountModificationsRequest
* @return A Java Future containing the result of the DescribeAccountModifications operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeAccountModifications
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountModificationsAsync(
DescribeAccountModificationsRequest describeAccountModificationsRequest);
/**
*
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
* specified account.
*
*
* @param describeAccountModificationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeAccountModifications operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeAccountModifications
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountModificationsAsync(
DescribeAccountModificationsRequest describeAccountModificationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the associations between the application and the specified associated resources.
*
*
* @param describeApplicationAssociationsRequest
* @return A Java Future containing the result of the DescribeApplicationAssociations operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeApplicationAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeApplicationAssociationsAsync(
DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest);
/**
*
* Describes the associations between the application and the specified associated resources.
*
*
* @param describeApplicationAssociationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeApplicationAssociations operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeApplicationAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeApplicationAssociationsAsync(
DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the specified applications by filtering based on their compute types, license availability, operating
* systems, and owners.
*
*
* @param describeApplicationsRequest
* @return A Java Future containing the result of the DescribeApplications operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future describeApplicationsAsync(DescribeApplicationsRequest describeApplicationsRequest);
/**
*
* Describes the specified applications by filtering based on their compute types, license availability, operating
* systems, and owners.
*
*
* @param describeApplicationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeApplications operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future describeApplicationsAsync(DescribeApplicationsRequest describeApplicationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the associations between the applications and the specified bundle.
*
*
* @param describeBundleAssociationsRequest
* @return A Java Future containing the result of the DescribeBundleAssociations operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeBundleAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeBundleAssociationsAsync(
DescribeBundleAssociationsRequest describeBundleAssociationsRequest);
/**
*
* Describes the associations between the applications and the specified bundle.
*
*
* @param describeBundleAssociationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeBundleAssociations operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeBundleAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeBundleAssociationsAsync(
DescribeBundleAssociationsRequest describeBundleAssociationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param describeClientBrandingRequest
* @return A Java Future containing the result of the DescribeClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future describeClientBrandingAsync(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.
*
*
*
* @param describeClientBrandingRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future describeClientBrandingAsync(DescribeClientBrandingRequest describeClientBrandingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*
*
* @param describeClientPropertiesRequest
* @return A Java Future containing the result of the DescribeClientProperties operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeClientProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future describeClientPropertiesAsync(DescribeClientPropertiesRequest describeClientPropertiesRequest);
/**
*
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*
*
* @param describeClientPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeClientProperties operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeClientProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future describeClientPropertiesAsync(DescribeClientPropertiesRequest describeClientPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of Amazon Connect client add-ins that have been created.
*
*
* @param describeConnectClientAddInsRequest
* @return A Java Future containing the result of the DescribeConnectClientAddIns operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectClientAddInsAsync(
DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest);
/**
*
* Retrieves a list of Amazon Connect client add-ins that have been created.
*
*
* @param describeConnectClientAddInsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectClientAddIns operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectClientAddInsAsync(
DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeConnectionAliasPermissionsRequest
* @return A Java Future containing the result of the DescribeConnectionAliasPermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectionAliasPermissionsAsync(
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.
*
*
* @param describeConnectionAliasPermissionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectionAliasPermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectionAliasPermissionsAsync(
DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information,
* see
* Cross-Region Redirection for Amazon WorkSpaces.
*
*
* @param describeConnectionAliasesRequest
* @return A Java Future containing the result of the DescribeConnectionAliases operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeConnectionAliases
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectionAliasesAsync(
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.
*
*
* @param describeConnectionAliasesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectionAliases operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeConnectionAliases
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectionAliasesAsync(
DescribeConnectionAliasesRequest describeConnectionAliasesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the associations between the applications and the specified image.
*
*
* @param describeImageAssociationsRequest
* @return A Java Future containing the result of the DescribeImageAssociations operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeImageAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeImageAssociationsAsync(
DescribeImageAssociationsRequest describeImageAssociationsRequest);
/**
*
* Describes the associations between the applications and the specified image.
*
*
* @param describeImageAssociationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeImageAssociations operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeImageAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeImageAssociationsAsync(
DescribeImageAssociationsRequest describeImageAssociationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes one or more of your IP access control groups.
*
*
* @param describeIpGroupsRequest
* @return A Java Future containing the result of the DescribeIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeIpGroups
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeIpGroupsAsync(DescribeIpGroupsRequest describeIpGroupsRequest);
/**
*
* Describes one or more of your IP access control groups.
*
*
* @param describeIpGroupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeIpGroups
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeIpGroupsAsync(DescribeIpGroupsRequest describeIpGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the specified tags for the specified WorkSpaces resource.
*
*
* @param describeTagsRequest
* @return A Java Future containing the result of the DescribeTags operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeTagsAsync(DescribeTagsRequest describeTagsRequest);
/**
*
* Describes the specified tags for the specified WorkSpaces resource.
*
*
* @param describeTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeTags operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeTagsAsync(DescribeTagsRequest describeTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the associations betweens applications and the specified WorkSpace.
*
*
* @param describeWorkspaceAssociationsRequest
* @return A Java Future containing the result of the DescribeWorkspaceAssociations operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceAssociationsAsync(
DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest);
/**
*
* Describes the associations betweens applications and the specified WorkSpace.
*
*
* @param describeWorkspaceAssociationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceAssociations operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceAssociations
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceAssociationsAsync(
DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
* @param describeWorkspaceBundlesRequest
* @return A Java Future containing the result of the DescribeWorkspaceBundles operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceBundlesAsync(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.
*
*
* @param describeWorkspaceBundlesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceBundles operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeWorkspaceBundles operation.
*
* @see #describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest)
*/
java.util.concurrent.Future describeWorkspaceBundlesAsync();
/**
* Simplified method form for invoking the DescribeWorkspaceBundles operation with an AsyncHandler.
*
* @see #describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeWorkspaceBundlesAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @param describeWorkspaceDirectoriesRequest
* @return A Java Future containing the result of the DescribeWorkspaceDirectories operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceDirectoriesAsync(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest);
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @param describeWorkspaceDirectoriesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceDirectories operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceDirectoriesAsync(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeWorkspaceDirectories operation.
*
* @see #describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest)
*/
java.util.concurrent.Future describeWorkspaceDirectoriesAsync();
/**
* Simplified method form for invoking the DescribeWorkspaceDirectories operation with an AsyncHandler.
*
* @see #describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeWorkspaceDirectoriesAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
* image.
*
*
* @param describeWorkspaceImagePermissionsRequest
* @return A Java Future containing the result of the DescribeWorkspaceImagePermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceImagePermissionsAsync(
DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest);
/**
*
* Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
* image.
*
*
* @param describeWorkspaceImagePermissionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceImagePermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceImagePermissionsAsync(
DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise,
* all images in the account are described.
*
*
* @param describeWorkspaceImagesRequest
* @return A Java Future containing the result of the DescribeWorkspaceImages operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceImages
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceImagesAsync(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.
*
*
* @param describeWorkspaceImagesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceImages operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceImages
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceImagesAsync(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
* @param describeWorkspaceSnapshotsRequest
* @return A Java Future containing the result of the DescribeWorkspaceSnapshots operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceSnapshotsAsync(
DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest);
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
* @param describeWorkspaceSnapshotsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaceSnapshots operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspaceSnapshotsAsync(
DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeWorkspacesRequest
* @return A Java Future containing the result of the DescribeWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeWorkspacesAsync(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.
*
*
* @param describeWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeWorkspaces operation.
*
* @see #describeWorkspacesAsync(DescribeWorkspacesRequest)
*/
java.util.concurrent.Future describeWorkspacesAsync();
/**
* Simplified method form for invoking the DescribeWorkspaces operation with an AsyncHandler.
*
* @see #describeWorkspacesAsync(DescribeWorkspacesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeWorkspacesAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @param describeWorkspacesConnectionStatusRequest
* @return A Java Future containing the result of the DescribeWorkspacesConnectionStatus operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesConnectionStatusAsync(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest);
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @param describeWorkspacesConnectionStatusRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspacesConnectionStatus operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesConnectionStatusAsync(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list that describes the streaming sessions for a specified pool.
*
*
* @param describeWorkspacesPoolSessionsRequest
* @return A Java Future containing the result of the DescribeWorkspacesPoolSessions operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DescribeWorkspacesPoolSessions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesPoolSessionsAsync(
DescribeWorkspacesPoolSessionsRequest describeWorkspacesPoolSessionsRequest);
/**
*
* Retrieves a list that describes the streaming sessions for a specified pool.
*
*
* @param describeWorkspacesPoolSessionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspacesPoolSessions operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspacesPoolSessions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesPoolSessionsAsync(
DescribeWorkspacesPoolSessionsRequest describeWorkspacesPoolSessionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the specified WorkSpaces Pools.
*
*
* @param describeWorkspacesPoolsRequest
* @return A Java Future containing the result of the DescribeWorkspacesPools operation returned by the service.
* @sample AmazonWorkspacesAsync.DescribeWorkspacesPools
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesPoolsAsync(DescribeWorkspacesPoolsRequest describeWorkspacesPoolsRequest);
/**
*
* Describes the specified WorkSpaces Pools.
*
*
* @param describeWorkspacesPoolsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeWorkspacesPools operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DescribeWorkspacesPools
* @see AWS API Documentation
*/
java.util.concurrent.Future describeWorkspacesPoolsAsync(DescribeWorkspacesPoolsRequest describeWorkspacesPoolsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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
* .
*
*
*
* @param disassociateConnectionAliasRequest
* @return A Java Future containing the result of the DisassociateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsync.DisassociateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateConnectionAliasAsync(
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
* .
*
*
*
* @param disassociateConnectionAliasRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DisassociateConnectionAlias operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DisassociateConnectionAlias
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateConnectionAliasAsync(
DisassociateConnectionAliasRequest disassociateConnectionAliasRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disassociates the specified IP access control group from the specified directory.
*
*
* @param disassociateIpGroupsRequest
* @return A Java Future containing the result of the DisassociateIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsync.DisassociateIpGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateIpGroupsAsync(DisassociateIpGroupsRequest disassociateIpGroupsRequest);
/**
*
* Disassociates the specified IP access control group from the specified directory.
*
*
* @param disassociateIpGroupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DisassociateIpGroups operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.DisassociateIpGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateIpGroupsAsync(DisassociateIpGroupsRequest disassociateIpGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disassociates the specified application from a WorkSpace.
*
*
* @param disassociateWorkspaceApplicationRequest
* @return A Java Future containing the result of the DisassociateWorkspaceApplication operation returned by the
* service.
* @sample AmazonWorkspacesAsync.DisassociateWorkspaceApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateWorkspaceApplicationAsync(
DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest);
/**
*
* Disassociates the specified application from a WorkSpace.
*
*
* @param disassociateWorkspaceApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DisassociateWorkspaceApplication operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.DisassociateWorkspaceApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateWorkspaceApplicationAsync(
DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves account link information.
*
*
* @param getAccountLinkRequest
* @return A Java Future containing the result of the GetAccountLink operation returned by the service.
* @sample AmazonWorkspacesAsync.GetAccountLink
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getAccountLinkAsync(GetAccountLinkRequest getAccountLinkRequest);
/**
*
* Retrieves account link information.
*
*
* @param getAccountLinkRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetAccountLink operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.GetAccountLink
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getAccountLinkAsync(GetAccountLinkRequest getAccountLinkRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
*
* @param importClientBrandingRequest
* @return A Java Future containing the result of the ImportClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsync.ImportClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future importClientBrandingAsync(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.
*
*
*
*
*
* @param importClientBrandingRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ImportClientBranding operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ImportClientBranding
* @see AWS API Documentation
*/
java.util.concurrent.Future importClientBrandingAsync(ImportClientBrandingRequest importClientBrandingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param importWorkspaceImageRequest
* @return A Java Future containing the result of the ImportWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsync.ImportWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future importWorkspaceImageAsync(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.
*
*
* @param importWorkspaceImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ImportWorkspaceImage operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ImportWorkspaceImage
* @see AWS API Documentation
*/
java.util.concurrent.Future importWorkspaceImageAsync(ImportWorkspaceImageRequest importWorkspaceImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all account links.
*
*
* @param listAccountLinksRequest
* @return A Java Future containing the result of the ListAccountLinks operation returned by the service.
* @sample AmazonWorkspacesAsync.ListAccountLinks
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listAccountLinksAsync(ListAccountLinksRequest listAccountLinksRequest);
/**
*
* Lists all account links.
*
*
* @param listAccountLinksRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListAccountLinks operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ListAccountLinks
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listAccountLinksAsync(ListAccountLinksRequest listAccountLinksRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listAvailableManagementCidrRangesRequest
* @return A Java Future containing the result of the ListAvailableManagementCidrRanges operation returned by the
* service.
* @sample AmazonWorkspacesAsync.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
java.util.concurrent.Future listAvailableManagementCidrRangesAsync(
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.
*
*
* @param listAvailableManagementCidrRangesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListAvailableManagementCidrRanges operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
java.util.concurrent.Future listAvailableManagementCidrRangesAsync(
ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param migrateWorkspaceRequest
* @return A Java Future containing the result of the MigrateWorkspace operation returned by the service.
* @sample AmazonWorkspacesAsync.MigrateWorkspace
* @see AWS
* API Documentation
*/
java.util.concurrent.Future migrateWorkspaceAsync(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.
*
*
* @param migrateWorkspaceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the MigrateWorkspace operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.MigrateWorkspace
* @see AWS
* API Documentation
*/
java.util.concurrent.Future migrateWorkspaceAsync(MigrateWorkspaceRequest migrateWorkspaceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param modifyAccountRequest
* @return A Java Future containing the result of the ModifyAccount operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifyAccount
* @see AWS API
* Documentation
*/
java.util.concurrent.Future modifyAccountAsync(ModifyAccountRequest modifyAccountRequest);
/**
*
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param modifyAccountRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyAccount operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifyAccount
* @see AWS API
* Documentation
*/
java.util.concurrent.Future modifyAccountAsync(ModifyAccountRequest modifyAccountRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
*
*
* @param modifyCertificateBasedAuthPropertiesRequest
* @return A Java Future containing the result of the ModifyCertificateBasedAuthProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsync.ModifyCertificateBasedAuthProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyCertificateBasedAuthPropertiesAsync(
ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest);
/**
*
* Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
*
*
* @param modifyCertificateBasedAuthPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyCertificateBasedAuthProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.ModifyCertificateBasedAuthProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyCertificateBasedAuthPropertiesAsync(
ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modifies the properties of the specified Amazon WorkSpaces clients.
*
*
* @param modifyClientPropertiesRequest
* @return A Java Future containing the result of the ModifyClientProperties operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifyClientProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyClientPropertiesAsync(ModifyClientPropertiesRequest modifyClientPropertiesRequest);
/**
*
* Modifies the properties of the specified Amazon WorkSpaces clients.
*
*
* @param modifyClientPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyClientProperties operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifyClientProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyClientPropertiesAsync(ModifyClientPropertiesRequest modifyClientPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param modifySamlPropertiesRequest
* @return A Java Future containing the result of the ModifySamlProperties operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifySamlProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifySamlPropertiesAsync(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.
*
*
* @param modifySamlPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifySamlProperties operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifySamlProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifySamlPropertiesAsync(ModifySamlPropertiesRequest modifySamlPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
*
*
* @param modifySelfservicePermissionsRequest
* @return A Java Future containing the result of the ModifySelfservicePermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsync.ModifySelfservicePermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future modifySelfservicePermissionsAsync(
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.
*
*
* @param modifySelfservicePermissionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifySelfservicePermissions operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.ModifySelfservicePermissions
* @see AWS API Documentation
*/
java.util.concurrent.Future modifySelfservicePermissionsAsync(
ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modifies the specified streaming properties.
*
*
* @param modifyStreamingPropertiesRequest
* @return A Java Future containing the result of the ModifyStreamingProperties operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifyStreamingProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyStreamingPropertiesAsync(
ModifyStreamingPropertiesRequest modifyStreamingPropertiesRequest);
/**
*
* Modifies the specified streaming properties.
*
*
* @param modifyStreamingPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyStreamingProperties operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifyStreamingProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyStreamingPropertiesAsync(
ModifyStreamingPropertiesRequest modifyStreamingPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see
*
* Control Device Access.
*
*
* @param modifyWorkspaceAccessPropertiesRequest
* @return A Java Future containing the result of the ModifyWorkspaceAccessProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsync.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceAccessPropertiesAsync(
ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest);
/**
*
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see
*
* Control Device Access.
*
*
* @param modifyWorkspaceAccessPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyWorkspaceAccessProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceAccessPropertiesAsync(
ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Modify the default properties used to create WorkSpaces.
*
*
* @param modifyWorkspaceCreationPropertiesRequest
* @return A Java Future containing the result of the ModifyWorkspaceCreationProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsync.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceCreationPropertiesAsync(
ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest);
/**
*
* Modify the default properties used to create WorkSpaces.
*
*
* @param modifyWorkspaceCreationPropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyWorkspaceCreationProperties operation returned by the
* service.
* @sample AmazonWorkspacesAsyncHandler.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceCreationPropertiesAsync(
ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param modifyWorkspacePropertiesRequest
* @return A Java Future containing the result of the ModifyWorkspaceProperties operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspacePropertiesAsync(
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.
*
*
*
* @param modifyWorkspacePropertiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyWorkspaceProperties operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspacePropertiesAsync(
ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param modifyWorkspaceStateRequest
* @return A Java Future containing the result of the ModifyWorkspaceState operation returned by the service.
* @sample AmazonWorkspacesAsync.ModifyWorkspaceState
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceStateAsync(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.
*
*
* @param modifyWorkspaceStateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyWorkspaceState operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.ModifyWorkspaceState
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyWorkspaceStateAsync(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param rebootWorkspacesRequest
* @return A Java Future containing the result of the RebootWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.RebootWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future rebootWorkspacesAsync(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.
*
*
* @param rebootWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RebootWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RebootWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param rebuildWorkspacesRequest
* @return A Java Future containing the result of the RebuildWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.RebuildWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future rebuildWorkspacesAsync(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.
*
*
* @param rebuildWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RebuildWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RebuildWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param registerWorkspaceDirectoryRequest
* @return A Java Future containing the result of the RegisterWorkspaceDirectory operation returned by the service.
* @sample AmazonWorkspacesAsync.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
java.util.concurrent.Future registerWorkspaceDirectoryAsync(
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.
*
*
* @param registerWorkspaceDirectoryRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RegisterWorkspaceDirectory operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
java.util.concurrent.Future registerWorkspaceDirectoryAsync(
RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Rejects the account link invitation.
*
*
* @param rejectAccountLinkInvitationRequest
* @return A Java Future containing the result of the RejectAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsync.RejectAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future rejectAccountLinkInvitationAsync(
RejectAccountLinkInvitationRequest rejectAccountLinkInvitationRequest);
/**
*
* Rejects the account link invitation.
*
*
* @param rejectAccountLinkInvitationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RejectAccountLinkInvitation operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RejectAccountLinkInvitation
* @see AWS API Documentation
*/
java.util.concurrent.Future rejectAccountLinkInvitationAsync(
RejectAccountLinkInvitationRequest rejectAccountLinkInvitationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param restoreWorkspaceRequest
* @return A Java Future containing the result of the RestoreWorkspace operation returned by the service.
* @sample AmazonWorkspacesAsync.RestoreWorkspace
* @see AWS
* API Documentation
*/
java.util.concurrent.Future restoreWorkspaceAsync(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.
*
*
* @param restoreWorkspaceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RestoreWorkspace operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RestoreWorkspace
* @see AWS
* API Documentation
*/
java.util.concurrent.Future restoreWorkspaceAsync(RestoreWorkspaceRequest restoreWorkspaceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes one or more rules from the specified IP access control group.
*
*
* @param revokeIpRulesRequest
* @return A Java Future containing the result of the RevokeIpRules operation returned by the service.
* @sample AmazonWorkspacesAsync.RevokeIpRules
* @see AWS API
* Documentation
*/
java.util.concurrent.Future revokeIpRulesAsync(RevokeIpRulesRequest revokeIpRulesRequest);
/**
*
* Removes one or more rules from the specified IP access control group.
*
*
* @param revokeIpRulesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RevokeIpRules operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.RevokeIpRules
* @see AWS API
* Documentation
*/
java.util.concurrent.Future revokeIpRulesAsync(RevokeIpRulesRequest revokeIpRulesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts the specified WorkSpaces.
*
*
* You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of
* STOPPED
.
*
*
* @param startWorkspacesRequest
* @return A Java Future containing the result of the StartWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.StartWorkspaces
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startWorkspacesAsync(StartWorkspacesRequest startWorkspacesRequest);
/**
*
* Starts the specified WorkSpaces.
*
*
* You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of
* STOPPED
.
*
*
* @param startWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.StartWorkspaces
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startWorkspacesAsync(StartWorkspacesRequest startWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts the specified pool.
*
*
* You cannot start a pool unless it has a running mode of AutoStop
and a state of STOPPED
* .
*
*
* @param startWorkspacesPoolRequest
* @return A Java Future containing the result of the StartWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsync.StartWorkspacesPool
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startWorkspacesPoolAsync(StartWorkspacesPoolRequest startWorkspacesPoolRequest);
/**
*
* Starts the specified pool.
*
*
* You cannot start a pool unless it has a running mode of AutoStop
and a state of STOPPED
* .
*
*
* @param startWorkspacesPoolRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.StartWorkspacesPool
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startWorkspacesPoolAsync(StartWorkspacesPoolRequest startWorkspacesPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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
.
*
*
* @param stopWorkspacesRequest
* @return A Java Future containing the result of the StopWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.StopWorkspaces
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopWorkspacesAsync(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
.
*
*
* @param stopWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.StopWorkspaces
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopWorkspacesAsync(StopWorkspacesRequest stopWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops the specified pool.
*
*
* You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of
* AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
*
*
* @param stopWorkspacesPoolRequest
* @return A Java Future containing the result of the StopWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsync.StopWorkspacesPool
* @see AWS
* API Documentation
*/
java.util.concurrent.Future stopWorkspacesPoolAsync(StopWorkspacesPoolRequest stopWorkspacesPoolRequest);
/**
*
* Stops the specified pool.
*
*
* You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of
* AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
*
*
* @param stopWorkspacesPoolRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.StopWorkspacesPool
* @see AWS
* API Documentation
*/
java.util.concurrent.Future stopWorkspacesPoolAsync(StopWorkspacesPoolRequest stopWorkspacesPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param terminateWorkspacesRequest
* @return A Java Future containing the result of the TerminateWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsync.TerminateWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future terminateWorkspacesAsync(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.
*
*
*
* @param terminateWorkspacesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TerminateWorkspaces operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.TerminateWorkspaces
* @see AWS
* API Documentation
*/
java.util.concurrent.Future terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Terminates the specified pool.
*
*
* @param terminateWorkspacesPoolRequest
* @return A Java Future containing the result of the TerminateWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsync.TerminateWorkspacesPool
* @see AWS API Documentation
*/
java.util.concurrent.Future terminateWorkspacesPoolAsync(TerminateWorkspacesPoolRequest terminateWorkspacesPoolRequest);
/**
*
* Terminates the specified pool.
*
*
* @param terminateWorkspacesPoolRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TerminateWorkspacesPool operation returned by the service.
* @sample AmazonWorkspacesAsyncHandler.TerminateWorkspacesPool
* @see AWS API Documentation
*/
java.util.concurrent.Future terminateWorkspacesPoolAsync(TerminateWorkspacesPoolRequest terminateWorkspacesPoolRequest,
com.amazonaws.handlers.AsyncHandler