Skip to content

SearchUserProfilesInput

Source code in docs_src/capo_datazone/types/search_user_profiles_input.py
class SearchUserProfilesInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</p>"""
    user_type: "capo_datazone.types.user_search_type.UserSearchType"
    """<p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>"""
    search_text: NotRequired["capo_datazone.types.user_search_text.UserSearchText"]
    """<p>Specifies the text for which to search.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results. </p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>"""

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon DataZone domain in which you want to search user profiles.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

search_text instance-attribute

search_text: NotRequired[UserSearchText]

Specifies the text for which to search.

user_type instance-attribute

user_type: UserSearchType

Specifies the user type for the SearchUserProfiles action.