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 IoT SiteWise Gateways API

The Gateways API from Amazon IoT SiteWise — 4 operation(s) for gateways.

Amazon IoT SiteWise Gateways API is one of 16 APIs that Amazon IoT SiteWise publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateways. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 7 operations across 4 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

7 operations 4 paths 29 schemas 1 DELETE3 GET2 POST1 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://iotsitewise.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT SiteWise Gateways 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 7

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

Gateways 7
POST
/20200301/gateways
Amazon IoT SiteWise Create Gateway
CreateGateway 7 params body → 201480481482483484
GET
/20200301/gateways
Amazon IoT SiteWise List Gateways
ListGateways 9 params → 200480481482
DELETE
/20200301/gateways/{gatewayId}
Amazon IoT SiteWise Delete Gateway
DeleteGateway 8 params → 200480481482483
GET
/20200301/gateways/{gatewayId}
Amazon IoT SiteWise Describe Gateway
DescribeGateway 8 params → 200480481482483
PUT
/20200301/gateways/{gatewayId}
Amazon IoT SiteWise Update Gateway
UpdateGateway 8 params body → 200480481482483484
GET
/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}
Amazon IoT SiteWise Describe Gateway Capability Configuration
DescribeGatewayCapabilityConfiguration 9 params → 200480481482483
POST
/20200301/gateways/{gatewayId}/capability
Amazon IoT SiteWise Update Gateway Capability Configuration
UpdateGatewayCapabilityConfiguration 8 params body → 201480481482483484485

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DescribeGatewayResponse (7 properties), GatewaySummary (6 properties), DescribeGatewayCapabilityConfigurationResponse (4 properties), ListGatewaysResponse (2 properties). Each schema is shown below with its type and property counts.

NextToken
string
Timestamp
string
ListGatewaysResponse
object
2 properties 1 required
GreengrassV2
object
Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge compon…
1 property 1 required
CapabilityNamespace
string
UpdateGatewayCapabilityConfigurationResponse
object
2 properties 2 required
DescribeGatewayResponse
object
7 properties 6 required
CapabilityConfiguration
string
GatewaySummary
object
Contains a summary of a gateway.
6 properties 4 required
CreateGatewayResponse
object
2 properties 2 required
InternalFailureException
GatewayCapabilitySummary
object
Contains a summary of a gateway capability configuration.
2 properties 2 required
GatewaySummaries
array
ResourceNotFoundException
ID
string
DescribeGatewayCapabilityConfigurationResponse
object
4 properties 4 required
ConflictingOperationException
ThrottlingException
InvalidRequestException
ARN
string
TagValue
string
Greengrass
object
Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Green…
1 property 1 required
GatewayPlatform
object
Contains a gateway's platform information.
2 properties
GatewayCapabilitySummaries
array
LimitExceededException
Name
string
ResourceAlreadyExistsException
CapabilitySyncStatus
string
CoreDeviceThingName
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-sitewise-gateways-api-openapi.yml Raw ↑

Other APIs Amazon IoT SiteWise publishes across the network.

Amazon IoT SiteWise Access Policies API
Amazon IoT SiteWise Asset Models API
Amazon IoT SiteWise Assets API
Amazon IoT SiteWise Configuration API
Amazon IoT SiteWise Dashboards API
Amazon IoT SiteWise Dashboards#projectId API
Amazon IoT SiteWise Jobs API
Amazon IoT SiteWise Logging API
Amazon IoT SiteWise Portals API
Amazon IoT SiteWise Projects API
Amazon IoT SiteWise Projects#portalId API
Amazon IoT SiteWise Properties API
Where this information came from

This is an independent, third-party profile of Amazon IoT SiteWise Gateways 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.