software.amazon.awssdk.services.workspaces.WorkSpacesAsyncClient Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.workspaces;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.workspaces.model.AssociateConnectionAliasRequest;
import software.amazon.awssdk.services.workspaces.model.AssociateConnectionAliasResponse;
import software.amazon.awssdk.services.workspaces.model.AssociateIpGroupsRequest;
import software.amazon.awssdk.services.workspaces.model.AssociateIpGroupsResponse;
import software.amazon.awssdk.services.workspaces.model.AuthorizeIpRulesRequest;
import software.amazon.awssdk.services.workspaces.model.AuthorizeIpRulesResponse;
import software.amazon.awssdk.services.workspaces.model.CopyWorkspaceImageRequest;
import software.amazon.awssdk.services.workspaces.model.CopyWorkspaceImageResponse;
import software.amazon.awssdk.services.workspaces.model.CreateConnectClientAddInRequest;
import software.amazon.awssdk.services.workspaces.model.CreateConnectClientAddInResponse;
import software.amazon.awssdk.services.workspaces.model.CreateConnectionAliasRequest;
import software.amazon.awssdk.services.workspaces.model.CreateConnectionAliasResponse;
import software.amazon.awssdk.services.workspaces.model.CreateIpGroupRequest;
import software.amazon.awssdk.services.workspaces.model.CreateIpGroupResponse;
import software.amazon.awssdk.services.workspaces.model.CreateTagsRequest;
import software.amazon.awssdk.services.workspaces.model.CreateTagsResponse;
import software.amazon.awssdk.services.workspaces.model.CreateUpdatedWorkspaceImageRequest;
import software.amazon.awssdk.services.workspaces.model.CreateUpdatedWorkspaceImageResponse;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspaceBundleRequest;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspaceBundleResponse;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspaceImageRequest;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspaceImageResponse;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.CreateWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteClientBrandingRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteClientBrandingResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteConnectClientAddInRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteConnectClientAddInResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteConnectionAliasRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteConnectionAliasResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteIpGroupRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteIpGroupResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteTagsRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteTagsResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteWorkspaceBundleRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteWorkspaceBundleResponse;
import software.amazon.awssdk.services.workspaces.model.DeleteWorkspaceImageRequest;
import software.amazon.awssdk.services.workspaces.model.DeleteWorkspaceImageResponse;
import software.amazon.awssdk.services.workspaces.model.DeregisterWorkspaceDirectoryRequest;
import software.amazon.awssdk.services.workspaces.model.DeregisterWorkspaceDirectoryResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeAccountModificationsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeAccountModificationsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeAccountRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeAccountResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeClientBrandingRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeClientBrandingResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeClientPropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeClientPropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectClientAddInsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectClientAddInsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectionAliasPermissionsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectionAliasPermissionsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectionAliasesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeConnectionAliasesResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeIpGroupsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeIpGroupsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeTagsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeTagsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceImagePermissionsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceImagePermissionsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceImagesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceImagesResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceSnapshotsRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceSnapshotsResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesConnectionStatusRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesConnectionStatusResponse;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.DisassociateConnectionAliasRequest;
import software.amazon.awssdk.services.workspaces.model.DisassociateConnectionAliasResponse;
import software.amazon.awssdk.services.workspaces.model.DisassociateIpGroupsRequest;
import software.amazon.awssdk.services.workspaces.model.DisassociateIpGroupsResponse;
import software.amazon.awssdk.services.workspaces.model.ImportClientBrandingRequest;
import software.amazon.awssdk.services.workspaces.model.ImportClientBrandingResponse;
import software.amazon.awssdk.services.workspaces.model.ImportWorkspaceImageRequest;
import software.amazon.awssdk.services.workspaces.model.ImportWorkspaceImageResponse;
import software.amazon.awssdk.services.workspaces.model.ListAvailableManagementCidrRangesRequest;
import software.amazon.awssdk.services.workspaces.model.ListAvailableManagementCidrRangesResponse;
import software.amazon.awssdk.services.workspaces.model.MigrateWorkspaceRequest;
import software.amazon.awssdk.services.workspaces.model.MigrateWorkspaceResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyAccountRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyAccountResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyClientPropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyClientPropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.ModifySamlPropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.ModifySamlPropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.ModifySelfservicePermissionsRequest;
import software.amazon.awssdk.services.workspaces.model.ModifySelfservicePermissionsResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceAccessPropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceAccessPropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceCreationPropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceCreationPropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspacePropertiesRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspacePropertiesResponse;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceStateRequest;
import software.amazon.awssdk.services.workspaces.model.ModifyWorkspaceStateResponse;
import software.amazon.awssdk.services.workspaces.model.RebootWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.RebootWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.RebuildWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.RebuildWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.RegisterWorkspaceDirectoryRequest;
import software.amazon.awssdk.services.workspaces.model.RegisterWorkspaceDirectoryResponse;
import software.amazon.awssdk.services.workspaces.model.RestoreWorkspaceRequest;
import software.amazon.awssdk.services.workspaces.model.RestoreWorkspaceResponse;
import software.amazon.awssdk.services.workspaces.model.RevokeIpRulesRequest;
import software.amazon.awssdk.services.workspaces.model.RevokeIpRulesResponse;
import software.amazon.awssdk.services.workspaces.model.StartWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.StartWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.StopWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.StopWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.TerminateWorkspacesRequest;
import software.amazon.awssdk.services.workspaces.model.TerminateWorkspacesResponse;
import software.amazon.awssdk.services.workspaces.model.UpdateConnectClientAddInRequest;
import software.amazon.awssdk.services.workspaces.model.UpdateConnectClientAddInResponse;
import software.amazon.awssdk.services.workspaces.model.UpdateConnectionAliasPermissionRequest;
import software.amazon.awssdk.services.workspaces.model.UpdateConnectionAliasPermissionResponse;
import software.amazon.awssdk.services.workspaces.model.UpdateRulesOfIpGroupRequest;
import software.amazon.awssdk.services.workspaces.model.UpdateRulesOfIpGroupResponse;
import software.amazon.awssdk.services.workspaces.model.UpdateWorkspaceBundleRequest;
import software.amazon.awssdk.services.workspaces.model.UpdateWorkspaceBundleResponse;
import software.amazon.awssdk.services.workspaces.model.UpdateWorkspaceImagePermissionRequest;
import software.amazon.awssdk.services.workspaces.model.UpdateWorkspaceImagePermissionResponse;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher;
/**
* Service client for accessing Amazon WorkSpaces asynchronously. This can be created using the static
* {@link #builder()} method.
*
* 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("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface WorkSpacesAsyncClient extends SdkClient {
String SERVICE_NAME = "workspaces";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "workspaces";
/**
* Create a {@link WorkSpacesAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static WorkSpacesAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link WorkSpacesAsyncClient}.
*/
static WorkSpacesAsyncClientBuilder builder() {
return new DefaultWorkSpacesAsyncClientBuilder();
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AssociateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture associateConnectionAlias(
AssociateConnectionAliasRequest associateConnectionAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Associates the specified connection alias with the specified directory to enable cross-Region redirection. For
* more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
*
* This is a convenience which creates an instance of the {@link AssociateConnectionAliasRequest.Builder} avoiding
* the need to create one manually via {@link AssociateConnectionAliasRequest#builder()}
*
*
* @param associateConnectionAliasRequest
* A {@link Consumer} that will call methods on {@link AssociateConnectionAliasRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AssociateConnectionAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AssociateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture associateConnectionAlias(
Consumer associateConnectionAliasRequest) {
return associateConnectionAlias(AssociateConnectionAliasRequest.builder().applyMutation(associateConnectionAliasRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AssociateIpGroups
* @see AWS
* API Documentation
*/
default CompletableFuture associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Associates the specified IP access control group with the specified directory.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateIpGroupsRequest.Builder} avoiding the need
* to create one manually via {@link AssociateIpGroupsRequest#builder()}
*
*
* @param associateIpGroupsRequest
* A {@link Consumer} that will call methods on {@link AssociateIpGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the AssociateIpGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AssociateIpGroups
* @see AWS
* API Documentation
*/
default CompletableFuture associateIpGroups(
Consumer associateIpGroupsRequest) {
return associateIpGroups(AssociateIpGroupsRequest.builder().applyMutation(associateIpGroupsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AuthorizeIpRules
* @see AWS
* API Documentation
*/
default CompletableFuture authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more rules to the specified IP access control group.
*
*
* This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the
* rules.
*
*
*
* This is a convenience which creates an instance of the {@link AuthorizeIpRulesRequest.Builder} avoiding the need
* to create one manually via {@link AuthorizeIpRulesRequest#builder()}
*
*
* @param authorizeIpRulesRequest
* A {@link Consumer} that will call methods on {@link AuthorizeIpRulesRequest.Builder} to create a request.
* @return A Java Future containing the result of the AuthorizeIpRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.AuthorizeIpRules
* @see AWS
* API Documentation
*/
default CompletableFuture authorizeIpRules(
Consumer authorizeIpRulesRequest) {
return authorizeIpRules(AuthorizeIpRulesRequest.builder().applyMutation(authorizeIpRulesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - OperationNotSupportedException This operation is not supported.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
default CompletableFuture copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Copies the specified image from the specified Region to the current Region. For more information about copying
* images, see Copy a
* Custom WorkSpaces Image.
*
*
* In the China (Ningxia) Region, you can copy images only within the same Region.
*
*
* In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services
* Support.
*
*
*
* Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services
* account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns
* an image, use the
* DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
*
*
*
* This is a convenience which creates an instance of the {@link CopyWorkspaceImageRequest.Builder} avoiding the
* need to create one manually via {@link CopyWorkspaceImageRequest#builder()}
*
*
* @param copyWorkspaceImageRequest
* A {@link Consumer} that will call methods on {@link CopyWorkspaceImageRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CopyWorkspaceImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - OperationNotSupportedException This operation is not supported.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
default CompletableFuture copyWorkspaceImage(
Consumer copyWorkspaceImageRequest) {
return copyWorkspaceImage(CopyWorkspaceImageRequest.builder().applyMutation(copyWorkspaceImageRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceCreationFailedException The resource could not be created.
* - ResourceAlreadyExistsException The specified resource already exists.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture createConnectClientAddIn(
CreateConnectClientAddInRequest createConnectClientAddInRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client
* add-in within a directory.
*
*
* This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
*
*
*
* This is a convenience which creates an instance of the {@link CreateConnectClientAddInRequest.Builder} avoiding
* the need to create one manually via {@link CreateConnectClientAddInRequest#builder()}
*
*
* @param createConnectClientAddInRequest
* A {@link Consumer} that will call methods on {@link CreateConnectClientAddInRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateConnectClientAddIn operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceCreationFailedException The resource could not be created.
* - ResourceAlreadyExistsException The specified resource already exists.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture createConnectClientAddIn(
Consumer createConnectClientAddInRequest) {
return createConnectClientAddIn(CreateConnectClientAddInRequest.builder().applyMutation(createConnectClientAddInRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAlreadyExistsException The specified resource already exists.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture createConnectionAlias(
CreateConnectionAliasRequest createConnectionAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link CreateConnectionAliasRequest.Builder} avoiding the
* need to create one manually via {@link CreateConnectionAliasRequest#builder()}
*
*
* @param createConnectionAliasRequest
* A {@link Consumer} that will call methods on {@link CreateConnectionAliasRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateConnectionAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAlreadyExistsException The specified resource already exists.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture createConnectionAlias(
Consumer createConnectionAliasRequest) {
return createConnectionAlias(CreateConnectionAliasRequest.builder().applyMutation(createConnectionAliasRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceCreationFailedException The resource could not be created.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateIpGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createIpGroup(CreateIpGroupRequest createIpGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an IP access control group.
*
*
* An IP access control group provides you with the ability to control the IP addresses from which users are allowed
* to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and
* then associate the group with your directory. You can add rules when you create the group or at any time using
* AuthorizeIpRules.
*
*
* There is a default IP access control group associated with your directory. If you don't associate an IP access
* control group with your directory, the default group is used. The default group includes a default rule that
* allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for
* your directory.
*
*
*
* This is a convenience which creates an instance of the {@link CreateIpGroupRequest.Builder} avoiding the need to
* create one manually via {@link CreateIpGroupRequest#builder()}
*
*
* @param createIpGroupRequest
* A {@link Consumer} that will call methods on {@link CreateIpGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateIpGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceCreationFailedException The resource could not be created.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateIpGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createIpGroup(Consumer createIpGroupRequest) {
return createIpGroup(CreateIpGroupRequest.builder().applyMutation(createIpGroupRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateTags
* @see AWS API
* Documentation
*/
default CompletableFuture createTags(CreateTagsRequest createTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates the specified tags for the specified WorkSpaces resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTagsRequest.Builder} avoiding the need to
* create one manually via {@link CreateTagsRequest#builder()}
*
*
* @param createTagsRequest
* A {@link Consumer} that will call methods on {@link CreateTagsRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateTags
* @see AWS API
* Documentation
*/
default CompletableFuture createTags(Consumer createTagsRequest) {
return createTags(CreateTagsRequest.builder().applyMutation(createTagsRequest).build());
}
/**
*
* 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 Sever 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture createUpdatedWorkspaceImage(
CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at
* this time.
*
*
* -
*
* Microsoft Windows updates and other application updates are not included in the update process.
*
*
* -
*
* The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated
* image and created a new bundle.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateUpdatedWorkspaceImageRequest.Builder}
* avoiding the need to create one manually via {@link CreateUpdatedWorkspaceImageRequest#builder()}
*
*
* @param createUpdatedWorkspaceImageRequest
* A {@link Consumer} that will call methods on {@link CreateUpdatedWorkspaceImageRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the CreateUpdatedWorkspaceImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture createUpdatedWorkspaceImage(
Consumer createUpdatedWorkspaceImageRequest) {
return createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest.builder()
.applyMutation(createUpdatedWorkspaceImageRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceUnavailableException The specified resource is not available.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture createWorkspaceBundle(
CreateWorkspaceBundleRequest createWorkspaceBundleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom
* WorkSpaces Image and Bundle.
*
*
*
* This is a convenience which creates an instance of the {@link CreateWorkspaceBundleRequest.Builder} avoiding the
* need to create one manually via {@link CreateWorkspaceBundleRequest#builder()}
*
*
* @param createWorkspaceBundleRequest
* A {@link Consumer} that will call methods on {@link CreateWorkspaceBundleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateWorkspaceBundle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceUnavailableException The specified resource is not available.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture createWorkspaceBundle(
Consumer createWorkspaceBundleRequest) {
return createWorkspaceBundle(CreateWorkspaceBundleRequest.builder().applyMutation(createWorkspaceBundleRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture createWorkspaceImage(
CreateWorkspaceImageRequest createWorkspaceImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new WorkSpace image from an existing WorkSpace.
*
*
*
* This is a convenience which creates an instance of the {@link CreateWorkspaceImageRequest.Builder} avoiding the
* need to create one manually via {@link CreateWorkspaceImageRequest#builder()}
*
*
* @param createWorkspaceImageRequest
* A {@link Consumer} that will call methods on {@link CreateWorkspaceImageRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateWorkspaceImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture createWorkspaceImage(
Consumer createWorkspaceImageRequest) {
return createWorkspaceImage(CreateWorkspaceImageRequest.builder().applyMutation(createWorkspaceImageRequest).build());
}
/**
*
* Creates one or more WorkSpaces.
*
*
* This operation is asynchronous and returns before the WorkSpaces are created.
*
*
* @param createWorkspacesRequest
* @return A Java Future containing the result of the CreateWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates one or more WorkSpaces.
*
*
* This operation is asynchronous and returns before the WorkSpaces are created.
*
*
*
* This is a convenience which creates an instance of the {@link CreateWorkspacesRequest.Builder} avoiding the need
* to create one manually via {@link CreateWorkspacesRequest#builder()}
*
*
* @param createWorkspacesRequest
* A {@link Consumer} that will call methods on {@link CreateWorkspacesRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.CreateWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture createWorkspaces(
Consumer createWorkspacesRequest) {
return createWorkspaces(CreateWorkspacesRequest.builder().applyMutation(createWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteClientBranding
* @see AWS API Documentation
*/
default CompletableFuture deleteClientBranding(
DeleteClientBrandingRequest deleteClientBrandingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal.
* You can tailor your login portal company logo, the support email address, support link, link to reset password,
* and a custom message for users trying to sign in.
*
*
* After you delete your customized client branding, your login portal reverts to the default client branding.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteClientBrandingRequest.Builder} avoiding the
* need to create one manually via {@link DeleteClientBrandingRequest#builder()}
*
*
* @param deleteClientBrandingRequest
* A {@link Consumer} that will call methods on {@link DeleteClientBrandingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteClientBranding operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteClientBranding
* @see AWS API Documentation
*/
default CompletableFuture deleteClientBranding(
Consumer deleteClientBrandingRequest) {
return deleteClientBranding(DeleteClientBrandingRequest.builder().applyMutation(deleteClientBrandingRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture deleteConnectClientAddIn(
DeleteConnectClientAddInRequest deleteConnectClientAddInRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteConnectClientAddInRequest.Builder} avoiding
* the need to create one manually via {@link DeleteConnectClientAddInRequest#builder()}
*
*
* @param deleteConnectClientAddInRequest
* A {@link Consumer} that will call methods on {@link DeleteConnectClientAddInRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteConnectClientAddIn operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture deleteConnectClientAddIn(
Consumer deleteConnectClientAddInRequest) {
return deleteConnectClientAddIn(DeleteConnectClientAddInRequest.builder().applyMutation(deleteConnectClientAddInRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture deleteConnectionAlias(
DeleteConnectionAliasRequest deleteConnectionAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified connection alias. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your
* WorkSpaces users, you must take certain precautions to prevent potential security issues. For more
* information, see Security Considerations if You Stop Using Cross-Region Redirection.
*
*
*
* To delete a connection alias that has been shared, the shared account must first disassociate the connection
* alias from any directories it has been associated with. Then you must unshare the connection alias from the
* account it has been shared with. You can delete a connection alias only after it is no longer shared with any
* accounts or associated with any directories.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteConnectionAliasRequest.Builder} avoiding the
* need to create one manually via {@link DeleteConnectionAliasRequest#builder()}
*
*
* @param deleteConnectionAliasRequest
* A {@link Consumer} that will call methods on {@link DeleteConnectionAliasRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteConnectionAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture deleteConnectionAlias(
Consumer deleteConnectionAliasRequest) {
return deleteConnectionAlias(DeleteConnectionAliasRequest.builder().applyMutation(deleteConnectionAliasRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteIpGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified IP access control group.
*
*
* You cannot delete an IP access control group that is associated with a directory.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIpGroupRequest.Builder} avoiding the need to
* create one manually via {@link DeleteIpGroupRequest#builder()}
*
*
* @param deleteIpGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteIpGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteIpGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteIpGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteIpGroup(Consumer deleteIpGroupRequest) {
return deleteIpGroup(DeleteIpGroupRequest.builder().applyMutation(deleteIpGroupRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteTags
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTags(DeleteTagsRequest deleteTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified tags from the specified WorkSpaces resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteTagsRequest.Builder} avoiding the need to
* create one manually via {@link DeleteTagsRequest#builder()}
*
*
* @param deleteTagsRequest
* A {@link Consumer} that will call methods on {@link DeleteTagsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteTags
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTags(Consumer deleteTagsRequest) {
return deleteTags(DeleteTagsRequest.builder().applyMutation(deleteTagsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkspaceBundle(
DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces
* Bundle or Image.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteWorkspaceBundleRequest.Builder} avoiding the
* need to create one manually via {@link DeleteWorkspaceBundleRequest#builder()}
*
*
* @param deleteWorkspaceBundleRequest
* A {@link Consumer} that will call methods on {@link DeleteWorkspaceBundleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteWorkspaceBundle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkspaceBundle(
Consumer deleteWorkspaceBundleRequest) {
return deleteWorkspaceBundle(DeleteWorkspaceBundleRequest.builder().applyMutation(deleteWorkspaceBundleRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAssociatedException The resource is associated with a directory.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkspaceImage(
DeleteWorkspaceImageRequest deleteWorkspaceImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified image from your account. To delete an image, you must first delete any bundles that are
* associated with the image and unshare the image if it is shared with other accounts.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteWorkspaceImageRequest.Builder} avoiding the
* need to create one manually via {@link DeleteWorkspaceImageRequest#builder()}
*
*
* @param deleteWorkspaceImageRequest
* A {@link Consumer} that will call methods on {@link DeleteWorkspaceImageRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteWorkspaceImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceAssociatedException The resource is associated with a directory.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeleteWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkspaceImage(
Consumer deleteWorkspaceImageRequest) {
return deleteWorkspaceImage(DeleteWorkspaceImageRequest.builder().applyMutation(deleteWorkspaceImageRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
default CompletableFuture deregisterWorkspaceDirectory(
DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is
* deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister
* the directory.
*
*
*
* Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no
* WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will
* be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per
* the Directory Service pricing terms.
*
*
* To delete empty directories, see Delete the
* Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create
* a new one when you want to start using WorkSpaces again.
*
*
*
* This is a convenience which creates an instance of the {@link DeregisterWorkspaceDirectoryRequest.Builder}
* avoiding the need to create one manually via {@link DeregisterWorkspaceDirectoryRequest#builder()}
*
*
* @param deregisterWorkspaceDirectoryRequest
* A {@link Consumer} that will call methods on {@link DeregisterWorkspaceDirectoryRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeregisterWorkspaceDirectory operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
default CompletableFuture deregisterWorkspaceDirectory(
Consumer deregisterWorkspaceDirectoryRequest) {
return deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest.builder()
.applyMutation(deregisterWorkspaceDirectoryRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeAccount
* @see AWS
* API Documentation
*/
default CompletableFuture describeAccount(DescribeAccountRequest describeAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccountRequest.Builder} avoiding the need
* to create one manually via {@link DescribeAccountRequest#builder()}
*
*
* @param describeAccountRequest
* A {@link Consumer} that will call methods on {@link DescribeAccountRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeAccount operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeAccount
* @see AWS
* API Documentation
*/
default CompletableFuture describeAccount(
Consumer describeAccountRequest) {
return describeAccount(DescribeAccountRequest.builder().applyMutation(describeAccountRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeAccountModifications
* @see AWS API Documentation
*/
default CompletableFuture describeAccountModifications(
DescribeAccountModificationsRequest describeAccountModificationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
* specified account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccountModificationsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeAccountModificationsRequest#builder()}
*
*
* @param describeAccountModificationsRequest
* A {@link Consumer} that will call methods on {@link DescribeAccountModificationsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeAccountModifications operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeAccountModifications
* @see AWS API Documentation
*/
default CompletableFuture describeAccountModifications(
Consumer describeAccountModificationsRequest) {
return describeAccountModifications(DescribeAccountModificationsRequest.builder()
.applyMutation(describeAccountModificationsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeClientBranding
* @see AWS API Documentation
*/
default CompletableFuture describeClientBranding(
DescribeClientBrandingRequest describeClientBrandingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the specified client branding. Client branding allows you to customize the log in page of various
* device types for your users. You can add your company logo, the support email address, support link, link to
* reset password, and a custom message for users trying to sign in.
*
*
*
* Only device types that have branding information configured will be shown in the response.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeClientBrandingRequest.Builder} avoiding the
* need to create one manually via {@link DescribeClientBrandingRequest#builder()}
*
*
* @param describeClientBrandingRequest
* A {@link Consumer} that will call methods on {@link DescribeClientBrandingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeClientBranding operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeClientBranding
* @see AWS API Documentation
*/
default CompletableFuture describeClientBranding(
Consumer describeClientBrandingRequest) {
return describeClientBranding(DescribeClientBrandingRequest.builder().applyMutation(describeClientBrandingRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeClientProperties
* @see AWS API Documentation
*/
default CompletableFuture describeClientProperties(
DescribeClientPropertiesRequest describeClientPropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeClientPropertiesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeClientPropertiesRequest#builder()}
*
*
* @param describeClientPropertiesRequest
* A {@link Consumer} that will call methods on {@link DescribeClientPropertiesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeClientProperties operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeClientProperties
* @see AWS API Documentation
*/
default CompletableFuture describeClientProperties(
Consumer describeClientPropertiesRequest) {
return describeClientProperties(DescribeClientPropertiesRequest.builder().applyMutation(describeClientPropertiesRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
default CompletableFuture describeConnectClientAddIns(
DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of Amazon Connect client add-ins that have been created.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConnectClientAddInsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeConnectClientAddInsRequest#builder()}
*
*
* @param describeConnectClientAddInsRequest
* A {@link Consumer} that will call methods on {@link DescribeConnectClientAddInsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeConnectClientAddIns operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
default CompletableFuture describeConnectClientAddIns(
Consumer describeConnectClientAddInsRequest) {
return describeConnectClientAddIns(DescribeConnectClientAddInsRequest.builder()
.applyMutation(describeConnectClientAddInsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
default CompletableFuture describeConnectionAliasPermissions(
DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account
* for the specified connection alias. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConnectionAliasPermissionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeConnectionAliasPermissionsRequest#builder()}
*
*
* @param describeConnectionAliasPermissionsRequest
* A {@link Consumer} that will call methods on {@link DescribeConnectionAliasPermissionsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeConnectionAliasPermissions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
default CompletableFuture describeConnectionAliasPermissions(
Consumer describeConnectionAliasPermissionsRequest) {
return describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest.builder()
.applyMutation(describeConnectionAliasPermissionsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectionAliases
* @see AWS API Documentation
*/
default CompletableFuture describeConnectionAliases(
DescribeConnectionAliasesRequest describeConnectionAliasesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information,
* see
* Cross-Region Redirection for Amazon WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConnectionAliasesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeConnectionAliasesRequest#builder()}
*
*
* @param describeConnectionAliasesRequest
* A {@link Consumer} that will call methods on {@link DescribeConnectionAliasesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeConnectionAliases operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeConnectionAliases
* @see AWS API Documentation
*/
default CompletableFuture describeConnectionAliases(
Consumer describeConnectionAliasesRequest) {
return describeConnectionAliases(DescribeConnectionAliasesRequest.builder()
.applyMutation(describeConnectionAliasesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeIpGroups
* @see AWS
* API Documentation
*/
default CompletableFuture describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes one or more of your IP access control groups.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeIpGroupsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeIpGroupsRequest#builder()}
*
*
* @param describeIpGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeIpGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeIpGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeIpGroups
* @see AWS
* API Documentation
*/
default CompletableFuture describeIpGroups(
Consumer describeIpGroupsRequest) {
return describeIpGroups(DescribeIpGroupsRequest.builder().applyMutation(describeIpGroupsRequest).build());
}
/**
*
* Describes one or more of your IP access control groups.
*
*
* @return A Java Future containing the result of the DescribeIpGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeIpGroups
* @see AWS
* API Documentation
*/
default CompletableFuture describeIpGroups() {
return describeIpGroups(DescribeIpGroupsRequest.builder().build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeTags
* @see AWS API
* Documentation
*/
default CompletableFuture describeTags(DescribeTagsRequest describeTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the specified tags for the specified WorkSpaces resource.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTagsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeTagsRequest#builder()}
*
*
* @param describeTagsRequest
* A {@link Consumer} that will call methods on {@link DescribeTagsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeTags
* @see AWS API
* Documentation
*/
default CompletableFuture describeTags(Consumer describeTagsRequest) {
return describeTags(DescribeTagsRequest.builder().applyMutation(describeTagsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceBundles(
DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceBundlesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeWorkspaceBundlesRequest#builder()}
*
*
* @param describeWorkspaceBundlesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceBundlesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeWorkspaceBundles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceBundles(
Consumer describeWorkspaceBundlesRequest) {
return describeWorkspaceBundles(DescribeWorkspaceBundlesRequest.builder().applyMutation(describeWorkspaceBundlesRequest)
.build());
}
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
* @return A Java Future containing the result of the DescribeWorkspaceBundles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceBundles() {
return describeWorkspaceBundles(DescribeWorkspaceBundlesRequest.builder().build());
}
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
*
* This is a variant of
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator() {
return describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest.builder().build());
}
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
*
* This is a variant of
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation.
*
*
* @param describeWorkspaceBundlesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(
DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
*
* This is a variant of
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceBundlesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeWorkspaceBundlesRequest#builder()}
*
*
* @param describeWorkspaceBundlesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceBundlesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(
Consumer describeWorkspaceBundlesRequest) {
return describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest.builder()
.applyMutation(describeWorkspaceBundlesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceDirectories(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceDirectoriesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeWorkspaceDirectoriesRequest#builder()}
*
*
* @param describeWorkspaceDirectoriesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceDirectoriesRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeWorkspaceDirectories operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceDirectories(
Consumer describeWorkspaceDirectoriesRequest) {
return describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest.builder()
.applyMutation(describeWorkspaceDirectoriesRequest).build());
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @return A Java Future containing the result of the DescribeWorkspaceDirectories operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceDirectories() {
return describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest.builder().build());
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
*
* This is a variant of
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator() {
return describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest.builder().build());
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
*
* This is a variant of
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation.
*
*
* @param describeWorkspaceDirectoriesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
*
* This is a variant of
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceDirectoriesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeWorkspaceDirectoriesRequest#builder()}
*
*
* @param describeWorkspaceDirectoriesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceDirectoriesRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(
Consumer describeWorkspaceDirectoriesRequest) {
return describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest.builder()
.applyMutation(describeWorkspaceDirectoriesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceImagePermissions(
DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
* image.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceImagePermissionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeWorkspaceImagePermissionsRequest#builder()}
*
*
* @param describeWorkspaceImagePermissionsRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceImagePermissionsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeWorkspaceImagePermissions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceImagePermissions(
Consumer describeWorkspaceImagePermissionsRequest) {
return describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest.builder()
.applyMutation(describeWorkspaceImagePermissionsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceImages
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceImages(
DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise,
* all images in the account are described.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceImagesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeWorkspaceImagesRequest#builder()}
*
*
* @param describeWorkspaceImagesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceImagesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeWorkspaceImages operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceImages
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceImages(
Consumer describeWorkspaceImagesRequest) {
return describeWorkspaceImages(DescribeWorkspaceImagesRequest.builder().applyMutation(describeWorkspaceImagesRequest)
.build());
}
/**
*
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise,
* all images in the account are described.
*
*
* @return A Java Future containing the result of the DescribeWorkspaceImages operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceImages
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceImages() {
return describeWorkspaceImages(DescribeWorkspaceImagesRequest.builder().build());
}
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
* @param describeWorkspaceSnapshotsRequest
* @return A Java Future containing the result of the DescribeWorkspaceSnapshots operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceSnapshots(
DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspaceSnapshotsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeWorkspaceSnapshotsRequest#builder()}
*
*
* @param describeWorkspaceSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspaceSnapshotsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeWorkspaceSnapshots operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspaceSnapshots(
Consumer describeWorkspaceSnapshotsRequest) {
return describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest.builder()
.applyMutation(describeWorkspaceSnapshotsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the specified WorkSpaces.
*
*
* You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify
* only one filter at a time.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspacesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeWorkspacesRequest#builder()}
*
*
* @param describeWorkspacesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspacesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture describeWorkspaces(
Consumer describeWorkspacesRequest) {
return describeWorkspaces(DescribeWorkspacesRequest.builder().applyMutation(describeWorkspacesRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture describeWorkspaces() {
return describeWorkspaces(DescribeWorkspacesRequest.builder().build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspacesConnectionStatus(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspacesConnectionStatusRequest.Builder}
* avoiding the need to create one manually via {@link DescribeWorkspacesConnectionStatusRequest#builder()}
*
*
* @param describeWorkspacesConnectionStatusRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspacesConnectionStatusRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeWorkspacesConnectionStatus operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspacesConnectionStatus(
Consumer describeWorkspacesConnectionStatusRequest) {
return describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest.builder()
.applyMutation(describeWorkspacesConnectionStatusRequest).build());
}
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @return A Java Future containing the result of the DescribeWorkspacesConnectionStatus operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
default CompletableFuture describeWorkspacesConnectionStatus() {
return describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest.builder().build());
}
/**
*
* Describes the specified WorkSpaces.
*
*
* You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify
* only one filter at a time.
*
*
*
* This is a variant of
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesPublisher describeWorkspacesPaginator() {
return describeWorkspacesPaginator(DescribeWorkspacesRequest.builder().build());
}
/**
*
* Describes the specified WorkSpaces.
*
*
* You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify
* only one filter at a time.
*
*
*
* This is a variant of
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation.
*
*
* @param describeWorkspacesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesPublisher describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the specified WorkSpaces.
*
*
* You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify
* only one filter at a time.
*
*
*
* This is a variant of
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkspacesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeWorkspacesRequest#builder()}
*
*
* @param describeWorkspacesRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkspacesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesPublisher describeWorkspacesPaginator(
Consumer describeWorkspacesRequest) {
return describeWorkspacesPaginator(DescribeWorkspacesRequest.builder().applyMutation(describeWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DisassociateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture disassociateConnectionAlias(
DisassociateConnectionAliasRequest disassociateConnectionAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region
* redirection between two directories in different Regions. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateConnectionAliasRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateConnectionAliasRequest#builder()}
*
*
* @param disassociateConnectionAliasRequest
* A {@link Consumer} that will call methods on {@link DisassociateConnectionAliasRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DisassociateConnectionAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceNotFoundException The resource could not be found.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DisassociateConnectionAlias
* @see AWS API Documentation
*/
default CompletableFuture disassociateConnectionAlias(
Consumer disassociateConnectionAliasRequest) {
return disassociateConnectionAlias(DisassociateConnectionAliasRequest.builder()
.applyMutation(disassociateConnectionAliasRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DisassociateIpGroups
* @see AWS API Documentation
*/
default CompletableFuture disassociateIpGroups(
DisassociateIpGroupsRequest disassociateIpGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates the specified IP access control group from the specified directory.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateIpGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DisassociateIpGroupsRequest#builder()}
*
*
* @param disassociateIpGroupsRequest
* A {@link Consumer} that will call methods on {@link DisassociateIpGroupsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DisassociateIpGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.DisassociateIpGroups
* @see AWS API Documentation
*/
default CompletableFuture disassociateIpGroups(
Consumer disassociateIpGroupsRequest) {
return disassociateIpGroups(DisassociateIpGroupsRequest.builder().applyMutation(disassociateIpGroupsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ImportClientBranding
* @see AWS API Documentation
*/
default CompletableFuture importClientBranding(
ImportClientBrandingRequest importClientBrandingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can
* tailor your login portal company logo, the support email address, support link, link to reset password, and a
* custom message for users trying to sign in.
*
*
* After you import client branding, the default branding experience for the specified platform type is replaced
* with the imported experience
*
*
*
* -
*
* You must specify at least one platform type when importing client branding.
*
*
* -
*
* You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client
* branding for different platform types using separate requests.
*
*
* -
*
* In each platform type, the SupportEmail and SupportLink parameters are mutually
* exclusive. You can specify only one parameter for each platform type, but not both.
*
*
* -
*
* Imported data can take up to a minute to appear in the WorkSpaces client.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ImportClientBrandingRequest.Builder} avoiding the
* need to create one manually via {@link ImportClientBrandingRequest#builder()}
*
*
* @param importClientBrandingRequest
* A {@link Consumer} that will call methods on {@link ImportClientBrandingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ImportClientBranding operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ImportClientBranding
* @see AWS API Documentation
*/
default CompletableFuture importClientBranding(
Consumer importClientBrandingRequest) {
return importClientBranding(ImportClientBrandingRequest.builder().applyMutation(importClientBrandingRequest).build());
}
/**
*
* Imports the specified Windows 10 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ImportWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture importWorkspaceImage(
ImportWorkspaceImageRequest importWorkspaceImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an
* already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For
* more information about creating BYOL images, see Bring Your Own Windows
* Desktop Licenses.
*
*
*
* This is a convenience which creates an instance of the {@link ImportWorkspaceImageRequest.Builder} avoiding the
* need to create one manually via {@link ImportWorkspaceImageRequest#builder()}
*
*
* @param importWorkspaceImageRequest
* A {@link Consumer} that will call methods on {@link ImportWorkspaceImageRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ImportWorkspaceImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ImportWorkspaceImage
* @see AWS API Documentation
*/
default CompletableFuture importWorkspaceImage(
Consumer importWorkspaceImageRequest) {
return importWorkspaceImage(ImportWorkspaceImageRequest.builder().applyMutation(importWorkspaceImageRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagementCidrRanges(
ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management
* interface when you enable Bring Your Own License (BYOL).
*
*
* This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't
* enabled for BYOL, you'll receive an AccessDeniedException error.
*
*
* The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for
* interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to
* manage the WorkSpace.
*
*
*
* This is a convenience which creates an instance of the {@link ListAvailableManagementCidrRangesRequest.Builder}
* avoiding the need to create one manually via {@link ListAvailableManagementCidrRangesRequest#builder()}
*
*
* @param listAvailableManagementCidrRangesRequest
* A {@link Consumer} that will call methods on {@link ListAvailableManagementCidrRangesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListAvailableManagementCidrRanges operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagementCidrRanges(
Consumer listAvailableManagementCidrRangesRequest) {
return listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest.builder()
.applyMutation(listAvailableManagementCidrRangesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - OperationNotSupportedException This operation is not supported.
* - OperationInProgressException The properties of this WorkSpace are currently being modified. Try again
* in a moment.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.MigrateWorkspace
* @see AWS
* API Documentation
*/
default CompletableFuture migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
* volume.
*
*
* The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
* user volume from the last available snapshot of the original WorkSpace. During migration, the original
* D:\Users\%USERNAME% user profile folder is renamed to
* D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
* generated by the new OS. Certain files in the old user profile are moved to the new user profile.
*
*
* For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
*
*
*
* This is a convenience which creates an instance of the {@link MigrateWorkspaceRequest.Builder} avoiding the need
* to create one manually via {@link MigrateWorkspaceRequest#builder()}
*
*
* @param migrateWorkspaceRequest
* A {@link Consumer} that will call methods on {@link MigrateWorkspaceRequest.Builder} to create a request.
* @return A Java Future containing the result of the MigrateWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - OperationNotSupportedException This operation is not supported.
* - OperationInProgressException The properties of this WorkSpace are currently being modified. Try again
* in a moment.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.MigrateWorkspace
* @see AWS
* API Documentation
*/
default CompletableFuture migrateWorkspace(
Consumer migrateWorkspaceRequest) {
return migrateWorkspace(MigrateWorkspaceRequest.builder().applyMutation(migrateWorkspaceRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - ResourceUnavailableException The specified resource is not available.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyAccount
* @see AWS API
* Documentation
*/
default CompletableFuture modifyAccount(ModifyAccountRequest modifyAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyAccountRequest.Builder} avoiding the need to
* create one manually via {@link ModifyAccountRequest#builder()}
*
*
* @param modifyAccountRequest
* A {@link Consumer} that will call methods on {@link ModifyAccountRequest.Builder} to create a request.
* @return A Java Future containing the result of the ModifyAccount operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - ResourceUnavailableException The specified resource is not available.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyAccount
* @see AWS API
* Documentation
*/
default CompletableFuture modifyAccount(Consumer modifyAccountRequest) {
return modifyAccount(ModifyAccountRequest.builder().applyMutation(modifyAccountRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyClientProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyClientProperties(
ModifyClientPropertiesRequest modifyClientPropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the properties of the specified Amazon WorkSpaces clients.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyClientPropertiesRequest.Builder} avoiding the
* need to create one manually via {@link ModifyClientPropertiesRequest#builder()}
*
*
* @param modifyClientPropertiesRequest
* A {@link Consumer} that will call methods on {@link ModifyClientPropertiesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ModifyClientProperties operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyClientProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyClientProperties(
Consumer modifyClientPropertiesRequest) {
return modifyClientProperties(ModifyClientPropertiesRequest.builder().applyMutation(modifyClientPropertiesRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifySamlProperties
* @see AWS API Documentation
*/
default CompletableFuture modifySamlProperties(
ModifySamlPropertiesRequest modifySamlPropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access
* URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
*
*
*
* This is a convenience which creates an instance of the {@link ModifySamlPropertiesRequest.Builder} avoiding the
* need to create one manually via {@link ModifySamlPropertiesRequest#builder()}
*
*
* @param modifySamlPropertiesRequest
* A {@link Consumer} that will call methods on {@link ModifySamlPropertiesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ModifySamlProperties operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifySamlProperties
* @see AWS API Documentation
*/
default CompletableFuture modifySamlProperties(
Consumer modifySamlPropertiesRequest) {
return modifySamlProperties(ModifySamlPropertiesRequest.builder().applyMutation(modifySamlPropertiesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifySelfservicePermissions
* @see AWS API Documentation
*/
default CompletableFuture modifySelfservicePermissions(
ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
*
*
*
* This is a convenience which creates an instance of the {@link ModifySelfservicePermissionsRequest.Builder}
* avoiding the need to create one manually via {@link ModifySelfservicePermissionsRequest#builder()}
*
*
* @param modifySelfservicePermissionsRequest
* A {@link Consumer} that will call methods on {@link ModifySelfservicePermissionsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ModifySelfservicePermissions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifySelfservicePermissions
* @see AWS API Documentation
*/
default CompletableFuture modifySelfservicePermissions(
Consumer modifySelfservicePermissionsRequest) {
return modifySelfservicePermissions(ModifySelfservicePermissionsRequest.builder()
.applyMutation(modifySelfservicePermissionsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceAccessProperties(
ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see
*
* Control Device Access.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyWorkspaceAccessPropertiesRequest.Builder}
* avoiding the need to create one manually via {@link ModifyWorkspaceAccessPropertiesRequest#builder()}
*
*
* @param modifyWorkspaceAccessPropertiesRequest
* A {@link Consumer} that will call methods on {@link ModifyWorkspaceAccessPropertiesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ModifyWorkspaceAccessProperties operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceAccessProperties(
Consumer modifyWorkspaceAccessPropertiesRequest) {
return modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest.builder()
.applyMutation(modifyWorkspaceAccessPropertiesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceCreationProperties(
ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modify the default properties used to create WorkSpaces.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyWorkspaceCreationPropertiesRequest.Builder}
* avoiding the need to create one manually via {@link ModifyWorkspaceCreationPropertiesRequest#builder()}
*
*
* @param modifyWorkspaceCreationPropertiesRequest
* A {@link Consumer} that will call methods on {@link ModifyWorkspaceCreationPropertiesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ModifyWorkspaceCreationProperties operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceCreationProperties(
Consumer modifyWorkspaceCreationPropertiesRequest) {
return modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest.builder()
.applyMutation(modifyWorkspaceCreationPropertiesRequest).build());
}
/**
*
* Modifies the specified WorkSpace properties. For important information about how to modify the size of the root
* and user volumes, see
* Modify a WorkSpace.
*
*
* @param modifyWorkspacePropertiesRequest
* @return A Java Future containing the result of the ModifyWorkspaceProperties operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationInProgressException The properties of this WorkSpace are currently being modified. Try again
* in a moment.
* - UnsupportedWorkspaceConfigurationException The configuration of this WorkSpace is not supported for
* this operation. For more information, see Required
* Configuration and Service Components for WorkSpaces .
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceProperties(
ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the specified WorkSpace properties. For important information about how to modify the size of the root
* and user volumes, see
* Modify a WorkSpace.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyWorkspacePropertiesRequest.Builder} avoiding
* the need to create one manually via {@link ModifyWorkspacePropertiesRequest#builder()}
*
*
* @param modifyWorkspacePropertiesRequest
* A {@link Consumer} that will call methods on {@link ModifyWorkspacePropertiesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ModifyWorkspaceProperties operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationInProgressException The properties of this WorkSpace are currently being modified. Try again
* in a moment.
* - UnsupportedWorkspaceConfigurationException The configuration of this WorkSpace is not supported for
* this operation. For more information, see Required
* Configuration and Service Components for WorkSpaces .
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceProperties(
Consumer modifyWorkspacePropertiesRequest) {
return modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest.builder()
.applyMutation(modifyWorkspacePropertiesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceState
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceState(
ModifyWorkspaceStateRequest modifyWorkspaceStateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the state of the specified WorkSpace.
*
*
* To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE.
* WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop
* WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
* state.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyWorkspaceStateRequest.Builder} avoiding the
* need to create one manually via {@link ModifyWorkspaceStateRequest#builder()}
*
*
* @param modifyWorkspaceStateRequest
* A {@link Consumer} that will call methods on {@link ModifyWorkspaceStateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ModifyWorkspaceState operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - ResourceNotFoundException The resource could not be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.ModifyWorkspaceState
* @see AWS API Documentation
*/
default CompletableFuture modifyWorkspaceState(
Consumer modifyWorkspaceStateRequest) {
return modifyWorkspaceState(ModifyWorkspaceStateRequest.builder().applyMutation(modifyWorkspaceStateRequest).build());
}
/**
*
* Reboots the specified WorkSpaces.
*
*
* You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
*
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RebootWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Reboots the specified WorkSpaces.
*
*
* You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
*
*
* This operation is asynchronous and returns before the WorkSpaces have rebooted.
*
*
*
* This is a convenience which creates an instance of the {@link RebootWorkspacesRequest.Builder} avoiding the need
* to create one manually via {@link RebootWorkspacesRequest#builder()}
*
*
* @param rebootWorkspacesRequest
* A {@link Consumer} that will call methods on {@link RebootWorkspacesRequest.Builder} to create a request.
* @return A Java Future containing the result of the RebootWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RebootWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture rebootWorkspaces(
Consumer rebootWorkspacesRequest) {
return rebootWorkspaces(RebootWorkspacesRequest.builder().applyMutation(rebootWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RebuildWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Rebuilds the specified WorkSpace.
*
*
* You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR,
* UNHEALTHY, STOPPED, or REBOOTING.
*
*
* Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more
* information, see Rebuild
* a WorkSpace.
*
*
* This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
*
*
*
* This is a convenience which creates an instance of the {@link RebuildWorkspacesRequest.Builder} avoiding the need
* to create one manually via {@link RebuildWorkspacesRequest#builder()}
*
*
* @param rebuildWorkspacesRequest
* A {@link Consumer} that will call methods on {@link RebuildWorkspacesRequest.Builder} to create a request.
* @return A Java Future containing the result of the RebuildWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RebuildWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture rebuildWorkspaces(
Consumer rebuildWorkspacesRequest) {
return rebuildWorkspaces(RebuildWorkspacesRequest.builder().applyMutation(rebuildWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - AccessDeniedException The user is not authorized to access a resource.
* - WorkspacesDefaultRoleNotFoundException The workspaces_DefaultRole role could not be found. If this is
* the first time you are registering a directory, you will need to create the workspaces_DefaultRole role
* before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - UnsupportedNetworkConfigurationException The configuration of this network is not supported for this
* operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP
* range. For more information, see Configure a
* VPC for Amazon WorkSpaces.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
default CompletableFuture registerWorkspaceDirectory(
RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is
* registered. If this is the first time you are registering a directory, you will need to create the
* workspaces_DefaultRole role before you can register a directory. For more information, see
* Creating the workspaces_DefaultRole Role.
*
*
*
* This is a convenience which creates an instance of the {@link RegisterWorkspaceDirectoryRequest.Builder} avoiding
* the need to create one manually via {@link RegisterWorkspaceDirectoryRequest#builder()}
*
*
* @param registerWorkspaceDirectoryRequest
* A {@link Consumer} that will call methods on {@link RegisterWorkspaceDirectoryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RegisterWorkspaceDirectory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - AccessDeniedException The user is not authorized to access a resource.
* - WorkspacesDefaultRoleNotFoundException The workspaces_DefaultRole role could not be found. If this is
* the first time you are registering a directory, you will need to create the workspaces_DefaultRole role
* before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - UnsupportedNetworkConfigurationException The configuration of this network is not supported for this
* operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP
* range. For more information, see Configure a
* VPC for Amazon WorkSpaces.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
default CompletableFuture registerWorkspaceDirectory(
Consumer registerWorkspaceDirectoryRequest) {
return registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest.builder()
.applyMutation(registerWorkspaceDirectoryRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RestoreWorkspace
* @see AWS
* API Documentation
*/
default CompletableFuture restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Restores the specified WorkSpace to its last known healthy state.
*
*
* You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
* UNHEALTHY, or STOPPED.
*
*
* Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more
* information, see Restore a WorkSpace.
*
*
* This operation is asynchronous and returns before the WorkSpace is completely restored.
*
*
*
* This is a convenience which creates an instance of the {@link RestoreWorkspaceRequest.Builder} avoiding the need
* to create one manually via {@link RestoreWorkspaceRequest#builder()}
*
*
* @param restoreWorkspaceRequest
* A {@link Consumer} that will call methods on {@link RestoreWorkspaceRequest.Builder} to create a request.
* @return A Java Future containing the result of the RestoreWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RestoreWorkspace
* @see AWS
* API Documentation
*/
default CompletableFuture restoreWorkspace(
Consumer restoreWorkspaceRequest) {
return restoreWorkspace(RestoreWorkspaceRequest.builder().applyMutation(restoreWorkspaceRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RevokeIpRules
* @see AWS API
* Documentation
*/
default CompletableFuture revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more rules from the specified IP access control group.
*
*
*
* This is a convenience which creates an instance of the {@link RevokeIpRulesRequest.Builder} avoiding the need to
* create one manually via {@link RevokeIpRulesRequest#builder()}
*
*
* @param revokeIpRulesRequest
* A {@link Consumer} that will call methods on {@link RevokeIpRulesRequest.Builder} to create a request.
* @return A Java Future containing the result of the RevokeIpRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.RevokeIpRules
* @see AWS API
* Documentation
*/
default CompletableFuture revokeIpRules(Consumer revokeIpRulesRequest) {
return revokeIpRules(RevokeIpRulesRequest.builder().applyMutation(revokeIpRulesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.StartWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts the specified WorkSpaces.
*
*
* You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
* STOPPED.
*
*
*
* This is a convenience which creates an instance of the {@link StartWorkspacesRequest.Builder} avoiding the need
* to create one manually via {@link StartWorkspacesRequest#builder()}
*
*
* @param startWorkspacesRequest
* A {@link Consumer} that will call methods on {@link StartWorkspacesRequest.Builder} to create a request.
* @return A Java Future containing the result of the StartWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.StartWorkspaces
* @see AWS
* API Documentation
*/
default CompletableFuture startWorkspaces(
Consumer startWorkspacesRequest) {
return startWorkspaces(StartWorkspacesRequest.builder().applyMutation(startWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.StopWorkspaces
* @see AWS API
* Documentation
*/
default CompletableFuture stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops the specified WorkSpaces.
*
*
* You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of
* AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
*
*
*
* This is a convenience which creates an instance of the {@link StopWorkspacesRequest.Builder} avoiding the need to
* create one manually via {@link StopWorkspacesRequest#builder()}
*
*
* @param stopWorkspacesRequest
* A {@link Consumer} that will call methods on {@link StopWorkspacesRequest.Builder} to create a request.
* @return A Java Future containing the result of the StopWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.StopWorkspaces
* @see AWS API
* Documentation
*/
default CompletableFuture stopWorkspaces(Consumer stopWorkspacesRequest) {
return stopWorkspaces(StopWorkspacesRequest.builder().applyMutation(stopWorkspacesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.TerminateWorkspaces
* @see AWS API Documentation
*/
default CompletableFuture terminateWorkspaces(
TerminateWorkspacesRequest terminateWorkspacesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Terminates the specified WorkSpaces.
*
*
*
* Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to
* archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
*
*
*
* You can terminate a WorkSpace that is in any state except SUSPENDED.
*
*
* This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a
* WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
* directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
* check for the WorkSpace ID by using DescribeWorkSpaces. If
* the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
*
*
*
* Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no
* WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will
* be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per
* the Directory Service pricing terms.
*
*
* To delete empty directories, see Delete the
* Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create
* a new one when you want to start using WorkSpaces again.
*
*
*
* This is a convenience which creates an instance of the {@link TerminateWorkspacesRequest.Builder} avoiding the
* need to create one manually via {@link TerminateWorkspacesRequest#builder()}
*
*
* @param terminateWorkspacesRequest
* A {@link Consumer} that will call methods on {@link TerminateWorkspacesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TerminateWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.TerminateWorkspaces
* @see AWS API Documentation
*/
default CompletableFuture terminateWorkspaces(
Consumer terminateWorkspacesRequest) {
return terminateWorkspaces(TerminateWorkspacesRequest.builder().applyMutation(terminateWorkspacesRequest).build());
}
/**
*
* Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect
* client add-in.
*
*
* @param updateConnectClientAddInRequest
* @return A Java Future containing the result of the UpdateConnectClientAddIn operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture updateConnectClientAddIn(
UpdateConnectClientAddInRequest updateConnectClientAddInRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect
* client add-in.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateConnectClientAddInRequest.Builder} avoiding
* the need to create one manually via {@link UpdateConnectClientAddInRequest#builder()}
*
*
* @param updateConnectClientAddInRequest
* A {@link Consumer} that will call methods on {@link UpdateConnectClientAddInRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateConnectClientAddIn operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateConnectClientAddIn
* @see AWS API Documentation
*/
default CompletableFuture updateConnectClientAddIn(
Consumer updateConnectClientAddInRequest) {
return updateConnectClientAddIn(UpdateConnectClientAddInRequest.builder().applyMutation(updateConnectClientAddInRequest)
.build());
}
/**
*
* Shares or unshares a connection alias with one account by specifying whether that account has permission to
* associate the connection alias with a directory. If the association permission is granted, the connection alias
* is shared with that account. If the association permission is revoked, the connection alias is unshared with the
* account. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* -
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
* -
*
* To delete a connection alias that has been shared, the shared account must first disassociate the connection
* alias from any directories it has been associated with. Then you must unshare the connection alias from the
* account it has been shared with. You can delete a connection alias only after it is no longer shared with any
* accounts or associated with any directories.
*
*
*
*
*
* @param updateConnectionAliasPermissionRequest
* @return A Java Future containing the result of the UpdateConnectionAliasPermission operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateConnectionAliasPermission
* @see AWS API Documentation
*/
default CompletableFuture updateConnectionAliasPermission(
UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Shares or unshares a connection alias with one account by specifying whether that account has permission to
* associate the connection alias with a directory. If the association permission is granted, the connection alias
* is shared with that account. If the association permission is revoked, the connection alias is unshared with the
* account. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* -
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
* -
*
* To delete a connection alias that has been shared, the shared account must first disassociate the connection
* alias from any directories it has been associated with. Then you must unshare the connection alias from the
* account it has been shared with. You can delete a connection alias only after it is no longer shared with any
* accounts or associated with any directories.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link UpdateConnectionAliasPermissionRequest.Builder}
* avoiding the need to create one manually via {@link UpdateConnectionAliasPermissionRequest#builder()}
*
*
* @param updateConnectionAliasPermissionRequest
* A {@link Consumer} that will call methods on {@link UpdateConnectionAliasPermissionRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the UpdateConnectionAliasPermission operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - ResourceNotFoundException The resource could not be found.
* - ResourceAssociatedException The resource is associated with a directory.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateConnectionAliasPermission
* @see AWS API Documentation
*/
default CompletableFuture updateConnectionAliasPermission(
Consumer updateConnectionAliasPermissionRequest) {
return updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest.builder()
.applyMutation(updateConnectionAliasPermissionRequest).build());
}
/**
*
* Replaces the current rules of the specified IP access control group with the specified rules.
*
*
* @param updateRulesOfIpGroupRequest
* @return A Java Future containing the result of the UpdateRulesOfIpGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateRulesOfIpGroup
* @see AWS API Documentation
*/
default CompletableFuture updateRulesOfIpGroup(
UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Replaces the current rules of the specified IP access control group with the specified rules.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRulesOfIpGroupRequest.Builder} avoiding the
* need to create one manually via {@link UpdateRulesOfIpGroupRequest#builder()}
*
*
* @param updateRulesOfIpGroupRequest
* A {@link Consumer} that will call methods on {@link UpdateRulesOfIpGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateRulesOfIpGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceLimitExceededException Your resource limits have been exceeded.
* - InvalidResourceStateException The state of the resource is not valid for this operation.
* - AccessDeniedException The user is not authorized to access a resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateRulesOfIpGroup
* @see AWS API Documentation
*/
default CompletableFuture updateRulesOfIpGroup(
Consumer updateRulesOfIpGroupRequest) {
return updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest.builder().applyMutation(updateRulesOfIpGroupRequest).build());
}
/**
*
* Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom
* WorkSpaces Bundle.
*
*
*
* Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update
* existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or
* delete and recreate them.
*
*
*
* @param updateWorkspaceBundleRequest
* @return A Java Future containing the result of the UpdateWorkspaceBundle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture updateWorkspaceBundle(
UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom
* WorkSpaces Bundle.
*
*
*
* Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update
* existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or
* delete and recreate them.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateWorkspaceBundleRequest.Builder} avoiding the
* need to create one manually via {@link UpdateWorkspaceBundleRequest#builder()}
*
*
* @param updateWorkspaceBundleRequest
* A {@link Consumer} that will call methods on {@link UpdateWorkspaceBundleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateWorkspaceBundle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateWorkspaceBundle
* @see AWS API Documentation
*/
default CompletableFuture updateWorkspaceBundle(
Consumer updateWorkspaceBundleRequest) {
return updateWorkspaceBundle(UpdateWorkspaceBundleRequest.builder().applyMutation(updateWorkspaceBundleRequest).build());
}
/**
*
* Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that
* account has permission to copy the image. If the copy image permission is granted, the image is shared with that
* account. If the copy image permission is revoked, the image is unshared with the account.
*
*
* After an image has been shared, the recipient account can copy the image to other Regions as needed.
*
*
* In the China (Ningxia) Region, you can copy images only within the same Region.
*
*
* In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services
* Support.
*
*
* For more information about sharing images, see Share or Unshare a
* Custom WorkSpaces Image.
*
*
*
* -
*
* To delete an image that has been shared, you must unshare the image before you delete it.
*
*
* -
*
* Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in
* Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US),
* contact Amazon Web Services Support.
*
*
*
*
*
* @param updateWorkspaceImagePermissionRequest
* @return A Java Future containing the result of the UpdateWorkspaceImagePermission operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateWorkspaceImagePermission
* @see AWS API Documentation
*/
default CompletableFuture updateWorkspaceImagePermission(
UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that
* account has permission to copy the image. If the copy image permission is granted, the image is shared with that
* account. If the copy image permission is revoked, the image is unshared with the account.
*
*
* After an image has been shared, the recipient account can copy the image to other Regions as needed.
*
*
* In the China (Ningxia) Region, you can copy images only within the same Region.
*
*
* In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services
* Support.
*
*
* For more information about sharing images, see Share or Unshare a
* Custom WorkSpaces Image.
*
*
*
* -
*
* To delete an image that has been shared, you must unshare the image before you delete it.
*
*
* -
*
* Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in
* Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US),
* contact Amazon Web Services Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link UpdateWorkspaceImagePermissionRequest.Builder}
* avoiding the need to create one manually via {@link UpdateWorkspaceImagePermissionRequest#builder()}
*
*
* @param updateWorkspaceImagePermissionRequest
* A {@link Consumer} that will call methods on {@link UpdateWorkspaceImagePermissionRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the UpdateWorkspaceImagePermission operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The resource could not be found.
* - ResourceUnavailableException The specified resource is not available.
* - AccessDeniedException The user is not authorized to access a resource.
* - InvalidParameterValuesException One or more parameter values are not valid.
* - OperationNotSupportedException This operation is not supported.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkSpacesAsyncClient.UpdateWorkspaceImagePermission
* @see AWS API Documentation
*/
default CompletableFuture updateWorkspaceImagePermission(
Consumer updateWorkspaceImagePermissionRequest) {
return updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest.builder()
.applyMutation(updateWorkspaceImagePermissionRequest).build());
}
}