Amazon IoT TwinMaker Workspaces API is one of 8 APIs that Amazon IoT TwinMaker publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
26 operations
across 15 paths,
and defines 154 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://iottwinmaker.{region}.amazonaws.com, https://iottwinmaker.{region}.amazonaws.com, http://iottwinmaker.{region}.amazonaws.com.cn, https://iottwinmaker.{region}.amazonaws.com.cn.
26 operations15 paths154 schemas5 DELETE4 GET13 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Amazon IoT TwinMaker Workspaces 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 26
Across 15 paths, the API surfaces 26 operations — 5 DELETE, 4 GET, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 154 schemas that model the data the API accepts and returns. The most detailed are GetComponentTypeResponse (16 properties), GetEntityResponse (12 properties), GetSceneResponse (11 properties), PropertyDefinitionResponse (11 properties). Each schema is shown below with its type and property counts.
OrderByList
array
PropertyDefinitionRequest
object
An object that sets information about a property.
8 properties
GeneratedSceneMetadataMap
object
PropertyLatestValueMap
object
Expression
string
SyncResourceSummaries
array
Type
string
FunctionRequest
object
The function request body.
3 properties
DataValue
object
An object that specifies a value for a property.
9 properties
Values
array
ResourceNotFoundException
ListSyncJobsResponse
object
2 properties
SceneCapability
string
Id
string
ExtendsFrom
array
Long
integer
PropertyGroupsResponse
object
Value
string
S3Url
string
Name
string
PropertyGroupResponse
object
The property group response
3 properties3 required
String
string
DeleteComponentTypeResponse
object
1 property1 required
GroupType
string
Double
number
PropertyDisplayName
string
RelationshipValue
object
A value that associates a component and an entity.
2 properties
SceneMetadataMap
object
IntervalInSeconds
integer
ListEntitiesResponse
object
2 properties
MaxResults
integer
UpdateComponentTypeResponse
object
4 properties4 required
ParentEntityUpdateType
string
EntitySummaries
array
Configuration
object
TagValue
string
InternalServerException
BatchPutPropertyError
object
An error returned by the BatchPutProperty action.
3 properties3 required
Description
string
SyncJobState
string
DeleteSyncJobResponse
object
1 property1 required
ConnectorFailureException
SyncJobStatus
object
The SyncJob status.
2 properties
GetWorkspaceResponse
object
7 properties6 required
PropertyDefinitionResponse
object
An object that contains response data from a property definition request.
11 properties8 required
Scope
string
SyncResourceFilter
object
The sync resource filter.
4 properties
UpdateSceneResponse
object
1 property1 required
PropertyLatestValue
object
The latest value of the property.
2 properties1 required
BatchPutPropertyErrorEntry
object
An object that contains information about errors returned by the BatchPutProperty action.
1 property1 required
ErrorMessage
string
EntityPropertyReference
object
An object that uniquely identifies an entity property.
4 properties1 required
ListEntitiesFilter
object
An object that filters items in a list of entities.
3 properties
FunctionsResponse
object
ComponentResponse
object
An object that returns information about a component type create or update request.
8 properties
ComponentPropertyGroupRequest
object
The component property group request.
3 properties
TabularPropertyValue
array
RoleArn
string
PropertyValueList
array
ComponentTypeId
string
DeleteSceneResponse
object
EntitySummary
object
An object that contains information about an entity.
9 properties6 required
ParentEntityId
string
Integer
integer
UpdateEntityResponse
object
2 properties2 required
PropertyRequest
object
An object that sets information about a property.
3 properties
Boolean
boolean
CreateComponentTypeResponse
object
3 properties3 required
SyncJobSummary
object
The SyncJob summary.
6 properties
ComponentTypeSummaries
array
Status
object
An object that represents the status of an entity, component, component type, or workspace.
2 properties
ErrorDetails
object
The error details.
2 properties
PropertyNames
array
PropertyDefinitionsResponse
object
SceneErrorCode
string
Order
string
SceneSummaries
array
SyncJobSummaries
array
S3Location
string
ErrorCode
string
TwinMakerArn
string
DataType
object
An object that specifies the data type of a property.
5 properties1 required
BatchPutPropertyValuesResponse
object
1 property1 required
GetSceneResponse
object
11 properties6 required
PropertyRequests
object
ComponentPropertyGroupResponses
object
ConnectorTimeoutException
NextToken
string
ListComponentTypesResponse
object
4 properties2 required
PropertyFilter
object
An object that filters items returned by a property request.
3 properties
ComponentUpdateRequest
object
The component update request.
5 properties
DataConnector
object
The data connector.
2 properties
SyncResourceSummary
object
The sync resource summary.
5 properties
EntityId
string
ExternalIdProperty
object
RequiredProperties
array
PropertyValueEntry
object
An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
2 properties1 required
ComponentsMap
object
DeleteEntityResponse
object
1 property1 required
SceneSummary
object
An object that contains information about a scene.
6 properties5 required
GetEntityResponse
object
12 properties9 required
State
string
SyncResourceStatus
object
The sync resource status.
2 properties
SyncResourceState
string
GetPropertyValueResponse
object
3 properties
SyncSource
string
GetComponentTypeResponse
object
16 properties5 required
Errors
array
DeleteWorkspaceResponse
object
PropertyValues
array
ComponentUpdateType
string
ComponentTypeSummary
object
An object that contains information about a component type.
7 properties4 required
InterpolationType
string
CreateWorkspaceResponse
object
2 properties2 required
ConflictException
PropertyFilters
array
Time
string
Timestamp represented in ISO 8601 format
UpdateWorkspaceResponse
object
1 property1 required
ThrottlingException
ComponentPropertyGroupResponse
object
The component property group response.
3 properties3 required
CreateSceneResponse
object
2 properties2 required
PropertyGroupUpdateType
string
SceneError
object
The scene error.
2 properties
Relationship
object
An object that specifies a relationship with another component type.
2 properties
ServiceQuotaExceededException
ListScenesResponse
object
2 properties
ComponentTypeName
string
LambdaFunction
object
The Lambda function.
1 property1 required
GetPropertyValueHistoryResponse
object
2 properties1 required
ComponentRequest
object
An object that sets information about a component type create or update request.
4 properties
CreateEntityResponse
object
4 properties4 required
ListSyncResourcesResponse
object
2 properties
PropertyValueHistory
object
The history of values for a time series property.
2 properties1 required
OrderBy
object
Filter criteria that orders the return output. It can be sorted in ascending or descending order.
2 properties1 required
ListComponentTypesFilter
object
An object that filters items in a list of component types. Only one object is accepted as a valid input.
3 properties
SceneMetadataValue
string
SyncResourceType
string
EntityName
string
PropertyUpdateType
string
DataValueMap
object
ComponentPropertyGroupRequests
object
TabularPropertyValues
array
DataValueList
array
CreateSyncJobResponse
object
3 properties3 required
Timestamp
string
supports epoch seconds value
ErrorEntries
array
AccessDeniedException
PropertyGroupRequest
object
2 properties
ValidationException
LambdaArn
string
SceneCapabilities
array
PropertyValue
object
An object that contains information about a value for a time series property.
3 properties1 required
FunctionResponse
object
The function response.
4 properties
PropertyTableValue
object
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 IoT TwinMaker Workspaces 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.
