View a markdown version of this page

ListSearchesFilters - AWS IoT SiteWise

ListSearchesFilters

Optional filters for ListSearches. When multiple filters are set, a search must match all of them.

Contents

groupIdFilter

Returns only searches whose groupId is one of the listed values.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 2. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: No

searchTypeFilter

Returns only searches whose searchType is one of the listed values.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: DEEP | QUICK

Required: No

startedAfter

Returns only searches started at or after this time.

Type: Timestamp

Required: No

startedBefore

Returns only searches started at or before this time.

Type: Timestamp

Required: No

statusFilter

Returns only searches whose status is one of the listed values.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Valid Values: QUEUED | RUNNING | SUCCEEDED | FAILED

Required: No

See Also

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