# Amazon WorkSpaces API

> Amazon WorkSpaces API on Apizie: 65 endpoints (Associates the specified connection alias with the specified directory to enable cross-Region redirection.…, Associates the specified IP access control group with the specified directory., Adds one or more rules to the specified IP access control group. This action gives users permission to…, Copies the specified image from the specified Region to the current Region. For more information about…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-workspaces`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-workspaces
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-workspaces/openapi.json

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…

## Endpoints

### Associates the specified connection alias with the specified directory to enable cross-Region redirection.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/associate-connection-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Associates the specified IP access control group with the specified directory.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/associate-ip-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Adds one or more rules to the specified IP access control group. This action gives users permission to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/authorize-ip-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Copies the specified image from the specified Region to the current Region. For more information about…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/copy-workspace-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-connect-client-add-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the specified connection alias for use with cross-Region redirection. For more information, see…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-connection-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an IP access control group. An IP access control group provides you with the ability to control the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a standby WorkSpace in a secondary Region.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-standby-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the specified tags for the specified WorkSpaces resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-updated-workspace-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-workspace-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a new WorkSpace image from an existing WorkSpace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-workspace-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/create-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-client-branding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a client-add-in for Amazon Connect that is configured within a directory.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-connect-client-add-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-connection-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified IP access control group. You cannot delete an IP access control group that is…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified tags from the specified WorkSpaces resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-workspace-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified image from your account. To delete an image, you must first delete any bundles that…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/delete-workspace-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/deregister-workspace-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-account-modifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the specified client branding. Client branding allows you to customize the log in page of various…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-client-branding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-client-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list of Amazon Connect client add-ins that have been created.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-connect-client-add-ins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-connection-alias-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes the connection aliases used for cross-Region redirection. For more…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-connection-aliases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes one or more of your IP access control groups.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-ip-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the specified tags for the specified WorkSpaces resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspace-bundles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Describes the available directories that are registered with Amazon WorkSpaces.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspace-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspace-image-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list that describes one or more specified images, if the image identifiers are provided.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspace-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the snapshots for the specified WorkSpace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspace-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Limit | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Describes the connection status of the specified WorkSpaces.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/describe-workspaces-connection-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/disassociate-connection-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Disassociates the specified IP access control group from the specified directory.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/disassociate-ip-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/import-client-branding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/import-workspace-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/list-available-management-cidr-ranges` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/migrate-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-certificate-based-auth-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies the properties of the specified Amazon WorkSpaces clients.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-client-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-saml-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-selfservice-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Specifies which devices and operating systems users can use to access their WorkSpaces. For more…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-workspace-access-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modify the default properties used to create WorkSpaces.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-workspace-creation-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Modifies the specified WorkSpace properties. For important information about how to modify the size of the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-workspace-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/modify-workspace-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY .…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/reboot-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE , ERROR ,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/rebuild-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/register-workspace-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/restore-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Removes one or more rules from the specified IP access control group.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/revoke-ip-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/start-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/stop-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/terminate-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/update-connect-client-add-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Shares or unshares a connection alias with one account by specifying whether that account has permission to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/update-connection-alias-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Replaces the current rules of the specified IP access control group with the specified rules.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/update-rules-of-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/update-workspace-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/update-workspace-image-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/associate-connection-alias" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon WorkSpaces API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces/associate-connection-alias with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon WorkSpaces API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon WorkSpaces itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon WorkSpaces API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-workspaces.

### What is the status of the Amazon WorkSpaces API?
Needs your own provider key (bring your own key)