com.amazonaws.services.workspaces

Interface AmazonWorkspaces

All Known Subinterfaces:

AmazonWorkspacesAsync

All Known Implementing Classes:

AmazonWorkspacesAsyncClient, AmazonWorkspacesClient

public interface AmazonWorkspaces

Interface for accessing AmazonWorkspaces. Amazon WorkSpaces Service

This is the Amazon WorkSpaces API Reference . This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.

Method Summary

Methods

Modifier and Type	Method and Description
CreateWorkspacesResult	createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) Creates one or more WorkSpaces.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles() Obtains information about the WorkSpace bundles that are available to your account in the specified region.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) Obtains information about the WorkSpace bundles that are available to your account in the specified region.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories() Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
DescribeWorkspacesResult	describeWorkspaces() Obtains information about the specified WorkSpaces.
DescribeWorkspacesResult	describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) Obtains information about the specified WorkSpaces.
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.
RebootWorkspacesResult	rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) Reboots the specified WorkSpaces.
RebuildWorkspacesResult	rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) Rebuilds the specified WorkSpaces.
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 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.
TerminateWorkspacesResult	terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) Terminates the specified WorkSpaces.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

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.

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.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

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.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

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

createWorkspaces

CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates one or more WorkSpaces.

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

Parameters:

createWorkspacesRequest - Container for the necessary parameters to execute the CreateWorkspaces service method on AmazonWorkspaces.

Returns:

The response from the CreateWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

ResourceLimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceBundles

DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Parameters:

describeWorkspaceBundlesRequest - Container for the necessary parameters to execute the DescribeWorkspaceBundles service method on AmazonWorkspaces.

Returns:

The response from the DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.

Throws:

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebootWorkspaces

RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE , IMPAIRED , or INOPERABLE .

NOTE: This operation is asynchronous and will return before the WorkSpaces have rebooted.

Parameters:

rebootWorkspacesRequest - Container for the necessary parameters to execute the RebootWorkspaces service method on AmazonWorkspaces.

Returns:

The response from the RebootWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaces

DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId , DirectoryId , or WorkspaceIds , can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Parameters:

describeWorkspacesRequest - Container for the necessary parameters to execute the DescribeWorkspaces service method on AmazonWorkspaces.

Returns:

The response from the DescribeWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

ResourceUnavailableException

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceDirectories

DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Parameters:

describeWorkspaceDirectoriesRequest - Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method on AmazonWorkspaces.

Returns:

The response from the DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.

Throws:

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebuildWorkspaces

RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

• The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
• The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.

Parameters:

rebuildWorkspacesRequest - Container for the necessary parameters to execute the RebuildWorkspaces service method on AmazonWorkspaces.

Returns:

The response from the RebuildWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

terminateWorkspaces

TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be 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 .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely terminated.

Parameters:

terminateWorkspacesRequest - Container for the necessary parameters to execute the TerminateWorkspaces service method on AmazonWorkspaces.

Returns:

The response from the TerminateWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceBundles

DescribeWorkspaceBundlesResult describeWorkspaceBundles()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Returns:

The response from the DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.

Throws:

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaces

DescribeWorkspacesResult describeWorkspaces()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId , DirectoryId , or WorkspaceIds , can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Returns:

The response from the DescribeWorkspaces service method, as returned by AmazonWorkspaces.

Throws:

ResourceUnavailableException

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceDirectories

DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Returns:

The response from the DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.

Throws:

InvalidParameterValuesException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

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.