com.amazonaws.services.workspaces

Class AbstractAmazonWorkspaces

java.lang.Object

com.amazonaws.services.workspaces.AbstractAmazonWorkspaces

All Implemented Interfaces:

AmazonWorkspaces

Direct Known Subclasses:

AbstractAmazonWorkspacesAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonWorkspaces
extends Object
implements AmazonWorkspaces

Abstract implementation of AmazonWorkspaces. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.workspaces.AmazonWorkspaces

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonWorkspaces()

Method Summary

Modifier and Type	Method and Description
AssociateConnectionAliasResult	associateConnectionAlias(AssociateConnectionAliasRequest request) Associates the specified connection alias with the specified directory to enable cross-Region redirection.
AssociateIpGroupsResult	associateIpGroups(AssociateIpGroupsRequest request) Associates the specified IP access control group with the specified directory.
AuthorizeIpRulesResult	authorizeIpRules(AuthorizeIpRulesRequest request) Adds one or more rules to the specified IP access control group.
CopyWorkspaceImageResult	copyWorkspaceImage(CopyWorkspaceImageRequest request) Copies the specified image from the specified Region to the current Region.
CreateConnectionAliasResult	createConnectionAlias(CreateConnectionAliasRequest request) Creates the specified connection alias for use with cross-Region redirection.
CreateIpGroupResult	createIpGroup(CreateIpGroupRequest request) Creates an IP access control group.
CreateTagsResult	createTags(CreateTagsRequest request) Creates the specified tags for the specified WorkSpaces resource.
CreateWorkspaceBundleResult	createWorkspaceBundle(CreateWorkspaceBundleRequest request) Creates the specified WorkSpace bundle.
CreateWorkspacesResult	createWorkspaces(CreateWorkspacesRequest request) Creates one or more WorkSpaces.
DeleteConnectionAliasResult	deleteConnectionAlias(DeleteConnectionAliasRequest request) Deletes the specified connection alias.
DeleteIpGroupResult	deleteIpGroup(DeleteIpGroupRequest request) Deletes the specified IP access control group.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deletes the specified tags from the specified WorkSpaces resource.
DeleteWorkspaceBundleResult	deleteWorkspaceBundle(DeleteWorkspaceBundleRequest request) Deletes the specified WorkSpace bundle.
DeleteWorkspaceImageResult	deleteWorkspaceImage(DeleteWorkspaceImageRequest request) Deletes the specified image from your account.
DeregisterWorkspaceDirectoryResult	deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest request) Deregisters the specified directory.
DescribeAccountResult	describeAccount(DescribeAccountRequest request) Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
DescribeAccountModificationsResult	describeAccountModifications(DescribeAccountModificationsRequest request) Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
DescribeClientPropertiesResult	describeClientProperties(DescribeClientPropertiesRequest request) Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
DescribeConnectionAliasesResult	describeConnectionAliases(DescribeConnectionAliasesRequest request) Retrieves a list that describes the connection aliases used for cross-Region redirection.
DescribeConnectionAliasPermissionsResult	describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest request) Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias.
DescribeIpGroupsResult	describeIpGroups(DescribeIpGroupsRequest request) Describes one or more of your IP access control groups.
DescribeTagsResult	describeTags(DescribeTagsRequest request) Describes the specified tags for the specified WorkSpaces resource.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles() Simplified method form for invoking the DescribeWorkspaceBundles operation.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request) Retrieves a list that describes the available WorkSpace bundles.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories() Simplified method form for invoking the DescribeWorkspaceDirectories operation.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request) Describes the available directories that are registered with Amazon WorkSpaces.
DescribeWorkspaceImagePermissionsResult	describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest request) Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
DescribeWorkspaceImagesResult	describeWorkspaceImages(DescribeWorkspaceImagesRequest request) 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 request) Describes the specified WorkSpaces.
DescribeWorkspacesConnectionStatusResult	describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request) Describes the connection status of the specified WorkSpaces.
DescribeWorkspaceSnapshotsResult	describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest request) Describes the snapshots for the specified WorkSpace.
DisassociateConnectionAliasResult	disassociateConnectionAlias(DisassociateConnectionAliasRequest request) Disassociates a connection alias from a directory.
DisassociateIpGroupsResult	disassociateIpGroups(DisassociateIpGroupsRequest request) 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 request) Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
ListAvailableManagementCidrRangesResult	listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request) 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 request) Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
ModifyAccountResult	modifyAccount(ModifyAccountRequest request) Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
ModifyClientPropertiesResult	modifyClientProperties(ModifyClientPropertiesRequest request) Modifies the properties of the specified Amazon WorkSpaces clients.
ModifySelfservicePermissionsResult	modifySelfservicePermissions(ModifySelfservicePermissionsRequest request) Modifies the self-service WorkSpace management capabilities for your users.
ModifyWorkspaceAccessPropertiesResult	modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest request) Specifies which devices and operating systems users can use to access their WorkSpaces.
ModifyWorkspaceCreationPropertiesResult	modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest request) Modify the default properties used to create WorkSpaces.
ModifyWorkspacePropertiesResult	modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request) Modifies the specified WorkSpace properties.
ModifyWorkspaceStateResult	modifyWorkspaceState(ModifyWorkspaceStateRequest request) Sets the state of the specified WorkSpace.
RebootWorkspacesResult	rebootWorkspaces(RebootWorkspacesRequest request) Reboots the specified WorkSpaces.
RebuildWorkspacesResult	rebuildWorkspaces(RebuildWorkspacesRequest request) Rebuilds the specified WorkSpace.
RegisterWorkspaceDirectoryResult	registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest request) Registers the specified directory.
RestoreWorkspaceResult	restoreWorkspace(RestoreWorkspaceRequest request) Restores the specified WorkSpace to its last known healthy state.
RevokeIpRulesResult	revokeIpRules(RevokeIpRulesRequest request) Removes one or more rules from the specified IP access control group.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://workspaces.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to AmazonWorkspaces.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartWorkspacesResult	startWorkspaces(StartWorkspacesRequest request) Starts the specified WorkSpaces.
StopWorkspacesResult	stopWorkspaces(StopWorkspacesRequest request) Stops the specified WorkSpaces.
TerminateWorkspacesResult	terminateWorkspaces(TerminateWorkspacesRequest request) Terminates the specified WorkSpaces.
UpdateConnectionAliasPermissionResult	updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest request) Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.
UpdateRulesOfIpGroupResult	updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request) Replaces the current rules of the specified IP access control group with the specified rules.
UpdateWorkspaceBundleResult	updateWorkspaceBundle(UpdateWorkspaceBundleRequest request) Updates a WorkSpace bundle with a new image.
UpdateWorkspaceImagePermissionResult	updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest request) Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonWorkspaces

protected AbstractAmazonWorkspaces()

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

setEndpoint in interface AmazonWorkspaces

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

public void setRegion(Region region)

Description copied from interface: AmazonWorkspaces

An alternative to AmazonWorkspaces.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.

Specified by:

setRegion in interface AmazonWorkspaces

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)

associateConnectionAlias

public AssociateConnectionAliasResult associateConnectionAlias(AssociateConnectionAliasRequest request)

Description copied from interface: AmazonWorkspaces

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

Specified by:

associateConnectionAlias in interface AmazonWorkspaces

Returns:

Result of the AssociateConnectionAlias operation returned by the service.

See Also:

AWS API Documentation

associateIpGroups

public AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

associateIpGroups in interface AmazonWorkspaces

Returns:

Result of the AssociateIpGroups operation returned by the service.

See Also:

AWS API Documentation

authorizeIpRules

public AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

authorizeIpRules in interface AmazonWorkspaces

Returns:

Result of the AuthorizeIpRules operation returned by the service.

See Also:

AWS API Documentation

copyWorkspaceImage

public CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest request)

Description copied from interface: AmazonWorkspaces

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

In the China (Ningxia) Region, you can copy images only within the same Region.

In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.

Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Specified by:

copyWorkspaceImage in interface AmazonWorkspaces

Returns:

Result of the CopyWorkspaceImage operation returned by the service.

See Also:

AWS API Documentation

createConnectionAlias

public CreateConnectionAliasResult createConnectionAlias(CreateConnectionAliasRequest request)

Description copied from interface: AmazonWorkspaces

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Specified by:

createConnectionAlias in interface AmazonWorkspaces

Returns:

Result of the CreateConnectionAlias operation returned by the service.

See Also:

AWS API Documentation

createIpGroup

public CreateIpGroupResult createIpGroup(CreateIpGroupRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

createIpGroup in interface AmazonWorkspaces

Returns:

Result of the CreateIpGroup operation returned by the service.

See Also:

AWS API Documentation

createTags

public CreateTagsResult createTags(CreateTagsRequest request)

Description copied from interface: AmazonWorkspaces

Creates the specified tags for the specified WorkSpaces resource.

Specified by:

createTags in interface AmazonWorkspaces

Returns:

Result of the CreateTags operation returned by the service.

See Also:

AWS API Documentation

createWorkspaceBundle

public CreateWorkspaceBundleResult createWorkspaceBundle(CreateWorkspaceBundleRequest request)

Description copied from interface: AmazonWorkspaces

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Specified by:

createWorkspaceBundle in interface AmazonWorkspaces

Returns:

Result of the CreateWorkspaceBundle operation returned by the service.

See Also:

AWS API Documentation

createWorkspaces

public CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

Creates one or more WorkSpaces.

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

Specified by:

createWorkspaces in interface AmazonWorkspaces

Returns:

Result of the CreateWorkspaces operation returned by the service.

See Also:

AWS API Documentation

deleteConnectionAlias

public DeleteConnectionAliasResult deleteConnectionAlias(DeleteConnectionAliasRequest request)

Description copied from interface: AmazonWorkspaces

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Specified by:

deleteConnectionAlias in interface AmazonWorkspaces

Returns:

Result of the DeleteConnectionAlias operation returned by the service.

See Also:

AWS API Documentation

deleteIpGroup

public DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest request)

Description copied from interface: AmazonWorkspaces

Deletes the specified IP access control group.

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

Specified by:

deleteIpGroup in interface AmazonWorkspaces

Returns:

Result of the DeleteIpGroup operation returned by the service.

See Also:

AWS API Documentation

deleteTags

public DeleteTagsResult deleteTags(DeleteTagsRequest request)

Description copied from interface: AmazonWorkspaces

Deletes the specified tags from the specified WorkSpaces resource.

Specified by:

deleteTags in interface AmazonWorkspaces

Returns:

Result of the DeleteTags operation returned by the service.

See Also:

AWS API Documentation

deleteWorkspaceBundle

public DeleteWorkspaceBundleResult deleteWorkspaceBundle(DeleteWorkspaceBundleRequest request)

Description copied from interface: AmazonWorkspaces

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Specified by:

deleteWorkspaceBundle in interface AmazonWorkspaces

Returns:

Result of the DeleteWorkspaceBundle operation returned by the service.

See Also:

AWS API Documentation

deleteWorkspaceImage

public DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

deleteWorkspaceImage in interface AmazonWorkspaces

Returns:

Result of the DeleteWorkspaceImage operation returned by the service.

See Also:

AWS API Documentation

deregisterWorkspaceDirectory

public DeregisterWorkspaceDirectoryResult deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest request)

Description copied from interface: AmazonWorkspaces

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

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.

To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Specified by:

deregisterWorkspaceDirectory in interface AmazonWorkspaces

Returns:

Result of the DeregisterWorkspaceDirectory operation returned by the service.

See Also:

AWS API Documentation

describeAccount

public DescribeAccountResult describeAccount(DescribeAccountRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

describeAccount in interface AmazonWorkspaces

Returns:

Result of the DescribeAccount operation returned by the service.

See Also:

AWS API Documentation

describeAccountModifications

public DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

describeAccountModifications in interface AmazonWorkspaces

Returns:

Result of the DescribeAccountModifications operation returned by the service.

See Also:

AWS API Documentation

describeClientProperties

public DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

describeClientProperties in interface AmazonWorkspaces

Returns:

Result of the DescribeClientProperties operation returned by the service.

See Also:

AWS API Documentation

describeConnectionAliasPermissions

public DescribeConnectionAliasPermissionsResult describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest request)

Description copied from interface: AmazonWorkspaces

Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Specified by:

describeConnectionAliasPermissions in interface AmazonWorkspaces

Returns:

Result of the DescribeConnectionAliasPermissions operation returned by the service.

See Also:

AWS API Documentation

describeConnectionAliases

public DescribeConnectionAliasesResult describeConnectionAliases(DescribeConnectionAliasesRequest request)

Description copied from interface: AmazonWorkspaces

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Specified by:

describeConnectionAliases in interface AmazonWorkspaces

Returns:

Result of the DescribeConnectionAliases operation returned by the service.

See Also:

AWS API Documentation

describeIpGroups

public DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest request)

Description copied from interface: AmazonWorkspaces

Describes one or more of your IP access control groups.

Specified by:

describeIpGroups in interface AmazonWorkspaces

Returns:

Result of the DescribeIpGroups operation returned by the service.

See Also:

AWS API Documentation

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest request)

Description copied from interface: AmazonWorkspaces

Describes the specified tags for the specified WorkSpaces resource.

Specified by:

describeTags in interface AmazonWorkspaces

Returns:

Result of the DescribeTags operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceBundles

public DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request)

Description copied from interface: AmazonWorkspaces

Retrieves a list that describes the available WorkSpace bundles.

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

Specified by:

describeWorkspaceBundles in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaceBundles operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceBundles

public DescribeWorkspaceBundlesResult describeWorkspaceBundles()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaceBundles operation.

Specified by:

describeWorkspaceBundles in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)

describeWorkspaceDirectories

public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request)

Description copied from interface: AmazonWorkspaces

Describes the available directories that are registered with Amazon WorkSpaces.

Specified by:

describeWorkspaceDirectories in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaceDirectories operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceDirectories

public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaceDirectories operation.

Specified by:

describeWorkspaceDirectories in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)

describeWorkspaceImagePermissions

public DescribeWorkspaceImagePermissionsResult describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest request)

Description copied from interface: AmazonWorkspaces

Describes the permissions that the owner of an image has granted to other AWS accounts for an image.

Specified by:

describeWorkspaceImagePermissions in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaceImagePermissions operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceImages

public DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

describeWorkspaceImages in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaceImages operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceSnapshots

public DescribeWorkspaceSnapshotsResult describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest request)

Description copied from interface: AmazonWorkspaces

Describes the snapshots for the specified WorkSpace.

Specified by:

describeWorkspaceSnapshots in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaceSnapshots operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaces

public DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

describeWorkspaces in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspaces operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaces

public DescribeWorkspacesResult describeWorkspaces()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaces operation.

Specified by:

describeWorkspaces in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaces(DescribeWorkspacesRequest)

describeWorkspacesConnectionStatus

public DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request)

Description copied from interface: AmazonWorkspaces

Describes the connection status of the specified WorkSpaces.

Specified by:

describeWorkspacesConnectionStatus in interface AmazonWorkspaces

Returns:

Result of the DescribeWorkspacesConnectionStatus operation returned by the service.

See Also:

AWS API Documentation

disassociateConnectionAlias

public DisassociateConnectionAliasResult disassociateConnectionAlias(DisassociateConnectionAliasRequest request)

Description copied from interface: AmazonWorkspaces

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

Specified by:

disassociateConnectionAlias in interface AmazonWorkspaces

Returns:

Result of the DisassociateConnectionAlias operation returned by the service.

See Also:

AWS API Documentation

disassociateIpGroups

public DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

disassociateIpGroups in interface AmazonWorkspaces

Returns:

Result of the DisassociateIpGroups operation returned by the service.

See Also:

AWS API Documentation

importWorkspaceImage

public ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest request)

Description copied from interface: AmazonWorkspaces

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Specified by:

importWorkspaceImage in interface AmazonWorkspaces

Returns:

Result of the ImportWorkspaceImage operation returned by the service.

See Also:

AWS API Documentation

listAvailableManagementCidrRanges

public ListAvailableManagementCidrRangesResult listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request)

Description copied from interface: AmazonWorkspaces

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

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

Specified by:

listAvailableManagementCidrRanges in interface AmazonWorkspaces

Returns:

Result of the ListAvailableManagementCidrRanges operation returned by the service.

See Also:

AWS API Documentation

migrateWorkspace

public MigrateWorkspaceResult migrateWorkspace(MigrateWorkspaceRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

migrateWorkspace in interface AmazonWorkspaces

Returns:

Result of the MigrateWorkspace operation returned by the service.

See Also:

AWS API Documentation

modifyAccount

public ModifyAccountResult modifyAccount(ModifyAccountRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

modifyAccount in interface AmazonWorkspaces

Returns:

Result of the ModifyAccount operation returned by the service.

See Also:

AWS API Documentation

modifyClientProperties

public ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest request)

Description copied from interface: AmazonWorkspaces

Modifies the properties of the specified Amazon WorkSpaces clients.

Specified by:

modifyClientProperties in interface AmazonWorkspaces

Returns:

Result of the ModifyClientProperties operation returned by the service.

See Also:

AWS API Documentation

modifySelfservicePermissions

public ModifySelfservicePermissionsResult modifySelfservicePermissions(ModifySelfservicePermissionsRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

modifySelfservicePermissions in interface AmazonWorkspaces

Returns:

Result of the ModifySelfservicePermissions operation returned by the service.

See Also:

AWS API Documentation

modifyWorkspaceAccessProperties

public ModifyWorkspaceAccessPropertiesResult modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

modifyWorkspaceAccessProperties in interface AmazonWorkspaces

Returns:

Result of the ModifyWorkspaceAccessProperties operation returned by the service.

See Also:

AWS API Documentation

modifyWorkspaceCreationProperties

public ModifyWorkspaceCreationPropertiesResult modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest request)

Description copied from interface: AmazonWorkspaces

Modify the default properties used to create WorkSpaces.

Specified by:

modifyWorkspaceCreationProperties in interface AmazonWorkspaces

Returns:

Result of the ModifyWorkspaceCreationProperties operation returned by the service.

See Also:

AWS API Documentation

modifyWorkspaceProperties

public ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request)

Description copied from interface: AmazonWorkspaces

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Specified by:

modifyWorkspaceProperties in interface AmazonWorkspaces

Returns:

Result of the ModifyWorkspaceProperties operation returned by the service.

See Also:

AWS API Documentation

modifyWorkspaceState

public ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

modifyWorkspaceState in interface AmazonWorkspaces

Returns:

Result of the ModifyWorkspaceState operation returned by the service.

See Also:

AWS API Documentation

rebootWorkspaces

public RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

rebootWorkspaces in interface AmazonWorkspaces

Returns:

Result of the RebootWorkspaces operation returned by the service.

See Also:

AWS API Documentation

rebuildWorkspaces

public RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

Rebuilds the specified WorkSpace.

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

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

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

Specified by:

rebuildWorkspaces in interface AmazonWorkspaces

Returns:

Result of the RebuildWorkspaces operation returned by the service.

See Also:

AWS API Documentation

registerWorkspaceDirectory

public RegisterWorkspaceDirectoryResult registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

registerWorkspaceDirectory in interface AmazonWorkspaces

Returns:

Result of the RegisterWorkspaceDirectory operation returned by the service.

See Also:

AWS API Documentation

restoreWorkspace

public RestoreWorkspaceResult restoreWorkspace(RestoreWorkspaceRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

restoreWorkspace in interface AmazonWorkspaces

Returns:

Result of the RestoreWorkspace operation returned by the service.

See Also:

AWS API Documentation

revokeIpRules

public RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

revokeIpRules in interface AmazonWorkspaces

Returns:

Result of the RevokeIpRules operation returned by the service.

See Also:

AWS API Documentation

startWorkspaces

public StartWorkspacesResult startWorkspaces(StartWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

Starts the specified WorkSpaces.

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

Specified by:

startWorkspaces in interface AmazonWorkspaces

Returns:

Result of the StartWorkspaces operation returned by the service.

See Also:

AWS API Documentation

stopWorkspaces

public StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

stopWorkspaces in interface AmazonWorkspaces

Returns:

Result of the StopWorkspaces operation returned by the service.

See Also:

AWS API Documentation

terminateWorkspaces

public TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

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 AWS Support before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED.

This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.

To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Specified by:

terminateWorkspaces in interface AmazonWorkspaces

Returns:

Result of the TerminateWorkspaces operation returned by the service.

See Also:

AWS API Documentation

updateConnectionAliasPermission

public UpdateConnectionAliasPermissionResult updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest request)

Description copied from interface: AmazonWorkspaces

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

• Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

• To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Specified by:

updateConnectionAliasPermission in interface AmazonWorkspaces

Returns:

Result of the UpdateConnectionAliasPermission operation returned by the service.

See Also:

AWS API Documentation

updateRulesOfIpGroup

public UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request)

Description copied from interface: AmazonWorkspaces

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

Specified by:

updateRulesOfIpGroup in interface AmazonWorkspaces

Returns:

Result of the UpdateRulesOfIpGroup operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceBundle

public UpdateWorkspaceBundleResult updateWorkspaceBundle(UpdateWorkspaceBundleRequest request)

Description copied from interface: AmazonWorkspaces

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

Specified by:

updateWorkspaceBundle in interface AmazonWorkspaces

Returns:

Result of the UpdateWorkspaceBundle operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceImagePermission

public UpdateWorkspaceImagePermissionResult updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest request)

Description copied from interface: AmazonWorkspaces

Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.

In the China (Ningxia) Region, you can copy images only within the same Region.

In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.

For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

• To delete an image that has been shared, you must unshare the image before you delete it.

• Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.

Specified by:

updateWorkspaceImagePermission in interface AmazonWorkspaces

Returns:

Result of the UpdateWorkspaceImagePermission operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonWorkspaces

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.

Specified by:

shutdown in interface AmazonWorkspaces

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonWorkspaces

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.

Specified by:

getCachedResponseMetadata in interface AmazonWorkspaces

Parameters:

request - The originally executed request.

Returns:

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