Skip to main content

entity_tags

Expands all tag keys and values for entities in a region

Overview

Nameentity_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Idaws.iottwinmaker.entity_tags

Fields

NameDatatypeDescription
entity_idstringThe ID of the entity.
entity_namestringThe name of the entity.
statusobjectThe current status of the entity.
has_child_entitiesbooleanA Boolean value that specifies whether the entity has child entities or not.
parent_entity_idstringThe ID of the parent entity.
arnstringThe ARN of the entity.
descriptionstringThe description of the entity.
creation_date_timestringThe date and time when the entity was created.
update_date_timestringThe last date and time when the entity was updated.
workspace_idstringThe ID of the workspace.
componentsobjectA map that sets information about a component type.
composite_componentsobjectA map that sets information about a composite component.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all entities in a region.

SELECT
region,
entity_id,
entity_name,
status,
has_child_entities,
parent_entity_id,
arn,
description,
creation_date_time,
update_date_time,
workspace_id,
components,
composite_components,
tag_key,
tag_value
FROM aws.iottwinmaker.entity_tags
WHERE region = 'us-east-1';

Permissions

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