com.amazonaws.services.workspaces

Class AmazonWorkspacesClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.workspaces.AmazonWorkspacesClient

All Implemented Interfaces:

AmazonWorkspaces

Direct Known Subclasses:

AmazonWorkspacesAsyncClient

public class AmazonWorkspacesClient
extends AmazonWebServiceClient
implements AmazonWorkspaces

Client for accessing AmazonWorkspaces. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon WorkSpaces Service

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonWorkspaces exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonWorkspacesClient() Constructs a new client to invoke service methods on AmazonWorkspaces.
AmazonWorkspacesClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials.
AmazonWorkspacesClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials and client configuration options.
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider.
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider and client configuration options.
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonWorkspacesClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonWorkspaces.

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	setEndpoint(String endpoint, String serviceName, String regionId)
TerminateWorkspacesResult	terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) Terminates the specified WorkSpaces.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonWorkspaces exceptions.

Constructor Detail

AmazonWorkspacesClient

public AmazonWorkspacesClient()

Constructs a new client to invoke service methods on AmazonWorkspaces. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonWorkspacesClient

public AmazonWorkspacesClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonWorkspaces. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonWorkspaces (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonWorkspacesClient

public AmazonWorkspacesClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonWorkspacesClient

public AmazonWorkspacesClient(AWSCredentials awsCredentials,
                      ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonWorkspaces (ex: proxy settings, retry counts, etc.).

AmazonWorkspacesClient

public AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonWorkspacesClient

public AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider,
                      ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonWorkspaces (ex: proxy settings, retry counts, etc.).

AmazonWorkspacesClient

public AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider,
                      ClientConfiguration clientConfiguration,
                      RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonWorkspaces (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

createWorkspaces

public CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)

Creates one or more WorkSpaces.

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

Specified by:

createWorkspaces in interface AmazonWorkspaces

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

public DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)

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.

Specified by:

describeWorkspaceBundles in interface AmazonWorkspaces

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

public RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)

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.

Specified by:

rebootWorkspaces in interface AmazonWorkspaces

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

public DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)

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.

Specified by:

describeWorkspaces in interface AmazonWorkspaces

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

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

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.

Specified by:

describeWorkspaceDirectories in interface AmazonWorkspaces

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

public RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)

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.

Specified by:

rebuildWorkspaces in interface AmazonWorkspaces

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

public TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)

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.

Specified by:

terminateWorkspaces in interface AmazonWorkspaces

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

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

Specified by:

describeWorkspaceBundles in interface 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.

describeWorkspaces

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

Specified by:

describeWorkspaces in interface 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

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

Specified by:

describeWorkspaceDirectories in interface 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.

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

Overrides:

setEndpoint in class AmazonWebServiceClient

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.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

getCachedResponseMetadata

public 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 the 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.