---
title: "POST /workspaces/{workspaceId}/entities"
method: POST
path: "/workspaces/{workspaceId}/entities"
---

# POST /workspaces/{workspaceId}/entities

`POST /workspaces/{workspaceId}/entities`

Creates an entity.

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `entityId` string — The ID of the entity.
  - `entityName` string, required — The name of the entity.
  - `description` string — The description of the entity.
  - `components` object — An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
  - `compositeComponents` object — This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.
  - `parentEntityId` string — The ID of the entity's parent entity.
  - `tags` object — Metadata that you can use to manage the entity.

## Response `200`

Success

- CreateEntityResponse
  - `entityId` string, required — The ID of the entity.
  - `arn` string, required — The ARN of the entity.
  - `creationDateTime` string, date-time, required — The date and time when the entity was created.
  - `state` 'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'ERROR', required — The current state of the entity.

## Other responses

- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — ConflictException
- `485` — ServiceQuotaExceededException

---

[API](https://skmtc.net/aws/apis/iottwinmaker.md) · [All operations](https://skmtc.net/aws/apis/iottwinmaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iottwinmaker/versions/a66a26fd65ea/schema)