com.amazonaws.services.workspaces

Interface AmazonWorkspaces

All Known Subinterfaces:

AmazonWorkspacesAsync

All Known Implementing Classes:

AbstractAmazonWorkspaces, AbstractAmazonWorkspacesAsync, AmazonWorkspacesAsyncClient, AmazonWorkspacesClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkspaces

Interface for accessing Amazon WorkSpaces.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkspaces instead.

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateIpGroupsResult	associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest) Associates the specified IP access control group with the specified directory.
AuthorizeIpRulesResult	authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest) Adds one or more rules to the specified IP access control group.
CopyWorkspaceImageResult	copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest) Copies the specified image from the specified Region to the current Region.
CreateIpGroupResult	createIpGroup(CreateIpGroupRequest createIpGroupRequest) Creates an IP access control group.
CreateTagsResult	createTags(CreateTagsRequest createTagsRequest) Creates the specified tags for the specified WorkSpaces resource.
CreateWorkspacesResult	createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) Creates one or more WorkSpaces.
DeleteIpGroupResult	deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest) Deletes the specified IP access control group.
DeleteTagsResult	deleteTags(DeleteTagsRequest deleteTagsRequest) Deletes the specified tags from the specified WorkSpaces resource.
DeleteWorkspaceImageResult	deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest) Deletes the specified image from your account.
DeregisterWorkspaceDirectoryResult	deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest) Deregisters the specified directory.
DescribeAccountResult	describeAccount(DescribeAccountRequest describeAccountRequest) Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
DescribeAccountModificationsResult	describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest) Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
DescribeClientPropertiesResult	describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest) Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
DescribeIpGroupsResult	describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest) Describes one or more of your IP access control groups.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Describes the specified tags for the specified WorkSpaces resource.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles() Simplified method form for invoking the DescribeWorkspaceBundles operation.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) Retrieves a list that describes the available WorkSpace bundles.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories() Simplified method form for invoking the DescribeWorkspaceDirectories operation.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) Describes the available directories that are registered with Amazon WorkSpaces.
DescribeWorkspaceImagesResult	describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest) Retrieves a list that describes one or more specified images, if the image identifiers are provided.
DescribeWorkspacesResult	describeWorkspaces() Simplified method form for invoking the DescribeWorkspaces operation.
DescribeWorkspacesResult	describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) Describes the specified WorkSpaces.
DescribeWorkspacesConnectionStatusResult	describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) Describes the connection status of the specified WorkSpaces.
DescribeWorkspaceSnapshotsResult	describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest) Describes the snapshots for the specified WorkSpace.
DisassociateIpGroupsResult	disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest) Disassociates the specified IP access control group from the specified directory.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ImportWorkspaceImageResult	importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest) Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
ListAvailableManagementCidrRangesResult	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).
MigrateWorkspaceResult	migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest) Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
ModifyAccountResult	modifyAccount(ModifyAccountRequest modifyAccountRequest) Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
ModifyClientPropertiesResult	modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest) Modifies the properties of the specified Amazon WorkSpaces clients.
ModifySelfservicePermissionsResult	modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest) Modifies the self-service WorkSpace management capabilities for your users.
ModifyWorkspaceAccessPropertiesResult	modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest) Specifies which devices and operating systems users can use to access their WorkSpaces.
ModifyWorkspaceCreationPropertiesResult	modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest) Modify the default properties used to create WorkSpaces.
ModifyWorkspacePropertiesResult	modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) Modifies the specified WorkSpace properties.
ModifyWorkspaceStateResult	modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest) Sets the state of the specified WorkSpace.
RebootWorkspacesResult	rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) Reboots the specified WorkSpaces.
RebuildWorkspacesResult	rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) Rebuilds the specified WorkSpace.
RegisterWorkspaceDirectoryResult	registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest) Registers the specified directory.
RestoreWorkspaceResult	restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest) Restores the specified WorkSpace to its last known healthy state.
RevokeIpRulesResult	revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest) Removes one or more rules from the specified IP access control group.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartWorkspacesResult	startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) Starts the specified WorkSpaces.
StopWorkspacesResult	stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) Stops the specified WorkSpaces.
TerminateWorkspacesResult	terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) Terminates the specified WorkSpaces.
UpdateRulesOfIpGroupResult	updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest) Replaces the current rules of the specified IP access control group with the specified rules.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("https://workspaces.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://workspaces.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://workspaces.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

associateIpGroups

AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)

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

Parameters:

associateIpGroupsRequest -

Returns:

Result of the AssociateIpGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

authorizeIpRules

AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)

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

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

Parameters:

authorizeIpRulesRequest -

Returns:

Result of the AuthorizeIpRules operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

copyWorkspaceImage

CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)

Copies the specified image from the specified Region to the current Region.

Parameters:

copyWorkspaceImageRequest -

Returns:

Result of the CopyWorkspaceImage operation returned by the service.

Throws:

ResourceLimitExceededException - Your resource limits have been exceeded.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - The resource could not be found.

ResourceUnavailableException - The specified resource is not available.

OperationNotSupportedException - This operation is not supported.

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

createIpGroup

CreateIpGroupResult createIpGroup(CreateIpGroupRequest createIpGroupRequest)

Creates an IP access control group.

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

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

Parameters:

createIpGroupRequest -

Returns:

Result of the CreateIpGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTags

CreateTagsResult createTags(CreateTagsRequest createTagsRequest)

Creates the specified tags for the specified WorkSpaces resource.

Parameters:

createTagsRequest -

Returns:

Result of the CreateTags operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceLimitExceededException - Your resource limits have been exceeded.

See Also:

AWS API Documentation

createWorkspaces

CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)

Creates one or more WorkSpaces.

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

Parameters:

createWorkspacesRequest -

Returns:

Result of the CreateWorkspaces operation returned by the service.

Throws:

ResourceLimitExceededException - Your resource limits have been exceeded.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

deleteIpGroup

DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)

Deletes the specified IP access control group.

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

Parameters:

deleteIpGroupRequest -

Returns:

Result of the DeleteIpGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTags

DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)

Deletes the specified tags from the specified WorkSpaces resource.

Parameters:

deleteTagsRequest -

Returns:

Result of the DeleteTags operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

deleteWorkspaceImage

DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)

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

Parameters:

deleteWorkspaceImageRequest -

Returns:

Result of the DeleteWorkspaceImage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deregisterWorkspaceDirectory

DeregisterWorkspaceDirectoryResult deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)

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

Parameters:

deregisterWorkspaceDirectoryRequest -

Returns:

Result of the DeregisterWorkspaceDirectory operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

OperationNotSupportedException - This operation is not supported.

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The state of the resource is not valid for this operation.

See Also:

AWS API Documentation

describeAccount

DescribeAccountResult describeAccount(DescribeAccountRequest describeAccountRequest)

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

Parameters:

describeAccountRequest -

Returns:

Result of the DescribeAccount operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeAccountModifications

DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)

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

Parameters:

describeAccountModificationsRequest -

Returns:

Result of the DescribeAccountModifications operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeClientProperties

DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)

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

Parameters:

describeClientPropertiesRequest -

Returns:

Result of the DescribeClientProperties operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeIpGroups

DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)

Describes one or more of your IP access control groups.

Parameters:

describeIpGroupsRequest -

Returns:

Result of the DescribeIpGroups operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeTags

DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Describes the specified tags for the specified WorkSpaces resource.

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeWorkspaceBundles

DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)

Retrieves a list that describes the available WorkSpace bundles.

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

Parameters:

describeWorkspaceBundlesRequest -

Returns:

Result of the DescribeWorkspaceBundles operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

describeWorkspaceBundles

DescribeWorkspaceBundlesResult describeWorkspaceBundles()

Simplified method form for invoking the DescribeWorkspaceBundles operation.

See Also:

describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)

describeWorkspaceDirectories

DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)

Describes the available directories that are registered with Amazon WorkSpaces.

Parameters:

describeWorkspaceDirectoriesRequest -

Returns:

Result of the DescribeWorkspaceDirectories operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

describeWorkspaceDirectories

DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()

Simplified method form for invoking the DescribeWorkspaceDirectories operation.

See Also:

describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)

describeWorkspaceImages

DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)

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

Parameters:

describeWorkspaceImagesRequest -

Returns:

Result of the DescribeWorkspaceImages operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeWorkspaceSnapshots

DescribeWorkspaceSnapshotsResult describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)

Describes the snapshots for the specified WorkSpace.

Parameters:

describeWorkspaceSnapshotsRequest -

Returns:

Result of the DescribeWorkspaceSnapshots operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeWorkspaces

DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)

Describes the specified WorkSpaces.

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

Parameters:

describeWorkspacesRequest -

Returns:

Result of the DescribeWorkspaces operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceUnavailableException - The specified resource is not available.

See Also:

AWS API Documentation

describeWorkspaces

DescribeWorkspacesResult describeWorkspaces()

Simplified method form for invoking the DescribeWorkspaces operation.

See Also:

describeWorkspaces(DescribeWorkspacesRequest)

describeWorkspacesConnectionStatus

DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)

Describes the connection status of the specified WorkSpaces.

Parameters:

describeWorkspacesConnectionStatusRequest -

Returns:

Result of the DescribeWorkspacesConnectionStatus operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

disassociateIpGroups

DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)

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

Parameters:

disassociateIpGroupsRequest -

Returns:

Result of the DisassociateIpGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

importWorkspaceImage

ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)

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.

Parameters:

importWorkspaceImageRequest -

Returns:

Result of the ImportWorkspaceImage operation returned by the service.

Throws:

ResourceLimitExceededException - Your resource limits have been exceeded.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - The resource could not be found.

OperationNotSupportedException - This operation is not supported.

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

listAvailableManagementCidrRanges

ListAvailableManagementCidrRangesResult 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).

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

Parameters:

listAvailableManagementCidrRangesRequest -

Returns:

Result of the ListAvailableManagementCidrRanges operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

migrateWorkspace

MigrateWorkspaceResult migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)

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

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

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

Parameters:

migrateWorkspaceRequest -

Returns:

Result of the MigrateWorkspace operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

AccessDeniedException - The user is not authorized to access a resource.

OperationNotSupportedException - This operation is not supported.

OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.

ResourceUnavailableException - The specified resource is not available.

See Also:

AWS API Documentation

modifyAccount

ModifyAccountResult modifyAccount(ModifyAccountRequest modifyAccountRequest)

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

Parameters:

modifyAccountRequest -

Returns:

Result of the ModifyAccount operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyClientProperties

ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)

Modifies the properties of the specified Amazon WorkSpaces clients.

Parameters:

modifyClientPropertiesRequest -

Returns:

Result of the ModifyClientProperties operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifySelfservicePermissions

ModifySelfservicePermissionsResult modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)

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

Parameters:

modifySelfservicePermissionsRequest -

Returns:

Result of the ModifySelfservicePermissions operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

modifyWorkspaceAccessProperties

ModifyWorkspaceAccessPropertiesResult modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)

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

Parameters:

modifyWorkspaceAccessPropertiesRequest -

Returns:

Result of the ModifyWorkspaceAccessProperties operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

modifyWorkspaceCreationProperties

ModifyWorkspaceCreationPropertiesResult modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)

Modify the default properties used to create WorkSpaces.

Parameters:

modifyWorkspaceCreationPropertiesRequest -

Returns:

Result of the ModifyWorkspaceCreationProperties operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

modifyWorkspaceProperties

ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)

Modifies the specified WorkSpace properties.

Parameters:

modifyWorkspacePropertiesRequest -

Returns:

Result of the ModifyWorkspaceProperties operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

InvalidResourceStateException - The state of the resource is not valid for this operation.

OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.

UnsupportedWorkspaceConfigurationException - The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .

ResourceNotFoundException - The resource could not be found.

AccessDeniedException - The user is not authorized to access a resource.

ResourceUnavailableException - The specified resource is not available.

See Also:

AWS API Documentation

modifyWorkspaceState

ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)

Sets the state of the specified WorkSpace.

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

Parameters:

modifyWorkspaceStateRequest -

Returns:

Result of the ModifyWorkspaceState operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

rebootWorkspaces

RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)

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.

Parameters:

rebootWorkspacesRequest -

Returns:

Result of the RebootWorkspaces operation returned by the service.

See Also:

AWS API Documentation

rebuildWorkspaces

RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)

Rebuilds the specified WorkSpace.

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

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

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

Parameters:

rebuildWorkspacesRequest -

Returns:

Result of the RebuildWorkspaces operation returned by the service.

See Also:

AWS API Documentation

registerWorkspaceDirectory

RegisterWorkspaceDirectoryResult registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)

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

Parameters:

registerWorkspaceDirectoryRequest -

Returns:

Result of the RegisterWorkspaceDirectory operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

ResourceLimitExceededException - Your resource limits have been exceeded.

AccessDeniedException - The user is not authorized to access a resource.

WorkspacesDefaultRoleNotFoundException - The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

InvalidResourceStateException - The state of the resource is not valid for this operation.

UnsupportedNetworkConfigurationException - The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.

OperationNotSupportedException - This operation is not supported.

See Also:

AWS API Documentation

restoreWorkspace

RestoreWorkspaceResult restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)

Restores the specified WorkSpace to its last known healthy state.

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

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

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

Parameters:

restoreWorkspaceRequest -

Returns:

Result of the RestoreWorkspace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

revokeIpRules

RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)

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

Parameters:

revokeIpRulesRequest -

Returns:

Result of the RevokeIpRules operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startWorkspaces

StartWorkspacesResult startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)

Starts the specified WorkSpaces.

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

Parameters:

startWorkspacesRequest -

Returns:

Result of the StartWorkspaces operation returned by the service.

See Also:

AWS API Documentation

stopWorkspaces

StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)

Stops the specified WorkSpaces.

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

Parameters:

stopWorkspacesRequest -

Returns:

Result of the StopWorkspaces operation returned by the service.

See Also:

AWS API Documentation

terminateWorkspaces

TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services 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.

Parameters:

terminateWorkspacesRequest -

Returns:

Result of the TerminateWorkspaces operation returned by the service.

See Also:

AWS API Documentation

updateRulesOfIpGroup

UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)

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

Parameters:

updateRulesOfIpGroupRequest -

Returns:

Result of the UpdateRulesOfIpGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.