UpdateEntity - IoT TwinMaker

UpdateEntity

Updates an entity.

Request Syntax

PUT /workspaces/workspaceId/entities/entityId HTTP/1.1 Content-type: application/json { "componentUpdates": { "string" : { "componentTypeId": "string", "description": "string", "propertyUpdates": { "string" : { "definition": { "configuration": { "string" : "string" }, "dataType": { "allowedValues": [ { "booleanValue": boolean, "doubleValue": number, "expression": "string", "integerValue": number, "listValue": [ "DataValue" ], "longValue": number, "mapValue": { "string" : "DataValue" }, "relationshipValue": { "targetComponentName": "string", "targetEntityId": "string" }, "stringValue": "string" } ], "nestedType": "DataType", "relationship": { "relationshipType": "string", "targetComponentTypeId": "string" }, "type": "string", "unitOfMeasure": "string" }, "defaultValue": { "booleanValue": boolean, "doubleValue": number, "expression": "string", "integerValue": number, "listValue": [ "DataValue" ], "longValue": number, "mapValue": { "string" : "DataValue" }, "relationshipValue": { "targetComponentName": "string", "targetEntityId": "string" }, "stringValue": "string" }, "isExternalId": boolean, "isRequiredInEntity": boolean, "isStoredExternally": boolean, "isTimeSeries": boolean }, "updateType": "string", "value": { "booleanValue": boolean, "doubleValue": number, "expression": "string", "integerValue": number, "listValue": [ "DataValue" ], "longValue": number, "mapValue": { "string" : "DataValue" }, "relationshipValue": { "targetComponentName": "string", "targetEntityId": "string" }, "stringValue": "string" } } }, "updateType": "string" } }, "description": "string", "entityName": "string", "parentEntityUpdate": { "parentEntityId": "string", "updateType": "string" } }

URI Request Parameters

The request uses the following URI parameters.

entityId

The ID of the entity.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: Yes

workspaceId

The ID of the workspace that contains the entity.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

componentUpdates

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

Type: String to ComponentUpdateRequest object map

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [a-zA-Z_\-0-9]+

Required: No

description

The description of the entity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Pattern: .*

Required: No

entityName

The name of the entity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+

Required: No

parentEntityUpdate

An object that describes the update request for a parent entity.

Type: ParentEntityUpdateRequest object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "state": "string", "updateDateTime": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

state

The current state of the entity update.

Type: String

Valid Values: CREATING | UPDATING | DELETING | ACTIVE | ERROR

updateDateTime

The date and time when the entity was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

ConflictException

A conflict occurred.

HTTP Status Code: 409

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

Failed

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: