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

Amazon WorkSpaces Web IpAccessSettings API

The IpAccessSettings API from Amazon WorkSpaces Web — 2 operation(s) for ipaccesssettings.

Amazon WorkSpaces Web IpAccessSettings 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 IpAccessSettings. 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 5 operations across 2 paths, and defines 28 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.

5 operations 2 paths 28 schemas 1 DELETE2 GET1 PATCH1 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon WorkSpaces Web IpAccessSettings 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

IpAccessSettings 5
POST
/ipAccessSettings
Amazon WorkSpaces Web Create Ip Access Settings
CreateIpAccessSettings 7 params body → 200480481482483484485
GET
/ipAccessSettings
Amazon WorkSpaces Web List Ip Access Settings
ListIpAccessSettings 9 params → 200480481482483
DELETE
/ipAccessSettings/{ipAccessSettingsArn}
Amazon WorkSpaces Web Delete Ip Access Settings
DeleteIpAccessSettings 8 params → 200480481482483484
GET
/ipAccessSettings/{ipAccessSettingsArn}
Amazon WorkSpaces Web Get Ip Access Settings
GetIpAccessSettings 8 params → 200480481482483484
PATCH
/ipAccessSettings/{ipAccessSettingsArn}
Amazon WorkSpaces Web Update Ip Access Settings
UpdateIpAccessSettings 8 params body → 200480481482483484

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are IpAccessSettings (6 properties), IpAccessSettingsSummary (4 properties), Tag (2 properties), IpRule (2 properties). Each schema is shown below with its type and property counts.

CreateIpAccessSettingsResponse
object
1 property 1 required
Description
string
ConflictException
StringType
string
IpRange
string
A single IP address or an IP address range in CIDR notation
PaginationToken
string
IpAccessSettings
object
The IP access settings resource that can be associated with a web portal.
6 properties 1 required
ThrottlingException
Tag
object
The tag.
2 properties 2 required
TagKey
string
ServiceQuotaExceededException
ResourceNotFoundException
DeleteIpAccessSettingsResponse
object
DisplayName
string
IpAccessSettingsList
array
ListIpAccessSettingsResponse
object
2 properties
ARN
string
IpRule
object
The IP rules of the IP access settings.
2 properties 1 required
Timestamp
string
AccessDeniedException
IpAccessSettingsSummary
object
The summary of IP access settings.
4 properties
ArnList
array
ValidationException
GetIpAccessSettingsResponse
object
1 property
IpRuleList
array
UpdateIpAccessSettingsResponse
object
1 property 1 required
TagValue
string
InternalServerException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Amazon WorkSpaces Web publishes across the network.

Amazon WorkSpaces Web BrowserSettings API
Amazon WorkSpaces Web IdentityProviders API
Amazon WorkSpaces Web NetworkSettings API
Amazon WorkSpaces Web PortalIdp API
Amazon WorkSpaces Web Portals API
Amazon WorkSpaces Web Tags API
Amazon WorkSpaces Web TrustStores API
Amazon WorkSpaces Web UserAccessLoggingSettings API
Amazon WorkSpaces Web UserSettings API
Where this information came from

This is an independent, third-party profile of Amazon WorkSpaces Web IpAccessSettings 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.