Amazon WorkSpaces Web

Amazon WorkSpaces Web Portals API

The Portals API from Amazon WorkSpaces Web — 15 operation(s) for portals.

GitHub OpenAPI

Operations 21

PUT /portals/{portalArn}/browserSettings#browserSettingsArn Amazon WorkSpaces Web Associate Browser Settings #
PUT /portals/{portalArn}/ipAccessSettings#ipAccessSettingsArn Amazon WorkSpaces Web Associate Ip Access Settings #
PUT /portals/{portalArn}/networkSettings#networkSettingsArn Amazon WorkSpaces Web Associate Network Settings #
PUT /portals/{portalArn}/trustStores#trustStoreArn Amazon WorkSpaces Web Associate Trust Store #
PUT /portals/{portalArn}/userAccessLoggingSettings#userAccessLoggingSettingsArn Amazon WorkSpaces Web Associate User Access Logging Settings #
PUT /portals/{portalArn}/userSettings#userSettingsArn Amazon WorkSpaces Web Associate User Settings #
POST /portals Amazon WorkSpaces Web Create Portal #
GET /portals Amazon WorkSpaces Web List Portals #
DELETE /portals/{portalArn} Amazon WorkSpaces Web Delete Portal #
GET /portals/{portalArn} Amazon WorkSpaces Web Get Portal #
PUT /portals/{portalArn} Amazon WorkSpaces Web Update Portal #
DELETE /portals/{portalArn}/browserSettings Amazon WorkSpaces Web Disassociate Browser Settings #
DELETE /portals/{portalArn}/ipAccessSettings Amazon WorkSpaces Web Disassociate Ip Access Settings #
DELETE /portals/{portalArn}/networkSettings Amazon WorkSpaces Web Disassociate Network Settings #
DELETE /portals/{portalArn}/trustStores Amazon WorkSpaces Web Disassociate Trust Store #
DELETE /portals/{portalArn}/userAccessLoggingSettings Amazon WorkSpaces Web Disassociate User Access Logging Settings #
DELETE /portals/{portalArn}/userSettings Amazon WorkSpaces Web Disassociate User Settings #
GET /portals/{portalArn}/identityProviders Amazon WorkSpaces Web List Identity Providers #
GET /portals/{portalArn+} Get Portal #
PUT /portals/{portalArn+} Update Portal #
DELETE /portals/{portalArn+} Delete Portal #

Documentation

📖
Documentation
https://docs.aws.amazon.com/workspaces-web/latest/adminguide/
📖
APIReference
https://docs.aws.amazon.com/workspaces-web/latest/APIReference/
📖
GettingStarted
https://docs.aws.amazon.com/workspaces-web/latest/adminguide/getting-started.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-workspaces-web/openapi/amazon-workspaces-web-portals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-workspaces-web/json-schema/workspaces-web-portal-schema.json

Other Resources

🔗
Pricing
https://aws.amazon.com/workspaces/web/pricing/
🔗
FAQ
https://aws.amazon.com/workspaces/web/faqs/
🔗
JSONLD
https://artifacts.apis.io/amazon-workspaces-web/json-ld/amazon-workspaces-web-context.jsonld
🔗
APIsJSON
https://artifacts.apis.io/amazon-workspaces-web/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-workspaces-web:amazon-workspaces-web-portals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-workspaces-web-portals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Workspaces Web Portals API
  version: '2020-07-08'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-aws-signingName differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged Portals across 2 of this provider''s published API definitions: amazon-workspaces-web-openapi-original.yaml, amazon-workspaces-web-portals-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://workspaces-web.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces Web multi-region endpoint
- url: https://workspaces-web.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces Web multi-region endpoint
- url: http://workspaces-web.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces Web endpoint for China (Beijing) and China (Ningxia)
- url: https://workspaces-web.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces Web endpoint for China (Beijing) and China (Ningxia)
tags:


# --- truncated at 32 KB (110 KB total) ---
# Full source: https://artifacts.apis.io/amazon-workspaces-web/openapi/amazon-workspaces-web-portals-api-openapi.yml