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

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkspacesClient
extends AmazonWebServiceClient
implements AmazonWorkspaces

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

Amazon WorkSpaces Service

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonWorkspacesClient() Deprecated. use AmazonWorkspacesClientBuilder.defaultClient()
AmazonWorkspacesClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonWorkspacesClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonWorkspacesClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonWorkspacesClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AssociateIpGroupsResult	associateIpGroups(AssociateIpGroupsRequest request) Associates the specified IP access control group with the specified directory.
AuthorizeIpRulesResult	authorizeIpRules(AuthorizeIpRulesRequest request) Adds one or more rules to the specified IP access control group.
static AmazonWorkspacesClientBuilder	builder()
CopyWorkspaceImageResult	copyWorkspaceImage(CopyWorkspaceImageRequest request) Copies the specified image from the specified Region to the current Region.
CreateIpGroupResult	createIpGroup(CreateIpGroupRequest request) Creates an IP access control group.
CreateTagsResult	createTags(CreateTagsRequest request) Creates the specified tags for the specified WorkSpaces resource.
CreateWorkspacesResult	createWorkspaces(CreateWorkspacesRequest request) Creates one or more WorkSpaces.
DeleteIpGroupResult	deleteIpGroup(DeleteIpGroupRequest request) Deletes the specified IP access control group.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deletes the specified tags from the specified WorkSpaces resource.
DeleteWorkspaceImageResult	deleteWorkspaceImage(DeleteWorkspaceImageRequest request) Deletes the specified image from your account.
DescribeAccountResult	describeAccount(DescribeAccountRequest request) Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
DescribeAccountModificationsResult	describeAccountModifications(DescribeAccountModificationsRequest request) Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
DescribeClientPropertiesResult	describeClientProperties(DescribeClientPropertiesRequest request) Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
DescribeIpGroupsResult	describeIpGroups(DescribeIpGroupsRequest request) Describes one or more of your IP access control groups.
DescribeTagsResult	describeTags(DescribeTagsRequest request) Describes the specified tags for the specified WorkSpaces resource.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles() Simplified method form for invoking the DescribeWorkspaceBundles operation.
DescribeWorkspaceBundlesResult	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request) Retrieves a list that describes the available WorkSpace bundles.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories() Simplified method form for invoking the DescribeWorkspaceDirectories operation.
DescribeWorkspaceDirectoriesResult	describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request) Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
DescribeWorkspaceImagesResult	describeWorkspaceImages(DescribeWorkspaceImagesRequest request) Retrieves a list that describes one or more specified images, if the image identifiers are provided.
DescribeWorkspacesResult	describeWorkspaces() Simplified method form for invoking the DescribeWorkspaces operation.
DescribeWorkspacesResult	describeWorkspaces(DescribeWorkspacesRequest request) Describes the specified WorkSpaces.
DescribeWorkspacesConnectionStatusResult	describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request) Describes the connection status of the specified WorkSpaces.
DisassociateIpGroupsResult	disassociateIpGroups(DisassociateIpGroupsRequest request) Disassociates the specified IP access control group from the specified directory.
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.
ImportWorkspaceImageResult	importWorkspaceImage(ImportWorkspaceImageRequest request) Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
ListAvailableManagementCidrRangesResult	listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request) Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).
ModifyAccountResult	modifyAccount(ModifyAccountRequest request) Modifies the configuration of bring your own license (BYOL) for the specified account.
ModifyClientPropertiesResult	modifyClientProperties(ModifyClientPropertiesRequest request) Modifies the properties of the specified Amazon WorkSpaces clients.
ModifyWorkspacePropertiesResult	modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request) Modifies the specified WorkSpace properties.
ModifyWorkspaceStateResult	modifyWorkspaceState(ModifyWorkspaceStateRequest request) Sets the state of the specified WorkSpace.
RebootWorkspacesResult	rebootWorkspaces(RebootWorkspacesRequest request) Reboots the specified WorkSpaces.
RebuildWorkspacesResult	rebuildWorkspaces(RebuildWorkspacesRequest request) Rebuilds the specified WorkSpace.
RevokeIpRulesResult	revokeIpRules(RevokeIpRulesRequest request) Removes one or more rules from the specified IP access control group.
StartWorkspacesResult	startWorkspaces(StartWorkspacesRequest request) Starts the specified WorkSpaces.
StopWorkspacesResult	stopWorkspaces(StopWorkspacesRequest request) Stops the specified WorkSpaces.
TerminateWorkspacesResult	terminateWorkspaces(TerminateWorkspacesRequest request) Terminates the specified WorkSpaces.
UpdateRulesOfIpGroupResult	updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request) Replaces the current rules of the specified IP access control group with the specified rules.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonWorkspacesClient

@Deprecated
public AmazonWorkspacesClient()

Deprecated. use AmazonWorkspacesClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon WorkSpaces. 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

@Deprecated
public AmazonWorkspacesClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon WorkSpaces. 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 Amazon WorkSpaces (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonWorkspacesClient

@Deprecated
public AmazonWorkspacesClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonWorkspacesClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon WorkSpaces 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

@Deprecated
public AmazonWorkspacesClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon WorkSpaces 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 Amazon WorkSpaces (ex: proxy settings, retry counts, etc.).

AmazonWorkspacesClient

@Deprecated
public AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon WorkSpaces 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

@Deprecated
public AmazonWorkspacesClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon WorkSpaces 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 Amazon WorkSpaces (ex: proxy settings, retry counts, etc.).

AmazonWorkspacesClient

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

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon WorkSpaces 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 Amazon WorkSpaces (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonWorkspacesClientBuilder builder()

associateIpGroups

public AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest request)

Associates the specified IP access control group with the specified directory.

Specified by:

associateIpGroups in interface AmazonWorkspaces

Parameters:

associateIpGroupsRequest -

Returns:

Result of the AssociateIpGroups operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

ResourceLimitExceededException - Your resource limits have been exceeded.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

OperationNotSupportedException - This operation is not supported.

See Also:

AWS API Documentation

authorizeIpRules

public AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest request)

Adds one or more rules to the specified IP access control group.

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Specified by:

authorizeIpRules in interface AmazonWorkspaces

Parameters:

authorizeIpRulesRequest -

Returns:

Result of the AuthorizeIpRules operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

ResourceLimitExceededException - Your resource limits have been exceeded.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

copyWorkspaceImage

public CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest request)

Copies the specified image from the specified Region to the current Region.

Specified by:

copyWorkspaceImage in interface AmazonWorkspaces

Parameters:

copyWorkspaceImageRequest -

Returns:

Result of the CopyWorkspaceImage operation returned by the service.

Throws:

ResourceLimitExceededException - Your resource limits have been exceeded.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - The resource could not be found.

ResourceUnavailableException - The specified resource is not available.

OperationNotSupportedException - This operation is not supported.

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

createIpGroup

public CreateIpGroupResult createIpGroup(CreateIpGroupRequest request)

Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Specified by:

createIpGroup in interface AmazonWorkspaces

Parameters:

createIpGroupRequest -

Returns:

Result of the CreateIpGroup operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceLimitExceededException - Your resource limits have been exceeded.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceCreationFailedException - The resource could not be created.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

createTags

public CreateTagsResult createTags(CreateTagsRequest request)

Creates the specified tags for the specified WorkSpaces resource.

Specified by:

createTags in interface AmazonWorkspaces

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

public CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest request)

Creates one or more WorkSpaces.

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

Specified by:

createWorkspaces in interface AmazonWorkspaces

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

deleteIpGroup

public DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest request)

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

Specified by:

deleteIpGroup in interface AmazonWorkspaces

Parameters:

deleteIpGroupRequest -

Returns:

Result of the DeleteIpGroup operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

ResourceAssociatedException - The resource is associated with a directory.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

deleteTags

public DeleteTagsResult deleteTags(DeleteTagsRequest request)

Deletes the specified tags from the specified WorkSpaces resource.

Specified by:

deleteTags in interface AmazonWorkspaces

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

deleteWorkspaceImage

public DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest request)

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.

Specified by:

deleteWorkspaceImage in interface AmazonWorkspaces

Parameters:

deleteWorkspaceImageRequest -

Returns:

Result of the DeleteWorkspaceImage operation returned by the service.

Throws:

ResourceAssociatedException - The resource is associated with a directory.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeAccount

public DescribeAccountResult describeAccount(DescribeAccountRequest request)

Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.

Specified by:

describeAccount in interface AmazonWorkspaces

Parameters:

describeAccountRequest -

Returns:

Result of the DescribeAccount operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeAccountModifications

public DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest request)

Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.

Specified by:

describeAccountModifications in interface AmazonWorkspaces

Parameters:

describeAccountModificationsRequest -

Returns:

Result of the DescribeAccountModifications operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeClientProperties

public DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest request)

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Specified by:

describeClientProperties in interface AmazonWorkspaces

Parameters:

describeClientPropertiesRequest -

Returns:

Result of the DescribeClientProperties operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeIpGroups

public DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest request)

Describes one or more of your IP access control groups.

Specified by:

describeIpGroups in interface AmazonWorkspaces

Parameters:

describeIpGroupsRequest -

Returns:

Result of the DescribeIpGroups operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest request)

Describes the specified tags for the specified WorkSpaces resource.

Specified by:

describeTags in interface AmazonWorkspaces

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

public DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request)

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

Specified by:

describeWorkspaceBundles in interface AmazonWorkspaces

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

public DescribeWorkspaceBundlesResult describeWorkspaceBundles()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaceBundles operation.

Specified by:

describeWorkspaceBundles in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)

describeWorkspaceDirectories

public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request)

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

Specified by:

describeWorkspaceDirectories in interface AmazonWorkspaces

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

public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaceDirectories operation.

Specified by:

describeWorkspaceDirectories in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)

describeWorkspaceImages

public DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest request)

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Specified by:

describeWorkspaceImages in interface AmazonWorkspaces

Parameters:

describeWorkspaceImagesRequest -

Returns:

Result of the DescribeWorkspaceImages operation returned by the service.

Throws:

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

describeWorkspaces

public DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest request)

Describes the specified WorkSpaces.

You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

Specified by:

describeWorkspaces in interface AmazonWorkspaces

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

public DescribeWorkspacesResult describeWorkspaces()

Description copied from interface: AmazonWorkspaces

Simplified method form for invoking the DescribeWorkspaces operation.

Specified by:

describeWorkspaces in interface AmazonWorkspaces

See Also:

AmazonWorkspaces.describeWorkspaces(DescribeWorkspacesRequest)

describeWorkspacesConnectionStatus

public DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request)

Describes the connection status of the specified WorkSpaces.

Specified by:

describeWorkspacesConnectionStatus in interface AmazonWorkspaces

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

disassociateIpGroups

public DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest request)

Disassociates the specified IP access control group from the specified directory.

Specified by:

disassociateIpGroups in interface AmazonWorkspaces

Parameters:

disassociateIpGroupsRequest -

Returns:

Result of the DisassociateIpGroups operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

importWorkspaceImage

public ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest request)

Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.

Specified by:

importWorkspaceImage in interface AmazonWorkspaces

Parameters:

importWorkspaceImageRequest -

Returns:

Result of the ImportWorkspaceImage operation returned by the service.

Throws:

ResourceLimitExceededException - Your resource limits have been exceeded.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - The resource could not be found.

OperationNotSupportedException - This operation is not supported.

AccessDeniedException - The user is not authorized to access a resource.

InvalidParameterValuesException - One or more parameter values are not valid.

See Also:

AWS API Documentation

listAvailableManagementCidrRanges

public ListAvailableManagementCidrRangesResult listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request)

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

Specified by:

listAvailableManagementCidrRanges in interface AmazonWorkspaces

Parameters:

listAvailableManagementCidrRangesRequest -

Returns:

Result of the ListAvailableManagementCidrRanges operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

modifyAccount

public ModifyAccountResult modifyAccount(ModifyAccountRequest request)

Modifies the configuration of bring your own license (BYOL) for the specified account.

Specified by:

modifyAccount in interface AmazonWorkspaces

Parameters:

modifyAccountRequest -

Returns:

Result of the ModifyAccount operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

AccessDeniedException - The user is not authorized to access a resource.

InvalidResourceStateException - The state of the resource is not valid for this operation.

ResourceUnavailableException - The specified resource is not available.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

modifyClientProperties

public ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest request)

Modifies the properties of the specified Amazon WorkSpaces clients.

Specified by:

modifyClientProperties in interface AmazonWorkspaces

Parameters:

modifyClientPropertiesRequest -

Returns:

Result of the ModifyClientProperties operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

modifyWorkspaceProperties

public ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request)

Modifies the specified WorkSpace properties.

Specified by:

modifyWorkspaceProperties in interface AmazonWorkspaces

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 resource 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

modifyWorkspaceState

public ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest request)

Sets the state of the specified WorkSpace.

To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

Specified by:

modifyWorkspaceState in interface AmazonWorkspaces

Parameters:

modifyWorkspaceStateRequest -

Returns:

Result of the ModifyWorkspaceState operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

InvalidResourceStateException - The state of the resource is not valid for this operation.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

rebootWorkspaces

public RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest request)

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Specified by:

rebootWorkspaces in interface AmazonWorkspaces

Parameters:

rebootWorkspacesRequest -

Returns:

Result of the RebootWorkspaces operation returned by the service.

See Also:

AWS API Documentation

rebuildWorkspaces

public RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest request)

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY.

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.

Specified by:

rebuildWorkspaces in interface AmazonWorkspaces

Parameters:

rebuildWorkspacesRequest -

Returns:

Result of the RebuildWorkspaces operation returned by the service.

See Also:

AWS API Documentation

revokeIpRules

public RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest request)

Removes one or more rules from the specified IP access control group.

Specified by:

revokeIpRules in interface AmazonWorkspaces

Parameters:

revokeIpRulesRequest -

Returns:

Result of the RevokeIpRules operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

startWorkspaces

public StartWorkspacesResult startWorkspaces(StartWorkspacesRequest request)

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.

Specified by:

startWorkspaces in interface AmazonWorkspaces

Parameters:

startWorkspacesRequest -

Returns:

Result of the StartWorkspaces operation returned by the service.

See Also:

AWS API Documentation

stopWorkspaces

public StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest request)

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.

Specified by:

stopWorkspaces in interface AmazonWorkspaces

Parameters:

stopWorkspacesRequest -

Returns:

Result of the StopWorkspaces operation returned by the service.

See Also:

AWS API Documentation

terminateWorkspaces

public TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest request)

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.

Specified by:

terminateWorkspaces in interface AmazonWorkspaces

Parameters:

terminateWorkspacesRequest -

Returns:

Result of the TerminateWorkspaces operation returned by the service.

See Also:

AWS API Documentation

updateRulesOfIpGroup

public UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request)

Replaces the current rules of the specified IP access control group with the specified rules.

Specified by:

updateRulesOfIpGroup in interface AmazonWorkspaces

Parameters:

updateRulesOfIpGroupRequest -

Returns:

Result of the UpdateRulesOfIpGroup operation returned by the service.

Throws:

InvalidParameterValuesException - One or more parameter values are not valid.

ResourceNotFoundException - The resource could not be found.

ResourceLimitExceededException - Your resource limits have been exceeded.

InvalidResourceStateException - The state of the resource is not valid for this operation.

AccessDeniedException - The user is not authorized to access a resource.

See Also:

AWS API Documentation

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.