ListUsersFilters
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 ListUsers operation. This is only used as input to Operation.
Contents
- DisplayNamePrefix
-
Filters only users with the provided display name prefix.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- IdentityProviderUserIdPrefix
-
Filters only users with the ID from the IAM Identity Center.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern:
^[A-Fa-f0-9-]+$Required: No
- PrimaryEmailPrefix
-
Filters only users with the provided email prefix.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- State
-
Filters only users with the provided state.
Type: String
Valid Values:
ENABLED | DISABLED | DELETEDRequired: No
- UsernamePrefix
-
Filters only users with the provided username prefix.
Type: String
Length Constraints: Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
