ListEntitiesFilter - AWS IoT TwinMaker

ListEntitiesFilter

An object that filters items in a list of entities.

Contents

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

componentTypeId

The ID of the component type in the entities in the list.

Type: String

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

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

Required: No

externalId

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

Type: String

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

Pattern: .*

Required: No

parentEntityId

The parent of the entities in the list.

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: