AWS IoT Things Graph
API Reference (API Version 2018-09-06)

EntityDescription

Describes the properties of an entity.

Contents

arn

The entity ARN.

Type: String

Required: No

createdAt

The time at which the entity was created.

Type: Timestamp

Required: No

definition

The definition document of the entity.

Type: DefinitionDocument object

Required: No

id

The entity ID.

Type: String

Length Constraints: Maximum length of 160.

Pattern: ^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}_]+)*)$

Required: No

type

The entity type.

Type: String

Valid Values: DEVICE | SERVICE | DEVICE_MODEL | CAPABILITY | STATE | ACTION | EVENT | PROPERTY | MAPPING | ENUM

Required: No

See Also

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

On this page: