Amazon Web Services, Inc.

AWS IoT TwinMaker

IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from…

IoT & devices#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

IoT TwinMaker is a service with which you can
build operational digital twins of physical systems. IoT TwinMaker overlays measurements
and analysis from real-world sensors, cameras, and enterprise applications so you can
create data visualizations to monitor your physical factory, building, or industrial plant.
You can use this real-world data to monitor operations and diagnose and repair
errors.

Endpoints 40

  • POSTBatch put property values/workspaces/:workspaceId/entity-propertiesSets values for multiple time series properties.
  • PUTCancel metadata transfer job/metadata-transfer-jobs/:metadataTransferJobId/cancelCancels the metadata transfer job.
  • GETGet component type/workspaces/:workspaceId/component-types/:componentTypeIdRetrieves information about a component type.
  • PUTUpdate component type/workspaces/:workspaceId/component-types/:componentTypeIdUpdates information in a component type.
  • POSTCreate component type/workspaces/:workspaceId/component-types/:componentTypeIdCreates a component type.
  • DELETEDelete component type/workspaces/:workspaceId/component-types/:componentTypeIdDeletes a component type.
  • POSTCreate entity/workspaces/:workspaceId/entitiesCreates an entity.
  • POSTCreate metadata transfer job/metadata-transfer-jobsCreates a new metadata transfer job.
  • POSTCreate scene/workspaces/:workspaceId/scenesCreates a scene.
  • POSTCreate sync job/workspaces/:workspaceId/sync-jobs/:syncSourceThis action creates a SyncJob.
  • DELETEDelete sync job/workspaces/:workspaceId/sync-jobs/:syncSourceDelete the SyncJob.
  • GETGet workspace/workspaces/:workspaceIdRetrieves information about a workspace.
  • PUTUpdate workspace/workspaces/:workspaceIdUpdates a workspace.
  • POSTCreate workspace/workspaces/:workspaceIdCreates a workplace.
  • DELETEDelete workspace/workspaces/:workspaceIdDeletes a workspace.
  • GETGet entity/workspaces/:workspaceId/entities/:entityIdRetrieves information about an entity.
  • PUTUpdate entity/workspaces/:workspaceId/entities/:entityIdUpdates an entity.
  • DELETEDelete entity/workspaces/:workspaceId/entities/:entityId?isRecursive=trueDeletes an entity.
  • GETGet scene/workspaces/:workspaceId/scenes/:sceneIdRetrieves information about a scene.
  • PUTUpdate scene/workspaces/:workspaceId/scenes/:sceneIdUpdates a scene.
  • DELETEDelete scene/workspaces/:workspaceId/scenes/:sceneIdDeletes a scene.
  • POSTExecute query/queries/executionRun queries to access information from your knowledge graph of entities within individual workspaces. The ExecuteQuery action only works with Amazon Web…
  • GETGet metadata transfer job/metadata-transfer-jobs/:metadataTransferJobIdGets a nmetadata transfer job.
  • GETGet pricing plan/pricingplanGets the pricing plan.
  • POSTUpdate pricing plan/pricingplanUpdate the pricing plan.
  • POSTGet property value/workspaces/:workspaceId/entity-properties/valueGets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName , componentTypeId , entityId…
  • POSTGet property value history/workspaces/:workspaceId/entity-properties/historyRetrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for…
  • GETGet sync job/sync-jobs/:syncSource?workspace=stringGets the SyncJob.
  • POSTList component types/workspaces/:workspaceId/component-types-listLists all component types in a workspace.
  • POSTList components/workspaces/:workspaceId/entities/:entityId/components-listThis API lists the components of an entity.
  • POSTList entities/workspaces/:workspaceId/entities-listLists all entities in a workspace.
  • POSTList metadata transfer jobs/metadata-transfer-jobs-listLists the metadata transfer jobs.
  • POSTList properties/workspaces/:workspaceId/properties-listThis API lists the properties of a component.
  • POSTList scenes/workspaces/:workspaceId/scenes-listLists all scenes in a workspace.
  • POSTList sync jobs/workspaces/:workspaceId/sync-jobs-listList all SyncJobs.
  • POSTList sync resources/workspaces/:workspaceId/sync-jobs/:syncSource/resources-listLists the sync resources.
  • POSTList tags for resource/tags-listLists all tags associated with a resource.
  • POSTList workspaces/workspaces-listRetrieves information about workspaces in the current account.
  • POSTTag resource/tagsAdds tags to a resource.
  • DELETEUntag resource/tags?resourceARN=string&tagKeys=Removes tags from a resource.

API details

Base URL
https://iottwinmaker.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
40 operations on 27 pathsPOST 22GET 7DELETE 6PUT 5
Description format
AWS Smithy model, API version 2021-11-29

How to test the AWS IoT TwinMaker 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 AWS IoT TwinMaker 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 “Batch put property values” (POST /workspaces/:workspaceId/entity-properties), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT TwinMaker?

IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from… It is listed under IoT & devices and has 40 endpoints.

Who publishes the AWS IoT TwinMaker?

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 AWS IoT TwinMaker?

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

How do I authenticate with the AWS IoT TwinMaker?

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

How many endpoints does the AWS IoT TwinMaker have?

40 operations on 27 paths (22 POST, 7 GET, 6 DELETE, 5 PUT).

Is forking the AWS IoT TwinMaker 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.