@Generated(value="software.amazon.awssdk:codegen") public interface WorkSpacesClient extends SdkClient
builder() method.
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateIpGroupsResponse |
associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
|
default AssociateIpGroupsResponse |
associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
|
default AuthorizeIpRulesResponse |
authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
|
default AuthorizeIpRulesResponse |
authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
|
static WorkSpacesClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkSpacesClient. |
static WorkSpacesClient |
create()
Create a
WorkSpacesClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateIpGroupResponse |
createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest)
Creates an IP access control group.
|
default CreateIpGroupResponse |
createIpGroup(CreateIpGroupRequest createIpGroupRequest)
Creates an IP access control group.
|
default CreateTagsResponse |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates the specified tags for the specified WorkSpace.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified WorkSpace.
|
default CreateWorkspacesResponse |
createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default CreateWorkspacesResponse |
createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default DeleteIpGroupResponse |
deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest)
Deletes the specified IP access control group.
|
default DeleteIpGroupResponse |
deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
Deletes the specified IP access control group.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from the specified WorkSpace.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpace.
|
default DeleteWorkspaceImageResponse |
deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest)
Deletes the specified image from your account.
|
default DeleteWorkspaceImageResponse |
deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
Deletes the specified image from your account.
|
default DescribeAccountResponse |
describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
|
default DescribeAccountResponse |
describeAccount(DescribeAccountRequest describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
|
default DescribeAccountModificationsResponse |
describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the
specified account.
|
default DescribeAccountModificationsResponse |
describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the
specified account.
|
default DescribeClientPropertiesResponse |
describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
default DescribeClientPropertiesResponse |
describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
default DescribeIpGroupsResponse |
describeIpGroups()
Describes one or more of your IP access control groups.
|
default DescribeIpGroupsResponse |
describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest)
Describes one or more of your IP access control groups.
|
default DescribeIpGroupsResponse |
describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
Describes one or more of your IP access control groups.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags for the specified WorkSpace.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpace.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles()
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesIterable |
describeWorkspaceBundlesPaginator()
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesIterable |
describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesIterable |
describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceDirectoriesResponse |
describeWorkspaceDirectories()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesResponse |
describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesResponse |
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesIterable |
describeWorkspaceDirectoriesPaginator()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesIterable |
describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesIterable |
describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceImagesResponse |
describeWorkspaceImages()
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default DescribeWorkspaceImagesResponse |
describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default DescribeWorkspaceImagesResponse |
describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default DescribeWorkspacesResponse |
describeWorkspaces()
Describes the specified WorkSpaces.
|
default DescribeWorkspacesResponse |
describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default DescribeWorkspacesResponse |
describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus()
Describes the connection status of the specified WorkSpaces.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
|
default DescribeWorkspacesIterable |
describeWorkspacesPaginator()
Describes the specified WorkSpaces.
|
default DescribeWorkspacesIterable |
describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default DescribeWorkspacesIterable |
describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default DisassociateIpGroupsResponse |
disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
|
default DisassociateIpGroupsResponse |
disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
|
default ImportWorkspaceImageResponse |
importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
|
default ImportWorkspaceImageResponse |
importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
|
default ListAvailableManagementCidrRangesResponse |
listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management
interface when you enable bring your own license (BYOL).
|
default ListAvailableManagementCidrRangesResponse |
listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management
interface when you enable bring your own license (BYOL).
|
default ModifyAccountResponse |
modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
|
default ModifyAccountResponse |
modifyAccount(ModifyAccountRequest modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
|
default ModifyClientPropertiesResponse |
modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
|
default ModifyClientPropertiesResponse |
modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
|
default ModifyWorkspacePropertiesResponse |
modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
|
default ModifyWorkspacePropertiesResponse |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
|
default ModifyWorkspaceStateResponse |
modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
|
default ModifyWorkspaceStateResponse |
modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
|
default RebootWorkspacesResponse |
rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default RebootWorkspacesResponse |
rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default RebuildWorkspacesResponse |
rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
|
default RebuildWorkspacesResponse |
rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
|
default RevokeIpRulesResponse |
revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
|
default RevokeIpRulesResponse |
revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
|
static ServiceMetadata |
serviceMetadata() |
default StartWorkspacesResponse |
startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default StartWorkspacesResponse |
startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default StopWorkspacesResponse |
stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default StopWorkspacesResponse |
stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default TerminateWorkspacesResponse |
terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
default TerminateWorkspacesResponse |
terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
default UpdateRulesOfIpGroupResponse |
updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
|
default UpdateRulesOfIpGroupResponse |
updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
|
serviceNameclosestatic final String SERVICE_NAME
static WorkSpacesClient create()
WorkSpacesClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkSpacesClientBuilder builder()
WorkSpacesClient.default AssociateIpGroupsResponse associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException
Associates the specified IP access control group with the specified directory.
associateIpGroupsRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.OperationNotSupportedException - This operation is not supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateIpGroupsResponse associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException
Associates the specified IP access control group with the specified directory.
This is a convenience which creates an instance of the AssociateIpGroupsRequest.Builder avoiding the need
to create one manually via AssociateIpGroupsRequest.builder()
associateIpGroupsRequest - A Consumer that will call methods on AssociateIpGroupsRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.OperationNotSupportedException - This operation is not supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AuthorizeIpRulesResponse authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
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.
authorizeIpRulesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AuthorizeIpRulesResponse authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
This is a convenience which creates an instance of the AuthorizeIpRulesRequest.Builder avoiding the need
to create one manually via AuthorizeIpRulesRequest.builder()
authorizeIpRulesRequest - A Consumer that will call methods on AuthorizeIpRulesRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIpGroupResponse createIpGroup(CreateIpGroupRequest createIpGroupRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
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.
createIpGroupRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceAlreadyExistsException - The specified resource already exists.ResourceCreationFailedException - The resource could not be created.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIpGroupResponse createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
This is a convenience which creates an instance of the CreateIpGroupRequest.Builder avoiding the need to
create one manually via CreateIpGroupRequest.builder()
createIpGroupRequest - A Consumer that will call methods on CreateIpGroupRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceAlreadyExistsException - The specified resource already exists.ResourceCreationFailedException - The resource could not be created.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException
Creates the specified tags for the specified WorkSpace.
createTagsRequest - ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException
Creates the specified tags for the specified WorkSpace.
This is a convenience which creates an instance of the CreateTagsRequest.Builder avoiding the need to
create one manually via CreateTagsRequest.builder()
createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request.ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWorkspacesResponse createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest - ResourceLimitExceededException - Your resource limits have been exceeded.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWorkspacesResponse createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
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 CreateWorkspacesRequest.Builder avoiding the need
to create one manually via CreateWorkspacesRequest.builder()
createWorkspacesRequest - A Consumer that will call methods on CreateWorkspacesRequest.Builder to create a request.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIpGroupResponse deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroupRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceAssociatedException - The resource is associated with a directory.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIpGroupResponse deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
This is a convenience which creates an instance of the DeleteIpGroupRequest.Builder avoiding the need to
create one manually via DeleteIpGroupRequest.builder()
deleteIpGroupRequest - A Consumer that will call methods on DeleteIpGroupRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceAssociatedException - The resource is associated with a directory.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified tags from the specified WorkSpace.
deleteTagsRequest - ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified tags from the specified WorkSpace.
This is a convenience which creates an instance of the DeleteTagsRequest.Builder avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWorkspaceImageResponse deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest) throws ResourceAssociatedException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image.
deleteWorkspaceImageRequest - ResourceAssociatedException - The resource is associated with a directory.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWorkspaceImageResponse deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest) throws ResourceAssociatedException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image.
This is a convenience which creates an instance of the DeleteWorkspaceImageRequest.Builder avoiding the
need to create one manually via DeleteWorkspaceImageRequest.builder()
deleteWorkspaceImageRequest - A Consumer that will call methods on DeleteWorkspaceImageRequest.Builder to create a
request.ResourceAssociatedException - The resource is associated with a directory.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountResponse describeAccount(DescribeAccountRequest describeAccountRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
describeAccountRequest - AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountResponse describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the DescribeAccountRequest.Builder avoiding the need
to create one manually via DescribeAccountRequest.builder()
describeAccountRequest - A Consumer that will call methods on DescribeAccountRequest.Builder to create a request.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountModificationsResponse describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
describeAccountModificationsRequest - AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountModificationsResponse describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the DescribeAccountModificationsRequest.Builder
avoiding the need to create one manually via DescribeAccountModificationsRequest.builder()
describeAccountModificationsRequest - A Consumer that will call methods on DescribeAccountModificationsRequest.Builder to create
a request.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeClientPropertiesResponse describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientPropertiesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeClientPropertiesResponse describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
This is a convenience which creates an instance of the DescribeClientPropertiesRequest.Builder avoiding
the need to create one manually via DescribeClientPropertiesRequest.builder()
describeClientPropertiesRequest - A Consumer that will call methods on DescribeClientPropertiesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIpGroupsResponse describeIpGroups() throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Describes one or more of your IP access control groups.
InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeIpGroups(DescribeIpGroupsRequest),
AWS
API Documentationdefault DescribeIpGroupsResponse describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Describes one or more of your IP access control groups.
describeIpGroupsRequest - InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIpGroupsResponse describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Describes one or more of your IP access control groups.
This is a convenience which creates an instance of the DescribeIpGroupsRequest.Builder avoiding the need
to create one manually via DescribeIpGroupsRequest.builder()
describeIpGroupsRequest - A Consumer that will call methods on DescribeIpGroupsRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the specified tags for the specified WorkSpace.
describeTagsRequest - ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the specified tags for the specified WorkSpace.
This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceBundlesResponse describeWorkspaceBundles() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaceBundles(DescribeWorkspaceBundlesRequest),
AWS API Documentationdefault DescribeWorkspaceBundlesResponse describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundlesRequest - InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceBundlesResponse describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
This is a convenience which creates an instance of the DescribeWorkspaceBundlesRequest.Builder avoiding
the need to create one manually via DescribeWorkspaceBundlesRequest.builder()
describeWorkspaceBundlesRequest - A Consumer that will call methods on DescribeWorkspaceBundlesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest),
AWS API Documentationdefault DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
describeWorkspaceBundlesRequest - InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
This is a convenience which creates an instance of the DescribeWorkspaceBundlesRequest.Builder avoiding
the need to create one manually via DescribeWorkspaceBundlesRequest.builder()
describeWorkspaceBundlesRequest - A Consumer that will call methods on DescribeWorkspaceBundlesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest),
AWS API Documentationdefault DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesRequest - InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
This is a convenience which creates an instance of the DescribeWorkspaceDirectoriesRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceDirectoriesRequest.builder()
describeWorkspaceDirectoriesRequest - A Consumer that will call methods on DescribeWorkspaceDirectoriesRequest.Builder to create
a request.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
This is a variant of
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest),
AWS API Documentationdefault DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
This is a variant of
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
describeWorkspaceDirectoriesRequest - InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
This is a variant of
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
This is a convenience which creates an instance of the DescribeWorkspaceDirectoriesRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceDirectoriesRequest.builder()
describeWorkspaceDirectoriesRequest - A Consumer that will call methods on DescribeWorkspaceDirectoriesRequest.Builder to create
a request.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceImagesResponse describeWorkspaceImages() throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaceImages(DescribeWorkspaceImagesRequest),
AWS API Documentationdefault DescribeWorkspaceImagesResponse describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImagesRequest - AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspaceImagesResponse describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
This is a convenience which creates an instance of the DescribeWorkspaceImagesRequest.Builder avoiding
the need to create one manually via DescribeWorkspaceImagesRequest.builder()
describeWorkspaceImagesRequest - A Consumer that will call methods on DescribeWorkspaceImagesRequest.Builder to create a
request.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesResponse describeWorkspaces() throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
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.
InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspaces(DescribeWorkspacesRequest),
AWS
API Documentationdefault DescribeWorkspacesResponse describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
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.
describeWorkspacesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesResponse describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
This is a convenience which creates an instance of the DescribeWorkspacesRequest.Builder avoiding the
need to create one manually via DescribeWorkspacesRequest.builder()
describeWorkspacesRequest - A Consumer that will call methods on DescribeWorkspacesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesIterable describeWorkspacesPaginator() throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspacesPaginator(DescribeWorkspacesRequest),
AWS
API Documentationdefault DescribeWorkspacesIterable describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
describeWorkspacesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesIterable describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
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
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
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
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
This is a convenience which creates an instance of the DescribeWorkspacesRequest.Builder avoiding the
need to create one manually via DescribeWorkspacesRequest.builder()
describeWorkspacesRequest - A Consumer that will call methods on DescribeWorkspacesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the connection status of the specified WorkSpaces.
InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest),
AWS API Documentationdefault DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatusRequest - InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException
Describes the connection status of the specified WorkSpaces.
This is a convenience which creates an instance of the DescribeWorkspacesConnectionStatusRequest.Builder
avoiding the need to create one manually via DescribeWorkspacesConnectionStatusRequest.builder()
describeWorkspacesConnectionStatusRequest - A Consumer that will call methods on DescribeWorkspacesConnectionStatusRequest.Builder to
create a request.InvalidParameterValuesException - One or more parameter values are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateIpGroupsResponse disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Disassociates the specified IP access control group from the specified directory.
disassociateIpGroupsRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateIpGroupsResponse disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Disassociates the specified IP access control group from the specified directory.
This is a convenience which creates an instance of the DisassociateIpGroupsRequest.Builder avoiding the
need to create one manually via DisassociateIpGroupsRequest.builder()
disassociateIpGroupsRequest - A Consumer that will call methods on DisassociateIpGroupsRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportWorkspaceImageResponse importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
importWorkspaceImageRequest - ResourceLimitExceededException - Your resource limits have been exceeded.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportWorkspaceImageResponse importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
This is a convenience which creates an instance of the ImportWorkspaceImageRequest.Builder avoiding the
need to create one manually via ImportWorkspaceImageRequest.builder()
importWorkspaceImageRequest - A Consumer that will call methods on ImportWorkspaceImageRequest.Builder to create a
request.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
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).
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.
listAvailableManagementCidrRangesRequest - InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
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).
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
This is a convenience which creates an instance of the ListAvailableManagementCidrRangesRequest.Builder
avoiding the need to create one manually via ListAvailableManagementCidrRangesRequest.builder()
listAvailableManagementCidrRangesRequest - A Consumer that will call methods on ListAvailableManagementCidrRangesRequest.Builder to
create a request.InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyAccountResponse modifyAccount(ModifyAccountRequest modifyAccountRequest) throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException, ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the configuration of bring your own license (BYOL) for the specified account.
modifyAccountRequest - InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.InvalidResourceStateException - The state of the resource is not valid for this operation.ResourceUnavailableException - The specified resource is not available.ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyAccountResponse modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest) throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException, ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the ModifyAccountRequest.Builder avoiding the need to
create one manually via ModifyAccountRequest.builder()
modifyAccountRequest - A Consumer that will call methods on ModifyAccountRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.InvalidResourceStateException - The state of the resource is not valid for this operation.ResourceUnavailableException - The specified resource is not available.ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClientPropertiesResponse modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the properties of the specified Amazon WorkSpaces client.
modifyClientPropertiesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyClientPropertiesResponse modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the properties of the specified Amazon WorkSpaces client.
This is a convenience which creates an instance of the ModifyClientPropertiesRequest.Builder avoiding the
need to create one manually via ModifyClientPropertiesRequest.builder()
modifyClientPropertiesRequest - A Consumer that will call methods on ModifyClientPropertiesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the specified WorkSpace properties.
modifyWorkspacePropertiesRequest - InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.UnsupportedWorkspaceConfigurationException - The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration
Guide.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException
Modifies the specified WorkSpace properties.
This is a convenience which creates an instance of the ModifyWorkspacePropertiesRequest.Builder avoiding
the need to create one manually via ModifyWorkspacePropertiesRequest.builder()
modifyWorkspacePropertiesRequest - A Consumer that will call methods on ModifyWorkspacePropertiesRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.UnsupportedWorkspaceConfigurationException - The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration
Guide.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ResourceUnavailableException - The specified resource is not available.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyWorkspaceStateResponse modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest) throws InvalidParameterValuesException, InvalidResourceStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
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, or rebuild. An AutoStop WorkSpace in
this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE state.
modifyWorkspaceStateRequest - InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyWorkspaceStateResponse modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest) throws InvalidParameterValuesException, InvalidResourceStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException
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, or rebuild. An AutoStop WorkSpace in
this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE state.
This is a convenience which creates an instance of the ModifyWorkspaceStateRequest.Builder avoiding the
need to create one manually via ModifyWorkspaceStateRequest.builder()
modifyWorkspaceStateRequest - A Consumer that will call methods on ModifyWorkspaceStateRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.ResourceNotFoundException - The resource could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootWorkspacesResponse rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
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.
rebootWorkspacesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootWorkspacesResponse rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
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 RebootWorkspacesRequest.Builder avoiding the need
to create one manually via RebootWorkspacesRequest.builder()
rebootWorkspacesRequest - A Consumer that will call methods on RebootWorkspacesRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebuildWorkspacesResponse rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or
UNHEALTHY.
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.
rebuildWorkspacesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebuildWorkspacesResponse rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or
UNHEALTHY.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
This is a convenience which creates an instance of the RebuildWorkspacesRequest.Builder avoiding the need
to create one manually via RebuildWorkspacesRequest.builder()
rebuildWorkspacesRequest - A Consumer that will call methods on RebuildWorkspacesRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokeIpRulesResponse revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Removes one or more rules from the specified IP access control group.
revokeIpRulesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokeIpRulesResponse revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Removes one or more rules from the specified IP access control group.
This is a convenience which creates an instance of the RevokeIpRulesRequest.Builder avoiding the need to
create one manually via RevokeIpRulesRequest.builder()
revokeIpRulesRequest - A Consumer that will call methods on RevokeIpRulesRequest.Builder to create a request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartWorkspacesResponse startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
startWorkspacesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartWorkspacesResponse startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
This is a convenience which creates an instance of the StartWorkspacesRequest.Builder avoiding the need
to create one manually via StartWorkspacesRequest.builder()
startWorkspacesRequest - A Consumer that will call methods on StartWorkspacesRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopWorkspacesResponse stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
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.
stopWorkspacesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopWorkspacesResponse stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
This is a convenience which creates an instance of the StopWorkspacesRequest.Builder avoiding the need to
create one manually via StopWorkspacesRequest.builder()
stopWorkspacesRequest - A Consumer that will call methods on StopWorkspacesRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TerminateWorkspacesResponse terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
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 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.
terminateWorkspacesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TerminateWorkspacesResponse terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException
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 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.
This is a convenience which creates an instance of the TerminateWorkspacesRequest.Builder avoiding the
need to create one manually via TerminateWorkspacesRequest.builder()
terminateWorkspacesRequest - A Consumer that will call methods on TerminateWorkspacesRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Replaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroupRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException
Replaces the current rules of the specified IP access control group with the specified rules.
This is a convenience which creates an instance of the UpdateRulesOfIpGroupRequest.Builder avoiding the
need to create one manually via UpdateRulesOfIpGroupRequest.builder()
updateRulesOfIpGroupRequest - A Consumer that will call methods on UpdateRulesOfIpGroupRequest.Builder to create a
request.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkSpacesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.