Amazon Web Services, Inc.

Amazon WorkSpaces Web

Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Endpoints 75

Portal

  • PUTAssociate browser settings/portals/:portalArn/browserSettings?browserSettingsArn=stringAssociates a browser settings resource with a web portal.
  • DELETEDisassociate browser settings/portals/:portalArn/browserSettingsDisassociates browser settings from a web portal.
  • PUTAssociate data protection settings/portals/:portalArn/dataProtectionSettings?dataProtectionSettingsArn=stringAssociates a data protection settings resource with a web portal.
  • DELETEDisassociate data protection settings/portals/:portalArn/dataProtectionSettingsDisassociates data protection settings from a web portal.
  • PUTAssociate ip access settings/portals/:portalArn/ipAccessSettings?ipAccessSettingsArn=stringAssociates an IP access settings resource with a web portal.
  • DELETEDisassociate ip access settings/portals/:portalArn/ipAccessSettingsDisassociates IP access settings from a web portal.
  • PUTAssociate network settings/portals/:portalArn/networkSettings?networkSettingsArn=stringAssociates a network settings resource with a web portal.
  • DELETEDisassociate network settings/portals/:portalArn/networkSettingsDisassociates network settings from a web portal.
  • PUTAssociate session logger/portals/:portalArn/sessionLogger?sessionLoggerArn=stringAssociates a session logger with a portal.
  • DELETEDisassociate session logger/portals/:portalArn/sessionLoggerDisassociates a session logger from a portal.
  • PUTAssociate trust store/portals/:portalArn/trustStores?trustStoreArn=stringAssociates a trust store with a web portal.
  • DELETEDisassociate trust store/portals/:portalArn/trustStoresDisassociates a trust store from a web portal.
  • PUTAssociate user access logging settings/portals/:portalArn/userAccessLoggingSettings?userAccessLoggingSettingsArn=stringAssociates a user access logging settings resource with a web portal.
  • DELETEDisassociate user access logging settings/portals/:portalArn/userAccessLoggingSettingsDisassociates user access logging settings from a web portal.
  • PUTAssociate user settings/portals/:portalArn/userSettings?userSettingsArn=stringAssociates a user settings resource with a web portal.
  • DELETEDisassociate user settings/portals/:portalArn/userSettingsDisassociates user settings from a web portal.
  • GETList portals/portals?nextToken=string&maxResults=0Retrieves a list or web portals.
  • POSTCreate portal/portalsCreates a web portal.
  • GETGet portal/portals/:portalArnGets the web portal.
  • PUTUpdate portal/portals/:portalArnUpdates a web portal.
  • DELETEDelete portal/portals/:portalArnDeletes a web portal.
  • GETGet portal service provider metadata/portalIdp/:portalArnGets the service provider metadata.

Browser settings

  • GETList browser settings/browserSettings?nextToken=string&maxResults=0Retrieves a list of browser settings.
  • POSTCreate browser settings/browserSettingsCreates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will…
  • GETGet browser settings/browserSettings/:browserSettingsArnGets browser settings.
  • DELETEDelete browser settings/browserSettings/:browserSettingsArnDeletes browser settings.
  • PATCHUpdate browser settings/browserSettings/:browserSettingsArnUpdates browser settings.

Data protection settings

  • GETList data protection settings/dataProtectionSettings?nextToken=string&maxResults=0Retrieves a list of data protection settings.
  • POSTCreate data protection settings/dataProtectionSettingsCreates a data protection settings resource that can be associated with a web portal.
  • GETGet data protection settings/dataProtectionSettings/:dataProtectionSettingsArnGets the data protection settings.
  • DELETEDelete data protection settings/dataProtectionSettings/:dataProtectionSettingsArnDeletes data protection settings.
  • PATCHUpdate data protection settings/dataProtectionSettings/:dataProtectionSettingsArnUpdates data protection settings.

Identity provider

  • POSTCreate identity provider/identityProvidersCreates an identity provider resource that is then associated with a web portal.
  • GETGet identity provider/identityProviders/:identityProviderArnGets the identity provider.
  • DELETEDelete identity provider/identityProviders/:identityProviderArnDeletes the identity provider.
  • PATCHUpdate identity provider/identityProviders/:identityProviderArnUpdates the identity provider.
  • GETList identity providers/portals/:portalArn/identityProviders?nextToken=string&maxResults=0Retrieves a list of identity providers for a specific web portal.

Ip access settings

  • GETList ip access settings/ipAccessSettings?nextToken=string&maxResults=0Retrieves a list of IP access settings.
  • POSTCreate ip access settings/ipAccessSettingsCreates an IP access settings resource that can be associated with a web portal.
  • GETGet ip access settings/ipAccessSettings/:ipAccessSettingsArnGets the IP access settings.
  • DELETEDelete ip access settings/ipAccessSettings/:ipAccessSettingsArnDeletes IP access settings.
  • PATCHUpdate ip access settings/ipAccessSettings/:ipAccessSettingsArnUpdates IP access settings.

Network settings

  • GETList network settings/networkSettings?nextToken=string&maxResults=0Retrieves a list of network settings.
  • POSTCreate network settings/networkSettingsCreates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming…
  • GETGet network settings/networkSettings/:networkSettingsArnGets the network settings.
  • DELETEDelete network settings/networkSettings/:networkSettingsArnDeletes network settings.
  • PATCHUpdate network settings/networkSettings/:networkSettingsArnUpdates network settings.

Session logger

  • GETList session loggers/sessionLoggers?nextToken=string&maxResults=0Lists all available session logger resources.
  • POSTCreate session logger/sessionLoggersCreates a session logger.
  • GETGet session logger/sessionLoggers/:sessionLoggerArnGets details about a specific session logger resource.
  • POSTUpdate session logger/sessionLoggers/:sessionLoggerArnUpdates the details of a session logger.
  • DELETEDelete session logger/sessionLoggers/:sessionLoggerArnDeletes a session logger resource.

Trust store

  • GETList trust stores/trustStores?nextToken=string&maxResults=0Retrieves a list of trust stores.
  • POSTCreate trust store/trustStoresCreates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web…
  • GETGet trust store/trustStores/:trustStoreArnGets the trust store.
  • DELETEDelete trust store/trustStores/:trustStoreArnDeletes the trust store.
  • PATCHUpdate trust store/trustStores/:trustStoreArnUpdates the trust store.
  • GETGet trust store certificate/trustStores/:trustStoreArn/certificate?thumbprint=stringGets the trust store certificate.
  • GETList trust store certificates/trustStores/:trustStoreArn/certificates?nextToken=string&maxResults=0Retrieves a list of trust store certificates.

User access logging settings

  • GETList user access logging settings/userAccessLoggingSettings?nextToken=string&maxResults=0Retrieves a list of user access logging settings.
  • POSTCreate user access logging settings/userAccessLoggingSettingsCreates a user access logging settings resource that can be associated with a web portal.
  • GETGet user access logging settings/userAccessLoggingSettings/:userAccessLoggingSettingsArnGets user access logging settings.
  • DELETEDelete user access logging settings/userAccessLoggingSettings/:userAccessLoggingSettingsArnDeletes user access logging settings.
  • PATCHUpdate user access logging settings/userAccessLoggingSettings/:userAccessLoggingSettingsArnUpdates the user access logging settings.

User settings

  • GETList user settings/userSettings?nextToken=string&maxResults=0Retrieves a list of user settings.
  • POSTCreate user settings/userSettingsCreates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer…
  • GETGet user settings/userSettings/:userSettingsArnGets user settings.
  • DELETEDelete user settings/userSettings/:userSettingsArnDeletes user settings.
  • PATCHUpdate user settings/userSettings/:userSettingsArnUpdates the user settings.
  • GETGet session/portals/:portalId/sessions/:sessionIdGets information for a secure browser session.
  • DELETEExpire session/portals/:portalId/sessions/:sessionIdExpires an active secure browser session.
  • GETList sessions/portals/:portalId/sessions?username=string&sessionId=string&sortBy=string&status=string&maxResults=0&nextToken=stringLists information for multiple secure browser sessions from a specific portal.
  • GETList tags for resource/tags/:resourceArnRetrieves a list of tags for a resource.
  • POSTTag resource/tags/:resourceArnAdds or overwrites one or more tags for the specified resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tags from the specified resource.

API details

Base URL
https://workspaces-web.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
75 operations on 35 pathsGET 26DELETE 20POST 12PUT 9PATCH 8
Main resources
Portal 22Trust store 7Browser settings 5Data protection settings 5Identity provider 5Ip access settings 5Network settings 5Session logger 5User access logging settings 5User settings 5
Description format
AWS Smithy model, API version 2020-07-08

How to test the Amazon WorkSpaces Web in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon WorkSpaces Web collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate browser settings” (PUT /portals/:portalArn/browserSettings?browserSettingsArn=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon WorkSpaces Web?

Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure… It is listed under Developer tools and has 75 endpoints.

Who publishes the Amazon WorkSpaces Web?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon WorkSpaces Web?

Requests go to https://workspaces-web.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon WorkSpaces Web?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon WorkSpaces Web have?

75 operations on 35 paths (26 GET, 20 DELETE, 12 POST, 9 PUT, 8 PATCH). The largest groups are Portal, Trust store, Browser settings, Data protection settings.

Is forking the Amazon WorkSpaces Web free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.