How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Amazon WorkSpaces Web

Amazon WorkSpaces Web Portals API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Amazon WorkSpaces Web Portals API is one of 10 APIs that Amazon WorkSpaces Web publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Portal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 1 JSON Schema.

This API exposes 18 operations across 15 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://workspaces-web.{region}.amazonaws.com, https://workspaces-web.{region}.amazonaws.com, http://workspaces-web.{region}.amazonaws.com.cn, https://workspaces-web.{region}.amazonaws.com.cn.

18 operations 15 paths 46 schemas 7 DELETE3 GET1 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://workspaces-web.amazonaws.com
Authentication
API Key
Contact
Mike Ralphson
License
Apache 2.0 License
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Amazon WorkSpaces Web Portals API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 7 DELETE, 3 GET, 1 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Portals 18
PUT
/portals/{portalArn}/browserSettings#browserSettingsArn
Amazon WorkSpaces Web Associate Browser Settings
AssociateBrowserSettings 9 params → 200480481482483484485
PUT
/portals/{portalArn}/ipAccessSettings#ipAccessSettingsArn
Amazon WorkSpaces Web Associate Ip Access Settings
AssociateIpAccessSettings 9 params → 200480481482483484485
PUT
/portals/{portalArn}/networkSettings#networkSettingsArn
Amazon WorkSpaces Web Associate Network Settings
AssociateNetworkSettings 9 params → 200480481482483484485
PUT
/portals/{portalArn}/trustStores#trustStoreArn
Amazon WorkSpaces Web Associate Trust Store
AssociateTrustStore 9 params → 200480481482483484
PUT
/portals/{portalArn}/userAccessLoggingSettings#userAccessLoggingSettingsArn
Amazon WorkSpaces Web Associate User Access Logging Settings
AssociateUserAccessLoggingSettings 9 params → 200480481482483484485
PUT
/portals/{portalArn}/userSettings#userSettingsArn
Amazon WorkSpaces Web Associate User Settings
AssociateUserSettings 9 params → 200480481482483484485
POST
/portals
Amazon WorkSpaces Web Create Portal
CreatePortal 7 params body → 200480481482483484485486
GET
/portals
Amazon WorkSpaces Web List Portals
ListPortals 9 params → 200480481482483
DELETE
/portals/{portalArn}
Amazon WorkSpaces Web Delete Portal
DeletePortal 8 params → 200480481482483484
GET
/portals/{portalArn}
Amazon WorkSpaces Web Get Portal
GetPortal 8 params → 200480481482483484
PUT
/portals/{portalArn}
Amazon WorkSpaces Web Update Portal
UpdatePortal 8 params body → 200480481482483484485
DELETE
/portals/{portalArn}/browserSettings
Amazon WorkSpaces Web Disassociate Browser Settings
DisassociateBrowserSettings 8 params → 200480481482483484
DELETE
/portals/{portalArn}/ipAccessSettings
Amazon WorkSpaces Web Disassociate Ip Access Settings
DisassociateIpAccessSettings 8 params → 200480481482483484
DELETE
/portals/{portalArn}/networkSettings
Amazon WorkSpaces Web Disassociate Network Settings
DisassociateNetworkSettings 8 params → 200480481482483484
DELETE
/portals/{portalArn}/trustStores
Amazon WorkSpaces Web Disassociate Trust Store
DisassociateTrustStore 8 params → 200480481482483484
DELETE
/portals/{portalArn}/userAccessLoggingSettings
Amazon WorkSpaces Web Disassociate User Access Logging Settings
DisassociateUserAccessLoggingSettings 8 params → 200480481482483484
DELETE
/portals/{portalArn}/userSettings
Amazon WorkSpaces Web Disassociate User Settings
DisassociateUserSettings 8 params → 200480481482483484
GET
/portals/{portalArn}/identityProviders
Amazon WorkSpaces Web List Identity Providers
ListIdentityProviders 10 params → 200480481482483

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Portal (15 properties), PortalSummary (14 properties), IdentityProviderSummary (3 properties), AssociateTrustStoreResponse (2 properties). Each schema is shown below with its type and property counts.

IdentityProviderSummary
object
The summary of the identity provider.
3 properties
ConflictException
StringType
string
DisassociateUserSettingsResponse
object
PaginationToken
string
DeletePortalResponse
object
ThrottlingException
Tag
object
The tag.
2 properties 2 required
TagKey
string
IdentityProviderList
array
IdentityProviderName
string
ServiceQuotaExceededException
DisassociateBrowserSettingsResponse
object
AssociateUserAccessLoggingSettingsResponse
object
2 properties 2 required
ResourceNotFoundException
DisassociateTrustStoreResponse
object
ListPortalsResponse
object
2 properties
IdentityProviderType
string
RendererType
string
DisplayName
string
CreatePortalResponse
object
2 properties 2 required
AuthenticationType
string
ARN
string
DisassociateUserAccessLoggingSettingsResponse
object
PortalStatus
string
BrowserType
string
UpdatePortalResponse
object
1 property
PortalList
array
ListIdentityProvidersResponse
object
2 properties
AssociateTrustStoreResponse
object
2 properties 2 required
DisassociateNetworkSettingsResponse
object
DisassociateIpAccessSettingsResponse
object
Timestamp
string
AccessDeniedException
AssociateIpAccessSettingsResponse
object
2 properties 2 required
StatusReason
string
AssociateBrowserSettingsResponse
object
2 properties 2 required
ValidationException
AssociateNetworkSettingsResponse
object
2 properties 2 required
PortalSummary
object
The summary of the portal.
14 properties
AssociateUserSettingsResponse
object
2 properties 2 required
GetPortalResponse
object
1 property
Portal
object
The web portal.
15 properties
PortalEndpoint
string
TagValue
string
InternalServerException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-workspaces-web-portals-api-openapi.yml Raw ↑

Other APIs Amazon WorkSpaces Web publishes across the network.

Amazon WorkSpaces Web BrowserSettings API
AE Profile APIs.io
Amazon WorkSpaces Web IdentityProviders API
AE Profile APIs.io
Amazon WorkSpaces Web IpAccessSettings API
AE Profile APIs.io
Amazon WorkSpaces Web NetworkSettings API
AE Profile APIs.io
Amazon WorkSpaces Web PortalIdp API
AE Profile APIs.io
Amazon WorkSpaces Web Tags API
AE Profile APIs.io
Amazon WorkSpaces Web TrustStores API
AE Profile APIs.io
Amazon WorkSpaces Web UserAccessLoggingSettings API
AE Profile APIs.io
Amazon WorkSpaces Web UserSettings API
AE Profile APIs.io
#Portal
← Back to A APIs
API Details
ID
amazon-workspaces-web:amazon-workspaces-web-portals-api
Base URL
https://workspaces-web.amazonaws.com
Docs
https://aws.amazon.com/workspaces/web/
Provider
Amazon WorkSpaces Web
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=amazon-workspaces-web-portals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/amazon-workspaces-web-portals-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Amazon WorkSpaces Web Portals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.