Skip to content

Amazon WorkSpaces API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Amazon WorkSpaces Service</fullname> <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>. 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.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/wsp.html">WorkSpaces endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>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 <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more information about using the CLI to manage your WorkSpaces resources, see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>

Amazon WorkSpaces is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 65 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2015-04-08
Endpoints
65
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=WorkspacesService.AssociateConnectionAlias<p>Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see <a href="https://docs.aw
POST/#X-Amz-Target=WorkspacesService.AssociateIpGroupsAssociates the specified IP access control group with the specified directory.
POST/#X-Amz-Target=WorkspacesService.AuthorizeIpRules<p>Adds one or more rules to the specified IP access control group.</p> <p>This action gives users permission to access their WorkSpaces from the CIDR address r
POST/#X-Amz-Target=WorkspacesService.CopyWorkspaceImage<p>Copies the specified image from the specified Region to the current Region. For more information about copying images, see <a href="https://docs.aws.amazon.c
POST/#X-Amz-Target=WorkspacesService.CreateConnectClientAddIn<p>Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.</p> <p>This client ad
POST/#X-Amz-Target=WorkspacesService.CreateConnectionAliasCreates the specified connection alias for use with cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/a
POST/#X-Amz-Target=WorkspacesService.CreateIpGroup<p>Creates an IP access control group.</p> <p>An IP access control group provides you with the ability to control the IP addresses from which users are allowed
POST/#X-Amz-Target=WorkspacesService.CreateStandbyWorkspacesCreates a standby WorkSpace in a secondary Region.
POST/#X-Amz-Target=WorkspacesService.CreateTagsCreates the specified tags for the specified WorkSpaces resource.
POST/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage<p>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
POST/#X-Amz-Target=WorkspacesService.CreateWorkspaceBundleCreates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see <a href="https://docs.aws.amazon.com/workspaces/latest/adming
POST/#X-Amz-Target=WorkspacesService.CreateWorkspaceImageCreates a new WorkSpace image from an existing WorkSpace.
POST/#X-Amz-Target=WorkspacesService.CreateWorkspaces<p>Creates one or more WorkSpaces.</p> <p>This operation is asynchronous and returns before the WorkSpaces are created.</p> <note> <p>The <code>MANUAL</code> ru
POST/#X-Amz-Target=WorkspacesService.DeleteClientBranding<p>Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company lo
POST/#X-Amz-Target=WorkspacesService.DeleteConnectClientAddInDeletes a client-add-in for Amazon Connect that is configured within a directory.
POST/#X-Amz-Target=WorkspacesService.DeleteConnectionAlias<p>Deletes the specified connection alias. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.
POST/#X-Amz-Target=WorkspacesService.DeleteIpGroup<p>Deletes the specified IP access control group.</p> <p>You cannot delete an IP access control group that is associated with a directory.</p>
POST/#X-Amz-Target=WorkspacesService.DeleteTagsDeletes the specified tags from the specified WorkSpaces resource.
POST/#X-Amz-Target=WorkspacesService.DeleteWorkspaceBundleDeletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see <a href="https://docs.aws.amazon.com/workspaces/latest/adming
POST/#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 if
POST/#X-Amz-Target=WorkspacesService.DeregisterWorkspaceDirectory<p>Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registe
POST/#X-Amz-Target=WorkspacesService.DescribeAccountRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
POST/#X-Amz-Target=WorkspacesService.DescribeAccountModificationsRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
POST/#X-Amz-Target=WorkspacesService.DescribeClientBranding<p>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 com
POST/#X-Amz-Target=WorkspacesService.DescribeClientPropertiesRetrieves a list that describes one or more specified Amazon WorkSpaces clients.
POST/#X-Amz-Target=WorkspacesService.DescribeConnectClientAddInsRetrieves a list of Amazon Connect client add-ins that have been created.
POST/#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 i
POST/#X-Amz-Target=WorkspacesService.DescribeConnectionAliasesRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspa
POST/#X-Amz-Target=WorkspacesService.DescribeIpGroupsDescribes one or more of your IP access control groups.
POST/#X-Amz-Target=WorkspacesService.DescribeTagsDescribes the specified tags for the specified WorkSpaces resource.
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles<p>Retrieves a list that describes the available WorkSpace bundles.</p> <p>You can filter the results using either bundle ID or owner, but not both.</p>
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectoriesDescribes the available directories that are registered with Amazon WorkSpaces.
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspaceImagePermissionsDescribes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
POST/#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.
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspaceSnapshotsDescribes the snapshots for the specified WorkSpace.
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspaces<p>Describes the specified WorkSpaces.</p> <p>You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify onl
POST/#X-Amz-Target=WorkspacesService.DescribeWorkspacesConnectionStatusDescribes the connection status of the specified WorkSpaces.
POST/#X-Amz-Target=WorkspacesService.DisassociateConnectionAlias<p>Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different R
POST/#X-Amz-Target=WorkspacesService.DisassociateIpGroupsDisassociates the specified IP access control group from the specified directory.
POST/#X-Amz-Target=WorkspacesService.ImportClientBranding<p>Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the sup
POST/#X-Amz-Target=WorkspacesService.ImportWorkspaceImageImports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in y
POST/#X-Amz-Target=WorkspacesService.ListAvailableManagementCidrRanges<p>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 Li
POST/#X-Amz-Target=WorkspacesService.MigrateWorkspace<p>Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.</p> <p>The migration process recreates
POST/#X-Amz-Target=WorkspacesService.ModifyAccountModifies the configuration of Bring Your Own License (BYOL) for the specified account.
POST/#X-Amz-Target=WorkspacesService.ModifyCertificateBasedAuthPropertiesModifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
POST/#X-Amz-Target=WorkspacesService.ModifyClientPropertiesModifies the properties of the specified Amazon WorkSpaces clients.
POST/#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 used
POST/#X-Amz-Target=WorkspacesService.ModifySelfservicePermissionsModifies the self-service WorkSpace management capabilities for your users. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adm
POST/#X-Amz-Target=WorkspacesService.ModifyWorkspaceAccessPropertiesSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see <a href="https://docs.aws.amazon.com/workspace
POST/#X-Amz-Target=WorkspacesService.ModifyWorkspaceCreationPropertiesModify the default properties used to create WorkSpaces.
POST/#X-Amz-Target=WorkspacesService.ModifyWorkspaceProperties<p>Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see <a href="https://docs.a
POST/#X-Amz-Target=WorkspacesService.ModifyWorkspaceState<p>Sets the state of the specified WorkSpace.</p> <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code
POST/#X-Amz-Target=WorkspacesService.RebootWorkspaces<p>Reboots the specified WorkSpaces.</p> <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or <code>UNHEALTHY</code>.</p> <p>This oper
POST/#X-Amz-Target=WorkspacesService.RebuildWorkspaces<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code
POST/#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 re
POST/#X-Amz-Target=WorkspacesService.RestoreWorkspace<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ER
POST/#X-Amz-Target=WorkspacesService.RevokeIpRulesRemoves one or more rules from the specified IP access control group.
POST/#X-Amz-Target=WorkspacesService.StartWorkspaces<p>Starts the specified WorkSpaces.</p> <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>STOPPED</code
POST/#X-Amz-Target=WorkspacesService.StopWorkspaces<p> Stops the specified WorkSpaces.</p> <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>AVAILABLE</cod
POST/#X-Amz-Target=WorkspacesService.TerminateWorkspaces<p>Terminates the specified WorkSpaces.</p> <important> <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If
POST/#X-Amz-Target=WorkspacesService.UpdateConnectClientAddInUpdates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
POST/#X-Amz-Target=WorkspacesService.UpdateConnectionAliasPermission<p>Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.
POST/#X-Amz-Target=WorkspacesService.UpdateRulesOfIpGroupReplaces the current rules of the specified IP access control group with the specified rules.
POST/#X-Amz-Target=WorkspacesService.UpdateWorkspaceBundle<p>Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see <a href="https://docs.aws.amazon.com/workspaces/lates
POST/#X-Amz-Target=WorkspacesService.UpdateWorkspaceImagePermission<p>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 t

Questions

Does the Amazon WorkSpaces API need an API key?

Yes. The Amazon WorkSpaces API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon WorkSpaces API support HTTPS?

Yes, the Amazon WorkSpaces API is served over HTTPS.

How many endpoints does the Amazon WorkSpaces API have?

Its OpenAPI description lists 65 endpoints in version 2015-04-08. All of them are shown on this page.

What are alternatives to the Amazon WorkSpaces API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).