Amazon WorkSpaces website screenshot

Amazon WorkSpaces

Amazon WorkSpaces is a managed, secure Desktop-as-a-Service (DaaS) solution that enables you to provision cloud-based virtual desktops for your users. It eliminates the need to procure and deploy hardware or install complex software, providing persistent desktops accessible from various devices with built-in security and management capabilities. The API provides 65 operations for workspace lifecycle management, bundle and directory management, image management, and IP access control groups.

1 APIs 8 Features
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

APIs

Amazon WorkSpaces API

The Amazon WorkSpaces API provides programmatic access to manage cloud-based virtual desktops. It enables developers to create, modify, and terminate WorkSpaces, manage workspac...

Pricing Plans

Amazon Workspaces Plans Pricing

3 plans

PLANS

Rate Limits

Amazon Workspaces Rate Limits

5 limits

RATE LIMITS

FinOps

Amazon Workspaces Finops

FINOPS

Features

Persistent Virtual Desktops

Cloud-based Windows or Linux desktops with persistent storage that users can access from any device or location.

Desktop Bundle Catalog

Configurable compute bundles ranging from Value to Graphics.g4dn to match workload requirements and cost targets.

Active Directory Integration

Integration with AWS Managed Microsoft AD and AD Connector for user authentication and policy management.

Application Management

Deploy and manage applications across WorkSpaces using application assignment and streaming capabilities.

IP Access Control Groups

Restrict workspace access by IP address ranges to enforce network-based access controls.

Running Mode Flexibility

AlwaysOn mode for power users and AutoStop mode for cost optimization of occasional-use desktops.

BYOD Support

Thin client, web browser, iOS, Android, Linux, macOS, and Windows client access for bring-your-own-device scenarios.

Workspace Snapshots and Restore

Automated snapshots enable restoring workspaces to previous states for disaster recovery and user error correction.

Use Cases

Remote Work Enablement

Provide secure cloud desktops to remote and distributed employees without managing physical hardware.

Contractor and Temporary Worker Access

Quickly provision and terminate secure desktops for contractors with time-limited access needs.

Desktop Refresh and Modernization

Replace aging desktop hardware with cloud-based virtual desktops to reduce capital expenditure.

BYOD Security

Enable personal device usage while keeping corporate data and applications in the secure cloud environment.

Regulated Industry Compliance

Maintain data residency and security compliance in regulated industries like healthcare and finance.

Semantic Vocabularies

Amazon Workspaces Context

175 classes · 173 properties

JSON-LD

API Governance Rules

Amazon WorkSpaces API Rules

16 rules · 8 errors 6 warnings 2 info

SPECTRAL

JSON Structure

Workspaces Access Denied Exception Structure

0 properties

JSON STRUCTURE

Workspaces Access Property Value Structure

0 properties

JSON STRUCTURE

Workspaces Account Modification List Structure

0 properties

JSON STRUCTURE

Workspaces Account Modification Structure

6 properties

JSON STRUCTURE

Workspaces Add In Name Structure

0 properties

JSON STRUCTURE

Workspaces Add In Url Structure

0 properties

JSON STRUCTURE

Workspaces Alias Structure

0 properties

JSON STRUCTURE

Workspaces Amazon Uuid Structure

0 properties

JSON STRUCTURE

Workspaces Application List Structure

0 properties

JSON STRUCTURE

Workspaces Application Structure

0 properties

JSON STRUCTURE

Workspaces Arn Structure

0 properties

JSON STRUCTURE

Workspaces Associate Connection Alias Request Structure

2 properties

JSON STRUCTURE

Workspaces Associate Connection Alias Result Structure

1 properties

JSON STRUCTURE

Workspaces Associate Ip Groups Request Structure

2 properties

JSON STRUCTURE

Workspaces Associate Ip Groups Result Structure

0 properties

JSON STRUCTURE

Workspaces Association Status Structure

0 properties

JSON STRUCTURE

Workspaces Authorize Ip Rules Request Structure

2 properties

JSON STRUCTURE

Workspaces Authorize Ip Rules Result Structure

0 properties

JSON STRUCTURE

Workspaces Aws Account Structure

0 properties

JSON STRUCTURE

Workspaces Boolean Object Structure

0 properties

JSON STRUCTURE

Workspaces Bundle Id List Structure

0 properties

JSON STRUCTURE

Workspaces Bundle Id Structure

0 properties

JSON STRUCTURE

Workspaces Bundle List Structure

0 properties

JSON STRUCTURE

Workspaces Bundle Owner Structure

0 properties

JSON STRUCTURE

Workspaces Bundle Type Structure

0 properties

JSON STRUCTURE

Workspaces Certificate Authority Arn Structure

0 properties

JSON STRUCTURE

Workspaces Certificate Based Auth Properties Structure

2 properties

JSON STRUCTURE

Workspaces Certificate Based Auth Status Enum Structure

0 properties

JSON STRUCTURE

Workspaces Client Device Type List Structure

0 properties

JSON STRUCTURE

Workspaces Client Device Type Structure

0 properties

JSON STRUCTURE

Workspaces Client Email Structure

0 properties

JSON STRUCTURE

Workspaces Client Locale Structure

0 properties

JSON STRUCTURE

Workspaces Client Login Message Structure

0 properties

JSON STRUCTURE

Workspaces Client Properties List Structure

0 properties

JSON STRUCTURE

Workspaces Client Properties Result Structure

2 properties

JSON STRUCTURE

Workspaces Client Properties Structure

2 properties

JSON STRUCTURE

Workspaces Client Url Structure

0 properties

JSON STRUCTURE

Workspaces Compute Structure

0 properties

JSON STRUCTURE

Workspaces Compute Type Structure

1 properties

JSON STRUCTURE

Workspaces Computer Name Structure

0 properties

JSON STRUCTURE

Workspaces Connect Client Add In List Structure

0 properties

JSON STRUCTURE

Workspaces Connect Client Add In Structure

4 properties

JSON STRUCTURE

Workspaces Connection Alias Association List Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias Association Structure

4 properties

JSON STRUCTURE

Workspaces Connection Alias Id List Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias Id Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias List Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias Permission Structure

2 properties

JSON STRUCTURE

Workspaces Connection Alias Permissions Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias State Structure

0 properties

JSON STRUCTURE

Workspaces Connection Alias Structure

5 properties

JSON STRUCTURE

Workspaces Connection Identifier Structure

0 properties

JSON STRUCTURE

Workspaces Connection State Structure

0 properties

JSON STRUCTURE

Workspaces Connection String Structure

0 properties

JSON STRUCTURE

Workspaces Copy Workspace Image Request Structure

5 properties

JSON STRUCTURE

Workspaces Copy Workspace Image Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Connect Client Add In Request Structure

3 properties

JSON STRUCTURE

Workspaces Create Connect Client Add In Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Connection Alias Request Structure

2 properties

JSON STRUCTURE

Workspaces Create Connection Alias Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Ip Group Request Structure

4 properties

JSON STRUCTURE

Workspaces Create Ip Group Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Standby Workspaces Request Structure

2 properties

JSON STRUCTURE

Workspaces Create Standby Workspaces Result Structure

2 properties

JSON STRUCTURE

Workspaces Create Tags Request Structure

2 properties

JSON STRUCTURE

Workspaces Create Tags Result Structure

0 properties

JSON STRUCTURE

Workspaces Create Updated Workspace Image Request Structure

4 properties

JSON STRUCTURE

Workspaces Create Updated Workspace Image Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Workspace Bundle Request Structure

7 properties

JSON STRUCTURE

Workspaces Create Workspace Bundle Result Structure

1 properties

JSON STRUCTURE

Workspaces Create Workspace Image Request Structure

4 properties

JSON STRUCTURE

Workspaces Create Workspace Image Result Structure

8 properties

JSON STRUCTURE

Workspaces Create Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Create Workspaces Result Structure

2 properties

JSON STRUCTURE

Workspaces Dedicated Tenancy Cidr Range List Structure

0 properties

JSON STRUCTURE

Workspaces Dedicated Tenancy Management Cidr Range Structure

0 properties

JSON STRUCTURE

Workspaces Dedicated Tenancy Modification State Enum Structure

0 properties

JSON STRUCTURE

Workspaces Dedicated Tenancy Support Enum Structure

0 properties

JSON STRUCTURE

Workspaces Dedicated Tenancy Support Result Enum Structure

0 properties

JSON STRUCTURE

Workspaces Default Client Branding Attributes Structure

5 properties

JSON STRUCTURE

Workspaces Default Import Client Branding Attributes Structure

5 properties

JSON STRUCTURE

Workspaces Default Logo Structure

0 properties

JSON STRUCTURE

Workspaces Default Ou Structure

0 properties

JSON STRUCTURE

Workspaces Default Workspace Creation Properties Structure

6 properties

JSON STRUCTURE

Workspaces Deletable Certificate Based Auth Properties List Structure

0 properties

JSON STRUCTURE

Workspaces Deletable Certificate Based Auth Property Structure

0 properties

JSON STRUCTURE

Workspaces Deletable Saml Properties List Structure

0 properties

JSON STRUCTURE

Workspaces Deletable Saml Property Structure

0 properties

JSON STRUCTURE

Workspaces Delete Client Branding Request Structure

2 properties

JSON STRUCTURE

Workspaces Delete Client Branding Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Connect Client Add In Request Structure

2 properties

JSON STRUCTURE

Workspaces Delete Connect Client Add In Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Connection Alias Request Structure

1 properties

JSON STRUCTURE

Workspaces Delete Connection Alias Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Ip Group Request Structure

1 properties

JSON STRUCTURE

Workspaces Delete Ip Group Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Tags Request Structure

2 properties

JSON STRUCTURE

Workspaces Delete Tags Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Workspace Bundle Request Structure

1 properties

JSON STRUCTURE

Workspaces Delete Workspace Bundle Result Structure

0 properties

JSON STRUCTURE

Workspaces Delete Workspace Image Request Structure

1 properties

JSON STRUCTURE

Workspaces Delete Workspace Image Result Structure

0 properties

JSON STRUCTURE

Workspaces Deregister Workspace Directory Request Structure

1 properties

JSON STRUCTURE

Workspaces Deregister Workspace Directory Result Structure

0 properties

JSON STRUCTURE

Workspaces Describe Account Modifications Request Structure

1 properties

JSON STRUCTURE

Workspaces Describe Account Modifications Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Account Request Structure

0 properties

JSON STRUCTURE

Workspaces Describe Account Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Client Branding Request Structure

1 properties

JSON STRUCTURE

Workspaces Describe Client Branding Result Structure

6 properties

JSON STRUCTURE

Workspaces Describe Client Properties Request Structure

1 properties

JSON STRUCTURE

Workspaces Describe Client Properties Result Structure

1 properties

JSON STRUCTURE

Workspaces Describe Connect Client Add Ins Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Connect Client Add Ins Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Connection Alias Permissions Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Connection Alias Permissions Result Structure

3 properties

JSON STRUCTURE

Workspaces Describe Connection Aliases Request Structure

4 properties

JSON STRUCTURE

Workspaces Describe Connection Aliases Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Ip Groups Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Ip Groups Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Tags Request Structure

1 properties

JSON STRUCTURE

Workspaces Describe Tags Result Structure

1 properties

JSON STRUCTURE

Workspaces Describe Workspace Bundles Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Workspace Bundles Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspace Directories Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Workspace Directories Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspace Image Permissions Request Structure

3 properties

JSON STRUCTURE

Workspaces Describe Workspace Image Permissions Result Structure

3 properties

JSON STRUCTURE

Workspaces Describe Workspace Images Request Structure

4 properties

JSON STRUCTURE

Workspaces Describe Workspace Images Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspace Snapshots Request Structure

1 properties

JSON STRUCTURE

Workspaces Describe Workspace Snapshots Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspaces Connection Status Request Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspaces Connection Status Result Structure

2 properties

JSON STRUCTURE

Workspaces Describe Workspaces Request Structure

6 properties

JSON STRUCTURE

Workspaces Describe Workspaces Result Structure

2 properties

JSON STRUCTURE

Workspaces Description Structure

0 properties

JSON STRUCTURE

Workspaces Directory Id List Structure

0 properties

JSON STRUCTURE

Workspaces Directory Id Structure

0 properties

JSON STRUCTURE

Workspaces Directory List Structure

0 properties

JSON STRUCTURE

Workspaces Directory Name Structure

0 properties

JSON STRUCTURE

Workspaces Disassociate Connection Alias Request Structure

1 properties

JSON STRUCTURE

Workspaces Disassociate Connection Alias Result Structure

0 properties

JSON STRUCTURE

Workspaces Disassociate Ip Groups Request Structure

2 properties

JSON STRUCTURE

Workspaces Disassociate Ip Groups Result Structure

0 properties

JSON STRUCTURE

Workspaces Dns Ip Addresses Structure

0 properties

JSON STRUCTURE

Workspaces Ec2 Image Id Structure

0 properties

JSON STRUCTURE

Workspaces Error Type Structure

0 properties

JSON STRUCTURE

Workspaces Failed Create Standby Workspaces Request List Structure

0 properties

JSON STRUCTURE

Workspaces Failed Create Standby Workspaces Request Structure

3 properties

JSON STRUCTURE

Workspaces Failed Create Workspace Request Structure

3 properties

JSON STRUCTURE

Workspaces Failed Create Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Reboot Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Rebuild Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Start Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Stop Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Terminate Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Failed Workspace Change Request Structure

3 properties

JSON STRUCTURE

Workspaces Image Permission Structure

1 properties

JSON STRUCTURE

Workspaces Image Permissions Structure

0 properties

JSON STRUCTURE

Workspaces Image Type Structure

0 properties

JSON STRUCTURE

Workspaces Import Client Branding Request Structure

7 properties

JSON STRUCTURE

Workspaces Import Client Branding Result Structure

6 properties

JSON STRUCTURE

Workspaces Import Workspace Image Request Structure

6 properties

JSON STRUCTURE

Workspaces Import Workspace Image Result Structure

1 properties

JSON STRUCTURE

Workspaces Invalid Parameter Values Exception Structure

0 properties

JSON STRUCTURE

Workspaces Invalid Resource State Exception Structure

0 properties

JSON STRUCTURE

Workspaces Ios Client Branding Attributes Structure

7 properties

JSON STRUCTURE

Workspaces Ios Import Client Branding Attributes Structure

7 properties

JSON STRUCTURE

Workspaces Ios Logo Structure

0 properties

JSON STRUCTURE

Workspaces Ios2 X Logo Structure

0 properties

JSON STRUCTURE

Workspaces Ios3 X Logo Structure

0 properties

JSON STRUCTURE

Workspaces Ip Address Structure

0 properties

JSON STRUCTURE

Workspaces Ip Group Desc Structure

0 properties

JSON STRUCTURE

Workspaces Ip Group Id List Structure

0 properties

JSON STRUCTURE

Workspaces Ip Group Id Structure

0 properties

JSON STRUCTURE

Workspaces Ip Group Name Structure

0 properties

JSON STRUCTURE

Workspaces Ip Revoked Rule List Structure

0 properties

JSON STRUCTURE

Workspaces Ip Rule Desc Structure

0 properties

JSON STRUCTURE

Workspaces Ip Rule Item Structure

2 properties

JSON STRUCTURE

Workspaces Ip Rule List Structure

0 properties

JSON STRUCTURE

Workspaces Ip Rule Structure

0 properties

JSON STRUCTURE

Workspaces Limit Structure

0 properties

JSON STRUCTURE

Workspaces List Available Management Cidr Ranges Request Structure

3 properties

JSON STRUCTURE

Workspaces List Available Management Cidr Ranges Result Structure

2 properties

JSON STRUCTURE

Workspaces Log Upload Enum Structure

0 properties

JSON STRUCTURE

Workspaces Login Message Structure

0 properties

JSON STRUCTURE

Workspaces Management Cidr Range Constraint Structure

0 properties

JSON STRUCTURE

Workspaces Management Cidr Range Max Results Structure

0 properties

JSON STRUCTURE

Workspaces Migrate Workspace Request Structure

2 properties

JSON STRUCTURE

Workspaces Migrate Workspace Result Structure

2 properties

JSON STRUCTURE

Workspaces Modification Resource Enum Structure

0 properties

JSON STRUCTURE

Workspaces Modification State Enum Structure

0 properties

JSON STRUCTURE

Workspaces Modification State List Structure

0 properties

JSON STRUCTURE

Workspaces Modification State Structure

2 properties

JSON STRUCTURE

Workspaces Modify Account Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Account Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Certificate Based Auth Properties Request Structure

3 properties

JSON STRUCTURE

Workspaces Modify Certificate Based Auth Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Client Properties Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Client Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Saml Properties Request Structure

3 properties

JSON STRUCTURE

Workspaces Modify Saml Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Selfservice Permissions Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Selfservice Permissions Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Workspace Access Properties Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Workspace Access Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Workspace Creation Properties Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Workspace Creation Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Workspace Properties Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Workspace Properties Result Structure

0 properties

JSON STRUCTURE

Workspaces Modify Workspace State Request Structure

2 properties

JSON STRUCTURE

Workspaces Modify Workspace State Result Structure

0 properties

JSON STRUCTURE

Workspaces Non Empty String Structure

0 properties

JSON STRUCTURE

Workspaces Operating System Structure

1 properties

JSON STRUCTURE

Workspaces Operating System Type Structure

0 properties

JSON STRUCTURE

Workspaces Operation In Progress Exception Structure

0 properties

JSON STRUCTURE

Workspaces Operation Not Supported Exception Structure

0 properties

JSON STRUCTURE

Workspaces Pagination Token Structure

0 properties

JSON STRUCTURE

Workspaces Pending Create Standby Workspaces Request List Structure

0 properties

JSON STRUCTURE

Workspaces Pending Create Standby Workspaces Request Structure

4 properties

JSON STRUCTURE

Workspaces Protocol List Structure

0 properties

JSON STRUCTURE

Workspaces Protocol Structure

0 properties

JSON STRUCTURE

Workspaces Reboot Request Structure

1 properties

JSON STRUCTURE

Workspaces Reboot Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Reboot Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Reboot Workspaces Result Structure

1 properties

JSON STRUCTURE

Workspaces Rebuild Request Structure

1 properties

JSON STRUCTURE

Workspaces Rebuild Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Rebuild Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Rebuild Workspaces Result Structure

1 properties

JSON STRUCTURE

Workspaces Reconnect Enum Structure

0 properties

JSON STRUCTURE

Workspaces Region Structure

0 properties

JSON STRUCTURE

Workspaces Register Workspace Directory Request Structure

6 properties

JSON STRUCTURE

Workspaces Register Workspace Directory Result Structure

0 properties

JSON STRUCTURE

Workspaces Registration Code Structure

0 properties

JSON STRUCTURE

Workspaces Related Workspace Properties Structure

4 properties

JSON STRUCTURE

Workspaces Related Workspaces Structure

0 properties

JSON STRUCTURE

Workspaces Resource Already Exists Exception Structure

0 properties

JSON STRUCTURE

Workspaces Resource Associated Exception Structure

0 properties

JSON STRUCTURE

Workspaces Resource Creation Failed Exception Structure

0 properties

JSON STRUCTURE

Workspaces Resource Id List Structure

0 properties

JSON STRUCTURE

Workspaces Resource Limit Exceeded Exception Structure

0 properties

JSON STRUCTURE

Workspaces Resource Not Found Exception Structure

0 properties

JSON STRUCTURE

Workspaces Resource Unavailable Exception Structure

0 properties

JSON STRUCTURE

Workspaces Restore Workspace Request Structure

1 properties

JSON STRUCTURE

Workspaces Restore Workspace Result Structure

0 properties

JSON STRUCTURE

Workspaces Revoke Ip Rules Request Structure

2 properties

JSON STRUCTURE

Workspaces Revoke Ip Rules Result Structure

0 properties

JSON STRUCTURE

Workspaces Root Storage Structure

1 properties

JSON STRUCTURE

Workspaces Root Volume Size Gib Structure

0 properties

JSON STRUCTURE

Workspaces Running Mode Auto Stop Timeout In Minutes Structure

0 properties

JSON STRUCTURE

Workspaces Running Mode Structure

0 properties

JSON STRUCTURE

Workspaces Saml Properties Structure

3 properties

JSON STRUCTURE

Workspaces Saml Status Enum Structure

0 properties

JSON STRUCTURE

Workspaces Saml User Access Url Structure

0 properties

JSON STRUCTURE

Workspaces Security Group Id Structure

0 properties

JSON STRUCTURE

Workspaces Selfservice Permissions Structure

5 properties

JSON STRUCTURE

Workspaces Snapshot List Structure

0 properties

JSON STRUCTURE

Workspaces Snapshot Structure

1 properties

JSON STRUCTURE

Workspaces Standby Workspace Relationship Type Structure

0 properties

JSON STRUCTURE

Workspaces Standby Workspace Structure

4 properties

JSON STRUCTURE

Workspaces Standby Workspaces List Structure

0 properties

JSON STRUCTURE

Workspaces Start Request Structure

1 properties

JSON STRUCTURE

Workspaces Start Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Start Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Start Workspaces Result Structure

1 properties

JSON STRUCTURE

Workspaces Stop Request Structure

1 properties

JSON STRUCTURE

Workspaces Stop Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Stop Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Stop Workspaces Result Structure

1 properties

JSON STRUCTURE

Workspaces Subnet Id Structure

0 properties

JSON STRUCTURE

Workspaces Subnet Ids Structure

0 properties

JSON STRUCTURE

Workspaces Tag Key List Structure

0 properties

JSON STRUCTURE

Workspaces Tag Key Structure

0 properties

JSON STRUCTURE

Workspaces Tag List Structure

0 properties

JSON STRUCTURE

Workspaces Tag Structure

2 properties

JSON STRUCTURE

Workspaces Tag Value Structure

0 properties

JSON STRUCTURE

Workspaces Target Workspace State Structure

0 properties

JSON STRUCTURE

Workspaces Tenancy Structure

0 properties

JSON STRUCTURE

Workspaces Terminate Request Structure

1 properties

JSON STRUCTURE

Workspaces Terminate Workspace Requests Structure

0 properties

JSON STRUCTURE

Workspaces Terminate Workspaces Request Structure

1 properties

JSON STRUCTURE

Workspaces Terminate Workspaces Result Structure

1 properties

JSON STRUCTURE

Workspaces Timestamp Structure

0 properties

JSON STRUCTURE

Workspaces Unsupported Network Configuration Exception Structure

0 properties

JSON STRUCTURE

Workspaces Unsupported Workspace Configuration Exception Structure

0 properties

JSON STRUCTURE

Workspaces Update Connect Client Add In Request Structure

4 properties

JSON STRUCTURE

Workspaces Update Connect Client Add In Result Structure

0 properties

JSON STRUCTURE

Workspaces Update Connection Alias Permission Request Structure

2 properties

JSON STRUCTURE

Workspaces Update Connection Alias Permission Result Structure

0 properties

JSON STRUCTURE

Workspaces Update Description Structure

0 properties

JSON STRUCTURE

Workspaces Update Result Structure

2 properties

JSON STRUCTURE

Workspaces Update Rules Of Ip Group Request Structure

2 properties

JSON STRUCTURE

Workspaces Update Rules Of Ip Group Result Structure

0 properties

JSON STRUCTURE

Workspaces Update Workspace Bundle Request Structure

2 properties

JSON STRUCTURE

Workspaces Update Workspace Bundle Result Structure

0 properties

JSON STRUCTURE

Workspaces Update Workspace Image Permission Request Structure

3 properties

JSON STRUCTURE

Workspaces Update Workspace Image Permission Result Structure

0 properties

JSON STRUCTURE

Workspaces User Name Structure

0 properties

JSON STRUCTURE

Workspaces User Storage Structure

1 properties

JSON STRUCTURE

Workspaces User Volume Size Gib Structure

0 properties

JSON STRUCTURE

Workspaces Volume Encryption Key Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Access Properties Structure

8 properties

JSON STRUCTURE

Workspaces Workspace Bundle Description Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Bundle Name Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Bundle State Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Bundle Structure

12 properties

JSON STRUCTURE

Workspaces Workspace Connection Status List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Connection Status Structure

4 properties

JSON STRUCTURE

Workspaces Workspace Creation Properties Structure

6 properties

JSON STRUCTURE

Workspaces Workspace Directory State Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Directory Structure

18 properties

JSON STRUCTURE

Workspaces Workspace Directory Type Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Error Code Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Id List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Id Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Description Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Error Code Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Id List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Id Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Ingestion Process Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Name Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Required Tenancy Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image State Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Image Structure

11 properties

JSON STRUCTURE

Workspaces Workspace List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Properties Structure

6 properties

JSON STRUCTURE

Workspaces Workspace Request List Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Request Structure

8 properties

JSON STRUCTURE

Workspaces Workspace State Structure

0 properties

JSON STRUCTURE

Workspaces Workspace Structure

16 properties

JSON STRUCTURE

Workspaces Workspaces Default Role Not Found Exception Structure

0 properties

JSON STRUCTURE

Workspaces Workspaces Ip Group Structure

4 properties

JSON STRUCTURE

Workspaces Workspaces Ip Groups List Structure

0 properties

JSON STRUCTURE

Example Payloads

Workspaces Account Modification Example

6 fields

EXAMPLE

Workspaces Associate Connection Alias Request Example

2 fields

EXAMPLE

Workspaces Associate Connection Alias Result Example

1 fields

EXAMPLE

Workspaces Associate Ip Groups Request Example

2 fields

EXAMPLE

Workspaces Authorize Ip Rules Request Example

2 fields

EXAMPLE

Workspaces Certificate Based Auth Properties Example

2 fields

EXAMPLE

Workspaces Client Properties Example

2 fields

EXAMPLE

Workspaces Client Properties Result Example

2 fields

EXAMPLE

Workspaces Compute Type Example

1 fields

EXAMPLE

Workspaces Connect Client Add In Example

4 fields

EXAMPLE

Workspaces Connection Alias Association Example

4 fields

EXAMPLE

Workspaces Connection Alias Example

5 fields

EXAMPLE

Workspaces Connection Alias Permission Example

2 fields

EXAMPLE

Workspaces Copy Workspace Image Request Example

5 fields

EXAMPLE

Workspaces Copy Workspace Image Result Example

1 fields

EXAMPLE

Workspaces Create Connect Client Add In Request Example

3 fields

EXAMPLE

Workspaces Create Connect Client Add In Result Example

1 fields

EXAMPLE

Workspaces Create Connection Alias Request Example

2 fields

EXAMPLE

Workspaces Create Connection Alias Result Example

1 fields

EXAMPLE

Workspaces Create Ip Group Request Example

4 fields

EXAMPLE

Workspaces Create Ip Group Result Example

1 fields

EXAMPLE

Workspaces Create Standby Workspaces Request Example

2 fields

EXAMPLE

Workspaces Create Standby Workspaces Result Example

2 fields

EXAMPLE

Workspaces Create Tags Request Example

2 fields

EXAMPLE

Workspaces Create Updated Workspace Image Request Example

4 fields

EXAMPLE

Workspaces Create Updated Workspace Image Result Example

1 fields

EXAMPLE

Workspaces Create Workspace Bundle Request Example

7 fields

EXAMPLE

Workspaces Create Workspace Bundle Result Example

1 fields

EXAMPLE

Workspaces Create Workspace Image Request Example

4 fields

EXAMPLE

Workspaces Create Workspace Image Result Example

8 fields

EXAMPLE

Workspaces Create Workspaces Request Example

1 fields

EXAMPLE

Workspaces Create Workspaces Result Example

2 fields

EXAMPLE

Workspaces Default Client Branding Attributes Example

5 fields

EXAMPLE

Workspaces Default Import Client Branding Attributes Example

5 fields

EXAMPLE

Workspaces Default Workspace Creation Properties Example

6 fields

EXAMPLE

Workspaces Delete Client Branding Request Example

2 fields

EXAMPLE

Workspaces Delete Connect Client Add In Request Example

2 fields

EXAMPLE

Workspaces Delete Connection Alias Request Example

1 fields

EXAMPLE

Workspaces Delete Ip Group Request Example

1 fields

EXAMPLE

Workspaces Delete Tags Request Example

2 fields

EXAMPLE

Workspaces Delete Workspace Bundle Request Example

1 fields

EXAMPLE

Workspaces Delete Workspace Image Request Example

1 fields

EXAMPLE

Workspaces Deregister Workspace Directory Request Example

1 fields

EXAMPLE

Workspaces Describe Account Modifications Request Example

1 fields

EXAMPLE

Workspaces Describe Account Modifications Result Example

2 fields

EXAMPLE

Workspaces Describe Account Result Example

2 fields

EXAMPLE

Workspaces Describe Client Branding Request Example

1 fields

EXAMPLE

Workspaces Describe Client Branding Result Example

6 fields

EXAMPLE

Workspaces Describe Client Properties Request Example

1 fields

EXAMPLE

Workspaces Describe Client Properties Result Example

1 fields

EXAMPLE

Workspaces Describe Connect Client Add Ins Request Example

3 fields

EXAMPLE

Workspaces Describe Connect Client Add Ins Result Example

2 fields

EXAMPLE

Workspaces Describe Connection Alias Permissions Request Example

3 fields

EXAMPLE

Workspaces Describe Connection Alias Permissions Result Example

3 fields

EXAMPLE

Workspaces Describe Connection Aliases Request Example

4 fields

EXAMPLE

Workspaces Describe Connection Aliases Result Example

2 fields

EXAMPLE

Workspaces Describe Ip Groups Request Example

3 fields

EXAMPLE

Workspaces Describe Ip Groups Result Example

2 fields

EXAMPLE

Workspaces Describe Tags Request Example

1 fields

EXAMPLE

Workspaces Describe Tags Result Example

1 fields

EXAMPLE

Workspaces Describe Workspace Bundles Request Example

3 fields

EXAMPLE

Workspaces Describe Workspace Bundles Result Example

2 fields

EXAMPLE

Workspaces Describe Workspace Directories Request Example

3 fields

EXAMPLE

Workspaces Describe Workspace Directories Result Example

2 fields

EXAMPLE

Workspaces Describe Workspace Image Permissions Request Example

3 fields

EXAMPLE

Workspaces Describe Workspace Image Permissions Result Example

3 fields

EXAMPLE

Workspaces Describe Workspace Images Request Example

4 fields

EXAMPLE

Workspaces Describe Workspace Images Result Example

2 fields

EXAMPLE

Workspaces Describe Workspace Snapshots Request Example

1 fields

EXAMPLE

Workspaces Describe Workspace Snapshots Result Example

2 fields

EXAMPLE

Workspaces Describe Workspaces Connection Status Request Example

2 fields

EXAMPLE

Workspaces Describe Workspaces Connection Status Result Example

2 fields

EXAMPLE

Workspaces Describe Workspaces Request Example

6 fields

EXAMPLE

Workspaces Describe Workspaces Result Example

2 fields

EXAMPLE

Workspaces Disassociate Connection Alias Request Example

1 fields

EXAMPLE

Workspaces Disassociate Ip Groups Request Example

2 fields

EXAMPLE

Workspaces Failed Create Standby Workspaces Request Example

3 fields

EXAMPLE

Workspaces Failed Create Workspace Request Example

3 fields

EXAMPLE

Workspaces Failed Workspace Change Request Example

3 fields

EXAMPLE

Workspaces Image Permission Example

1 fields

EXAMPLE

Workspaces Import Client Branding Request Example

7 fields

EXAMPLE

Workspaces Import Client Branding Result Example

6 fields

EXAMPLE

Workspaces Import Workspace Image Request Example

6 fields

EXAMPLE

Workspaces Import Workspace Image Result Example

1 fields

EXAMPLE

Workspaces Ios Client Branding Attributes Example

7 fields

EXAMPLE

Workspaces Ios Import Client Branding Attributes Example

7 fields

EXAMPLE

Workspaces Ip Rule Item Example

2 fields

EXAMPLE

Workspaces List Available Management Cidr Ranges Request Example

3 fields

EXAMPLE

Workspaces List Available Management Cidr Ranges Result Example

2 fields

EXAMPLE

Workspaces Migrate Workspace Request Example

2 fields

EXAMPLE

Workspaces Migrate Workspace Result Example

2 fields

EXAMPLE

Workspaces Modification State Example

2 fields

EXAMPLE

Workspaces Modify Account Request Example

2 fields

EXAMPLE

Workspaces Modify Certificate Based Auth Properties Request Example

3 fields

EXAMPLE

Workspaces Modify Client Properties Request Example

2 fields

EXAMPLE

Workspaces Modify Saml Properties Request Example

3 fields

EXAMPLE

Workspaces Modify Selfservice Permissions Request Example

2 fields

EXAMPLE

Workspaces Modify Workspace Access Properties Request Example

2 fields

EXAMPLE

Workspaces Modify Workspace Creation Properties Request Example

2 fields

EXAMPLE

Workspaces Modify Workspace Properties Request Example

2 fields

EXAMPLE

Workspaces Modify Workspace State Request Example

2 fields

EXAMPLE

Workspaces Operating System Example

1 fields

EXAMPLE

Workspaces Pending Create Standby Workspaces Request Example

4 fields

EXAMPLE

Workspaces Reboot Request Example

1 fields

EXAMPLE

Workspaces Reboot Workspaces Request Example

1 fields

EXAMPLE

Workspaces Reboot Workspaces Result Example

1 fields

EXAMPLE

Workspaces Rebuild Request Example

1 fields

EXAMPLE

Workspaces Rebuild Workspaces Request Example

1 fields

EXAMPLE

Workspaces Rebuild Workspaces Result Example

1 fields

EXAMPLE

Workspaces Register Workspace Directory Request Example

6 fields

EXAMPLE

Workspaces Related Workspace Properties Example

4 fields

EXAMPLE

Workspaces Restore Workspace Request Example

1 fields

EXAMPLE

Workspaces Revoke Ip Rules Request Example

2 fields

EXAMPLE

Workspaces Root Storage Example

1 fields

EXAMPLE

Workspaces Saml Properties Example

3 fields

EXAMPLE

Workspaces Selfservice Permissions Example

5 fields

EXAMPLE

Workspaces Snapshot Example

1 fields

EXAMPLE

Workspaces Standby Workspace Example

4 fields

EXAMPLE

Workspaces Start Request Example

1 fields

EXAMPLE

Workspaces Start Workspaces Request Example

1 fields

EXAMPLE

Workspaces Start Workspaces Result Example

1 fields

EXAMPLE

Workspaces Stop Request Example

1 fields

EXAMPLE

Workspaces Stop Workspaces Request Example

1 fields

EXAMPLE

Workspaces Stop Workspaces Result Example

1 fields

EXAMPLE

Workspaces Tag Example

2 fields

EXAMPLE

Workspaces Terminate Request Example

1 fields

EXAMPLE

Workspaces Terminate Workspaces Request Example

1 fields

EXAMPLE

Workspaces Terminate Workspaces Result Example

1 fields

EXAMPLE

Workspaces Update Connect Client Add In Request Example

4 fields

EXAMPLE

Workspaces Update Connection Alias Permission Request Example

2 fields

EXAMPLE

Workspaces Update Result Example

2 fields

EXAMPLE

Workspaces Update Rules Of Ip Group Request Example

2 fields

EXAMPLE

Workspaces Update Workspace Bundle Request Example

2 fields

EXAMPLE

Workspaces Update Workspace Image Permission Request Example

3 fields

EXAMPLE

Workspaces User Storage Example

1 fields

EXAMPLE

Workspaces Workspace Access Properties Example

8 fields

EXAMPLE

Workspaces Workspace Bundle Example

12 fields

EXAMPLE

Workspaces Workspace Connection Status Example

4 fields

EXAMPLE

Workspaces Workspace Creation Properties Example

6 fields

EXAMPLE

Workspaces Workspace Directory Example

18 fields

EXAMPLE

Workspaces Workspace Example

16 fields

EXAMPLE

Workspaces Workspace Image Example

11 fields

EXAMPLE

Workspaces Workspace Properties Example

6 fields

EXAMPLE

Workspaces Workspace Request Example

8 fields

EXAMPLE

Workspaces Workspaces Ip Group Example

4 fields

EXAMPLE

Resources

🌐
Portal
Portal
🔗
Website
Website
🔗
Documentation
Documentation
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
👥
GitHubOrganization
GitHubOrganization
🌐
Console
Console
📝
Signup
Signup
🔗
Login
Login
🟢
StatusPage
StatusPage
🔗
Contact
Contact
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑ 
aid: amazon-workspaces
name: Amazon WorkSpaces
description: Amazon WorkSpaces is a managed, secure Desktop-as-a-Service (DaaS) solution that enables you to provision cloud-based
  virtual desktops for your users. It eliminates the need to procure and deploy hardware or install complex software, providing
  persistent desktops accessible from various devices with built-in security and management capabilities. The API provides
  65 operations for workspace lifecycle management, bundle and directory management, image management, and IP access control
  groups.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
url: https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/apis.yml
created: '2024-01-15'
modified: '2026-05-19'
specificationVersion: '0.19'
type: Index
tags:
- AWS
- Desktop
- End User Computing
- Virtual Desktop
- Desktop as a Service
apis:
- aid: amazon-workspaces:amazon-workspaces-api
  name: Amazon WorkSpaces API
  description: The Amazon WorkSpaces API provides programmatic access to manage cloud-based virtual desktops. It enables developers
    to create, modify, and terminate WorkSpaces, manage workspace bundles and directories, configure IP access control groups,
    and automate desktop provisioning and lifecycle management at scale. 65 operations for workspace lifecycle, bundles, directories,
    images, and access control.
  humanURL: https://aws.amazon.com/workspaces/
  baseURL: https://workspaces.amazonaws.com
  tags:
  - AWS
  - Desktop
  - End User Computing
  - Virtual Desktop
  properties:
  - type: Documentation
    url: https://docs.aws.amazon.com/workspaces/
  - type: OpenAPI
    url: openapi/amazon-workspaces-openapi-original.yaml
  - type: Pricing
    url: https://aws.amazon.com/workspaces/pricing/
  - type: GettingStarted
    url: https://aws.amazon.com/workspaces/getting-started/
  - type: FAQ
    url: https://aws.amazon.com/workspaces/faqs/
  - type: APIReference
    url: https://docs.aws.amazon.com/workspaces/latest/api/welcome.html
  - type: JSONSchema
    url: json-schema/workspaces-workspace-schema.json
  - type: JSONLD
    url: json-ld/amazon-workspaces-context.jsonld
common:
- type: Portal
  url: https://aws.amazon.com/
- type: Website
  url: https://aws.amazon.com/workspaces/
- type: Documentation
  url: https://docs.aws.amazon.com/workspaces/
- type: TermsOfService
  url: https://aws.amazon.com/service-terms/
- type: PrivacyPolicy
  url: https://aws.amazon.com/privacy/
- type: Support
  url: https://aws.amazon.com/premiumsupport/
- type: GitHubOrganization
  url: https://github.com/aws
- type: Console
  url: https://console.aws.amazon.com/workspaces/
- type: Signup
  url: https://signin.aws.amazon.com/signup?request_type=register
- type: Login
  url: https://aws.amazon.com/console/
- type: StatusPage
  url: https://health.aws.amazon.com/health/status
- type: Contact
  url: https://aws.amazon.com/contact-us/
- type: SpectralRules
  url: rules/amazon-workspaces-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/amazon-workspaces-vocabulary.yaml
- type: Features
  data:
  - name: Persistent Virtual Desktops
    description: Cloud-based Windows or Linux desktops with persistent storage that users can access from any device or location.
  - name: Desktop Bundle Catalog
    description: Configurable compute bundles ranging from Value to Graphics.g4dn to match workload requirements and cost
      targets.
  - name: Active Directory Integration
    description: Integration with AWS Managed Microsoft AD and AD Connector for user authentication and policy management.
  - name: Application Management
    description: Deploy and manage applications across WorkSpaces using application assignment and streaming capabilities.
  - name: IP Access Control Groups
    description: Restrict workspace access by IP address ranges to enforce network-based access controls.
  - name: Running Mode Flexibility
    description: AlwaysOn mode for power users and AutoStop mode for cost optimization of occasional-use desktops.
  - name: BYOD Support
    description: Thin client, web browser, iOS, Android, Linux, macOS, and Windows client access for bring-your-own-device
      scenarios.
  - name: Workspace Snapshots and Restore
    description: Automated snapshots enable restoring workspaces to previous states for disaster recovery and user error correction.
- type: UseCases
  data:
  - name: Remote Work Enablement
    description: Provide secure cloud desktops to remote and distributed employees without managing physical hardware.
  - name: Contractor and Temporary Worker Access
    description: Quickly provision and terminate secure desktops for contractors with time-limited access needs.
  - name: Desktop Refresh and Modernization
    description: Replace aging desktop hardware with cloud-based virtual desktops to reduce capital expenditure.
  - name: BYOD Security
    description: Enable personal device usage while keeping corporate data and applications in the secure cloud environment.
  - name: Regulated Industry Compliance
    description: Maintain data residency and security compliance in regulated industries like healthcare and finance.
- type: Integrations
  data:
  - name: AWS Directory Service
    description: Managed Microsoft AD and AD Connector for user authentication and group policy management.
  - name: AWS IAM
    description: IAM-based access control for WorkSpaces API operations and resource-level permissions.
  - name: Amazon S3
    description: User storage and workspace image storage backed by Amazon S3.
  - name: AWS CloudTrail
    description: Audit logging of all WorkSpaces API calls for compliance and security monitoring.
  - name: Amazon CloudWatch
    description: Metrics and monitoring for workspace performance, connectivity, and health status.
- type: Integrations
  url: https://aws.amazon.com/marketplace/
integrations:
- name: Sign in
- name: Agent Mode
- name: Why AWS Marketplace?
- name: Get started in AWS Marketplace
- name: Industry
- name: Resources
- name: Become a Channel Partner
- name: Sell in AWS Marketplace
- name: Manage Your Account
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com