# AWS IoT TwinMaker API

> AWS IoT TwinMaker API on Apizie: 34 endpoints (Sets values for multiple time series properties., Retrieves information about a component type., Creates a component type., Updates information in a component type., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-iottwinmaker`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-iottwinmaker
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-iottwinmaker/openapi.json

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…

## Endpoints

### Sets values for multiple time series properties.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/batch-put-property-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the properties to set. |
| body | object | yes | JSON request body |

### Retrieves information about a component type.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-component-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the component type. |
| componentTypeId | string | yes | The ID of the component type. |

### Creates a component type.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/create-component-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the component type. |
| componentTypeId | string | yes | The ID of the component type. |
| body | object | yes | JSON request body |

### Updates information in a component type.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/update-component-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| componentTypeId | string | yes | The ID of the component type. |
| body | object | yes | JSON request body |

### Deletes a component type.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/delete-component-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the component type. |
| componentTypeId | string | yes | The ID of the component type to delete. |

### Creates an entity.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/create-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the entity. |
| body | object | yes | JSON request body |

### Creates a scene.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/create-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the scene. |
| body | object | yes | JSON request body |

### This action creates a SyncJob.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/create-sync-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The workspace ID. |
| syncSource | string | yes | The sync source. Currently the only supported syncSoource is SITEWISE . |
| body | object | yes | JSON request body |

### Delete the SyncJob.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/delete-sync-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The workspace ID. |
| syncSource | string | yes | The sync source. Currently the only supported syncSource is SITEWISE . |

### Retrieves information about a workspace.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |

### Creates a workplace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| body | object | yes | JSON request body |

### Updates a workspace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/update-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| body | object | yes | JSON request body |

### Deletes a workspace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/delete-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace to delete. |

### Retrieves information about an entity.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| entityId | string | yes | The ID of the entity. |

### Updates an entity.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/update-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the entity. |
| entityId | string | yes | The ID of the entity. |
| body | object | yes | JSON request body |

### Deletes an entity.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/delete-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the entity to delete. |
| entityId | string | yes | The ID of the entity to delete. |
| isRecursive | boolean | no | A Boolean value that specifies whether the operation deletes child entities. |

### Retrieves information about a scene.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the scene. |
| sceneId | string | yes | The ID of the scene. |

### Updates a scene.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/update-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the scene. |
| sceneId | string | yes | The ID of the scene. |
| body | object | yes | JSON request body |

### Deletes a scene.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/delete-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| sceneId | string | yes | The ID of the scene to delete. |

### Run queries to access information from your knowledge graph of entities within individual workspaces.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/execute-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets the pricing plan.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-pricing-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Update the pricing plan.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/update-pricing-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets the property values for a component, component type, entity, or workspace. You must specify a value for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace whose values the operation returns. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Retrieves information about the history of a time series property value for a component, component type,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-property-value-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets the SyncJob.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/get-sync-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| syncSource | string | yes | The sync source. Currently the only supported syncSource is SITEWISE . |
| workspace | string | no | The workspace ID. |

### Lists all component types in a workspace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-component-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists all entities in a workspace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists all scenes in a workspace.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the scenes. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### List all SyncJobs.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-sync-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the sync job. |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists the sync resources.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-sync-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workspaceId | string | yes | The ID of the workspace that contains the sync job. |
| syncSource | string | yes | The sync source. Currently the only supported syncSource is SITEWISE . |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists all tags associated with a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about workspaces in the current account.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/list-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Adds tags to a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Removes tags from a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceARN | string | yes | The ARN of the resource. |
| tagKeys | array | yes | A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/batch-put-property-values" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS IoT TwinMaker API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-iottwinmaker/batch-put-property-values with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS IoT TwinMaker API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS IoT TwinMaker itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS IoT TwinMaker API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-iottwinmaker.

### What is the status of the AWS IoT TwinMaker API?
Needs your own provider key (bring your own key)