Amazon WorkSpaces
amazonaws · Cloud
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 actio
Authentication
Sample Requests
Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkspacesService.DescribeWorkspaceBundles |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles?NextToken=example" \ -H "X-Amz-Target: WorkspacesService.DescribeWorkspaceBundles"
import requests
params = {
"NextToken": "example"
}
headers = {
"X-Amz-Target": "WorkspacesService.DescribeWorkspaceBundles"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles');
url.searchParams.set('NextToken', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkspacesService.DescribeWorkspaceBundles'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles")
q := baseURL.Query()
q.Set("NextToken", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkspacesService.DescribeWorkspaceBundles")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles")
uri.query = URI.encode_www_form({
"NextToken" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkspacesService.DescribeWorkspaceBundles"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles?" . http_build_query([
"NextToken" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkspacesService.DescribeWorkspaceBundles"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Describes the available directories that are registered with Amazon WorkSpaces.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkspacesService.DescribeWorkspaceDirectories |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories?NextToken=example" \ -H "X-Amz-Target: WorkspacesService.DescribeWorkspaceDirectories"
import requests
params = {
"NextToken": "example"
}
headers = {
"X-Amz-Target": "WorkspacesService.DescribeWorkspaceDirectories"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories');
url.searchParams.set('NextToken', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkspacesService.DescribeWorkspaceDirectories'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories")
q := baseURL.Query()
q.Set("NextToken", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkspacesService.DescribeWorkspaceDirectories")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories")
uri.query = URI.encode_www_form({
"NextToken" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkspacesService.DescribeWorkspaceDirectories"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories?" . http_build_query([
"NextToken" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkspacesService.DescribeWorkspaceDirectories"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));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.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkspacesService.DescribeWorkspaces |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces?Limit=10&NextToken=example" \ -H "X-Amz-Target: WorkspacesService.DescribeWorkspaces"
import requests
params = {
"Limit": "10",
"NextToken": "example"
}
headers = {
"X-Amz-Target": "WorkspacesService.DescribeWorkspaces"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces');
url.searchParams.set('Limit', '10');
url.searchParams.set('NextToken', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkspacesService.DescribeWorkspaces'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces")
q := baseURL.Query()
q.Set("Limit", "10")
q.Set("NextToken", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkspacesService.DescribeWorkspaces")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces")
uri.query = URI.encode_www_form({
"Limit" => "10",
"NextToken" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkspacesService.DescribeWorkspaces"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workspaces/2015-04-08/#X-Amz-Target=WorkspacesService.DescribeWorkspaces?" . http_build_query([
"Limit" => "10",
"NextToken" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkspacesService.DescribeWorkspaces"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Amazon WorkSpaces?
Amazon WorkSpaces is a Cloud API. Developers commonly use cloud APIs for:
- provisioning and managing cloud infrastructure
- automating deployments and container orchestration
- monitoring uptime and performance metrics
- managing storage buckets and databases
- setting up auto-scaling and load balancing
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Amazon WorkSpaces is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?