Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.workspaces;
 
 
Interface for accessing AmazonWorkspaces asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. Amazon WorkSpaces Service

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

 
 public interface AmazonWorkspacesAsync extends AmazonWorkspaces {
    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the CreateWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
 
     public Future<CreateWorkspacesResultcreateWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the CreateWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<CreateWorkspacesRequestCreateWorkspacesResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the RebootWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RebootWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<RebootWorkspacesRequestRebootWorkspacesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the DescribeWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<DescribeWorkspacesRequestDescribeWorkspacesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the RebuildWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RebuildWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<RebuildWorkspacesRequestRebuildWorkspacesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
Returns:
A Java Future object containing the response from the TerminateWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 operation on AmazonWorkspaces.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the TerminateWorkspaces service method, as returned by AmazonWorkspaces.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<TerminateWorkspacesRequestTerminateWorkspacesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;
}
        
New to GrepCode? Check out our FAQ X