entity

Gets an individual entity resource

Overview

Name	entity
Type	Resource
Description	entity
Id	awscc.iottwinmaker.entity

Fields

Name	Datatype	Description
entity_id	string	The ID of the entity.
entity_name	string	The name of the entity.
status	object	The current status of the entity.
has_child_entities	boolean	A Boolean value that specifies whether the entity has child entities or not.
parent_entity_id	string	The ID of the parent entity.
arn	string	The ARN of the entity.
description	string	The description of the entity.
creation_date_time	string	The date and time when the entity was created.
update_date_time	string	The last date and time when the entity was updated.
tags	object	A key-value pair to associate with a resource.
workspace_id	string	The ID of the workspace.
components	object	A map that sets information about a component type.
composite_components	object	A map that sets information about a composite component.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
entity_id,
entity_name,
status,
has_child_entities,
parent_entity_id,
arn,
description,
creation_date_time,
update_date_time,
tags,
workspace_id,
components,
composite_components
FROM awscc.iottwinmaker.entity
WHERE data__Identifier = '<WorkspaceId>|<EntityId>';

Permissions

To operate on the entity resource, the following permissions are required:

Read

iottwinmaker:GetComponentType,
iottwinmaker:GetEntity,
iottwinmaker:ListComponents,
iottwinmaker:ListProperties,
iottwinmaker:GetWorkspace,
iottwinmaker:ListEntities,
iottwinmaker:ListTagsForResource

Update

iottwinmaker:GetComponentType,
iottwinmaker:GetEntity,
iottwinmaker:ListComponents,
iottwinmaker:ListProperties,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource,
iottwinmaker:TagResource,
iottwinmaker:UntagResource,
iottwinmaker:UpdateEntity,
iottwinmaker:UpdateComponentType

Delete

iottwinmaker:GetEntity,
iottwinmaker:GetWorkspace,
iottwinmaker:DeleteEntity