# Amazon WorkSpaces Web API

> Amazon WorkSpaces Web API on Apizie: 58 endpoints (Associates a browser settings resource with a web portal., Associates an IP access settings resource with a web portal., Associates a network settings resource with a web portal., Associates a trust store with a web portal., …) 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-web/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide their employees with access to internal…

## Endpoints

### Associates a browser settings resource with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| browserSettingsArn | string | yes | The ARN of the browser settings. |
| portalArn | string | yes | The ARN of the web portal. |

### Associates an IP access settings resource with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ipAccessSettingsArn | string | yes | The ARN of the IP access settings. |
| portalArn | string | yes | The ARN of the web portal. |

### Associates a network settings resource with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| networkSettingsArn | string | yes | The ARN of the network settings. |
| portalArn | string | yes | The ARN of the web portal. |

### Associates a trust store with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-trust-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |
| trustStoreArn | string | yes | The ARN of the trust store. |

### Associates a user access logging settings resource with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |
| userAccessLoggingSettingsArn | string | yes | The ARN of the user access logging settings. |

### Associates a user settings resource with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/associate-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |
| userSettingsArn | string | yes | The ARN of the user settings. |

### Retrieves a list of browser settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a browser settings resource that can be associated with a web portal. Once associated with a web…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-browser-settings` (byok)

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

### Creates an identity provider resource that is then associated with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-identity-provider` (byok)

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

### Retrieves a list of IP access settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates an IP access settings resource that can be associated with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-ip-access-settings` (byok)

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

### Retrieves a list of network settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a network settings resource that can be associated with a web portal. Once associated with a web…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-network-settings` (byok)

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

### Retrieves a list or web portals.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-portals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-portal` (byok)

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

### Retrieves a list of trust stores.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-trust-stores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a trust store that can be associated with a web portal. A trust store contains certificate authority…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-trust-store` (byok)

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

### Retrieves a list of user access logging settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a user access logging settings resource that can be associated with a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-user-access-logging-settings` (byok)

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

### Retrieves a list of user settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |

### Creates a user settings resource that can be associated with a web portal. Once associated with a web…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/create-user-settings` (byok)

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

### Gets browser settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| browserSettingsArn | string | yes | The ARN of the browser settings. |

### Updates browser settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| browserSettingsArn | string | yes | The ARN of the browser settings. |
| body | object | yes | JSON request body |

### Deletes browser settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| browserSettingsArn | string | yes | The ARN of the browser settings. |

### Gets the identity provider.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-identity-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| identityProviderArn | string | yes | The ARN of the identity provider. |

### Updates the identity provider.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-identity-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| identityProviderArn | string | yes | The ARN of the identity provider. |
| body | object | yes | JSON request body |

### Deletes the identity provider.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-identity-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| identityProviderArn | string | yes | The ARN of the identity provider. |

### Gets the IP access settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ipAccessSettingsArn | string | yes | The ARN of the IP access settings. |

### Updates IP access settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ipAccessSettingsArn | string | yes | The ARN of the IP access settings. |
| body | object | yes | JSON request body |

### Deletes IP access settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ipAccessSettingsArn | string | yes | The ARN of the IP access settings. |

### Gets the network settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| networkSettingsArn | string | yes | The ARN of the network settings. |

### Updates network settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| networkSettingsArn | string | yes | The ARN of the network settings. |
| body | object | yes | JSON request body |

### Deletes network settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| networkSettingsArn | string | yes | The ARN of the network settings. |

### Gets the web portal.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Updates a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |
| body | object | yes | JSON request body |

### Deletes a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Gets the trust store.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-trust-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| trustStoreArn | string | yes | The ARN of the trust store. |

### Updates the trust store.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-trust-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| trustStoreArn | string | yes | The ARN of the trust store. |
| body | object | yes | JSON request body |

### Deletes the trust store.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-trust-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| trustStoreArn | string | yes | The ARN of the trust store. |

### Gets user access logging settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userAccessLoggingSettingsArn | string | yes | The ARN of the user access logging settings. |

### Updates the user access logging settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userAccessLoggingSettingsArn | string | yes | The ARN of the user access logging settings. |
| body | object | yes | JSON request body |

### Deletes user access logging settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userAccessLoggingSettingsArn | string | yes | The ARN of the user access logging settings. |

### Gets user settings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userSettingsArn | string | yes | The ARN of the user settings. |

### Updates the user settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/update-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userSettingsArn | string | yes | The ARN of the user settings. |
| body | object | yes | JSON request body |

### Deletes user settings.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/delete-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userSettingsArn | string | yes | The ARN of the user settings. |

### Disassociates browser settings from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-browser-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Disassociates IP access settings from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-ip-access-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Disassociates network settings from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Disassociates a trust store from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-trust-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Disassociates user access logging settings from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-user-access-logging-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Disassociates user settings from a web portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/disassociate-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Gets the service provider metadata.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-portal-service-provider-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalArn | string | yes | The ARN of the web portal. |

### Gets the trust store certificate.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/get-trust-store-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thumbprint | string | yes | The thumbprint of the trust store certificate. |
| trustStoreArn | string | yes | The ARN of the trust store certificate. |

### Retrieves a list of identity providers for a specific web portal.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-identity-providers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |
| portalArn | string | yes | The ARN of the web portal. |

### Retrieves a list of tags for a resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource. |

### Adds or overwrites one or more tags for the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource. |
| body | object | yes | JSON request body |

### Retrieves a list of trust store certificates.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/list-trust-store-certificates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results to be included in the next page. |
| nextToken | string | no | The pagination token used to retrieve the next page of results for this operation. |
| trustStoreArn | string | yes | The ARN of the trust store |

### Removes one or more tags from the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workspaces-web/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource. |
| tagKeys | array | yes | The list of tag keys to remove from the resource. |

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

## FAQ

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

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

### Can AI agents use the Amazon WorkSpaces Web 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-web.

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