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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

EntityFilter

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

Contents

name

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Type: String

Valid Values: NAME | NAMESPACE | SEMANTIC_TYPE_PATH | REFERENCED_ENTITY_ID

Required: No

value

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

Type: Array of strings

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: