ListGroupsFilters
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
Filtering options for ListGroups operation. This is only used as input to Operation.
Contents
- NamePrefix
-
Filters only groups with the provided name prefix.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- PrimaryEmailPrefix
-
Filters only groups with the provided primary email prefix.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- State
-
Filters only groups with the provided state.
Type: String
Valid Values:
ENABLED | DISABLED | DELETEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
