entities_list_only

Lists entities in a region or regions, for all properties use entities

Overview

Name	entities_list_only
Type	Resource
Description	Resource schema for AWS::IoTTwinMaker::Entity
Id	aws.iottwinmaker.entities_list_only

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

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all entities in a region.

SELECT
region,
workspace_id,
entity_id
FROM aws.iottwinmaker.entities_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the entities_list_only resource, see entities