search_group_profiles
Search for group profiles in an Amazon DataZone domain by specifying group type and optional text to filter results. Supports paginated responses.
Instructions
Searches for group profiles within a specified Amazon DataZone domain.
This operation allows you to find groups by specifying a group type and optional search text. Pagination is supported through maxResults and nextToken.
Args: domain_identifier (str): The identifier of the Amazon DataZone domain in which to search group profiles. Pattern: ^dzd[-][a-zA-Z0-9-]{1,36}$ Required: Yes
group_type (str): The type of group to search for.
Valid values:
- "SSO_GROUP"
- "DATAZONE_SSO_GROUP"
Required: Yes
max_results (int, optional): The maximum number of results to return in a single call.
Valid range: 1–50
Required: No
next_token (str, optional): Pagination token from a previous response. Use this to retrieve the next set of results.
Length: 1–8192 characters
Required: No
search_text (str, optional): Free-text string used to filter group profiles.
Max length: 1024
Required: NoReturns: dict: A response object containing: - items (List[dict]): A list of group profile summaries. Each summary includes: - domainId (str): The domain to which the group belongs. - groupName (str): The name of the group. - id (str): The unique identifier of the group profile. - status (str): The current status of the group profile. - nextToken (str, optional): A token to retrieve the next page of results, if more are available. Length: 1–8192 characters
Raises: HTTPError: If the API request fails or returns an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_type | Yes | ||
| next_token | No | ||
| max_results | No | ||
| search_text | No | ||
| domain_identifier | Yes |