Class AbstractAmazonWorkspaces
- All Implemented Interfaces:
AmazonWorkspaces
- Direct Known Subclasses:
AbstractAmazonWorkspacesAsync
AmazonWorkspaces
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateTags
(CreateTagsRequest request) Creates tags for a WorkSpace.createWorkspaces
(CreateWorkspacesRequest request) Creates one or more WorkSpaces.deleteTags
(DeleteTagsRequest request) Deletes tags from a WorkSpace.describeTags
(DescribeTagsRequest request) Describes tags for a WorkSpace.Simplified method form for invoking the DescribeWorkspaceBundles operation.Obtains information about the WorkSpace bundles that are available to your account in the specified region.Simplified method form for invoking the DescribeWorkspaceDirectories operation.Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.Simplified method form for invoking the DescribeWorkspaces operation.Obtains information about the specified WorkSpaces.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.rebootWorkspaces
(RebootWorkspacesRequest request) Reboots the specified WorkSpaces.Rebuilds the specified WorkSpaces.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://workspaces.us-east-1.amazonaws.com").void
An alternative toAmazonWorkspaces.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.Terminates the specified WorkSpaces.
-
Constructor Details
-
AbstractAmazonWorkspaces
protected AbstractAmazonWorkspaces()
-
-
Method Details
-
setEndpoint
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 interfaceAmazonWorkspaces
- 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
Description copied from interface:AmazonWorkspaces
An alternative toAmazonWorkspaces.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 interfaceAmazonWorkspaces
- Parameters:
region
- The region this client will communicate with. SeeRegion.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:
-
createTags
Description copied from interface:AmazonWorkspaces
Creates tags for a WorkSpace.
- Specified by:
createTags
in interfaceAmazonWorkspaces
- Parameters:
request
- The request of the create tags action.- Returns:
- Result of the CreateTags operation returned by the service.
-
createWorkspaces
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 interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the CreateWorkspaces operation.- Returns:
- Result of the CreateWorkspaces operation returned by the service.
-
deleteTags
Description copied from interface:AmazonWorkspaces
Deletes tags from a WorkSpace.
- Specified by:
deleteTags
in interfaceAmazonWorkspaces
- Parameters:
request
- The request of the delete tags action.- Returns:
- Result of the DeleteTags operation returned by the service.
-
describeTags
Description copied from interface:AmazonWorkspaces
Describes tags for a WorkSpace.
- Specified by:
describeTags
in interfaceAmazonWorkspaces
- Parameters:
request
- The request of the describe tags action.- Returns:
- Result of the DescribeTags operation returned by the service.
-
describeWorkspaceBundles
public DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request) Description copied from interface:AmazonWorkspaces
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 theOwner
parameter, but not both.This operation supports pagination with the use of the
NextToken
request and response parameters. If more results are available, theNextToken
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 interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the DescribeWorkspaceBundles operation.- Returns:
- Result of the DescribeWorkspaceBundles operation returned by the service.
-
describeWorkspaceBundles
Description copied from interface:AmazonWorkspaces
Simplified method form for invoking the DescribeWorkspaceBundles operation.- Specified by:
describeWorkspaceBundles
in interfaceAmazonWorkspaces
- See Also:
-
describeWorkspaceDirectories
public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request) Description copied from interface:AmazonWorkspaces
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, theNextToken
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 interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the DescribeWorkspaceDirectories operation.- Returns:
- Result of the DescribeWorkspaceDirectories operation returned by the service.
-
describeWorkspaceDirectories
Description copied from interface:AmazonWorkspaces
Simplified method form for invoking the DescribeWorkspaceDirectories operation.- Specified by:
describeWorkspaceDirectories
in interfaceAmazonWorkspaces
- See Also:
-
describeWorkspaces
Description copied from interface:AmazonWorkspaces
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as
BundleId
,DirectoryId
, orWorkspaceIds
, 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, theNextToken
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 interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the DescribeWorkspaces operation.- Returns:
- Result of the DescribeWorkspaces operation returned by the service.
-
describeWorkspaces
Description copied from interface:AmazonWorkspaces
Simplified method form for invoking the DescribeWorkspaces operation.- Specified by:
describeWorkspaces
in interfaceAmazonWorkspaces
- See Also:
-
rebootWorkspaces
Description copied from interface:AmazonWorkspaces
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of
AVAILABLE
,IMPAIRED
, orINOPERABLE
.This operation is asynchronous and will return before the WorkSpaces have rebooted.
- Specified by:
rebootWorkspaces
in interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the RebootWorkspaces operation.- Returns:
- Result of the RebootWorkspaces operation returned by the service.
-
rebuildWorkspaces
Description copied from interface:AmazonWorkspaces
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
orERROR
.This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.
- Specified by:
rebuildWorkspaces
in interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the RebuildWorkspaces operation.- Returns:
- Result of the RebuildWorkspaces operation returned by the service.
-
terminateWorkspaces
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 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
.This operation is asynchronous and will return before the WorkSpaces have been completely terminated.
- Specified by:
terminateWorkspaces
in interfaceAmazonWorkspaces
- Parameters:
request
- Contains the inputs for the TerminateWorkspaces operation.- Returns:
- Result of the TerminateWorkspaces operation returned by the service.
-
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 interfaceAmazonWorkspaces
-
getCachedResponseMetadata
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 interfaceAmazonWorkspaces
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-