EntitySummary - AWS IoT TwinMaker

EntitySummary

An object that contains information about an entity.

Contents

arn

The ARN of the entity.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+

Required: Yes

creationDateTime

The date and time when the entity was created.

Type: Timestamp

Required: Yes

entityId

The ID of the entity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: Yes

entityName

The name of the entity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

status

The current status of the entity.

Type: Status object

Required: Yes

updateDateTime

The last date and time when the entity was updated.

Type: Timestamp

Required: Yes

description

The description of the entity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Required: No

hasChildEntities

An eventual Boolean value that specifies whether the entity has child entities or not.

Type: Boolean

Required: No

parentEntityId

The ID of the parent entity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: \$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: No

See Also

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