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
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.
CreateIpGroupResult	createIpGroup(CreateIpGroupRequest request) Creates an IP access control group.
CreateTagsResult	createTags(CreateTagsRequest request) Creates the specified tags for the specified WorkSpace.
CreateWorkspacesResult	createWorkspaces(CreateWorkspacesRequest request) Creates one or more WorkSpaces.
DeleteIpGroupResult	deleteIpGroup(DeleteIpGroupRequest request) Deletes the specified IP access control group.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deletes the specified tags from the specified WorkSpace.
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 WorkSpace.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles() Simplified method form for invoking the DescribeWorkspaceBundles operation.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request) Describes the available WorkSpace bundles.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories() Simplified method form for invoking the DescribeWorkspaceDirectories operation.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request) Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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.
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.
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.
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.
UpdateRulesOfIpGroupResult	updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request) Replaces the current rules of the specified IP access control group with the specified rules.

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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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)

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

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 WorkSpace.

Specified by:

createTags in interface AmazonWorkspaces

Returns:

Result of the CreateTags 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

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 WorkSpace.

Specified by:

deleteTags in interface AmazonWorkspaces

Returns:

Result of the DeleteTags 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 WorkSpace.

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

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 AWS Directory Service 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)

describeWorkspaces

public DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest request)

Description copied from interface: AmazonWorkspaces

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, 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

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

modifyWorkspaceProperties

public ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request)

Description copied from interface: AmazonWorkspaces

Modifies the specified WorkSpace properties.

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, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can 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, or UNHEALTHY.

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

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

Specified by:

rebuildWorkspaces in interface AmazonWorkspaces

Returns:

Result of the RebuildWorkspaces 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 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.

Specified by:

terminateWorkspaces in interface AmazonWorkspaces

Returns:

Result of the TerminateWorkspaces 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

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.