EntityPropertyReference - AWS IoT TwinMaker

EntityPropertyReference

An object that uniquely identifies an entity property.

Contents

propertyName

The name of the property.

Type: String

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

Pattern: [a-zA-Z_\-0-9]+

Required: Yes

componentName

The name of the component.

Type: String

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

Pattern: [a-zA-Z_\-0-9]+

Required: No

componentPath

This string specifies the path to the composite component, starting from the top-level component.

Type: String

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

Pattern: [a-zA-Z_\-0-9/]+

Required: No

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: No

externalIdProperty

A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

Type: String to string map

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

Key Pattern: .*

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

Value Pattern: .*

Required: No

See Also

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