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 Configuration API

The Configuration API from Amazon IoT SiteWise — 2 operation(s) for configuration.

Amazon IoT SiteWise Configuration 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 Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 4 operations across 2 paths, and defines 26 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.

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

Authentication & Security 1

Amazon IoT SiteWise Configuration 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 4

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

Configuration 4
GET
/configuration/account/encryption
Amazon IoT SiteWise Describe Default Encryption Configuration
DescribeDefaultEncryptionConfiguration 7 params → 200480481482
POST
/configuration/account/encryption
Amazon IoT SiteWise Put Default Encryption Configuration
PutDefaultEncryptionConfiguration 7 params body → 200480481482483484
GET
/configuration/account/storage
Amazon IoT SiteWise Describe Storage Configuration
DescribeStorageConfiguration 7 params → 200480481482483484485
POST
/configuration/account/storage
Amazon IoT SiteWise Put Storage Configuration
PutStorageConfiguration 7 params body → 200480481482483484485486

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DescribeStorageConfigurationResponse (6 properties), PutStorageConfigurationResponse (5 properties), PutDefaultEncryptionConfigurationResponse (3 properties), DescribeDefaultEncryptionConfigurationResponse (3 properties). Each schema is shown below with its type and property counts.

RetentionPeriod
object
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
2 properties
Timestamp
string
Unlimited
boolean
DisassociatedDataStorageState
string
DescribeDefaultEncryptionConfigurationResponse
object
3 properties 2 required
ConfigurationState
string
DescribeStorageConfigurationResponse
object
6 properties 2 required
MultiLayerStorage
object
Contains information about the storage destination.
1 property 1 required
NumberOfDays
integer
InternalFailureException
CustomerManagedS3Storage
object
Contains information about a customer managed Amazon S3 bucket.
2 properties 2 required
ResourceNotFoundException
ConflictingOperationException
ErrorCode
string
ThrottlingException
InvalidRequestException
ARN
string
ErrorMessage
string
StorageType
string
PutDefaultEncryptionConfigurationResponse
object
3 properties 2 required
ConfigurationStatus
object
Contains current status information for the configuration.
2 properties 1 required
LimitExceededException
PutStorageConfigurationResponse
object
5 properties 2 required
ResourceAlreadyExistsException
ConfigurationErrorDetails
object
Contains the details of an IoT SiteWise configuration error.
2 properties 2 required
EncryptionType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-sitewise-configuration-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 Dashboards API
Amazon IoT SiteWise Dashboards#projectId API
Amazon IoT SiteWise Gateways 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 Configuration 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.