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

# PUT /workspaces/{workspaceId}/entities/{entityId}

`PUT /workspaces/{workspaceId}/entities/{entityId}`

Updates an entity.

## Path parameters

- `workspaceId` string, required
- `entityId` string, required

## Request body

- object
  - `entityName` string — The name of the entity.
  - `description` string — The description of the entity.
  - `componentUpdates` object — An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
  - `compositeComponentUpdates` 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>.
  - `parentEntityUpdate` object — The parent entity update request.
    - `updateType` 'UPDATE' | 'DELETE' — The type of the update.
    - `parentEntityId` string — The ID of the parent entity.

## Response `200`

Success

- UpdateEntityResponse
  - `updateDateTime` string, date-time, required — The date and time when the entity was last updated.
  - `state` 'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'ERROR', required — The current state of the entity update.

## Other responses

- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — ConflictException
- `486` — 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)