search_user_profiles
Search and filter user profiles by type and text in an Amazon DataZone domain, with pagination for large result sets.
Instructions
Searches for user profiles within a specified Amazon DataZone domain.
This API supports filtering results by user type and search text, as well as pagination through maxResults and nextToken.
Args: domain_identifier (str): The identifier of the Amazon DataZone domain in which to perform the search. Pattern: ^dzd[-][a-zA-Z0-9-]{1,36}$ Required: Yes
max_results (int, optional): The maximum number of user profiles to return in a single call.
Valid Range: 1–50
Required: No
next_token (str, optional): Pagination token from a previous response. Use to retrieve the next page of results.
Min length: 1, Max length: 8192
Required: No
search_text (str, optional): Text to search for in user profiles.
Max length: 1024
Required: No
user_type (str): The type of user profile to search for.
Valid values:
- "SSO_USER"
- "DATAZONE_USER"
- "DATAZONE_SSO_USER"
- "DATAZONE_IAM_USER"
Required: YesReturns: dict: A response object containing: - items (List[dict]): A list of user profile summaries. Each summary includes: - details (dict): UserProfileDetails (union type) - domainId (str): Domain ID the user profile belongs to. - id (str): The identifier of the user profile. - status (str): Profile status. Possible values: "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED". - type (str): Type of the user profile. Possible values: "IAM", "SSO". - nextToken (str, optional): Token for paginated responses. Min length: 1, Max length: 8192
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_type | Yes | ||
| next_token | No | ||
| max_results | No | ||
| search_text | No | ||
| domain_identifier | Yes |