Amazon Web Services, Inc.

Amazon WorkSpaces

Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 91

  • POSTAccept account link invitation/#X-Amz-Target=WorkspacesService.AcceptAccountLinkInvitationAccepts the account link invitation. There's currently no unlinking capability after you accept the account linking invitation.
  • POSTAssociate connection alias/#X-Amz-Target=WorkspacesService.AssociateConnectionAliasAssociates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection…
  • POSTAssociate ip groups/#X-Amz-Target=WorkspacesService.AssociateIpGroupsAssociates the specified IP access control group with the specified directory.
  • POSTAssociate workspace application/#X-Amz-Target=WorkspacesService.AssociateWorkspaceApplicationAssociates the specified application to the specified WorkSpace.
  • POSTAuthorize ip rules/#X-Amz-Target=WorkspacesService.AuthorizeIpRulesAdds 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…
  • POSTCopy workspace image/#X-Amz-Target=WorkspacesService.CopyWorkspaceImageCopies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image . In…
  • POSTCreate account link invitation/#X-Amz-Target=WorkspacesService.CreateAccountLinkInvitationCreates the account link invitation.
  • POSTCreate connect client add in/#X-Amz-Target=WorkspacesService.CreateConnectClientAddInCreates a client-add-in for Connect Customer within a directory. You can create only one Connect Customer client add-in within a directory. This client add-in…
  • POSTCreate connection alias/#X-Amz-Target=WorkspacesService.CreateConnectionAliasCreates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces .
  • POSTCreate ip group/#X-Amz-Target=WorkspacesService.CreateIpGroupCreates 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…
  • POSTCreate standby workspaces/#X-Amz-Target=WorkspacesService.CreateStandbyWorkspacesCreates a standby WorkSpace in a secondary Region.
  • POSTCreate tags/#X-Amz-Target=WorkspacesService.CreateTagsCreates the specified tags for the specified WorkSpaces resource.
  • POSTCreate updated workspace image/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImageCreates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required…
  • POSTCreate workspace bundle/#X-Amz-Target=WorkspacesService.CreateWorkspaceBundleCreates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle .
  • POSTCreate workspace image/#X-Amz-Target=WorkspacesService.CreateWorkspaceImageCreates a new WorkSpace image from an existing WorkSpace.
  • POSTCreate workspaces/#X-Amz-Target=WorkspacesService.CreateWorkspacesCreates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The MANUAL running mode value is only supported…
  • POSTCreate workspaces pool/#X-Amz-Target=WorkspacesService.CreateWorkspacesPoolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTDelete account link invitation/#X-Amz-Target=WorkspacesService.DeleteAccountLinkInvitationDeletes the account link invitation.
  • POSTDelete client branding/#X-Amz-Target=WorkspacesService.DeleteClientBrandingDeletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company…
  • POSTDelete connect client add in/#X-Amz-Target=WorkspacesService.DeleteConnectClientAddInDeletes a client-add-in for Connect Customer that is configured within a directory.
  • POSTDelete connection alias/#X-Amz-Target=WorkspacesService.DeleteConnectionAliasDeletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces . If you will no longer be using a fully…
  • POSTDelete ip group/#X-Amz-Target=WorkspacesService.DeleteIpGroupDeletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
  • POSTDelete tags/#X-Amz-Target=WorkspacesService.DeleteTagsDeletes the specified tags from the specified WorkSpaces resource.
  • POSTDelete workspace bundle/#X-Amz-Target=WorkspacesService.DeleteWorkspaceBundleDeletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image .
  • POSTDelete workspace image/#X-Amz-Target=WorkspacesService.DeleteWorkspaceImageDeletes 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…
  • POSTDeploy workspace applications/#X-Amz-Target=WorkspacesService.DeployWorkspaceApplicationsDeploys associated applications to the specified WorkSpace
  • POSTDeregister workspace directory/#X-Amz-Target=WorkspacesService.DeregisterWorkspaceDirectoryDeregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are…
  • POSTDescribe account/#X-Amz-Target=WorkspacesService.DescribeAccountRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
  • POSTDescribe account modifications/#X-Amz-Target=WorkspacesService.DescribeAccountModificationsRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
  • POSTDescribe application associations/#X-Amz-Target=WorkspacesService.DescribeApplicationAssociationsDescribes the associations between the application and the specified associated resources.
  • POSTDescribe applications/#X-Amz-Target=WorkspacesService.DescribeApplicationsDescribes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
  • POSTDescribe bundle associations/#X-Amz-Target=WorkspacesService.DescribeBundleAssociationsDescribes the associations between the applications and the specified bundle.
  • POSTDescribe client branding/#X-Amz-Target=WorkspacesService.DescribeClientBrandingDescribes 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…
  • POSTDescribe client properties/#X-Amz-Target=WorkspacesService.DescribeClientPropertiesRetrieves a list that describes one or more specified Amazon WorkSpaces clients.
  • POSTDescribe connect client add ins/#X-Amz-Target=WorkspacesService.DescribeConnectClientAddInsRetrieves a list of Connect Customer client add-ins that have been created.
  • POSTDescribe connection alias permissions/#X-Amz-Target=WorkspacesService.DescribeConnectionAliasPermissionsDescribes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more…
  • POSTDescribe connection aliases/#X-Amz-Target=WorkspacesService.DescribeConnectionAliasesRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon…
  • POSTDescribe custom workspace image import/#X-Amz-Target=WorkspacesService.DescribeCustomWorkspaceImageImportRetrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.
  • POSTDescribe image associations/#X-Amz-Target=WorkspacesService.DescribeImageAssociationsDescribes the associations between the applications and the specified image.
  • POSTDescribe ip groups/#X-Amz-Target=WorkspacesService.DescribeIpGroupsDescribes one or more of your IP access control groups.
  • POSTDescribe tags/#X-Amz-Target=WorkspacesService.DescribeTagsDescribes the specified tags for the specified WorkSpaces resource.
  • POSTDescribe workspace associations/#X-Amz-Target=WorkspacesService.DescribeWorkspaceAssociationsDescribes the associations betweens applications and the specified WorkSpace.
  • POSTDescribe workspace bundles/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundlesRetrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
  • POSTDescribe workspace directories/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectoriesDescribes the available directories that are registered with Amazon WorkSpaces.
  • POSTDescribe workspace image permissions/#X-Amz-Target=WorkspacesService.DescribeWorkspaceImagePermissionsDescribes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
  • POSTDescribe workspace images/#X-Amz-Target=WorkspacesService.DescribeWorkspaceImagesRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
  • POSTDescribe workspace snapshots/#X-Amz-Target=WorkspacesService.DescribeWorkspaceSnapshotsDescribes the snapshots for the specified WorkSpace.
  • POSTDescribe workspaces/#X-Amz-Target=WorkspacesService.DescribeWorkspacesDescribes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one…
  • POSTDescribe workspaces connection status/#X-Amz-Target=WorkspacesService.DescribeWorkspacesConnectionStatusDescribes the connection status of the specified WorkSpaces.
  • POSTDescribe workspaces pool sessions/#X-Amz-Target=WorkspacesService.DescribeWorkspacesPoolSessionsEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTDescribe workspaces pools/#X-Amz-Target=WorkspacesService.DescribeWorkspacesPoolsEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTDisassociate connection alias/#X-Amz-Target=WorkspacesService.DisassociateConnectionAliasDisassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different…
  • POSTDisassociate ip groups/#X-Amz-Target=WorkspacesService.DisassociateIpGroupsDisassociates the specified IP access control group from the specified directory.
  • POSTDisassociate workspace application/#X-Amz-Target=WorkspacesService.DisassociateWorkspaceApplicationDisassociates the specified application from a WorkSpace.
  • POSTGet account link/#X-Amz-Target=WorkspacesService.GetAccountLinkRetrieves account link information.
  • POSTImport client branding/#X-Amz-Target=WorkspacesService.ImportClientBrandingImports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the…
  • POSTImport custom workspace image/#X-Amz-Target=WorkspacesService.ImportCustomWorkspaceImageImports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already…
  • POSTImport workspace image/#X-Amz-Target=WorkspacesService.ImportWorkspaceImageImports 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…
  • POSTList account links/#X-Amz-Target=WorkspacesService.ListAccountLinksLists all account links.
  • POSTList available management cidr ranges/#X-Amz-Target=WorkspacesService.ListAvailableManagementCidrRangesRetrieves 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…
  • POSTMigrate workspace/#X-Amz-Target=WorkspacesService.MigrateWorkspaceMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the…
  • POSTModify account/#X-Amz-Target=WorkspacesService.ModifyAccountModifies the configuration of Bring Your Own License (BYOL) for the specified account.
  • POSTModify certificate based auth properties/#X-Amz-Target=WorkspacesService.ModifyCertificateBasedAuthPropertiesModifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
  • POSTModify client properties/#X-Amz-Target=WorkspacesService.ModifyClientPropertiesModifies the properties of the specified Amazon WorkSpaces clients.
  • POSTModify endpoint encryption mode/#X-Amz-Target=WorkspacesService.ModifyEndpointEncryptionModeModifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.
  • POSTModify saml properties/#X-Amz-Target=WorkspacesService.ModifySamlPropertiesModifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are…
  • POSTModify selfservice permissions/#X-Amz-Target=WorkspacesService.ModifySelfservicePermissionsModifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities…
  • POSTModify streaming properties/#X-Amz-Target=WorkspacesService.ModifyStreamingPropertiesModifies the specified streaming properties.
  • POSTModify workspace access properties/#X-Amz-Target=WorkspacesService.ModifyWorkspaceAccessPropertiesSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access .
  • POSTModify workspace creation properties/#X-Amz-Target=WorkspacesService.ModifyWorkspaceCreationPropertiesModify the default properties used to create WorkSpaces.
  • POSTModify workspace properties/#X-Amz-Target=WorkspacesService.ModifyWorkspacePropertiesModifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace . The…
  • POSTModify workspace state/#X-Amz-Target=WorkspacesService.ModifyWorkspaceStateSets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE . WorkSpaces in…
  • POSTReboot workspaces/#X-Amz-Target=WorkspacesService.RebootWorkspacesReboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE , UNHEALTHY , or REBOOTING . Reboot a WorkSpace in the REBOOTING…
  • POSTRebuild workspaces/#X-Amz-Target=WorkspacesService.RebuildWorkspacesRebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE , ERROR , UNHEALTHY , STOPPED , or REBOOTING . Rebuilding a…
  • POSTRegister workspace directory/#X-Amz-Target=WorkspacesService.RegisterWorkspaceDirectoryRegisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are…
  • POSTReject account link invitation/#X-Amz-Target=WorkspacesService.RejectAccountLinkInvitationRejects the account link invitation.
  • POSTRestore workspace/#X-Amz-Target=WorkspacesService.RestoreWorkspaceRestores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE , ERROR , UNHEALTHY , or…
  • POSTRevoke ip rules/#X-Amz-Target=WorkspacesService.RevokeIpRulesRemoves one or more rules from the specified IP access control group.
  • POSTStart workspaces/#X-Amz-Target=WorkspacesService.StartWorkspacesStarts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED .
  • POSTStart workspaces pool/#X-Amz-Target=WorkspacesService.StartWorkspacesPoolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTStop workspaces/#X-Amz-Target=WorkspacesService.StopWorkspacesStops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE , IMPAIRED , UNHEALTHY…
  • POSTStop workspaces pool/#X-Amz-Target=WorkspacesService.StopWorkspacesPoolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTTerminate workspaces/#X-Amz-Target=WorkspacesService.TerminateWorkspacesTerminates 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…
  • POSTTerminate workspaces pool/#X-Amz-Target=WorkspacesService.TerminateWorkspacesPoolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTTerminate workspaces pool session/#X-Amz-Target=WorkspacesService.TerminateWorkspacesPoolSessionEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…
  • POSTUpdate connect client add in/#X-Amz-Target=WorkspacesService.UpdateConnectClientAddInUpdates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in.
  • POSTUpdate connection alias permission/#X-Amz-Target=WorkspacesService.UpdateConnectionAliasPermissionShares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.…
  • POSTUpdate rules of ip group/#X-Amz-Target=WorkspacesService.UpdateRulesOfIpGroupReplaces the current rules of the specified IP access control group with the specified rules.
  • POSTUpdate workspace bundle/#X-Amz-Target=WorkspacesService.UpdateWorkspaceBundleUpdates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle . Existing…
  • POSTUpdate workspace image permission/#X-Amz-Target=WorkspacesService.UpdateWorkspaceImagePermissionShares 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…
  • POSTUpdate workspaces pool/#X-Amz-Target=WorkspacesService.UpdateWorkspacesPoolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be…

API details

Base URL
https://workspaces.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
91 operations on 91 pathsPOST 91
Description format
AWS Smithy model, API version 2015-04-08

How to test the Amazon WorkSpaces in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon WorkSpaces collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept account link invitation” (POST /#X-Amz-Target=WorkspacesService.AcceptAccountLinkInvitation), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon WorkSpaces?

Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as… It is listed under Developer tools and has 91 endpoints.

Who publishes the Amazon WorkSpaces?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon WorkSpaces?

Requests go to https://workspaces.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon WorkSpaces?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon WorkSpaces have?

91 operations on 91 paths (91 POST).

Is forking the Amazon WorkSpaces free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.