com.amazonaws.services.workspaces.AmazonWorkspaces Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workspaces Show documentation
/*
* Copyright 2011-2016 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;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.workspaces.model.*;
/**
* Interface for accessing Amazon WorkSpaces.
*
* Amazon WorkSpaces Service
*
* This reference provides detailed information about the Amazon WorkSpaces
* operations.
*
*/
public interface AmazonWorkspaces {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "workspaces";
/**
* 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
* {@link 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.
*
* @param 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.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonWorkspaces#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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link 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 Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Creates tags for a WorkSpace.
*
*
* @param createTagsRequest
* The request of the CreateTags operation.
* @return Result of the CreateTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @sample AmazonWorkspaces.CreateTags
*/
CreateTagsResult createTags(CreateTagsRequest createTagsRequest);
/**
*
* Creates one or more WorkSpaces.
*
*
*
* This operation is asynchronous and returns before the WorkSpaces are
* created.
*
*
*
* @param createWorkspacesRequest
* Contains the inputs for the CreateWorkspaces operation.
* @return Result of the CreateWorkspaces operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.CreateWorkspaces
*/
CreateWorkspacesResult createWorkspaces(
CreateWorkspacesRequest createWorkspacesRequest);
/**
*
* Deletes tags from a WorkSpace.
*
*
* @param deleteTagsRequest
* The request of the DeleteTags operation.
* @return Result of the DeleteTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DeleteTags
*/
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest);
/**
*
* Describes tags for a WorkSpace.
*
*
* @param describeTagsRequest
* The request of the DescribeTags operation.
* @return Result of the DescribeTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.DescribeTags
*/
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
* 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.
*
*
* @param describeWorkspaceBundlesRequest
* Contains the inputs for the DescribeWorkspaceBundles
* operation.
* @return Result of the DescribeWorkspaceBundles operation returned by the
* service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspaceBundles
*/
DescribeWorkspaceBundlesResult describeWorkspaceBundles(
DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaceBundles
* operation.
*
* @see #describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)
*/
DescribeWorkspaceBundlesResult describeWorkspaceBundles();
/**
*
* 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.
*
*
* @param describeWorkspaceDirectoriesRequest
* Contains the inputs for the DescribeWorkspaceDirectories
* operation.
* @return Result of the DescribeWorkspaceDirectories operation returned by
* the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspaceDirectories
*/
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(
DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaceDirectories
* operation.
*
* @see #describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)
*/
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories();
/**
*
* 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.
*
*
* @param describeWorkspacesRequest
* Contains the inputs for the DescribeWorkspaces operation.
* @return Result of the DescribeWorkspaces operation returned by the
* service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @sample AmazonWorkspaces.DescribeWorkspaces
*/
DescribeWorkspacesResult describeWorkspaces(
DescribeWorkspacesRequest describeWorkspacesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaces operation.
*
* @see #describeWorkspaces(DescribeWorkspacesRequest)
*/
DescribeWorkspacesResult describeWorkspaces();
/**
*
* Describes the connection status of a specified WorkSpace.
*
*
* @param describeWorkspacesConnectionStatusRequest
* @return Result of the DescribeWorkspacesConnectionStatus operation
* returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspacesConnectionStatus
*/
DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest);
/**
*
* Modifies the WorkSpace properties, including the RunningMode and AutoStop
* time.
*
*
* @param modifyWorkspacePropertiesRequest
* @return Result of the ModifyWorkspaceProperties operation returned by the
* service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The specified WorkSpace has an invalid state for this operation.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified.
* Try again in a moment.
* @throws UnsupportedWorkspaceConfigurationException
* The WorkSpace does not have the supported configuration for this
* operation. For more information, see the Amazon WorkSpaces Administration Guide.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* @throws ResourceUnavailableException
* The specified resource is not available.
* @sample AmazonWorkspaces.ModifyWorkspaceProperties
*/
ModifyWorkspacePropertiesResult modifyWorkspaceProperties(
ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest);
/**
*
* Reboots the specified WorkSpaces.
*
*
* To be able to reboot a WorkSpace, the WorkSpace must have a State
* of AVAILABLE, IMPAIRED, or
* INOPERABLE.
*
*
*
* This operation is asynchronous and returns before the WorkSpaces have
* rebooted.
*
*
*
* @param rebootWorkspacesRequest
* Contains the inputs for the RebootWorkspaces operation.
* @return Result of the RebootWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.RebootWorkspaces
*/
RebootWorkspacesResult rebootWorkspaces(
RebootWorkspacesRequest rebootWorkspacesRequest);
/**
*
* 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.
*
*
*
* This operation is asynchronous and returns before the WorkSpaces have
* been completely rebuilt.
*
*
*
* @param rebuildWorkspacesRequest
* Contains the inputs for the RebuildWorkspaces operation.
* @return Result of the RebuildWorkspaces operation returned by the
* service.
* @sample AmazonWorkspaces.RebuildWorkspaces
*/
RebuildWorkspacesResult rebuildWorkspaces(
RebuildWorkspacesRequest rebuildWorkspacesRequest);
/**
*
* Starts the specified WorkSpaces. The API only works with WorkSpaces that
* have RunningMode configured as AutoStop and the State set to “STOPPED.”
*
*
* @param startWorkspacesRequest
* @return Result of the StartWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.StartWorkspaces
*/
StartWorkspacesResult startWorkspaces(
StartWorkspacesRequest startWorkspacesRequest);
/**
*
* Stops the specified WorkSpaces. The API only works with WorkSpaces that
* have RunningMode configured as AutoStop and the State set to AVAILABLE,
* IMPAIRED, UNHEALTHY, or ERROR.
*
*
* @param stopWorkspacesRequest
* @return Result of the StopWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.StopWorkspaces
*/
StopWorkspacesResult stopWorkspaces(
StopWorkspacesRequest stopWorkspacesRequest);
/**
*
* 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 returns before the WorkSpaces have
* been completely terminated.
*
*
*
* @param terminateWorkspacesRequest
* Contains the inputs for the TerminateWorkspaces operation.
* @return Result of the TerminateWorkspaces operation returned by the
* service.
* @sample AmazonWorkspaces.TerminateWorkspaces
*/
TerminateWorkspacesResult terminateWorkspaces(
TerminateWorkspacesRequest terminateWorkspacesRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}