entities

Creates, updates, deletes, gets or lists an entities resource.

Overview

Name	entities
Type	Resource
Id	aws.iotthingsgraph.entities

Fields

The following fields are returned by SELECT queries:

get_entities

Name	Datatype	Description
descriptions	array	An array of descriptions for the specified entities.

search_entities

Name	Datatype	Description
id	string	The entity ID. (pattern: <code>^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)[\p{Alnum}]+(/[\p{Alnum}]+)):([\p{Alpha}]):([\p{Alnum}]+(/[\p{Alnum}]+))$</code>)
arn	string	The entity ARN.
created_at	string (date-time)	The time at which the entity was created.
definition	object	A document that defines an entity.
type_	string	The entity type. (DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_entities	select	region		Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities. Properties States Events Actions Capabilities Mappings Devices Device Models Services This action doesn't return definitions for systems, flows, and deployments.
search_entities	select	region		Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_entities

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities. Properties States Events Actions Capabilities Mappings Devices Device Models Services This action doesn't return definitions for systems, flows, and deployments.

SELECT
descriptions
FROM aws.iotthingsgraph.entities
WHERE region = '{{ region }}' -- required
;

search_entities

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

SELECT
id,
arn,
created_at,
definition,
type_
FROM aws.iotthingsgraph.entities
WHERE region = '{{ region }}' -- required
;