software.amazon.awssdk.services.workspaces.WorkSpacesClient 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.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.workspaces.model.AccessDeniedException;
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.InvalidParameterValuesException;
import software.amazon.awssdk.services.workspaces.model.InvalidResourceStateException;
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.OperationInProgressException;
import software.amazon.awssdk.services.workspaces.model.OperationNotSupportedException;
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.ResourceAlreadyExistsException;
import software.amazon.awssdk.services.workspaces.model.ResourceAssociatedException;
import software.amazon.awssdk.services.workspaces.model.ResourceCreationFailedException;
import software.amazon.awssdk.services.workspaces.model.ResourceLimitExceededException;
import software.amazon.awssdk.services.workspaces.model.ResourceNotFoundException;
import software.amazon.awssdk.services.workspaces.model.ResourceUnavailableException;
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.UnsupportedNetworkConfigurationException;
import software.amazon.awssdk.services.workspaces.model.UnsupportedWorkspaceConfigurationException;
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.model.WorkSpacesException;
import software.amazon.awssdk.services.workspaces.model.WorkspacesDefaultRoleNotFoundException;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable;
import software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable;
/**
* Service client for accessing Amazon WorkSpaces. 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 WorkSpacesClient 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 WorkSpacesClient} 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 WorkSpacesClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link WorkSpacesClient}.
*/
static WorkSpacesClientBuilder builder() {
return new DefaultWorkSpacesClientBuilder();
}
/**
*
* 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 Result of the AssociateConnectionAlias operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AssociateConnectionAlias
* @see AWS API Documentation
*/
default AssociateConnectionAliasResponse associateConnectionAlias(
AssociateConnectionAliasRequest associateConnectionAliasRequest) throws ResourceAssociatedException,
AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the AssociateConnectionAlias operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AssociateConnectionAlias
* @see AWS API Documentation
*/
default AssociateConnectionAliasResponse associateConnectionAlias(
Consumer associateConnectionAliasRequest)
throws ResourceAssociatedException, AccessDeniedException, ResourceNotFoundException,
InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
return associateConnectionAlias(AssociateConnectionAliasRequest.builder().applyMutation(associateConnectionAliasRequest)
.build());
}
/**
*
* Associates the specified IP access control group with the specified directory.
*
*
* @param associateIpGroupsRequest
* @return Result of the AssociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AssociateIpGroups
* @see AWS
* API Documentation
*/
default AssociateIpGroupsResponse associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the AssociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AssociateIpGroups
* @see AWS
* API Documentation
*/
default AssociateIpGroupsResponse associateIpGroups(Consumer associateIpGroupsRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the AuthorizeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AuthorizeIpRules
* @see AWS
* API Documentation
*/
default AuthorizeIpRulesResponse authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the AuthorizeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.AuthorizeIpRules
* @see AWS
* API Documentation
*/
default AuthorizeIpRulesResponse authorizeIpRules(Consumer authorizeIpRulesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CopyWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
default CopyWorkspaceImageResponse copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)
throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException,
ResourceUnavailableException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CopyWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
default CopyWorkspaceImageResponse copyWorkspaceImage(Consumer copyWorkspaceImageRequest)
throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException,
ResourceUnavailableException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateConnectClientAddIn
* @see AWS API Documentation
*/
default CreateConnectClientAddInResponse createConnectClientAddIn(
CreateConnectClientAddInRequest createConnectClientAddInRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, ResourceCreationFailedException, ResourceAlreadyExistsException, AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateConnectClientAddIn
* @see AWS API Documentation
*/
default CreateConnectClientAddInResponse createConnectClientAddIn(
Consumer createConnectClientAddInRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceCreationFailedException,
ResourceAlreadyExistsException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateConnectionAlias operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateConnectionAlias
* @see AWS API Documentation
*/
default CreateConnectionAliasResponse createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)
throws ResourceAlreadyExistsException, AccessDeniedException, InvalidParameterValuesException,
ResourceLimitExceededException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the CreateConnectionAlias operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateConnectionAlias
* @see AWS API Documentation
*/
default CreateConnectionAliasResponse createConnectionAlias(
Consumer createConnectionAliasRequest) throws ResourceAlreadyExistsException,
AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException,
InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the CreateIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateIpGroup
* @see AWS API
* Documentation
*/
default CreateIpGroupResponse createIpGroup(CreateIpGroupRequest createIpGroupRequest)
throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException,
ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateIpGroup
* @see AWS API
* Documentation
*/
default CreateIpGroupResponse createIpGroup(Consumer createIpGroupRequest)
throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException,
ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
return createIpGroup(CreateIpGroupRequest.builder().applyMutation(createIpGroupRequest).build());
}
/**
*
* Creates the specified tags for the specified WorkSpaces resource.
*
*
* @param createTagsRequest
* @return Result of the CreateTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateTags
* @see AWS API
* Documentation
*/
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws ResourceNotFoundException,
InvalidParameterValuesException, ResourceLimitExceededException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the CreateTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateTags
* @see AWS API
* Documentation
*/
default CreateTagsResponse createTags(Consumer createTagsRequest)
throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateUpdatedWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
default CreateUpdatedWorkspaceImageResponse createUpdatedWorkspaceImage(
CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest) throws ResourceLimitExceededException,
ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException,
InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the CreateUpdatedWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
default CreateUpdatedWorkspaceImageResponse createUpdatedWorkspaceImage(
Consumer createUpdatedWorkspaceImageRequest)
throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException,
OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException,
InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateWorkspaceBundle operation returned by the service.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaceBundle
* @see AWS API Documentation
*/
default CreateWorkspaceBundleResponse createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)
throws ResourceUnavailableException, ResourceAlreadyExistsException, ResourceLimitExceededException,
InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the CreateWorkspaceBundle operation returned by the service.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaceBundle
* @see AWS API Documentation
*/
default CreateWorkspaceBundleResponse createWorkspaceBundle(
Consumer createWorkspaceBundleRequest) throws ResourceUnavailableException,
ResourceAlreadyExistsException, ResourceLimitExceededException, InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
return createWorkspaceBundle(CreateWorkspaceBundleRequest.builder().applyMutation(createWorkspaceBundleRequest).build());
}
/**
*
* Creates a new WorkSpace image from an existing WorkSpace.
*
*
* @param createWorkspaceImageRequest
* @return Result of the CreateWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaceImage
* @see AWS API Documentation
*/
default CreateWorkspaceImageResponse createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest)
throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException,
OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException,
InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the CreateWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaceImage
* @see AWS API Documentation
*/
default CreateWorkspaceImageResponse createWorkspaceImage(
Consumer createWorkspaceImageRequest) throws ResourceLimitExceededException,
ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException,
InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the CreateWorkspaces operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaces
* @see AWS
* API Documentation
*/
default CreateWorkspacesResponse createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the CreateWorkspaces operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.CreateWorkspaces
* @see AWS
* API Documentation
*/
default CreateWorkspacesResponse createWorkspaces(Consumer createWorkspacesRequest)
throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DeleteClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteClientBranding
* @see AWS API Documentation
*/
default DeleteClientBrandingResponse deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DeleteClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteClientBranding
* @see AWS API Documentation
*/
default DeleteClientBrandingResponse deleteClientBranding(
Consumer deleteClientBrandingRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
return deleteClientBranding(DeleteClientBrandingRequest.builder().applyMutation(deleteClientBrandingRequest).build());
}
/**
*
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
*
*
* @param deleteConnectClientAddInRequest
* @return Result of the DeleteConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
default DeleteConnectClientAddInResponse deleteConnectClientAddIn(
DeleteConnectClientAddInRequest deleteConnectClientAddInRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeleteConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
default DeleteConnectClientAddInResponse deleteConnectClientAddIn(
Consumer deleteConnectClientAddInRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DeleteConnectionAlias operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteConnectionAlias
* @see AWS API Documentation
*/
default DeleteConnectionAliasResponse deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)
throws ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException,
InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DeleteConnectionAlias operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteConnectionAlias
* @see AWS API Documentation
*/
default DeleteConnectionAliasResponse deleteConnectionAlias(
Consumer deleteConnectionAliasRequest) throws ResourceNotFoundException,
ResourceAssociatedException, AccessDeniedException, InvalidParameterValuesException, InvalidResourceStateException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeleteIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteIpGroup
* @see AWS API
* Documentation
*/
default DeleteIpGroupResponse deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeleteIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteIpGroup
* @see AWS API
* Documentation
*/
default DeleteIpGroupResponse deleteIpGroup(Consumer deleteIpGroupRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
return deleteIpGroup(DeleteIpGroupRequest.builder().applyMutation(deleteIpGroupRequest).build());
}
/**
*
* Deletes the specified tags from the specified WorkSpaces resource.
*
*
* @param deleteTagsRequest
* @return Result of the DeleteTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteTags
* @see AWS API
* Documentation
*/
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException,
InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeleteTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteTags
* @see AWS API
* Documentation
*/
default DeleteTagsResponse deleteTags(Consumer deleteTagsRequest)
throws ResourceNotFoundException, InvalidParameterValuesException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DeleteWorkspaceBundle operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
default DeleteWorkspaceBundleResponse deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeleteWorkspaceBundle operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
default DeleteWorkspaceBundleResponse deleteWorkspaceBundle(
Consumer deleteWorkspaceBundleRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DeleteWorkspaceImage operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteWorkspaceImage
* @see AWS API Documentation
*/
default DeleteWorkspaceImageResponse deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
throws ResourceAssociatedException, InvalidResourceStateException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DeleteWorkspaceImage operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeleteWorkspaceImage
* @see AWS API Documentation
*/
default DeleteWorkspaceImageResponse deleteWorkspaceImage(
Consumer deleteWorkspaceImageRequest) throws ResourceAssociatedException,
InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeregisterWorkspaceDirectory operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
default DeregisterWorkspaceDirectoryResponse deregisterWorkspaceDirectory(
DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest) throws AccessDeniedException,
InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException,
InvalidResourceStateException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DeregisterWorkspaceDirectory operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
default DeregisterWorkspaceDirectoryResponse deregisterWorkspaceDirectory(
Consumer deregisterWorkspaceDirectoryRequest)
throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException,
ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DescribeAccount operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeAccount
* @see AWS
* API Documentation
*/
default DescribeAccountResponse describeAccount(DescribeAccountRequest describeAccountRequest) throws AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeAccount operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeAccount
* @see AWS
* API Documentation
*/
default DescribeAccountResponse describeAccount(Consumer describeAccountRequest)
throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeAccountModifications operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeAccountModifications
* @see AWS API Documentation
*/
default DescribeAccountModificationsResponse describeAccountModifications(
DescribeAccountModificationsRequest describeAccountModificationsRequest) throws AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeAccountModifications operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeAccountModifications
* @see AWS API Documentation
*/
default DescribeAccountModificationsResponse describeAccountModifications(
Consumer describeAccountModificationsRequest)
throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeClientBranding
* @see AWS API Documentation
*/
default DescribeClientBrandingResponse describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DescribeClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeClientBranding
* @see AWS API Documentation
*/
default DescribeClientBrandingResponse describeClientBranding(
Consumer describeClientBrandingRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
return describeClientBranding(DescribeClientBrandingRequest.builder().applyMutation(describeClientBrandingRequest)
.build());
}
/**
*
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*
*
* @param describeClientPropertiesRequest
* @return Result of the DescribeClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeClientProperties
* @see AWS API Documentation
*/
default DescribeClientPropertiesResponse describeClientProperties(
DescribeClientPropertiesRequest describeClientPropertiesRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeClientProperties
* @see AWS API Documentation
*/
default DescribeClientPropertiesResponse describeClientProperties(
Consumer describeClientPropertiesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
return describeClientProperties(DescribeClientPropertiesRequest.builder().applyMutation(describeClientPropertiesRequest)
.build());
}
/**
*
* Retrieves a list of Amazon Connect client add-ins that have been created.
*
*
* @param describeConnectClientAddInsRequest
* @return Result of the DescribeConnectClientAddIns operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
default DescribeConnectClientAddInsResponse describeConnectClientAddIns(
DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeConnectClientAddIns operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
default DescribeConnectClientAddInsResponse describeConnectClientAddIns(
Consumer describeConnectClientAddInsRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DescribeConnectionAliasPermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
default DescribeConnectionAliasPermissionsResponse describeConnectionAliasPermissions(
DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest) throws AccessDeniedException,
InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the DescribeConnectionAliasPermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
default DescribeConnectionAliasPermissionsResponse describeConnectionAliasPermissions(
Consumer describeConnectionAliasPermissionsRequest)
throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeConnectionAliases operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectionAliases
* @see AWS API Documentation
*/
default DescribeConnectionAliasesResponse describeConnectionAliases(
DescribeConnectionAliasesRequest describeConnectionAliasesRequest) throws AccessDeniedException,
InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DescribeConnectionAliases operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeConnectionAliases
* @see AWS API Documentation
*/
default DescribeConnectionAliasesResponse describeConnectionAliases(
Consumer describeConnectionAliasesRequest) throws AccessDeniedException,
InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
return describeConnectionAliases(DescribeConnectionAliasesRequest.builder()
.applyMutation(describeConnectionAliasesRequest).build());
}
/**
*
* Describes one or more of your IP access control groups.
*
*
* @return Result of the DescribeIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeIpGroups
* @see #describeIpGroups(DescribeIpGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeIpGroupsResponse describeIpGroups() throws InvalidParameterValuesException, AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
return describeIpGroups(DescribeIpGroupsRequest.builder().build());
}
/**
*
* Describes one or more of your IP access control groups.
*
*
* @param describeIpGroupsRequest
* @return Result of the DescribeIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeIpGroups
* @see AWS
* API Documentation
*/
default DescribeIpGroupsResponse describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DescribeIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeIpGroups
* @see AWS
* API Documentation
*/
default DescribeIpGroupsResponse describeIpGroups(Consumer describeIpGroupsRequest)
throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException,
WorkSpacesException {
return describeIpGroups(DescribeIpGroupsRequest.builder().applyMutation(describeIpGroupsRequest).build());
}
/**
*
* Describes the specified tags for the specified WorkSpaces resource.
*
*
* @param describeTagsRequest
* @return Result of the DescribeTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeTags
* @see AWS API
* Documentation
*/
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeTags
* @see AWS API
* Documentation
*/
default DescribeTagsResponse describeTags(Consumer describeTagsRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException {
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.
*
*
* @return Result of the DescribeWorkspaceBundles operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see #describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles() throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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.
*
*
* @param describeWorkspaceBundlesRequest
* @return Result of the DescribeWorkspaceBundles operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(
DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceBundles operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(
Consumer describeWorkspaceBundlesRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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.
*
*
*
* This is a variant of
* {@link #describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client
* .describeWorkspaceBundlesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see #describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest)
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator() throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client
* .describeWorkspaceBundlesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(
DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client
* .describeWorkspaceBundlesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(
Consumer describeWorkspaceBundlesRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest.builder()
.applyMutation(describeWorkspaceBundlesRequest).build());
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @return Result of the DescribeWorkspaceDirectories operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see #describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories() throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest.builder().build());
}
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @param describeWorkspaceDirectoriesRequest
* @return Result of the DescribeWorkspaceDirectories operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceDirectories operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(
Consumer describeWorkspaceDirectoriesRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest.builder()
.applyMutation(describeWorkspaceDirectoriesRequest).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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client
* .describeWorkspaceDirectoriesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see #describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest)
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator() throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client
* .describeWorkspaceDirectoriesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client
* .describeWorkspaceDirectoriesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(
Consumer describeWorkspaceDirectoriesRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
default DescribeWorkspaceImagePermissionsResponse describeWorkspaceImagePermissions(
DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest) throws ResourceNotFoundException,
AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
default DescribeWorkspaceImagePermissionsResponse describeWorkspaceImagePermissions(
Consumer describeWorkspaceImagePermissionsRequest)
throws ResourceNotFoundException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException,
SdkClientException, WorkSpacesException {
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.
*
*
* @return Result of the DescribeWorkspaceImages operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceImages
* @see #describeWorkspaceImages(DescribeWorkspaceImagesRequest)
* @see AWS API Documentation
*/
default DescribeWorkspaceImagesResponse describeWorkspaceImages() throws AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
return describeWorkspaceImages(DescribeWorkspaceImagesRequest.builder().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 Result of the DescribeWorkspaceImages operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceImages
* @see AWS API Documentation
*/
default DescribeWorkspaceImagesResponse describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceImages operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceImages
* @see AWS API Documentation
*/
default DescribeWorkspaceImagesResponse describeWorkspaceImages(
Consumer describeWorkspaceImagesRequest) throws AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspaceImages(DescribeWorkspaceImagesRequest.builder().applyMutation(describeWorkspaceImagesRequest)
.build());
}
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
* @param describeWorkspaceSnapshotsRequest
* @return Result of the DescribeWorkspaceSnapshots operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
default DescribeWorkspaceSnapshotsResponse describeWorkspaceSnapshots(
DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspaceSnapshots operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
default DescribeWorkspaceSnapshotsResponse describeWorkspaceSnapshots(
Consumer describeWorkspaceSnapshotsRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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.
*
*
* @return Result of the DescribeWorkspaces operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see #describeWorkspaces(DescribeWorkspacesRequest)
* @see AWS
* API Documentation
*/
default DescribeWorkspacesResponse describeWorkspaces() throws InvalidParameterValuesException, ResourceUnavailableException,
AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspaces(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.
*
*
* @param describeWorkspacesRequest
* @return Result of the DescribeWorkspaces operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesResponse describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the DescribeWorkspaces operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesResponse describeWorkspaces(Consumer describeWorkspacesRequest)
throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException,
WorkSpacesException {
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.
*
*
*
* This is a variant of
* {@link #describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client
* .describeWorkspacesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see #describeWorkspacesPaginator(DescribeWorkspacesRequest)
* @see AWS
* API Documentation
*/
default DescribeWorkspacesIterable describeWorkspacesPaginator() throws InvalidParameterValuesException,
ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client
* .describeWorkspacesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesIterable describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client
* .describeWorkspacesPaginator(request);
* for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspaces
* @see AWS
* API Documentation
*/
default DescribeWorkspacesIterable describeWorkspacesPaginator(
Consumer describeWorkspacesRequest) throws InvalidParameterValuesException,
ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspacesPaginator(DescribeWorkspacesRequest.builder().applyMutation(describeWorkspacesRequest).build());
}
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @return Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspacesConnectionStatus
* @see #describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest)
* @see AWS API Documentation
*/
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus()
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest.builder().build());
}
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @param describeWorkspacesConnectionStatusRequest
* @return Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DescribeWorkspacesConnectionStatus
* @see AWS API Documentation
*/
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(
Consumer describeWorkspacesConnectionStatusRequest)
throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
return describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest.builder()
.applyMutation(describeWorkspacesConnectionStatusRequest).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 Result of the DisassociateConnectionAlias operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DisassociateConnectionAlias
* @see AWS API Documentation
*/
default DisassociateConnectionAliasResponse disassociateConnectionAlias(
DisassociateConnectionAliasRequest disassociateConnectionAliasRequest) throws AccessDeniedException,
ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DisassociateConnectionAlias operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DisassociateConnectionAlias
* @see AWS API Documentation
*/
default DisassociateConnectionAliasResponse disassociateConnectionAlias(
Consumer disassociateConnectionAliasRequest)
throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException,
InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
return disassociateConnectionAlias(DisassociateConnectionAliasRequest.builder()
.applyMutation(disassociateConnectionAliasRequest).build());
}
/**
*
* Disassociates the specified IP access control group from the specified directory.
*
*
* @param disassociateIpGroupsRequest
* @return Result of the DisassociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DisassociateIpGroups
* @see AWS API Documentation
*/
default DisassociateIpGroupsResponse disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the DisassociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.DisassociateIpGroups
* @see AWS API Documentation
*/
default DisassociateIpGroupsResponse disassociateIpGroups(
Consumer disassociateIpGroupsRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ImportClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ImportClientBranding
* @see AWS API Documentation
*/
default ImportClientBrandingResponse importClientBranding(ImportClientBrandingRequest importClientBrandingRequest)
throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ImportClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ImportClientBranding
* @see AWS API Documentation
*/
default ImportClientBrandingResponse importClientBranding(
Consumer importClientBrandingRequest) throws InvalidParameterValuesException,
ResourceLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ImportWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ImportWorkspaceImage
* @see AWS API Documentation
*/
default ImportWorkspaceImageResponse importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException,
OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ImportWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ImportWorkspaceImage
* @see AWS API Documentation
*/
default ImportWorkspaceImageResponse importWorkspaceImage(
Consumer importWorkspaceImageRequest) throws ResourceLimitExceededException,
ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, AccessDeniedException,
InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ListAvailableManagementCidrRanges operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
default ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(
ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the ListAvailableManagementCidrRanges operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
default ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(
Consumer listAvailableManagementCidrRangesRequest)
throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the MigrateWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.MigrateWorkspace
* @see AWS
* API Documentation
*/
default MigrateWorkspaceResponse migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException,
OperationNotSupportedException, OperationInProgressException, ResourceUnavailableException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the MigrateWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.MigrateWorkspace
* @see AWS
* API Documentation
*/
default MigrateWorkspaceResponse migrateWorkspace(Consumer migrateWorkspaceRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException,
OperationNotSupportedException, OperationInProgressException, ResourceUnavailableException, AwsServiceException,
SdkClientException, WorkSpacesException {
return migrateWorkspace(MigrateWorkspaceRequest.builder().applyMutation(migrateWorkspaceRequest).build());
}
/**
*
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param modifyAccountRequest
* @return Result of the ModifyAccount operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyAccount
* @see AWS API
* Documentation
*/
default ModifyAccountResponse modifyAccount(ModifyAccountRequest modifyAccountRequest)
throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException,
ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifyAccount operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyAccount
* @see AWS API
* Documentation
*/
default ModifyAccountResponse modifyAccount(Consumer modifyAccountRequest)
throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException,
ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException {
return modifyAccount(ModifyAccountRequest.builder().applyMutation(modifyAccountRequest).build());
}
/**
*
* Modifies the properties of the specified Amazon WorkSpaces clients.
*
*
* @param modifyClientPropertiesRequest
* @return Result of the ModifyClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyClientProperties
* @see AWS API Documentation
*/
default ModifyClientPropertiesResponse modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifyClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyClientProperties
* @see AWS API Documentation
*/
default ModifyClientPropertiesResponse modifyClientProperties(
Consumer modifyClientPropertiesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifySamlProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifySamlProperties
* @see AWS API Documentation
*/
default ModifySamlPropertiesResponse modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest)
throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException,
ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifySamlProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifySamlProperties
* @see AWS API Documentation
*/
default ModifySamlPropertiesResponse modifySamlProperties(
Consumer modifySamlPropertiesRequest) throws AccessDeniedException,
InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifySelfservicePermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifySelfservicePermissions
* @see AWS API Documentation
*/
default ModifySelfservicePermissionsResponse modifySelfservicePermissions(
ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest) throws AccessDeniedException,
InvalidParameterValuesException, ResourceNotFoundException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the ModifySelfservicePermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifySelfservicePermissions
* @see AWS API Documentation
*/
default ModifySelfservicePermissionsResponse modifySelfservicePermissions(
Consumer modifySelfservicePermissionsRequest)
throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceAccessProperties operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
default ModifyWorkspaceAccessPropertiesResponse modifyWorkspaceAccessProperties(
ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest) throws ResourceNotFoundException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceAccessProperties operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
default ModifyWorkspaceAccessPropertiesResponse modifyWorkspaceAccessProperties(
Consumer modifyWorkspaceAccessPropertiesRequest)
throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
return modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest.builder()
.applyMutation(modifyWorkspaceAccessPropertiesRequest).build());
}
/**
*
* Modify the default properties used to create WorkSpaces.
*
*
* @param modifyWorkspaceCreationPropertiesRequest
* @return Result of the ModifyWorkspaceCreationProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
default ModifyWorkspaceCreationPropertiesResponse modifyWorkspaceCreationProperties(
ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest) throws AccessDeniedException,
InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceCreationProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
default ModifyWorkspaceCreationPropertiesResponse modifyWorkspaceCreationProperties(
Consumer modifyWorkspaceCreationPropertiesRequest)
throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws UnsupportedWorkspaceConfigurationException
* The configuration of this WorkSpace is not supported for this operation. For more information, see Required
* Configuration and Service Components for WorkSpaces .
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(
ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException,
InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException,
ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws UnsupportedWorkspaceConfigurationException
* The configuration of this WorkSpace is not supported for this operation. For more information, see Required
* Configuration and Service Components for WorkSpaces .
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(
Consumer modifyWorkspacePropertiesRequest)
throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException,
UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException,
ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceState operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceState
* @see AWS API Documentation
*/
default ModifyWorkspaceStateResponse modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
throws InvalidParameterValuesException, InvalidResourceStateException, ResourceNotFoundException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the ModifyWorkspaceState operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.ModifyWorkspaceState
* @see AWS API Documentation
*/
default ModifyWorkspaceStateResponse modifyWorkspaceState(
Consumer modifyWorkspaceStateRequest) throws InvalidParameterValuesException,
InvalidResourceStateException, ResourceNotFoundException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the RebootWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RebootWorkspaces
* @see AWS
* API Documentation
*/
default RebootWorkspacesResponse rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RebootWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RebootWorkspaces
* @see AWS
* API Documentation
*/
default RebootWorkspacesResponse rebootWorkspaces(Consumer rebootWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RebuildWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RebuildWorkspaces
* @see AWS
* API Documentation
*/
default RebuildWorkspacesResponse rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RebuildWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RebuildWorkspaces
* @see AWS
* API Documentation
*/
default RebuildWorkspacesResponse rebuildWorkspaces(Consumer rebuildWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RegisterWorkspaceDirectory operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws 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.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws 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.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
default RegisterWorkspaceDirectoryResponse registerWorkspaceDirectory(
RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, ResourceLimitExceededException, AccessDeniedException,
WorkspacesDefaultRoleNotFoundException, InvalidResourceStateException, UnsupportedNetworkConfigurationException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RegisterWorkspaceDirectory operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws 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.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws 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.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
default RegisterWorkspaceDirectoryResponse registerWorkspaceDirectory(
Consumer registerWorkspaceDirectoryRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
AccessDeniedException, WorkspacesDefaultRoleNotFoundException, InvalidResourceStateException,
UnsupportedNetworkConfigurationException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
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 Result of the RestoreWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RestoreWorkspace
* @see AWS
* API Documentation
*/
default RestoreWorkspaceResponse restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the RestoreWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RestoreWorkspace
* @see AWS
* API Documentation
*/
default RestoreWorkspaceResponse restoreWorkspace(Consumer restoreWorkspaceRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
return restoreWorkspace(RestoreWorkspaceRequest.builder().applyMutation(restoreWorkspaceRequest).build());
}
/**
*
* Removes one or more rules from the specified IP access control group.
*
*
* @param revokeIpRulesRequest
* @return Result of the RevokeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RevokeIpRules
* @see AWS API
* Documentation
*/
default RevokeIpRulesResponse revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the RevokeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.RevokeIpRules
* @see AWS API
* Documentation
*/
default RevokeIpRulesResponse revokeIpRules(Consumer revokeIpRulesRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException,
AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the StartWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.StartWorkspaces
* @see AWS
* API Documentation
*/
default StartWorkspacesResponse startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) throws AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the StartWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.StartWorkspaces
* @see AWS
* API Documentation
*/
default StartWorkspacesResponse startWorkspaces(Consumer startWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the StopWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.StopWorkspaces
* @see AWS API
* Documentation
*/
default StopWorkspacesResponse stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) throws AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the StopWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.StopWorkspaces
* @see AWS API
* Documentation
*/
default StopWorkspacesResponse stopWorkspaces(Consumer stopWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the TerminateWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.TerminateWorkspaces
* @see AWS API Documentation
*/
default TerminateWorkspacesResponse terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
throws AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the TerminateWorkspaces operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.TerminateWorkspaces
* @see AWS API Documentation
*/
default TerminateWorkspacesResponse terminateWorkspaces(
Consumer terminateWorkspacesRequest) throws AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the UpdateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateConnectClientAddIn
* @see AWS API Documentation
*/
default UpdateConnectClientAddInResponse updateConnectClientAddIn(
UpdateConnectClientAddInRequest updateConnectClientAddInRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateConnectClientAddIn
* @see AWS API Documentation
*/
default UpdateConnectClientAddInResponse updateConnectClientAddIn(
Consumer updateConnectClientAddInRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the UpdateConnectionAliasPermission operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateConnectionAliasPermission
* @see AWS API Documentation
*/
default UpdateConnectionAliasPermissionResponse updateConnectionAliasPermission(
UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest) throws AccessDeniedException,
InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException,
ResourceAssociatedException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the UpdateConnectionAliasPermission operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateConnectionAliasPermission
* @see AWS API Documentation
*/
default UpdateConnectionAliasPermissionResponse updateConnectionAliasPermission(
Consumer updateConnectionAliasPermissionRequest)
throws AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException,
ResourceNotFoundException, ResourceAssociatedException, InvalidResourceStateException,
OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateRulesOfIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateRulesOfIpGroup
* @see AWS API Documentation
*/
default UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException,
InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateRulesOfIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateRulesOfIpGroup
* @see AWS API Documentation
*/
default UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(
Consumer updateRulesOfIpGroupRequest) throws InvalidParameterValuesException,
ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateWorkspaceBundle operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateWorkspaceBundle
* @see AWS API Documentation
*/
default UpdateWorkspaceBundleResponse updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)
throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException,
ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateWorkspaceBundle operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateWorkspaceBundle
* @see AWS API Documentation
*/
default UpdateWorkspaceBundleResponse updateWorkspaceBundle(
Consumer updateWorkspaceBundleRequest) throws AccessDeniedException,
InvalidParameterValuesException, ResourceNotFoundException, ResourceUnavailableException, AwsServiceException,
SdkClientException, WorkSpacesException {
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 Result of the UpdateWorkspaceImagePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateWorkspaceImagePermission
* @see AWS API Documentation
*/
default UpdateWorkspaceImagePermissionResponse updateWorkspaceImagePermission(
UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest) throws ResourceNotFoundException,
ResourceUnavailableException, AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException,
AwsServiceException, SdkClientException, WorkSpacesException {
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 Result of the UpdateWorkspaceImagePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkSpacesException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkSpacesClient.UpdateWorkspaceImagePermission
* @see AWS API Documentation
*/
default UpdateWorkspaceImagePermissionResponse updateWorkspaceImagePermission(
Consumer updateWorkspaceImagePermissionRequest)
throws ResourceNotFoundException, ResourceUnavailableException, AccessDeniedException,
InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException,
WorkSpacesException {
return updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest.builder()
.applyMutation(updateWorkspaceImagePermissionRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
}