com.amazonaws.services.workspaces.AmazonWorkspaces Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workspaces Show documentation
/*
* Copyright 2017-2022 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 javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.workspaces.model.*;
/**
* Interface for accessing Amazon WorkSpaces.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.workspaces.AbstractAmazonWorkspaces} instead.
*
*
* Amazon WorkSpaces Service
*
* Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your
* users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex
* software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from
* multiple devices or web browsers.
*
*
* This API Reference provides detailed information about the actions, data types, parameters, and errors of the
* WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service
* quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon
* Web Services General Reference.
*
*
* You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs.
* For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more
* information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see
* the Amazon WorkSpaces User Guide. For more
* information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI
* Reference.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* 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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
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)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* Associates the specified connection alias with the specified directory to enable cross-Region redirection. For
* more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
*
* @param associateConnectionAliasRequest
* @return Result of the AssociateConnectionAlias operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.AssociateConnectionAlias
* @see AWS API Documentation
*/
AssociateConnectionAliasResult associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest);
/**
*
* Associates the specified IP access control group with the specified directory.
*
*
* @param associateIpGroupsRequest
* @return Result of the AssociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.AssociateIpGroups
* @see AWS
* API Documentation
*/
AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest);
/**
*
* 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.
*
*
* @param authorizeIpRulesRequest
* @return Result of the AuthorizeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.AuthorizeIpRules
* @see AWS
* API Documentation
*/
AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest);
/**
*
* Copies the specified image from the specified Region to the current Region. For more information about copying
* images, see Copy a
* Custom WorkSpaces Image.
*
*
* In the China (Ningxia) Region, you can copy images only within the same Region.
*
*
* In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services
* Support.
*
*
*
* Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services
* account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns
* an image, use the
* DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
*
*
*
* @param copyWorkspaceImageRequest
* @return Result of the CopyWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.CopyWorkspaceImage
* @see AWS
* API Documentation
*/
CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest);
/**
*
* Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client
* add-in within a directory.
*
*
* This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
*
*
* @param createConnectClientAddInRequest
* @return Result of the CreateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.CreateConnectClientAddIn
* @see AWS API Documentation
*/
CreateConnectClientAddInResult createConnectClientAddIn(CreateConnectClientAddInRequest createConnectClientAddInRequest);
/**
*
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
* @param createConnectionAliasRequest
* @return Result of the CreateConnectionAlias operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.CreateConnectionAlias
* @see AWS API Documentation
*/
CreateConnectionAliasResult createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest);
/**
*
* 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.
*
*
* @param createIpGroupRequest
* @return Result of the CreateIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceCreationFailedException
* The resource could not be created.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.CreateIpGroup
* @see AWS API
* Documentation
*/
CreateIpGroupResult createIpGroup(CreateIpGroupRequest createIpGroupRequest);
/**
*
* Creates a Standby WorkSpace in a secondary region.
*
*
* @param createStandbyWorkspacesRequest
* @return Result of the CreateStandbyWorkspaces operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @sample AmazonWorkspaces.CreateStandbyWorkspaces
* @see AWS API Documentation
*/
CreateStandbyWorkspacesResult createStandbyWorkspaces(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest);
/**
*
* Creates the specified tags for the specified WorkSpaces resource.
*
*
* @param createTagsRequest
* @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
* @see AWS API
* Documentation
*/
CreateTagsResult createTags(CreateTagsRequest createTagsRequest);
/**
*
* Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has
* the latest drivers and other updates required by the Amazon WorkSpaces components.
*
*
* To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use
* DescribeWorkspaceImages.
*
*
*
* -
*
* Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at
* this time.
*
*
* -
*
* Microsoft Windows updates and other application updates are not included in the update process.
*
*
* -
*
* The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated
* image and created a new bundle.
*
*
*
*
*
* @param createUpdatedWorkspaceImageRequest
* @return Result of the CreateUpdatedWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.CreateUpdatedWorkspaceImage
* @see AWS API Documentation
*/
CreateUpdatedWorkspaceImageResult createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest);
/**
*
* Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom
* WorkSpaces Image and Bundle.
*
*
* @param createWorkspaceBundleRequest
* @return Result of the CreateWorkspaceBundle operation returned by the service.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.CreateWorkspaceBundle
* @see AWS API Documentation
*/
CreateWorkspaceBundleResult createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest);
/**
*
* Creates a new WorkSpace image from an existing WorkSpace.
*
*
* @param createWorkspaceImageRequest
* @return Result of the CreateWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.CreateWorkspaceImage
* @see AWS API Documentation
*/
CreateWorkspaceImageResult createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest);
/**
*
* Creates one or more WorkSpaces.
*
*
* This operation is asynchronous and returns before the WorkSpaces are created.
*
*
*
* The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team
* to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
*
*
*
* @param createWorkspacesRequest
* @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
* @see AWS
* API Documentation
*/
CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest);
/**
*
* Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal.
* You can tailor your login portal company logo, the support email address, support link, link to reset password,
* and a custom message for users trying to sign in.
*
*
* After you delete your customized client branding, your login portal reverts to the default client branding.
*
*
* @param deleteClientBrandingRequest
* @return Result of the DeleteClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DeleteClientBranding
* @see AWS API Documentation
*/
DeleteClientBrandingResult deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest);
/**
*
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
*
*
* @param deleteConnectClientAddInRequest
* @return Result of the DeleteConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DeleteConnectClientAddIn
* @see AWS API Documentation
*/
DeleteConnectClientAddInResult deleteConnectClientAddIn(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest);
/**
*
* Deletes the specified connection alias. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your
* WorkSpaces users, you must take certain precautions to prevent potential security issues. For more
* information, see Security Considerations if You Stop Using Cross-Region Redirection.
*
*
*
* To delete a connection alias that has been shared, the shared account must first disassociate the connection
* alias from any directories it has been associated with. Then you must unshare the connection alias from the
* account it has been shared with. You can delete a connection alias only after it is no longer shared with any
* accounts or associated with any directories.
*
*
*
* @param deleteConnectionAliasRequest
* @return Result of the DeleteConnectionAlias operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.DeleteConnectionAlias
* @see AWS API Documentation
*/
DeleteConnectionAliasResult deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest);
/**
*
* Deletes the specified IP access control group.
*
*
* You cannot delete an IP access control group that is associated with a directory.
*
*
* @param deleteIpGroupRequest
* @return Result of the DeleteIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DeleteIpGroup
* @see AWS API
* Documentation
*/
DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest);
/**
*
* Deletes the specified tags from the specified WorkSpaces resource.
*
*
* @param deleteTagsRequest
* @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
* @see AWS API
* Documentation
*/
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest);
/**
*
* Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces
* Bundle or Image.
*
*
* @param deleteWorkspaceBundleRequest
* @return Result of the DeleteWorkspaceBundle operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DeleteWorkspaceBundle
* @see AWS API Documentation
*/
DeleteWorkspaceBundleResult deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest);
/**
*
* Deletes the specified image from your account. To delete an image, you must first delete any bundles that are
* associated with the image and unshare the image if it is shared with other accounts.
*
*
* @param deleteWorkspaceImageRequest
* @return Result of the DeleteWorkspaceImage operation returned by the service.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DeleteWorkspaceImage
* @see AWS API Documentation
*/
DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest);
/**
*
* Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is
* deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister
* the directory.
*
*
*
* Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no
* WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will
* be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per
* the Directory Service pricing terms.
*
*
* To delete empty directories, see Delete the
* Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create
* a new one when you want to start using WorkSpaces again.
*
*
*
* @param deregisterWorkspaceDirectoryRequest
* @return Result of the DeregisterWorkspaceDirectory operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @sample AmazonWorkspaces.DeregisterWorkspaceDirectory
* @see AWS API Documentation
*/
DeregisterWorkspaceDirectoryResult deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest);
/**
*
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param describeAccountRequest
* @return Result of the DescribeAccount operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeAccount
* @see AWS API
* Documentation
*/
DescribeAccountResult describeAccount(DescribeAccountRequest describeAccountRequest);
/**
*
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
* specified account.
*
*
* @param describeAccountModificationsRequest
* @return Result of the DescribeAccountModifications operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeAccountModifications
* @see AWS API Documentation
*/
DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest);
/**
*
* Describes the specified client branding. Client branding allows you to customize the log in page of various
* device types for your users. You can add your company logo, the support email address, support link, link to
* reset password, and a custom message for users trying to sign in.
*
*
*
* Only device types that have branding information configured will be shown in the response.
*
*
*
* @param describeClientBrandingRequest
* @return Result of the DescribeClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeClientBranding
* @see AWS API Documentation
*/
DescribeClientBrandingResult describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest);
/**
*
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*
*
* @param describeClientPropertiesRequest
* @return Result of the DescribeClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeClientProperties
* @see AWS API Documentation
*/
DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest);
/**
*
* Retrieves a list of Amazon Connect client add-ins that have been created.
*
*
* @param describeConnectClientAddInsRequest
* @return Result of the DescribeConnectClientAddIns operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeConnectClientAddIns
* @see AWS API Documentation
*/
DescribeConnectClientAddInsResult describeConnectClientAddIns(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest);
/**
*
* Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account
* for the specified connection alias. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
* @param describeConnectionAliasPermissionsRequest
* @return Result of the DescribeConnectionAliasPermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.DescribeConnectionAliasPermissions
* @see AWS API Documentation
*/
DescribeConnectionAliasPermissionsResult describeConnectionAliasPermissions(
DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest);
/**
*
* Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information,
* see
* Cross-Region Redirection for Amazon WorkSpaces.
*
*
* @param describeConnectionAliasesRequest
* @return Result of the DescribeConnectionAliases operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.DescribeConnectionAliases
* @see AWS API Documentation
*/
DescribeConnectionAliasesResult describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest);
/**
*
* Describes one or more of your IP access control groups.
*
*
* @param describeIpGroupsRequest
* @return Result of the DescribeIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeIpGroups
* @see AWS
* API Documentation
*/
DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest);
/**
*
* Describes the specified tags for the specified WorkSpaces resource.
*
*
* @param describeTagsRequest
* @return Result of the DescribeTags operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.DescribeTags
* @see AWS API
* Documentation
*/
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
* Retrieves a list that describes the available WorkSpace bundles.
*
*
* You can filter the results using either bundle ID or owner, but not both.
*
*
* @param describeWorkspaceBundlesRequest
* @return Result of the DescribeWorkspaceBundles operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspaceBundles
* @see AWS API Documentation
*/
DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaceBundles operation.
*
* @see #describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)
*/
DescribeWorkspaceBundlesResult describeWorkspaceBundles();
/**
*
* Describes the available directories that are registered with Amazon WorkSpaces.
*
*
* @param describeWorkspaceDirectoriesRequest
* @return Result of the DescribeWorkspaceDirectories operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspaceDirectories
* @see AWS API Documentation
*/
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaceDirectories operation.
*
* @see #describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)
*/
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories();
/**
*
* Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
* image.
*
*
* @param describeWorkspaceImagePermissionsRequest
* @return Result of the DescribeWorkspaceImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.DescribeWorkspaceImagePermissions
* @see AWS API Documentation
*/
DescribeWorkspaceImagePermissionsResult describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest);
/**
*
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise,
* all images in the account are described.
*
*
* @param describeWorkspaceImagesRequest
* @return Result of the DescribeWorkspaceImages operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeWorkspaceImages
* @see AWS API Documentation
*/
DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest);
/**
*
* Describes the snapshots for the specified WorkSpace.
*
*
* @param describeWorkspaceSnapshotsRequest
* @return Result of the DescribeWorkspaceSnapshots operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DescribeWorkspaceSnapshots
* @see AWS API Documentation
*/
DescribeWorkspaceSnapshotsResult describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest);
/**
*
* 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.
*
*
* @param describeWorkspacesRequest
* @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
* @see AWS
* API Documentation
*/
DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest);
/**
* Simplified method form for invoking the DescribeWorkspaces operation.
*
* @see #describeWorkspaces(DescribeWorkspacesRequest)
*/
DescribeWorkspacesResult describeWorkspaces();
/**
*
* Describes the connection status of the specified WorkSpaces.
*
*
* @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
* @see AWS API Documentation
*/
DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(
DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest);
/**
*
* Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region
* redirection between two directories in different Regions. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
*
* @param disassociateConnectionAliasRequest
* @return Result of the DisassociateConnectionAlias operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.DisassociateConnectionAlias
* @see AWS API Documentation
*/
DisassociateConnectionAliasResult disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest);
/**
*
* Disassociates the specified IP access control group from the specified directory.
*
*
* @param disassociateIpGroupsRequest
* @return Result of the DisassociateIpGroups operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.DisassociateIpGroups
* @see AWS API Documentation
*/
DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest);
/**
*
* Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can
* tailor your login portal company logo, the support email address, support link, link to reset password, and a
* custom message for users trying to sign in.
*
*
* After you import client branding, the default branding experience for the specified platform type is replaced
* with the imported experience
*
*
*
* -
*
* You must specify at least one platform type when importing client branding.
*
*
* -
*
* You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client
* branding for different platform types using separate requests.
*
*
* -
*
* In each platform type, the SupportEmail and SupportLink parameters are mutually
* exclusive. You can specify only one parameter for each platform type, but not both.
*
*
* -
*
* Imported data can take up to a minute to appear in the WorkSpaces client.
*
*
*
*
*
* @param importClientBrandingRequest
* @return Result of the ImportClientBranding operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.ImportClientBranding
* @see AWS API Documentation
*/
ImportClientBrandingResult importClientBranding(ImportClientBrandingRequest importClientBrandingRequest);
/**
*
* Imports the specified Windows 10 Bring Your Own License (BYOL) or Windows Server 2016 BYOL image into Amazon
* WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account,
* and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows
* Desktop Licenses.
*
*
* @param importWorkspaceImageRequest
* @return Result of the ImportWorkspaceImage operation returned by the service.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @sample AmazonWorkspaces.ImportWorkspaceImage
* @see AWS API Documentation
*/
ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest);
/**
*
* 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).
*
*
* This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't
* enabled for BYOL, you'll receive an AccessDeniedException error.
*
*
* 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.
*
*
* @param listAvailableManagementCidrRangesRequest
* @return Result of the ListAvailableManagementCidrRanges operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.ListAvailableManagementCidrRanges
* @see AWS API Documentation
*/
ListAvailableManagementCidrRangesResult listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest);
/**
*
* Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
* volume.
*
*
* The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
* user volume from the last available snapshot of the original WorkSpace. During migration, the original
* D:\Users\%USERNAME% user profile folder is renamed to
* D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
* generated by the new OS. Certain files in the old user profile are moved to the new user profile.
*
*
* For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
*
*
* @param migrateWorkspaceRequest
* @return Result of the MigrateWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @sample AmazonWorkspaces.MigrateWorkspace
* @see AWS
* API Documentation
*/
MigrateWorkspaceResult migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest);
/**
*
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*
*
* @param modifyAccountRequest
* @return Result of the ModifyAccount operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.ModifyAccount
* @see AWS API
* Documentation
*/
ModifyAccountResult modifyAccount(ModifyAccountRequest modifyAccountRequest);
/**
*
* Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
*
*
* @param modifyCertificateBasedAuthPropertiesRequest
* @return Result of the ModifyCertificateBasedAuthProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.ModifyCertificateBasedAuthProperties
* @see AWS API Documentation
*/
ModifyCertificateBasedAuthPropertiesResult modifyCertificateBasedAuthProperties(
ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest);
/**
*
* Modifies the properties of the specified Amazon WorkSpaces clients.
*
*
* @param modifyClientPropertiesRequest
* @return Result of the ModifyClientProperties operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.ModifyClientProperties
* @see AWS API Documentation
*/
ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest);
/**
*
* Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access
* URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
*
*
* @param modifySamlPropertiesRequest
* @return Result of the ModifySamlProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.ModifySamlProperties
* @see AWS API Documentation
*/
ModifySamlPropertiesResult modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest);
/**
*
* Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
*
*
* @param modifySelfservicePermissionsRequest
* @return Result of the ModifySelfservicePermissions operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @sample AmazonWorkspaces.ModifySelfservicePermissions
* @see AWS API Documentation
*/
ModifySelfservicePermissionsResult modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest);
/**
*
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see
*
* Control Device Access.
*
*
* @param modifyWorkspaceAccessPropertiesRequest
* @return Result of the ModifyWorkspaceAccessProperties operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.ModifyWorkspaceAccessProperties
* @see AWS API Documentation
*/
ModifyWorkspaceAccessPropertiesResult modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest);
/**
*
* Modify the default properties used to create WorkSpaces.
*
*
* @param modifyWorkspaceCreationPropertiesRequest
* @return Result of the ModifyWorkspaceCreationProperties operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.ModifyWorkspaceCreationProperties
* @see AWS API Documentation
*/
ModifyWorkspaceCreationPropertiesResult modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest);
/**
*
* Modifies the specified WorkSpace properties. For important information about how to modify the size of the root
* and user volumes, see
* Modify a WorkSpace.
*
*
*
* The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team
* to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
*
*
*
* @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 state of the resource is not valid for this operation.
* @throws OperationInProgressException
* The properties of this WorkSpace are currently being modified. Try again in a moment.
* @throws UnsupportedWorkspaceConfigurationException
* The configuration of this WorkSpace is not supported for this operation. For more information, see Required
* Configuration and Service Components for WorkSpaces .
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @sample AmazonWorkspaces.ModifyWorkspaceProperties
* @see AWS API Documentation
*/
ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest);
/**
*
* 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.
*
*
* @param modifyWorkspaceStateRequest
* @return Result of the ModifyWorkspaceState operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.ModifyWorkspaceState
* @see AWS API Documentation
*/
ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest);
/**
*
* 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.
*
*
* @param rebootWorkspacesRequest
* @return Result of the RebootWorkspaces operation returned by the service.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.RebootWorkspaces
* @see AWS
* API Documentation
*/
RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest);
/**
*
* Rebuilds the specified WorkSpace.
*
*
* You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR,
* UNHEALTHY, STOPPED, or REBOOTING.
*
*
* 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.
*
*
* @param rebuildWorkspacesRequest
* @return Result of the RebuildWorkspaces operation returned by the service.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.RebuildWorkspaces
* @see AWS
* API Documentation
*/
RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest);
/**
*
* Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is
* registered. If this is the first time you are registering a directory, you will need to create the
* workspaces_DefaultRole role before you can register a directory. For more information, see
* Creating the workspaces_DefaultRole Role.
*
*
* @param registerWorkspaceDirectoryRequest
* @return Result of the RegisterWorkspaceDirectory operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws WorkspacesDefaultRoleNotFoundException
* The workspaces_DefaultRole role could not be found. If this is the first time you are registering a
* directory, you will need to create the workspaces_DefaultRole role before you can register a directory.
* For more information, see Creating the workspaces_DefaultRole Role.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws UnsupportedNetworkConfigurationException
* The configuration of this network is not supported for this operation, or your network configuration
* conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a
* VPC for Amazon WorkSpaces.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.RegisterWorkspaceDirectory
* @see AWS API Documentation
*/
RegisterWorkspaceDirectoryResult registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest);
/**
*
* Restores the specified WorkSpace to its last known healthy state.
*
*
* You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
* UNHEALTHY, or STOPPED.
*
*
* Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more
* information, see Restore a WorkSpace.
*
*
* This operation is asynchronous and returns before the WorkSpace is completely restored.
*
*
* @param restoreWorkspaceRequest
* @return Result of the RestoreWorkspace operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.RestoreWorkspace
* @see AWS
* API Documentation
*/
RestoreWorkspaceResult restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest);
/**
*
* Removes one or more rules from the specified IP access control group.
*
*
* @param revokeIpRulesRequest
* @return Result of the RevokeIpRules operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.RevokeIpRules
* @see AWS API
* Documentation
*/
RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest);
/**
*
* Starts the specified WorkSpaces.
*
*
* You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
* STOPPED.
*
*
* @param startWorkspacesRequest
* @return Result of the StartWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.StartWorkspaces
* @see AWS API
* Documentation
*/
StartWorkspacesResult startWorkspaces(StartWorkspacesRequest startWorkspacesRequest);
/**
*
* 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.
*
*
* @param stopWorkspacesRequest
* @return Result of the StopWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.StopWorkspaces
* @see AWS API
* Documentation
*/
StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest);
/**
*
* 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 Support 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. After a
* WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
* directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
* check for the WorkSpace ID by using DescribeWorkSpaces. If
* the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
*
*
*
* Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no
* WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will
* be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per
* the Directory Service pricing terms.
*
*
* To delete empty directories, see Delete the
* Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create
* a new one when you want to start using WorkSpaces again.
*
*
*
* @param terminateWorkspacesRequest
* @return Result of the TerminateWorkspaces operation returned by the service.
* @sample AmazonWorkspaces.TerminateWorkspaces
* @see AWS
* API Documentation
*/
TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest);
/**
*
* Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect
* client add-in.
*
*
* @param updateConnectClientAddInRequest
* @return Result of the UpdateConnectClientAddIn operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.UpdateConnectClientAddIn
* @see AWS API Documentation
*/
UpdateConnectClientAddInResult updateConnectClientAddIn(UpdateConnectClientAddInRequest updateConnectClientAddInRequest);
/**
*
* Shares or unshares a connection alias with one account by specifying whether that account has permission to
* associate the connection alias with a directory. If the association permission is granted, the connection alias
* is shared with that account. If the association permission is revoked, the connection alias is unshared with the
* account. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*
*
* -
*
* Before performing this operation, call
* DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
* .
*
*
* -
*
* To delete a connection alias that has been shared, the shared account must first disassociate the connection
* alias from any directories it has been associated with. Then you must unshare the connection alias from the
* account it has been shared with. You can delete a connection alias only after it is no longer shared with any
* accounts or associated with any directories.
*
*
*
*
*
* @param updateConnectionAliasPermissionRequest
* @return Result of the UpdateConnectionAliasPermission operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceAssociatedException
* The resource is associated with a directory.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.UpdateConnectionAliasPermission
* @see AWS API Documentation
*/
UpdateConnectionAliasPermissionResult updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest);
/**
*
* Replaces the current rules of the specified IP access control group with the specified rules.
*
*
* @param updateRulesOfIpGroupRequest
* @return Result of the UpdateRulesOfIpGroup operation returned by the service.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceLimitExceededException
* Your resource limits have been exceeded.
* @throws InvalidResourceStateException
* The state of the resource is not valid for this operation.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @sample AmazonWorkspaces.UpdateRulesOfIpGroup
* @see AWS API Documentation
*/
UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest);
/**
*
* Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom
* WorkSpaces Bundle.
*
*
*
* Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update
* existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or
* delete and recreate them.
*
*
*
* @param updateWorkspaceBundleRequest
* @return Result of the UpdateWorkspaceBundle operation returned by the service.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.UpdateWorkspaceBundle
* @see AWS API Documentation
*/
UpdateWorkspaceBundleResult updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest);
/**
*
* Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that
* account has permission to copy the image. If the copy image permission is granted, the image is shared with that
* account. If the copy image permission is revoked, the image is unshared with the account.
*
*
* After an image has been shared, the recipient account can copy the image to other Regions as needed.
*
*
* In the China (Ningxia) Region, you can copy images only within the same Region.
*
*
* In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services
* Support.
*
*
* For more information about sharing images, see Share or Unshare a
* Custom WorkSpaces Image.
*
*
*
* -
*
* To delete an image that has been shared, you must unshare the image before you delete it.
*
*
* -
*
* Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in
* Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US),
* contact Amazon Web Services Support.
*
*
*
*
*
* @param updateWorkspaceImagePermissionRequest
* @return Result of the UpdateWorkspaceImagePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource could not be found.
* @throws ResourceUnavailableException
* The specified resource is not available.
* @throws AccessDeniedException
* The user is not authorized to access a resource.
* @throws InvalidParameterValuesException
* One or more parameter values are not valid.
* @throws OperationNotSupportedException
* This operation is not supported.
* @sample AmazonWorkspaces.UpdateWorkspaceImagePermission
* @see AWS API Documentation
*/
UpdateWorkspaceImagePermissionResult updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest);
/**
* 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);
}