search_user_profiles ¶

def search_user_profiles(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    user_type: "capo_datazone.types.user_search_type.UserSearchType",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    search_text: Optional[
        "capo_datazone.types.user_search_text.UserSearchText"
    ] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_datazone.types.search_user_profiles_output.SearchUserProfilesOutput":
    """<p>Searches user profiles in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</p>
        user_type: <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
        search_text: <p>Specifies the text for which to search.</p>
        max_results: <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: <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>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.search_user_profiles_input.SearchUserProfilesInput]",
    ) -> OperationResponse[
        "capo_datazone.types.search_user_profiles_output.SearchUserProfilesOutput"
    ]:
        import capo_datazone._operations.data_zone.search_user_profiles

        output, http_response = (
            capo_datazone._operations.data_zone.search_user_profiles.search_user_profiles(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_datazone.types.search_user_profiles_input.SearchUserProfilesInput",
    ) -> dict[str, Any]:
        import capo_datazone.types.search_user_profiles_input

        return capo_datazone.types.search_user_profiles_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_datazone.types.search_user_profiles_output.SearchUserProfilesOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.search_user_profiles_output

        return capo_datazone.types.search_user_profiles_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "SearchUserProfiles",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_datazone.types.search_user_profiles_input.SearchUserProfilesInput = {
        "domain_identifier": domain_identifier,
        "user_type": user_type,
    }
    if search_text is not None:
        input_["search_text"] = search_text
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output