Filters
Important
Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs.
Learn about migration steps here:
How to migrate data from Amazon WorkDocs
Filters results based on entity metadata.
Contents
- AncestorIds
-
Filter based on resource’s path.
Type: Array of strings
Array Members: Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- ContentCategories
-
Filters by content category.
Type: Array of strings
Array Members: Maximum number of 9 items.
Valid Values:
IMAGE | DOCUMENT | PDF | SPREADSHEET | PRESENTATION | AUDIO | VIDEO | SOURCE_CODE | OTHERRequired: No
- CreatedRange
-
Filter based on resource’s creation timestamp.
Type: DateRangeType object
Required: No
- Labels
-
Filter by labels using exact match.
Type: Array of strings
Array Members: Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- ModifiedRange
-
Filter based on resource’s modified timestamp.
Type: DateRangeType object
Required: No
- Principals
-
Filter based on UserIds or GroupIds.
Type: Array of SearchPrincipalType objects
Array Members: Maximum number of 10 items.
Required: No
- ResourceTypes
-
Filters based on entity type.
Type: Array of strings
Array Members: Maximum number of 4 items.
Valid Values:
FOLDER | DOCUMENT | COMMENT | DOCUMENT_VERSIONRequired: No
- SearchCollectionTypes
-
Filter based on file groupings.
Type: Array of strings
Array Members: Maximum number of 2 items.
Valid Values:
OWNED | SHARED_WITH_MERequired: No
- SizeRange
-
Filter based on size (in bytes).
Type: LongRangeType object
Required: No
- TextLocales
-
Filters by the locale of the content or comment.
Type: Array of strings
Array Members: Maximum number of 1 item.
Valid Values:
AR | BG | BN | DA | DE | CS | EL | EN | ES | FA | FI | FR | HI | HU | ID | IT | JA | KO | LT | LV | NL | NO | PT | RO | RU | SV | SW | TH | TR | ZH | DEFAULTRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
