@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkspaces
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkspaces instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptAccountLinkInvitationResult |
acceptAccountLinkInvitation(AcceptAccountLinkInvitationRequest acceptAccountLinkInvitationRequest)
Accepts the account link invitation.
|
AssociateConnectionAliasResult |
associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest)
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
|
AssociateIpGroupsResult |
associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
|
AssociateWorkspaceApplicationResult |
associateWorkspaceApplication(AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest)
Associates the specified application to the specified WorkSpace.
|
AuthorizeIpRulesResult |
authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
|
CopyWorkspaceImageResult |
copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)
Copies the specified image from the specified Region to the current Region.
|
CreateAccountLinkInvitationResult |
createAccountLinkInvitation(CreateAccountLinkInvitationRequest createAccountLinkInvitationRequest)
Creates the account link invitation.
|
CreateConnectClientAddInResult |
createConnectClientAddIn(CreateConnectClientAddInRequest createConnectClientAddInRequest)
Creates a client-add-in for Amazon Connect within a directory.
|
CreateConnectionAliasResult |
createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection.
|
CreateIpGroupResult |
createIpGroup(CreateIpGroupRequest createIpGroupRequest)
Creates an IP access control group.
|
CreateStandbyWorkspacesResult |
createStandbyWorkspaces(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest)
Creates a standby WorkSpace in a secondary Region.
|
CreateTagsResult |
createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified WorkSpaces resource.
|
CreateUpdatedWorkspaceImageResult |
createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest)
Creates a new updated WorkSpace image based on the specified source image.
|
CreateWorkspaceBundleResult |
createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle.
|
CreateWorkspaceImageResult |
createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest)
Creates a new WorkSpace image from an existing WorkSpace.
|
CreateWorkspacesResult |
createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
|
CreateWorkspacesPoolResult |
createWorkspacesPool(CreateWorkspacesPoolRequest createWorkspacesPoolRequest)
Creates a pool of WorkSpaces.
|
DeleteAccountLinkInvitationResult |
deleteAccountLinkInvitation(DeleteAccountLinkInvitationRequest deleteAccountLinkInvitationRequest)
Deletes the account link invitation.
|
DeleteClientBrandingResult |
deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest)
Deletes customized client branding.
|
DeleteConnectClientAddInResult |
deleteConnectClientAddIn(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest)
Deletes a client-add-in for Amazon Connect that is configured within a directory.
|
DeleteConnectionAliasResult |
deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)
Deletes the specified connection alias.
|
DeleteIpGroupResult |
deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
Deletes the specified IP access control group.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpaces resource.
|
DeleteWorkspaceBundleResult |
deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle.
|
DeleteWorkspaceImageResult |
deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
Deletes the specified image from your account.
|
DeployWorkspaceApplicationsResult |
deployWorkspaceApplications(DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest)
Deploys associated applications to the specified WorkSpace
|
DeregisterWorkspaceDirectoryResult |
deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)
Deregisters the specified directory.
|
DescribeAccountResult |
describeAccount(DescribeAccountRequest describeAccountRequest)
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
|
DescribeAccountModificationsResult |
describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
specified account.
|
DescribeApplicationAssociationsResult |
describeApplicationAssociations(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest)
Describes the associations between the application and the specified associated resources.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Describes the specified applications by filtering based on their compute types, license availability, operating
systems, and owners.
|
DescribeBundleAssociationsResult |
describeBundleAssociations(DescribeBundleAssociationsRequest describeBundleAssociationsRequest)
Describes the associations between the applications and the specified bundle.
|
DescribeClientBrandingResult |
describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest)
Describes the specified client branding.
|
DescribeClientPropertiesResult |
describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
DescribeConnectClientAddInsResult |
describeConnectClientAddIns(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest)
Retrieves a list of Amazon Connect client add-ins that have been created.
|
DescribeConnectionAliasesResult |
describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection.
|
DescribeConnectionAliasPermissionsResult |
describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest)
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account
for the specified connection alias.
|
DescribeImageAssociationsResult |
describeImageAssociations(DescribeImageAssociationsRequest describeImageAssociationsRequest)
Describes the associations between the applications and the specified image.
|
DescribeIpGroupsResult |
describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
Describes one or more of your IP access control groups.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpaces resource.
|
DescribeWorkspaceAssociationsResult |
describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest)
Describes the associations betweens applications and the specified WorkSpace.
|
DescribeWorkspaceBundlesResult |
describeWorkspaceBundles()
Simplified method form for invoking the DescribeWorkspaceBundles operation.
|
DescribeWorkspaceBundlesResult |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
DescribeWorkspaceDirectoriesResult |
describeWorkspaceDirectories()
Simplified method form for invoking the DescribeWorkspaceDirectories operation.
|
DescribeWorkspaceDirectoriesResult |
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
|
DescribeWorkspaceImagePermissionsResult |
describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
image.
|
DescribeWorkspaceImagesResult |
describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
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 describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
DescribeWorkspacesConnectionStatusResult |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
|
DescribeWorkspaceSnapshotsResult |
describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
|
DescribeWorkspacesPoolsResult |
describeWorkspacesPools(DescribeWorkspacesPoolsRequest describeWorkspacesPoolsRequest)
Describes the specified WorkSpaces Pools.
|
DescribeWorkspacesPoolSessionsResult |
describeWorkspacesPoolSessions(DescribeWorkspacesPoolSessionsRequest describeWorkspacesPoolSessionsRequest)
Retrieves a list that describes the streaming sessions for a specified pool.
|
DisassociateConnectionAliasResult |
disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest)
Disassociates a connection alias from a directory.
|
DisassociateIpGroupsResult |
disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
|
DisassociateWorkspaceApplicationResult |
disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest)
Disassociates the specified application from a WorkSpace.
|
GetAccountLinkResult |
getAccountLink(GetAccountLinkRequest getAccountLinkRequest)
Retrieves account link information.
|
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.
|
ImportClientBrandingResult |
importClientBranding(ImportClientBrandingRequest importClientBrandingRequest)
Imports client branding.
|
ImportWorkspaceImageResult |
importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
|
ListAccountLinksResult |
listAccountLinks(ListAccountLinksRequest listAccountLinksRequest)
Lists all account links.
|
ListAvailableManagementCidrRangesResult |
listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
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).
|
MigrateWorkspaceResult |
migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
volume.
|
ModifyAccountResult |
modifyAccount(ModifyAccountRequest modifyAccountRequest)
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
|
ModifyCertificateBasedAuthPropertiesResult |
modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest)
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
|
ModifyClientPropertiesResult |
modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces clients.
|
ModifySamlPropertiesResult |
modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest)
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.
|
ModifySelfservicePermissionsResult |
modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users.
|
ModifyStreamingPropertiesResult |
modifyStreamingProperties(ModifyStreamingPropertiesRequest modifyStreamingPropertiesRequest)
Modifies the specified streaming properties.
|
ModifyWorkspaceAccessPropertiesResult |
modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces.
|
ModifyWorkspaceCreationPropertiesResult |
modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
|
ModifyWorkspacePropertiesResult |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
|
ModifyWorkspaceStateResult |
modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
|
RebootWorkspacesResult |
rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
RebuildWorkspacesResult |
rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
|
RegisterWorkspaceDirectoryResult |
registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)
Registers the specified directory.
|
RejectAccountLinkInvitationResult |
rejectAccountLinkInvitation(RejectAccountLinkInvitationRequest rejectAccountLinkInvitationRequest)
Rejects the account link invitation.
|
RestoreWorkspaceResult |
restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)
Restores the specified WorkSpace to its last known healthy state.
|
RevokeIpRulesResult |
revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartWorkspacesResult |
startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
|
StartWorkspacesPoolResult |
startWorkspacesPool(StartWorkspacesPoolRequest startWorkspacesPoolRequest)
Starts the specified pool.
|
StopWorkspacesResult |
stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
StopWorkspacesPoolResult |
stopWorkspacesPool(StopWorkspacesPoolRequest stopWorkspacesPoolRequest)
Stops the specified pool.
|
TerminateWorkspacesResult |
terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
TerminateWorkspacesPoolResult |
terminateWorkspacesPool(TerminateWorkspacesPoolRequest terminateWorkspacesPoolRequest)
Terminates the specified pool.
|
TerminateWorkspacesPoolSessionResult |
terminateWorkspacesPoolSession(TerminateWorkspacesPoolSessionRequest terminateWorkspacesPoolSessionRequest)
Terminates the pool session.
|
UpdateConnectClientAddInResult |
updateConnectClientAddIn(UpdateConnectClientAddInRequest updateConnectClientAddInRequest)
Updates a Amazon Connect client add-in.
|
UpdateConnectionAliasPermissionResult |
updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest)
Shares or unshares a connection alias with one account by specifying whether that account has permission to
associate the connection alias with a directory.
|
UpdateRulesOfIpGroupResult |
updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
|
UpdateWorkspaceBundleResult |
updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)
Updates a WorkSpace bundle with a new image.
|
UpdateWorkspaceImagePermissionResult |
updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest)
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.
|
UpdateWorkspacesPoolResult |
updateWorkspacesPool(UpdateWorkspacesPoolRequest updateWorkspacesPoolRequest)
Updates the specified pool.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://workspaces.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: 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.
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 void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AcceptAccountLinkInvitationResult acceptAccountLinkInvitation(AcceptAccountLinkInvitationRequest acceptAccountLinkInvitationRequest)
Accepts the account link invitation.
There's currently no unlinking capability after you accept the account linking invitation.
acceptAccountLinkInvitationRequest - ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ConflictException - The TargetAccountId is already linked or invited.InternalServerException - Unexpected server error occured.AssociateConnectionAliasResult associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest)
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
.
associateConnectionAliasRequest - ResourceAssociatedException - The resource is associated with a directory.AccessDeniedException - The user is not authorized to access a resource.ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationNotSupportedException - This operation is not supported.AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
associateIpGroupsRequest - 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.AssociateWorkspaceApplicationResult associateWorkspaceApplication(AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest)
Associates the specified application to the specified WorkSpace.
associateWorkspaceApplicationRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceAlreadyExistsException - The specified resource already exists.ResourceInUseException - The specified resource is currently in use.ResourceNotFoundException - The resource could not be found.ComputeNotCompatibleException - The compute type of the WorkSpace is not compatible with the application.OperatingSystemNotCompatibleException - The operating system of the WorkSpace is not compatible with the application.ApplicationNotSupportedException - The specified application is not supported.IncompatibleApplicationsException - The specified application is not compatible with the resource.AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
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.
authorizeIpRulesRequest - 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.CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)
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.
copyWorkspaceImageRequest - 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.CreateAccountLinkInvitationResult createAccountLinkInvitation(CreateAccountLinkInvitationRequest createAccountLinkInvitationRequest)
Creates the account link invitation.
createAccountLinkInvitationRequest - ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.AccessDeniedException - The user is not authorized to access a resource.ConflictException - The TargetAccountId is already linked or invited.InternalServerException - Unexpected server error occured.CreateConnectClientAddInResult createConnectClientAddIn(CreateConnectClientAddInRequest createConnectClientAddInRequest)
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.
createConnectClientAddInRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceCreationFailedException - The resource could not be created.ResourceAlreadyExistsException - The specified resource already exists.AccessDeniedException - The user is not authorized to access a resource.CreateConnectionAliasResult createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
createConnectionAliasRequest - ResourceAlreadyExistsException - The specified resource already exists.AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationNotSupportedException - This operation is not supported.CreateIpGroupResult createIpGroup(CreateIpGroupRequest createIpGroupRequest)
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.
createIpGroupRequest - 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.CreateStandbyWorkspacesResult createStandbyWorkspaces(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest)
Creates a standby WorkSpace in a secondary Region.
createStandbyWorkspacesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.CreateTagsResult createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified WorkSpaces resource.
createTagsRequest - ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.CreateUpdatedWorkspaceImageResult createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest)
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 Server 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.
createUpdatedWorkspaceImageRequest - 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.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.CreateWorkspaceBundleResult createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
createWorkspaceBundleRequest - ResourceUnavailableException - The specified resource is not available.ResourceAlreadyExistsException - The specified resource already exists.ResourceLimitExceededException - Your resource limits have been exceeded.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.CreateWorkspaceImageResult createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest)
Creates a new WorkSpace image from an existing WorkSpace.
createWorkspaceImageRequest - 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.InvalidResourceStateException - The state of the resource is not valid for this operation.AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
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.
You don't need to specify the PCOIP protocol for Linux bundles because WSP is the
default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
createWorkspacesRequest - ResourceLimitExceededException - Your resource limits have been exceeded.InvalidParameterValuesException - One or more parameter values are not valid.CreateWorkspacesPoolResult createWorkspacesPool(CreateWorkspacesPoolRequest createWorkspacesPoolRequest)
Creates a pool of WorkSpaces.
createWorkspacesPoolRequest - ResourceLimitExceededException - Your resource limits have been exceeded.ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.ResourceAlreadyExistsException - The specified resource already exists.OperationNotSupportedException - This operation is not supported.AccessDeniedException - The user is not authorized to access a resource.DeleteAccountLinkInvitationResult deleteAccountLinkInvitation(DeleteAccountLinkInvitationRequest deleteAccountLinkInvitationRequest)
Deletes the account link invitation.
deleteAccountLinkInvitationRequest - ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.AccessDeniedException - The user is not authorized to access a resource.ResourceNotFoundException - The resource could not be found.ConflictException - The TargetAccountId is already linked or invited.InternalServerException - Unexpected server error occured.DeleteClientBrandingResult deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest)
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.
deleteClientBrandingRequest - 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.DeleteConnectClientAddInResult deleteConnectClientAddIn(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest)
Deletes a client-add-in for Amazon Connect that is configured within a directory.
deleteConnectClientAddInRequest - 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.DeleteConnectionAliasResult deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)
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.
deleteConnectionAliasRequest - 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.InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationNotSupportedException - This operation is not supported.DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroupRequest - 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.DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpaces resource.
deleteTagsRequest - ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.DeleteWorkspaceBundleResult deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
deleteWorkspaceBundleRequest - 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.DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
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.
deleteWorkspaceImageRequest - 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.DeployWorkspaceApplicationsResult deployWorkspaceApplications(DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest)
Deploys associated applications to the specified WorkSpace
deployWorkspaceApplicationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceInUseException - The specified resource is currently in use.ResourceNotFoundException - The resource could not be found.IncompatibleApplicationsException - The specified application is not compatible with the resource.DeregisterWorkspaceDirectoryResult deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)
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.
deregisterWorkspaceDirectoryRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The state of the resource is not valid for this operation.DescribeAccountResult describeAccount(DescribeAccountRequest describeAccountRequest)
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountRequest - AccessDeniedException - The user is not authorized to access a resource.DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountModificationsRequest - AccessDeniedException - The user is not authorized to access a resource.DescribeApplicationAssociationsResult describeApplicationAssociations(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest)
Describes the associations between the application and the specified associated resources.
describeApplicationAssociationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
describeApplicationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.DescribeBundleAssociationsResult describeBundleAssociations(DescribeBundleAssociationsRequest describeBundleAssociationsRequest)
Describes the associations between the applications and the specified bundle.
describeBundleAssociationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.DescribeClientBrandingResult describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest)
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.
describeClientBrandingRequest - 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.DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientPropertiesRequest - 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.DescribeConnectClientAddInsResult describeConnectClientAddIns(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest)
Retrieves a list of Amazon Connect client add-ins that have been created.
describeConnectClientAddInsRequest - 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.DescribeConnectionAliasPermissionsResult describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest)
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.
describeConnectionAliasPermissionsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.DescribeConnectionAliasesResult describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.DescribeImageAssociationsResult describeImageAssociations(DescribeImageAssociationsRequest describeImageAssociationsRequest)
Describes the associations between the applications and the specified image.
describeImageAssociationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
Describes one or more of your IP access control groups.
describeIpGroupsRequest - InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpaces resource.
describeTagsRequest - ResourceNotFoundException - The resource could not be found.DescribeWorkspaceAssociationsResult describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest)
Describes the associations betweens applications and the specified WorkSpace.
describeWorkspaceAssociationsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundlesRequest - InvalidParameterValuesException - One or more parameter values are not valid.DescribeWorkspaceBundlesResult describeWorkspaceBundles()
DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesRequest - InvalidParameterValuesException - One or more parameter values are not valid.DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()
DescribeWorkspaceImagePermissionsResult describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
describeWorkspaceImagePermissionsRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImagesRequest - AccessDeniedException - The user is not authorized to access a resource.DescribeWorkspaceSnapshotsResult describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
describeWorkspaceSnapshotsRequest - 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.DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
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.
describeWorkspacesRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceUnavailableException - The specified resource is not available.DescribeWorkspacesResult describeWorkspaces()
DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatusRequest - InvalidParameterValuesException - One or more parameter values are not valid.DescribeWorkspacesPoolSessionsResult describeWorkspacesPoolSessions(DescribeWorkspacesPoolSessionsRequest describeWorkspacesPoolSessionsRequest)
Retrieves a list that describes the streaming sessions for a specified pool.
describeWorkspacesPoolSessionsRequest - 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.DescribeWorkspacesPoolsResult describeWorkspacesPools(DescribeWorkspacesPoolsRequest describeWorkspacesPoolsRequest)
Describes the specified WorkSpaces Pools.
describeWorkspacesPoolsRequest - 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.DisassociateConnectionAliasResult disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest)
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
.
disassociateConnectionAliasRequest - AccessDeniedException - The user is not authorized to access a resource.ResourceNotFoundException - The resource could not be found.InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationNotSupportedException - This operation is not supported.DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
disassociateIpGroupsRequest - 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.OperationNotSupportedException - This operation is not supported.DisassociateWorkspaceApplicationResult disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest)
Disassociates the specified application from a WorkSpace.
disassociateWorkspaceApplicationRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceInUseException - The specified resource is currently in use.ResourceNotFoundException - The resource could not be found.GetAccountLinkResult getAccountLink(GetAccountLinkRequest getAccountLinkRequest)
Retrieves account link information.
getAccountLinkRequest - AccessDeniedException - The user is not authorized to access a resource.ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.ResourceNotFoundException - The resource could not be found.InternalServerException - Unexpected server error occured.ImportClientBrandingResult importClientBranding(ImportClientBrandingRequest importClientBrandingRequest)
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.
importClientBrandingRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified Windows 10 or 11 Bring Your Own License (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.
importWorkspaceImageRequest - 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.ListAccountLinksResult listAccountLinks(ListAccountLinksRequest listAccountLinksRequest)
Lists all account links.
listAccountLinksRequest - AccessDeniedException - The user is not authorized to access a resource.ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.InternalServerException - Unexpected server error occured.ListAvailableManagementCidrRangesResult listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
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.
listAvailableManagementCidrRangesRequest - InvalidParameterValuesException - One or more parameter values are not valid.AccessDeniedException - The user is not authorized to access a resource.MigrateWorkspaceResult migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)
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.
migrateWorkspaceRequest - 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.OperationNotSupportedException - This operation is not supported.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.ResourceUnavailableException - The specified resource is not available.ModifyAccountResult modifyAccount(ModifyAccountRequest modifyAccountRequest)
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
modifyAccountRequest - 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.ModifyCertificateBasedAuthPropertiesResult modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest)
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
modifyCertificateBasedAuthPropertiesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces clients.
modifyClientPropertiesRequest - 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.OperationNotSupportedException - This operation is not supported.ModifySamlPropertiesResult modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest)
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.
modifySamlPropertiesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.ResourceNotFoundException - The resource could not be found.ModifySelfservicePermissionsResult modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
modifySelfservicePermissionsRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.ModifyStreamingPropertiesResult modifyStreamingProperties(ModifyStreamingPropertiesRequest modifyStreamingPropertiesRequest)
Modifies the specified streaming properties.
modifyStreamingPropertiesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.ModifyWorkspaceAccessPropertiesResult modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
modifyWorkspaceAccessPropertiesRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ModifyWorkspaceCreationPropertiesResult modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
modifyWorkspaceCreationPropertiesRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
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.
modifyWorkspacePropertiesRequest - 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 Required
Configuration and Service Components for WorkSpaces .ResourceNotFoundException - The resource could not be found.AccessDeniedException - The user is not authorized to access a resource.ResourceUnavailableException - The specified resource is not available.ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
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.
modifyWorkspaceStateRequest - 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.OperationNotSupportedException - This operation is not supported.RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or
REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been
stuck in the REBOOTING state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesRequest - OperationNotSupportedException - This operation is not supported.RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
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.
rebuildWorkspacesRequest - OperationNotSupportedException - This operation is not supported.RegisterWorkspaceDirectoryResult registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)
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.
registerWorkspaceDirectoryRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceLimitExceededException - Your resource limits have been exceeded.AccessDeniedException - The user is not authorized to access a resource.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.InvalidResourceStateException - The state of the resource is not valid for this operation.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.OperationNotSupportedException - This operation is not supported.ResourceAlreadyExistsException - The specified resource already exists.RejectAccountLinkInvitationResult rejectAccountLinkInvitation(RejectAccountLinkInvitationRequest rejectAccountLinkInvitationRequest)
Rejects the account link invitation.
rejectAccountLinkInvitationRequest - AccessDeniedException - The user is not authorized to access a resource.ValidationException - You either haven't provided a TargetAccountId or are using the same value for
TargetAccountId and SourceAccountId.ResourceNotFoundException - The resource could not be found.ConflictException - The TargetAccountId is already linked or invited.InternalServerException - Unexpected server error occured.RestoreWorkspaceResult restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)
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.
restoreWorkspaceRequest - 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.OperationNotSupportedException - This operation is not supported.RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
revokeIpRulesRequest - 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.StartWorkspacesResult startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
startWorkspacesRequest - StartWorkspacesPoolResult startWorkspacesPool(StartWorkspacesPoolRequest startWorkspacesPoolRequest)
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED
.
startWorkspacesPoolRequest - InvalidParameterValuesException - One or more parameter values are not valid.InvalidResourceStateException - The state of the resource is not valid for this operation.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.AccessDeniedException - The user is not authorized to access a resource.StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
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.
stopWorkspacesRequest - StopWorkspacesPoolResult stopWorkspacesPool(StopWorkspacesPoolRequest stopWorkspacesPoolRequest)
Stops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesPoolRequest - 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.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.AccessDeniedException - The user is not authorized to access a resource.TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
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.
terminateWorkspacesRequest - TerminateWorkspacesPoolResult terminateWorkspacesPool(TerminateWorkspacesPoolRequest terminateWorkspacesPoolRequest)
Terminates the specified pool.
terminateWorkspacesPoolRequest - 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.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.AccessDeniedException - The user is not authorized to access a resource.TerminateWorkspacesPoolSessionResult terminateWorkspacesPoolSession(TerminateWorkspacesPoolSessionRequest terminateWorkspacesPoolSessionRequest)
Terminates the pool session.
terminateWorkspacesPoolSessionRequest - InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.OperationNotSupportedException - This operation is not supported.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.AccessDeniedException - The user is not authorized to access a resource.UpdateConnectClientAddInResult updateConnectClientAddIn(UpdateConnectClientAddInRequest updateConnectClientAddInRequest)
Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
updateConnectClientAddInRequest - 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.UpdateConnectionAliasPermissionResult updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest)
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.
updateConnectionAliasPermissionRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceLimitExceededException - Your resource limits have been exceeded.ResourceNotFoundException - The resource could not be found.ResourceAssociatedException - The resource is associated with a directory.InvalidResourceStateException - The state of the resource is not valid for this operation.OperationNotSupportedException - This operation is not supported.UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroupRequest - 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.UpdateWorkspaceBundleResult updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)
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.
updateWorkspaceBundleRequest - AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.ResourceNotFoundException - The resource could not be found.ResourceUnavailableException - The specified resource is not available.OperationNotSupportedException - This operation is not supported.UpdateWorkspaceImagePermissionResult updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest)
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.
updateWorkspaceImagePermissionRequest - ResourceNotFoundException - The resource could not be found.ResourceUnavailableException - The specified resource is not available.AccessDeniedException - The user is not authorized to access a resource.InvalidParameterValuesException - One or more parameter values are not valid.OperationNotSupportedException - This operation is not supported.UpdateWorkspacesPoolResult updateWorkspacesPool(UpdateWorkspacesPoolRequest updateWorkspacesPoolRequest)
Updates the specified pool.
updateWorkspacesPoolRequest - 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.ResourceLimitExceededException - Your resource limits have been exceeded.OperationNotSupportedException - This operation is not supported.OperationInProgressException - The properties of this WorkSpace are currently being modified. Try again in a moment.AccessDeniedException - The user is not authorized to access a resource.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.