AmazonWorkspaces (AWS SDK for Java

All Known Subinterfaces:

AmazonWorkspacesAsync

All Known Implementing Classes:

AbstractAmazonWorkspaces, AbstractAmazonWorkspacesAsync, AmazonWorkspacesAsyncClient, AmazonWorkspacesClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkspaces
```
Interface for accessing Amazon WorkSpaces.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkspaces instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateTagsResult`	`createTags(CreateTagsRequest createTagsRequest)` Creates tags for the specified WorkSpace.
`CreateWorkspacesResult`	`createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)` Creates one or more WorkSpaces.
`DeleteTagsResult`	`deleteTags(DeleteTagsRequest deleteTagsRequest)` Deletes the specified tags from a WorkSpace.
`DescribeTagsResult`	`describeTags(DescribeTagsRequest describeTagsRequest)` Describes the tags for the specified WorkSpace.
`DescribeWorkspaceBundlesResult`	`describeWorkspaceBundles()` Simplified method form for invoking the DescribeWorkspaceBundles operation.
`DescribeWorkspaceBundlesResult`	`describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)` Describes the available WorkSpace bundles.
`DescribeWorkspaceDirectoriesResult`	`describeWorkspaceDirectories()` Simplified method form for invoking the DescribeWorkspaceDirectories operation.
`DescribeWorkspaceDirectoriesResult`	`describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)` 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 describeWorkspacesRequest)` Describes the specified WorkSpaces.
`DescribeWorkspacesConnectionStatusResult`	`describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)` Describes the connection status of 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.
`ModifyWorkspacePropertiesResult`	`modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)` Modifies the specified WorkSpace properties.
`RebootWorkspacesResult`	`rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)` Reboots the specified WorkSpaces.
`RebuildWorkspacesResult`	`rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)` Rebuilds the specified WorkSpaces.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartWorkspacesResult`	`startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)` Starts the specified WorkSpaces.
`StopWorkspacesResult`	`stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)` Stops the specified WorkSpaces.
`TerminateWorkspacesResult`	`terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)` Terminates the specified WorkSpaces.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://workspaces.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://workspaces.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: 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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createTags
```
CreateTagsResult createTags(CreateTagsRequest createTagsRequest)
```
    Creates tags for the specified WorkSpace.
    
    Parameters:
    
    createTagsRequest -
    
    Returns:
    
    Result of the CreateTags operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource could not be found.
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    ResourceLimitExceededException - Your resource limits have been exceeded.
    
    See Also:
    
    AWS API Documentation
  - createWorkspaces
```
CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
```
    Creates one or more WorkSpaces.
    
    This operation is asynchronous and returns before the WorkSpaces are created.
    
    Parameters:
    
    createWorkspacesRequest -
    
    Returns:
    
    Result of the CreateWorkspaces operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - Your resource limits have been exceeded.
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - deleteTags
```
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
```
    Deletes the specified tags from a WorkSpace.
    
    Parameters:
    
    deleteTagsRequest -
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource could not be found.
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - describeTags
```
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
```
    Describes the tags for the specified WorkSpace.
    
    Parameters:
    
    describeTagsRequest -
    
    Returns:
    
    Result of the DescribeTags operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource could not be found.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaceBundles
```
DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
```
    Describes the available WorkSpace bundles.
    
    You can filter the results using either bundle ID or owner, but not both.
    
    Parameters:
    
    describeWorkspaceBundlesRequest -
    
    Returns:
    
    Result of the DescribeWorkspaceBundles operation returned by the service.
    
    Throws:
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaceBundles
```
DescribeWorkspaceBundlesResult describeWorkspaceBundles()
```
    Simplified method form for invoking the DescribeWorkspaceBundles operation.
    
    See Also:
    
    describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)
  - describeWorkspaceDirectories
```
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
```
    Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
    
    Parameters:
    
    describeWorkspaceDirectoriesRequest -
    
    Returns:
    
    Result of the DescribeWorkspaceDirectories operation returned by the service.
    
    Throws:
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaceDirectories
```
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()
```
    Simplified method form for invoking the DescribeWorkspaceDirectories operation.
    
    See Also:
    
    describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)
  - describeWorkspaces
```
DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
```
    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.
    
    Parameters:
    
    describeWorkspacesRequest -
    
    Returns:
    
    Result of the DescribeWorkspaces operation returned by the service.
    
    Throws:
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    ResourceUnavailableException - The specified resource is not available.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaces
```
DescribeWorkspacesResult describeWorkspaces()
```
    Simplified method form for invoking the DescribeWorkspaces operation.
    
    See Also:
    
    describeWorkspaces(DescribeWorkspacesRequest)
  - describeWorkspacesConnectionStatus
```
DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
```
    Describes the connection status of the specified WorkSpaces.
    
    Parameters:
    
    describeWorkspacesConnectionStatusRequest -
    
    Returns:
    
    Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
    
    Throws:
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - modifyWorkspaceProperties
```
ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
```
    Modifies the specified WorkSpace properties.
    
    Parameters:
    
    modifyWorkspacePropertiesRequest -
    
    Returns:
    
    Result of the ModifyWorkspaceProperties operation returned by the service.
    
    Throws:
    
    InvalidParameterValuesException - One or more parameter values are not valid.
    
    InvalidResourceStateException - The state of the WorkSpace is not valid for this operation.
    
    OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.
    
    UnsupportedWorkspaceConfigurationException - The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - The user is not authorized to access a resource.
    
    ResourceUnavailableException - The specified resource is not available.
    
    See Also:
    
    AWS API Documentation
  - rebootWorkspaces
```
RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
```
    Reboots the specified WorkSpaces.
    
    You cannot reboot a WorkSpace unless its state is AVAILABLE, IMPAIRED, or INOPERABLE.
    
    This operation is asynchronous and returns before the WorkSpaces have rebooted.
    
    Parameters:
    
    rebootWorkspacesRequest -
    
    Returns:
    
    Result of the RebootWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebuildWorkspaces
```
RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
```
    Rebuilds the specified WorkSpaces.
    
    You cannot rebuild a WorkSpace unless its state is AVAILABLE or ERROR.
    
    Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
    
    This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
    
    Parameters:
    
    rebuildWorkspacesRequest -
    
    Returns:
    
    Result of the RebuildWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startWorkspaces
```
StartWorkspacesResult startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
```
    Starts the specified WorkSpaces.
    
    You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
    
    Parameters:
    
    startWorkspacesRequest -
    
    Returns:
    
    Result of the StartWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopWorkspaces
```
StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
```
    Stops the specified WorkSpaces.
    
    You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
    
    Parameters:
    
    stopWorkspacesRequest -
    
    Returns:
    
    Result of the StopWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - terminateWorkspaces
```
TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
```
    Terminates the specified WorkSpaces.
    
    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.
    
    You can terminate a WorkSpace that is in any state except SUSPENDED.
    
    This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
    
    Parameters:
    
    terminateWorkspacesRequest -
    
    Returns:
    
    Result of the TerminateWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.

Did this page help you?

Interface AmazonWorkspaces

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

createTags

createWorkspaces

deleteTags

describeTags

describeWorkspaceBundles

describeWorkspaceBundles

describeWorkspaceDirectories

describeWorkspaceDirectories

describeWorkspaces

describeWorkspaces

describeWorkspacesConnectionStatus

modifyWorkspaceProperties

rebootWorkspaces

rebuildWorkspaces

startWorkspaces

stopWorkspaces

terminateWorkspaces

shutdown

getCachedResponseMetadata